如何在自定义Wagtail StreamBlock中使用功能标志控制区块可见性

直接在StreamBlock类定义时用条件判断添加embed块会导致数据库结构不一致——开启功能标志的站点会存储包含embed的内容，关闭的站点则无法识别这些内容，这是非常危险的。正确的做法是先完整定义所有块，再基于用户权限动态过滤可见选项，同时做好后端验证。

步骤1：完整定义StreamBlock #

先把所有字段（包括embed）都定义好，确保数据库结构统一：

class OneColumnBlock(StreamBlock):
    paragraph = ParagraphBlock()
    image = ImageBlock()
    embed = CustomEmbedBlock(max_width=800)

步骤2：自定义Panel过滤可见块 #

通过自定义StreamFieldPanel，在渲染编辑界面时根据用户权限移除embed选项：

from wagtail.admin.panels import StreamFieldPanel

def user_has_premium_access(user):
    # 替换成你的权限判断逻辑，比如检查用户组、站点功能标志等
    return user.groups.filter(name="Premium Users").exists()

class RestrictedStreamFieldPanel(StreamFieldPanel):
    def get_form_options(self, *args, **kwargs):
        options = super().get_form_options(*args, **kwargs)
        current_user = self.request.user

        if not user_has_premium_access(current_user):
            # 遍历所有顶级块，找到OneColumnBlock并移除embed子块
            updated_block_defs = []
            for block_name, block_instance in options["block_defs"]:
                if block_name == "one_column":
                    # 复制子块字典，剔除embed
                    restricted_child_blocks = {
                        key: block for key, block in block_instance.child_blocks.items()
                        if key != "embed"
                    }
                    # 创建受限版本的OneColumnBlock
                    restricted_block = OneColumnBlock(restricted_child_blocks)
                    updated_block_defs.append((block_name, restricted_block))
                else:
                    updated_block_defs.append((block_name, block_instance))
            
            options["block_defs"] = updated_block_defs
        
        return options

步骤3：替换Page中的Panel #

在页面类里使用自定义的Panel：

class ScrollingExhibitPage(Page):
    body = StreamField(
        [("one_column", OneColumnBlock()), ("two_column", TwoColumnBlock()), ("full_width", FullWidthBlock())]
    )

    content_panels = Page.content_panels + [
        RestrictedStreamFieldPanel("body", heading="Body"),
    ]

步骤4：后端验证防止非法提交 #

即使前端隐藏了embed选项，也要在后端验证用户权限，防止通过API或其他方式提交：

from django.core.exceptions import ValidationError

class OneColumnBlock(StreamBlock):
    paragraph = ParagraphBlock()
    image = ImageBlock()
    embed = CustomEmbedBlock(max_width=800)

    def clean(self, value):
        cleaned_value = super().clean(value)
        # 从上下文获取当前用户（Wagtail编辑时会自动传递上下文）
        current_user = getattr(self.context, "user", None)

        if current_user and not user_has_premium_access(current_user):
            # 检查内容中是否包含embed块
            for block in cleaned_value:
                if block.block_type == "embed":
                    raise ValidationError("你没有使用嵌入块的权限")
        
        return cleaned_value

核心思路说明 #

• 数据库一致性优先：始终保持StreamBlock的结构完整，避免因功能开关导致数据库内容不兼容。
• 前后端双重控制：前端隐藏选项提升体验，后端验证确保安全。
• 权限判断灵活：user_has_premium_access函数可根据实际需求调整，比如读取站点设置、用户订阅状态等。

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