Wagtail中SnippetChooser模板重写及自定义查询的技术咨询

1. 修改/重写SnippetChooser模板 #

Wagtail的SnippetChooser默认模板位于wagtail/snippets/templates/wagtail_snippets/chooser/目录下，你可以通过两种方式自定义：

• 全局重写：在项目templates目录下创建wagtail_snippets/chooser/chooser.html，复制原模板内容并按需修改，Wagtail会优先加载项目内的模板文件。
• 针对特定Snippet重写：若只需修改某个特定Snippet的选择器，创建wagtail_snippets/chooser/[模型名小写]_chooser.html（比如模型为ProductSnippet，则创建product_snippet_chooser.html），该模板仅对目标Snippet的选择器生效。

2. 添加自定义筛选器及查询集操作 #

自定义查询集 #

• 在Snippet模型中直接定义：给Snippet模型添加admin_get_queryset方法，控制后台及选择器加载的数据集：

from wagtail.snippets.models import register_snippet

@register_snippet
class YourSnippet(models.Model):
    # 模型字段定义...

    def admin_get_queryset(self, request):
        # 示例：仅展示当前用户创建的条目
        return super().admin_get_queryset(request).filter(created_by=request.user)

• 自定义ChooserPanel：若需更灵活的控制，可重写SnippetChooserPanel的get_queryset方法：

from wagtail.snippets.edit_handlers import SnippetChooserPanel

class CustomSnippetChooserPanel(SnippetChooserPanel):
    def get_queryset(self, request):
        queryset = super().get_queryset(request)
        # 添加自定义过滤条件
        return queryset.filter(is_active=True)

# 在页面模型中使用自定义面板
class YourPage(Page):
    related_snippet = models.ForeignKey(YourSnippet, on_delete=models.SET_NULL, null=True)
    content_panels = Page.content_panels + [
        CustomSnippetChooserPanel('related_snippet'),
    ]

添加自定义筛选器 #

通过自定义SnippetViewSet给Snippet后台列表及选择器弹窗添加筛选器：

from wagtail.snippets.views.snippets import SnippetViewSet
from django.contrib.admin import SimpleListFilter

class StatusFilter(SimpleListFilter):
    title = '状态'
    parameter_name = 'status'

    def lookups(self, request, model_admin):
        return (
            ('active', '启用'),
            ('inactive', '禁用'),
        )

    def queryset(self, request, queryset):
        if self.value() == 'active':
            return queryset.filter(is_active=True)
        if self.value() == 'inactive':
            return queryset.filter(is_active=False)
        return queryset

class YourSnippetViewSet(SnippetViewSet):
    model = YourSnippet
    list_filter = [StatusFilter]  # 绑定自定义筛选器

# 注册自定义ViewSet
from wagtail.snippets.models import register_snippet
register_snippet(YourSnippetViewSet)

如果需要在选择器弹窗的前端添加筛选表单，可结合之前重写的模板添加表单元素，再通过自定义视图逻辑处理筛选参数。

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