钩子文档

wp_enqueue_editor

💡 云策文档标注

概述

wp_enqueue_editor 是一个 WordPress 动作钩子,在编辑器脚本和样式被入队时触发,主要用于开发者自定义编辑器资源加载。

关键要点

  • 触发时机:当 TinyMCE 和 Quicktags 编辑器的脚本和样式被入队时执行。
  • 参数:$to_load 是一个数组,包含布尔值指示 TinyMCE 和 Quicktags 是否正在加载。
  • 用途:允许开发者根据编辑器类型动态添加或修改脚本和样式。
  • 相关函数:与 _WP_Editors::enqueue_scripts() 方法关联,用于处理编辑器资源。

代码示例

do_action(
    'wp_enqueue_editor',
    array(
        'tinymce'   => ( $default_scripts || self::$has_tinymce ),
        'quicktags' => ( $default_scripts || self::$has_quicktags ),
    )
);

注意事项

  • 该钩子自 WordPress 3.9.0 版本引入,确保在兼容版本中使用。
  • 参数数组结构固定,包含 'tinymce' 和 'quicktags' 键,开发者应据此判断编辑器状态。

📄 原文内容

Fires when scripts and styles are enqueued for the editor.

Parameters

$to_loadarray
An array containing boolean values whether TinyMCE and Quicktags are being loaded.

Source

do_action(
	'wp_enqueue_editor',
	array(
		'tinymce'   => ( $default_scripts || self::$has_tinymce ),
		'quicktags' => ( $default_scripts || self::$has_quicktags ),
	)
);

Changelog

Version Description
3.9.0 Introduced.