钩子文档

mce_buttons

💡 云策文档标注

概述

mce_buttons 是一个 WordPress 过滤器钩子,用于修改 TinyMCE 编辑器第一行按钮列表(在可视化标签页中)。它允许开发者自定义编辑器界面,并支持通过 $editor_id 参数识别不同编辑器实例。

关键要点

  • 过滤器钩子:mce_buttons,用于过滤 TinyMCE 第一行按钮。
  • 参数:$mce_buttons(按钮数组)和 $editor_id(编辑器标识符,如 'content' 或 'classic-block')。
  • 相关钩子:mce_buttons_2、mce_buttons_3、mce_buttons_4 用于其他行按钮。
  • 版本历史:WordPress 3.3.0 添加了 $editor_id 参数,2.0.0 版本引入。

代码示例

$mce_buttons = apply_filters( 'mce_buttons', $mce_buttons, $editor_id );

注意事项

  • 使用时需确保正确处理 $editor_id 参数,以适配不同编辑器上下文(如经典编辑器或块编辑器中的 Classic block)。
  • 参考相关函数如 wp_tinymce_inline_scripts() 和 _WP_Editors::editor_settings() 以了解完整实现。

📄 原文内容

Filters the first-row list of TinyMCE buttons (Visual tab).

Parameters

$mce_buttonsarray
First-row list of buttons.
$editor_idstring
Unique editor identifier, e.g. 'content'. Accepts 'classic-block' when called from block editor’s Classic block.

More Information

See other relevant mce_buttons hooks:

Source

$mce_buttons = apply_filters( 'mce_buttons', $mce_buttons, $editor_id );

Changelog

Version Description
3.3.0 The $editor_id parameter was added.
2.0.0 Introduced.