Wagtail CMS如何在发布/存草稿前校验页面SnippetChooserPanel内容

Wagtail页面模型继承自Django原生模型，你可以通过重写页面模型的clean方法实现保存/发布时的自动校验，所有校验逻辑都会在数据写入数据库前触发，校验不通过时会直接阻断保存操作并返回错误提示。

前置假设 #

你的页面模型已经定义了3个关联对应Snippet的外键字段，且配置了SnippetChooserPanel，示例字段定义如下：

from django.db import models
from wagtail.models import Page
from wagtail.snippets.edit_handlers import SnippetChooserPanel
from .models import SnippetA, SnippetB, SnippetC # 替换为你实际的Snippet导入路径

class CustomPage(Page):
    # 三个关联Snippet的外键字段，可根据需求调整on_delete规则
    snippet_a = models.ForeignKey(SnippetA, on_delete=models.SET_NULL, null=True, blank=True, verbose_name="SnippetA")
    snippet_b = models.ForeignKey(SnippetB, on_delete=models.SET_NULL, null=True, blank=True, verbose_name="SnippetB")
    snippet_c = models.ForeignKey(SnippetC, on_delete=models.SET_NULL, null=True, blank=True, verbose_name="SnippetC")

    content_panels = Page.content_panels + [
        SnippetChooserPanel("snippet_a"),
        SnippetChooserPanel("snippet_b"),
        SnippetChooserPanel("snippet_c"),
    ]

核心校验代码 #

在上述CustomPage类中重写clean方法，实现两项校验逻辑：

from django.core.exceptions import ValidationError

# 放在CustomPage类内部
def clean(self):
    super().clean()
    errors = {}

    # 校验1：三类Snippet均已选择
    if not self.snippet_a:
        errors["snippet_a"] = "请选择SnippetA"
    if not self.snippet_b:
        errors["snippet_b"] = "请选择SnippetB"
    if not self.snippet_c:
        errors["snippet_c"] = "请选择SnippetC"
    
    # 已有空值的情况下无需继续校验关联关系
    if errors:
        raise ValidationError(errors)

    # 校验2：关联关系匹配
    # 注意：下方snippet_b.a、snippet_c.b需要替换为你Snippet模型中实际定义的外键字段名
    if self.snippet_b.a != self.snippet_a:
        errors["snippet_b"] = "所选SnippetB不属于当前选择的SnippetA"
    if self.snippet_c.b != self.snippet_b:
        errors["snippet_c"] = "所选SnippetC不属于当前选择的SnippetB"

    if errors:
        raise ValidationError(errors)

效果说明 #

• 无论用户点击保存草稿还是发布按钮，都会触发上述校验逻辑
• 错误提示会直接展示在对应输入项的下方，无需用户全局查找问题
• 校验不通过时数据不会写入数据库，符合业务要求

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