如何在Django CMS插件中实现外键字段的Autocomplete搜索功能？

问题原因 #

你之前配置的ProductBlockAdmin仅对Django原生后台的模型管理界面生效，而Django CMS的插件编辑器（弹窗）并不依赖普通ModelAdmin的配置，而是通过CMSPluginBase类控制表单渲染逻辑，因此之前的autocomplete_fields设置对插件编辑器无效。

解决方案 #

1. 配置关联模型的Admin（必填前提） #

首先确保关联的Product模型在Django admin中配置了search_fields，这是自动补全功能的核心基础：

from django.contrib import admin
from .models import Product

class ProductAdmin(admin.ModelAdmin):
    search_fields = ['name', 'sku']  # 替换为你的Product模型实际需要搜索的字段

admin.site.register(Product, ProductAdmin)

2. 自定义CMS插件的表单Widget #

修改你的CMS插件注册类，为product字段指定Django admin的自动补全Widget：

from django.contrib.admin.widgets import AutocompleteSelect
from django_cms.plugin_pool import plugin_pool
from django_cms.models.pluginmodel import CMSPluginBase
from .models import ProductBlock

class ProductBlockPlugin(CMSPluginBase):
    model = ProductBlock
    name = "产品区块"
    render_template = "plugins/product_block.html"  # 替换为你的插件模板路径

    def get_form(self, request, obj=None, **kwargs):
        form = super().get_form(request, obj, **kwargs)
        # 为product字段设置自动补全Widget
        product_field = ProductBlock._meta.get_field('product')
        form.base_fields['product'].widget = AutocompleteSelect(
            product_field.remote_field,
            self.admin_site,
            attrs={'style': 'width: 100%;'}
        )
        return form

plugin_pool.register_plugin(ProductBlockPlugin)

3. 验证静态资源加载 #

确保Django CMS的插件编辑器页面加载了自动补全所需的静态资源（autocomplete.js等），Django CMS 4.x通常会自动处理，若遇到异常，可在插件模板中手动引入表单媒体资源：

{{ form.media }}

注意事项 #

• 确保Django的CSRF配置正常，插件编辑器在iframe中运行，需正确传递CSRF令牌
• 若Product模型数据量极大，可添加limit_choices_to缩小自动补全范围
• 若不想自定义代码，也可使用适配Django CMS 4.x的第三方自动补全插件实现快速集成

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