钩子文档

wp_register_sidebar_widget

💡 云策文档标注

概述

wp_register_sidebar_widget 是一个 WordPress 钩子,用于在每个注册的小部件时触发一次。它允许开发者在注册小部件时执行自定义操作。

关键要点

  • 这是一个动作钩子,在注册小部件时触发。
  • 参数 $widget 是一个数组,包含默认的小部件参数。
  • 钩子定义在 wp-includes/widgets.php 文件中,从 WordPress 3.0.0 版本引入。

代码示例

// 示例:对默认的 'Pages' 小部件执行操作
add_action('wp_register_sidebar_widget', function($widget) {
    // 检查是否为特定小部件,例如 'Pages'
    if (isset($widget['id']) && $widget['id'] === 'pages') {
        // 执行自定义逻辑
        // 例如:修改小部件参数或添加额外功能
    }
});

注意事项

  • 钩子仅触发一次,适用于每个注册的小部件实例。
  • 参数 $widget 是一个数组,包含小部件的默认设置,如 id、name 等。
  • 开发者应确保回调函数正确处理 $widget 参数,以避免意外行为。

📄 原文内容

Fires once for each registered widget.

Parameters

$widgetarray
An array of default widget arguments.

Source

do_action( 'wp_register_sidebar_widget', $widget );

Changelog

Version Description
3.0.0 Introduced.

User Contributed Notes