Gutenberg开发中如何将父块从group/columns块innerBlocks列表排除?
自定义Gutenberg块嵌套异常的排除实现方法
问题场景
开发自定义Gutenberg块实现子块嵌套功能时,基础功能已正常生效:自定义父块不会出现在自身的直接内部块可选列表中,但当在自定义块内部插入Group、Columns这类通用容器块,打开容器块的内部块选择菜单时,这个自定义父块会异常出现在可选列表中,需要找到方法将该父块从这类嵌套容器的内部块可选列表中移除。
实际效果参考
- 正常生效的基础规则:自定义父块未直接显示在自定义块的内部块列表中

- 出现异常的嵌套场景:自定义父块显示在自定义块下创建的Group块的内部块可选列表中

异常根因
Gutenberg默认的内部块可选列表过滤逻辑,仅会匹配当前编辑位置的直接父级的块允许/排除规则,不会向上追溯跨层级的祖先块类型。因此当自定义父块内部插入Group、Columns这类无特殊块限制的通用容器块时,容器块自身的配置没有添加排除规则,就会让自定义父块异常出现在可选列表里。
具体实现方案
基于原生钩子实现多层级规则拦截
借助Gutenberg提供的blocks.__unstableGetBlockTypes全局过滤钩子,在生成可选块列表时,向上遍历当前编辑位置的所有祖先块,判断当前是否处于自定义父块的嵌套体系内,只要任意一层祖先包含自定义父块,就将该自定义块从可选列表中过滤掉:
import { select } from '@wordpress/data'; import { addFilter } from '@wordpress/hooks'; // 替换为实际开发的自定义块命名空间与块名 const TARGET_CUSTOM_BLOCK = 'your-plugin/your-custom-parent-block'; addFilter( 'blocks.__unstableGetBlockTypes', 'custom/filter-block-list-under-parent', (availableBlockList, parentBlockClientId) => { const { getBlock, getBlockRootClientId } = select('core/block-editor'); let currentCheckId = parentBlockClientId; // 向上逐层遍历所有祖先块 while (currentCheckId) { const currentBlock = getBlock(currentCheckId); // 检测到自定义父块作为任意层级祖先存在时,从可选列表中移除该自定义块 if (currentBlock?.name === TARGET_CUSTOM_BLOCK) { return availableBlockList.filter(block => block.name !== TARGET_CUSTOM_BLOCK); } currentCheckId = getBlockRootClientId(currentCheckId); } return availableBlockList; } );
方案特性
- 拦截逻辑不受嵌套层数限制:哪怕自定义块内部隔了多层Group、Columns、Column等通用容器,只要最终追溯的根祖先包含自定义块,就会自动触发排除规则,不需要单独给每个容器块配置排除项
- 不会干扰正常使用场景:该过滤逻辑仅在自定义块的嵌套体系内生效,在文章顶层、其他普通块内部等非自定义块嵌套的场景下,自定义块依然可以正常被选中插入
- 兼容性更强:所有逻辑基于编辑器公开的扩展钩子实现,不需要修改Gutenberg核心代码,后续版本升级时维护成本更低
补充优化方向
如果对规则精度有更高要求,也可以在自定义块的编辑渲染逻辑中,给内部插入的Group、Columns等通用容器块手动补充allowedBlocks配置,明确排除自定义块。这种方式的规则颗粒度更细,但后续维护成本更高,需要每次新增容器类型时同步补充排除规则,适合规则边界要求非常严格的场景。
内容的提问来源于stack exchange,提问作者Pankaj Prajapati
相关产品推荐
相关产品推荐

