Wagtail自定义URL Block的help_text未在后台UI显示的问题

我创建了一个继承自Wagtail URL Block的自定义块类AirtableBlock，在类内初始化URLBlock时设置了help_text参数。自定义块可正常显示，但帮助文本未出现在后台UI中——加载块时无显示，悬停也不出现。官方文档标注URL Block支持help_text参数，请问该帮助文本应显示在何处，如何让它在自定义块中正常显示？

自定义块代码片段：

class AirtableBlock(URLBlock):
    url = URLBlock(icon="link", help_text="Lorem ipsum dolor sit amet, consectetur adipiscing elit")

    class Meta:
        template = "core/blocks/airtable_embed.html"
        icon = "code"

后台UI显示：

我已尝试为URL Block添加help_text参数，预期该文本会显示在UI中，但并未生效。

解决方法 #

你的代码写法存在问题：AirtableBlock继承自URLBlock，但你在类内部又定义了一个url = URLBlock(...)的字段，这会让自定义块变成包含子字段的复合块，导致设置的help_text属于内部嵌套的URLBlock，而非自定义块本身，因此后台UI无法正确渲染这个帮助文本。

正确的做法是直接重写自定义块的__init__方法，将help_text传递给父类URLBlock的构造函数，代码如下：

from wagtail.blocks import URLBlock

class AirtableBlock(URLBlock):
    def __init__(self, **kwargs):
        # 设置默认的help_text和icon，也可直接传入参数覆盖
        kwargs.setdefault('help_text', "Lorem ipsum dolor sit amet, consectetur adipiscing elit")
        kwargs.setdefault('icon', "link")
        super().__init__(**kwargs)

    class Meta:
        template = "core/blocks/airtable_embed.html"
        icon = "code"

修改后，help_text会归属到AirtableBlock本身，在后台UI中，它通常会显示在URL输入框的下方，或鼠标悬停在输入框/块区域时弹出提示。

注意：继承Wagtail内置的简单块（如URLBlock、CharBlock这类单一输入的块）时，无需在类内部嵌套同名块字段，直接通过构造方法传递参数即可。

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