
本文旨在解决在 WordPress 块编辑器中,如何准确判断主题提供的块编辑器设置何时加载完成,以便及时修改这些设置的问题。通过 PHP 的 block_editor_settings_all 过滤器,我们可以确保设置在编辑器加载时立即生效,避免了 JavaScript 异步加载可能导致的时机问题。
在 WordPress 块编辑器开发中,一个常见的问题是如何在主题提供的块编辑器设置加载完成后,立即对其进行修改。直接使用 JavaScript 监听块编辑器状态变化,可能会因为异步加载导致时机不确定,从而影响用户体验。更可靠的方法是在 PHP 端使用 block_editor_settings_all 过滤器,确保设置在编辑器加载时就已经完成修改。
使用 block_editor_settings_all 过滤器
block_editor_settings_all 是一个 PHP 过滤器,允许你在块编辑器设置传递到 JavaScript 前对其进行修改。这个过滤器接收两个参数:$editor_settings(包含编辑器设置的数组)和 $editor_context(编辑器上下文信息)。
以下代码示例展示了如何使用 block_editor_settings_all 过滤器来修改 allowedBlockTypes 设置,只允许使用名为 "foo" 的块:
function so_76324559_allow_foo( $editor_settings, $editor_context ){
// 可以在这里进行更复杂的检查,而不是直接替换 allowedBlockTypes
// 例如,如果 "foo" 不是唯一允许的块,可以进行添加操作
$editor_settings['allowedBlockTypes'] = ['foo'];
return $editor_settings;
}
add_filter( 'block_editor_settings_all', 'so_76324559_allow_foo', 10, 2 );代码解释:
- so_76324559_allow_foo 函数: 这个函数接收 $editor_settings 和 $editor_context 作为参数。$editor_settings 是一个关联数组,包含了块编辑器的所有设置。我们直接修改了 allowedBlockTypes 键的值,将其设置为只包含 "foo" 的数组。
- add_filter 函数: 这个函数将 so_76324559_allow_foo 函数注册为 block_editor_settings_all 过滤器的回调函数。10 是优先级,2 是传递给回调函数的参数数量。
注意事项:
- 在实际应用中,应该根据具体需求进行更细致的检查和修改,而不是简单地替换 allowedBlockTypes。例如,可以先检查 allowedBlockTypes 是否已经包含 "foo",如果没有则添加进去。
- $editor_context 参数可以用来判断当前编辑器的上下文,例如是否是站点编辑器、文章编辑器等,从而根据不同的上下文应用不同的设置。
- 确保将这段 PHP 代码添加到主题的 functions.php 文件或自定义插件中。
验证结果:
在添加上述 PHP 代码后,刷新 WordPress 后台的块编辑器页面。在浏览器的开发者工具控制台中运行以下 JavaScript 代码:
wp.data.select('core/block-editor').getSettings().allowedBlockTypes应该会立即看到输出结果为 ["foo"],表明 allowedBlockTypes 设置已经被成功修改,并且在编辑器加载时就已经生效。
总结
使用 PHP 的 block_editor_settings_all 过滤器是在 WordPress 块编辑器中修改主题设置的最佳实践。它避免了 JavaScript 异步加载带来的时机问题,确保设置在编辑器加载时就已经生效,从而提供更稳定和可预测的开发体验。在实际开发中,请根据具体需求进行更细致的检查和修改,以满足不同的应用场景。










