在Django CMS中为页面设置添加自定义字段

核心配置与排查步骤 #

1. 确认PageExtension模型的正确定义与注册 #

你的模型必须继承自cms.extensions.PageExtension，并且通过page_extension_pool完成注册——这是最容易遗漏的关键步骤：

from django.db import models
from cms.extensions import PageExtension
from cms.extensions.extension_pool import page_extension_pool

class MyPageExtension(PageExtension):
    custom_field = models.CharField(max_length=255, blank=True, verbose_name="自定义字段")

# 必须调用此方法注册扩展
page_extension_pool.register(MyPageExtension)

2. 配置对应的Admin扩展类 #

需要创建继承自PageExtensionAdmin的Admin类，并注册到Django admin系统：

from django.contrib import admin
from cms.extensions import PageExtensionAdmin
from .models import MyPageExtension

class MyPageExtensionAdmin(PageExtensionAdmin):
    # 指定要在后台显示的字段
    fields = ('custom_field',)

admin.site.register(MyPageExtension, MyPageExtensionAdmin)

3. 确保应用已加入INSTALLED_APPS #

在项目的settings.py中，将你的自定义应用添加到INSTALLED_APPS列表：

INSTALLED_APPS = [
    # ... 其他默认应用
    'your_app_name',
]

4. 执行数据库迁移 #

修改模型后必须执行迁移，否则字段不会被创建到数据库中：

python manage.py makemigrations
python manage.py migrate

后台显示位置说明 #

配置完成后，自定义字段默认会出现在页面编辑界面的**「高级设置」标签页底部**的页面扩展区域。如果需要调整到「设置」标签页，需自定义PageExtensionAdmin的change_form_template或使用CMS钩子实现，但默认逻辑下无需额外配置。

常见排查点 #

• 重启Django开发服务器：代码修改后必须重启才能生效
• 检查用户权限：当前登录用户需拥有change_page和change_mypageextension权限
• 查看Django日志：排查是否存在模型注册失败、Admin配置错误等报错

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