基于信号实现Django-CMS中PlaceholderField的通用删除方案

我之前也踩过一模一样的坑！用PlaceholderField确实能快速实现灵活的富内容功能，但删除关联模型时，Placeholder和它绑定的插件、媒体资源总会留在数据库里，一个个写delete方法或者定制管理器真的太繁琐了。下面分享两个通用化的解决方案，帮你一次性搞定所有带PlaceholderField的模型：

方案一：用抽象基类统一封装删除逻辑 #

这种方法让所有需要清理Placeholder资源的模型继承一个基类，不用重复编写删除代码：

from django.db import models
from cms.models.fields import PlaceholderField

class PlaceholderCleanupModel(models.Model):
    class Meta:
        abstract = True

    def delete(self, *args, **kwargs):
        # 自动识别当前模型的所有PlaceholderField字段
        placeholder_fields = [
            field.name for field in self._meta.fields 
            if isinstance(field, PlaceholderField)
        ]
        # 逐个清理关联的Placeholder及其附属资源
        for field_name in placeholder_fields:
            placeholder = getattr(self, field_name, None)
            if placeholder:
                # Django-CMS的Placeholder.delete()会自动清理关联的插件和媒体资源
                placeholder.delete()
        # 最后执行模型本身的删除逻辑
        super().delete(*args, **kwargs)

之后你的业务模型只要继承这个抽象类就可以了：

class Article(PlaceholderCleanupModel):
    title = models.CharField(max_length=200)
    content = PlaceholderField('article_content')

class Product(PlaceholderCleanupModel):
    name = models.CharField(max_length=100)
    description = PlaceholderField('product_desc')

方案二：用Django信号全局监听删除事件 #

如果不想修改模型的继承关系，用信号方案更灵活，全局监听所有带PlaceholderField的模型删除事件：

from django.db.models.signals import pre_delete
from django.dispatch import receiver
from cms.models.fields import PlaceholderField

@receiver(pre_delete)
def cleanup_placeholder_resources(sender, instance, **kwargs):
    # 检查当前实例所属模型是否包含PlaceholderField
    placeholder_fields = [
        field.name for field in instance._meta.fields 
        if isinstance(field, PlaceholderField)
    ]
    for field_name in placeholder_fields:
        placeholder = getattr(instance, field_name, None)
        if placeholder:
            placeholder.delete()

把这段代码放在你的app的signals.py文件中，然后在apps.py里注册信号：

from django.apps import AppConfig

class YourAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'your_app_name'

    def ready(self):
        import your_app_name.signals

关键注意点 #

• 两种方案都依赖Django-CMS内置的Placeholder.delete()机制，它会自动清理关联的CMSPlugin实例和对应的媒体文件（前提是插件本身实现了正确的资源清理逻辑）
• 如果是批量删除（比如Article.objects.all().delete()），抽象基类的delete方法不会被触发，这时信号方案更可靠，因为pre_delete信号会为每个实例执行清理
• 测试时记得验证：删除模型后，数据库中cms_placeholder、cms_cmsplugin表的对应记录是否被删除，以及相关媒体文件是否被清理

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