如何将Django CMS插件限制在其创建页面显示

我之前帮好几个开发者解决过这个问题——默认情况下，Django CMS的自定义插件是全局可见的，所有页面在添加插件时都能看到它。要实现「插件仅在指定页面可选」，核心是做页面级别的插件权限过滤，下面给你几个实用的方案：

方案1：重写插件的is_allowed方法（最灵活） #

这个方法能直接在插件类里控制哪些页面可以使用它，适合需要动态绑定页面的场景。

步骤1：给插件模型添加关联页面字段（可选，若需动态绑定） #

如果你希望插件被第一次添加到某个页面后，就只在该页面可用，可以给插件模型加一个外键关联到Page：

from django.db import models
from cms.models import Page
from cms.models.pluginmodel import CMSPlugin

class MyImagePluginModel(CMSPlugin):
    image = models.ImageField(upload_to='plugin_images')
    # 存储关联的页面，editable=False避免用户手动修改
    associated_page = models.ForeignKey(Page, on_delete=models.CASCADE, editable=False, null=True)

步骤2：重写插件类的方法 #

在你的插件类里，先通过save_model把当前编辑的页面绑定到插件实例，再重写is_allowed方法判断当前页面是否符合要求：

from cms.plugin_base import CMSPluginBase

class MyImagePlugin(CMSPluginBase):
    model = MyImagePluginModel
    name = "专属图片插件"
    render_template = "plugins/my_image.html"

    def save_model(self, request, obj, form, change):
        # 保存当前编辑的页面到插件实例
        if request.current_page:
            obj.associated_page = request.current_page
        super().save_model(request, obj, form, change)

    def is_allowed(self, placeholder, page):
        # 情况1：只允许指定页面ID的页面使用（固定页面）
        # allowed_page_ids = [1, 3]  # 替换成你的页面ID列表
        # return page.id in allowed_page_ids if page else False

        # 情况2：只允许插件第一次绑定的页面使用（动态绑定）
        if not page:
            return False
        # 先检查是否已有插件实例绑定到某个页面
        existing_instances = MyImagePluginModel.objects.exclude(associated_page__isnull=True)
        if existing_instances.exists():
            allowed_page = existing_instances.first().associated_page
            return page.id == allowed_page.id
        # 若还没有实例，允许当前页面添加
        return True

这样，要么只有你指定ID的页面能看到这个插件，要么插件被第一次添加到某个页面后，其他页面就再也看不到它了。

方案2：通过CMS_PLACEHOLDER_CONF全局配置 #

如果你的页面使用固定的Placeholder（比如content），可以在settings.py里直接配置该Placeholder仅在特定页面允许你的插件：

CMS_PLACEHOLDER_CONF = {
    'content': {
        'name': '内容区域',
        'plugins': {
            # 这里的'myimageplugin'是你插件类名的小写（若没指定plugin_name）
            'myimageplugin': lambda placeholder: placeholder.page.id == 1,
        },
    },
}

这个lambda函数会判断当前Placeholder所在的页面ID是否为1，只有符合条件的页面，在该Placeholder下才能看到你的插件。

方案3：基于用户权限控制（备选） #

如果你的需求是只有特定用户能在特定页面添加插件，可以用Django的权限系统：

1. 给插件类添加权限属性：

class MyImagePlugin(CMSPluginBase):
    model = MyImagePluginModel
    name = "我的图片插件"
    permission = 'myapp.use_my_image_plugin'

2. 在models.py里注册自定义权限：

from django.contrib.auth.models import Permission
from django.contrib.contenttypes.models import ContentType
from django.db.models.signals import post_migrate

def create_plugin_permissions(sender, **kwargs):
    content_type = ContentType.objects.get_for_model(MyImagePluginModel)
    Permission.objects.get_or_create(
        codename='use_my_image_plugin',
        name='允许使用专属图片插件',
        content_type=content_type,
    )

post_migrate.connect(create_plugin_permissions)

之后你只需要给能编辑目标页面的用户分配这个权限即可，但这个方案是用户级别的，不是页面级别的，适合多用户场景。

内容的提问来源于stack exchange，提问作者Rasovica