Django CMS 中扩展 PageContent 模型的正确方法

在 Django CMS 项目中，开发者经常需要扩展 PageContent 模型来添加自定义字段。本文将详细介绍如何正确实现这一功能，并解决模板中访问扩展字段的常见问题。

模型扩展实现

要扩展 PageContent 模型，首先需要创建一个继承自 PageContentExtension 的模型类：

from django.db import models
from cms.extensions import PageContentExtension
from cms.extensions.extension_pool import extension_pool

class PageMetaExtension(PageContentExtension):
    json_ld = models.JSONField(
        'JSON linked data',
        blank=True,
        default=dict
    )
    keywords = models.CharField(max_length=2000, default="", blank=True)

extension_pool.register(PageMetaExtension)

管理界面配置

为了让扩展模型在 Django 管理后台可见，需要创建相应的 Admin 类：

from django.contrib import admin
from cms.extensions import PageContentExtensionAdmin
from .models import PageMetaExtension

class PageMetaExtensionAdmin(PageContentExtensionAdmin):
    pass

admin.site.register(PageMetaExtension, PageMetaExtensionAdmin)

工具栏集成

为了在编辑模式下方便访问扩展功能，可以集成到 CMS 工具栏：

from cms.toolbar_pool import toolbar_pool
from cms.extensions.toolbar import ExtensionToolbar
from cms.utils import get_language_list
from .models import PageMetaExtension

@toolbar_pool.register
class PageMetaExtensionToolbar(ExtensionToolbar):
    model = PageMetaExtension

    def populate(self):
        current_page_menu = self._setup_extension_toolbar()
        if current_page_menu and self.toolbar.edit_mode_active:
            sub_menu = self._get_sub_menu(
                current_page_menu, 'submenu_label', 'Page meta', position=4
            )
            page = self._get_page()
            page_contents = page.pagecontent_set(manager="admin_manager").latest_content(
                language__in=get_language_list(page.node.site_id)
            )
            nodes = [
                (*self.get_page_content_extension_admin(page_content), page_content.title)
                for page_content in page_contents
            ]
            for title_extension, url, title in nodes:
                sub_menu.add_modal_item(
                    'Page meta - %s' % title, 
                    url=url, 
                    disabled=not self.toolbar.edit_mode_active
                )

模板访问的正确方法

在模板中访问扩展字段时，需要注意使用正确的方法名。早期文档中提到的 get_pagecontent_obj 方法实际上应该使用 get_content_obj：

{% if request.current_page.get_content_obj.pagemetaextension %}
  {% autoescape off %}
    <script type="application/ld+json">
      {{ request.current_page.get_content_obj.pagemetaextension.json_ld }}
    </script>
  {% endautoescape %}
{% endif %}

自定义模板标签方案

如果需要在多处访问扩展字段，可以创建自定义模板标签来简化操作：

from django import template

register = template.Library()

@register.simple_tag(takes_context=True)
def get_page_meta(context, field_name: str):
    request = context['request']
    extension = request.current_page.get_content_obj_attribute(
        attrname='pagemetaextension'
    )
    if extension is None:
        return None
    return extension.serializable_value(field_name=field_name)

然后在模板中使用：

<meta name="keywords" content="{% get_page_meta 'keywords' %}">

注意事项

1. 扩展字段只能获取已发布页面的内容，如果需要获取编辑中的内容，需要在模板标签中检查编辑模式

2. 方法名 get_content_obj 和 get_content_obj_attribute 是正确的方法名，早期文档中的 get_pagecontent_obj 是错误的

3. 扩展模型注册时必须调用 extension_pool.register() 方法

通过以上方法，开发者可以灵活地扩展 Django CMS 的 PageContent 模型，并在模板中正确访问扩展字段，实现更丰富的页面功能。