Gutenberg开发:如何在editor.BlockEdit过滤器中获取Block Context
问题定位与解决方案
核心问题排查
你遇到的props中无法获取Block Context的情况,通常由以下几个原因导致:
- usesContext的赋值逻辑存在隐患:你代码中使用的
Object.assign( ['card/blockName'] )属于API误用。Object.assign的设计用途是合并对象,用来设置数组形式的usesContext既不符合常规写法,还会直接覆盖核心块原生已有的usesContext配置,既可能破坏核心块自身的上下文功能,也可能因为配置识别问题导致Gutenberg无法正确给目标块注入上下文值。 - Block Context的传递规则限制:Gutenberg只有在目标块处于对应context提供者的块树后代范围内时,才会把上下文值注入到块的props中。如果目标块直接放在编辑器根层级、没有被对应的Card容器块包裹,哪怕声明了usesContext,props中也不会出现context字段,这是正常的设计逻辑,不是代码bug。
- 测试场景偏差:你之前在可正常接收上下文的自定义块上测试时没有拿到context,大概率是测试时没有把该块放到对应的容器块内部,不存在可匹配的context提供者,因此没有值可以注入。
修正后的完整实现
1. 给核心块扩展usesContext配置
替换原有错误的赋值逻辑,采用数组合并的方式保留核心块原生的配置,避免覆盖原有功能:
import { addFilter } from '@wordpress/hooks'; function addImageContext( settings ) { // 仅针对core/image块做扩展 if( settings.name !== 'core/image' ) return settings; // 合并原有usesContext配置,避免覆盖核心块原生逻辑 settings.usesContext = [ ...(settings.usesContext || []), 'card/blockName' ]; return settings; } addFilter( 'blocks.registerBlockType', 'gutenstrap/image-context', addImageContext );
2. BlockEdit过滤器中读取上下文并实现条件展示
只要上述的usesContext配置正确生效,并且目标块确实处于Card块的子树中,上下文值会直接作为props的一部分可访问:
import { createHigherOrderComponent } from '@wordpress/compose'; const addImageControls = createHigherOrderComponent( ( BlockEdit ) => { return ( props ) => { const { name, attributes, setAttributes, context, isSelected, } = props; // 判断当前Image块是否处于Card块包裹中 const isInsideCard = !!context?.['card/blockName']; return ( <> <BlockEdit { ...props } /> {/* 仅在Card上下文中展示的额外配置项 */} { isInsideCard && isSelected && ( <div style={{padding: '12px', background: '#f0f0f0', margin: '8px 0'}}> Card块专属的Image配置选项 </div> )} </> ); }; }, "addImageControls" ); addFilter( 'editor.BlockEdit', 'gutenstrap/image-context', addImageControls );
落地验证注意事项
- 测试时必须把Image块拖拽到Card容器块内部,不要在编辑器根层级单独测试,否则因为缺少对应的context提供者,props中不会出现context字段。
- 确认
providesContext的键名和usesContext的键名完全匹配,没有拼写、大小写差异,你代码中使用的card/blockName是符合Gutenberg规范的命名格式。 - 可以临时在BlockEdit组件中添加
console.log(props)语句,查看实际的props结构,确认context字段是否正常注入。 - 确保扩展脚本在编辑器初始化阶段就加载完成,不要在编辑器已经渲染完成后再注册过滤器,否则Gutenberg不会重新计算块的context注入逻辑。
内容的提问来源于stack exchange,提问作者pookaknight
相关产品推荐
相关产品推荐

