云策 WordPress 开发者社区

函数文档

wp_dashboard_trigger_widget_control()

查看官方原文 ↗
💡 云策文档标注

概述

wp_dashboard_trigger_widget_control() 函数用于触发仪表盘小部件的控制回调。它检查给定的 widget_control_id 是否有效，并调用相应的回调函数。

关键要点

  • 函数参数：$widget_control_id（可选，默认 false），类型为 int 或 false，表示注册的小部件 ID。
  • 功能逻辑：通过全局变量 $wp_dashboard_control_callbacks 验证 ID 存在且回调可调用，然后使用 call_user_func 执行回调。
  • 相关函数：与 _wp_dashboard_control_callback() 和 wp_dashboard_setup() 关联，用于输出控件和注册小部件。
  • 版本历史：自 WordPress 2.5.0 版本引入。
📄 原文内容

Calls widget control callback.

Parameters

$widget_control_idint|falseoptional
Registered widget ID.

Default:false

Source

function wp_dashboard_trigger_widget_control( $widget_control_id = false ) {
	global $wp_dashboard_control_callbacks;

	if ( is_scalar( $widget_control_id ) && $widget_control_id
		&& isset( $wp_dashboard_control_callbacks[ $widget_control_id ] )
		&& is_callable( $wp_dashboard_control_callbacks[ $widget_control_id ] )
	) {
		call_user_func(
			$wp_dashboard_control_callbacks[ $widget_control_id ],
			'',
			array(
				'id'       => $widget_control_id,
				'callback' => $wp_dashboard_control_callbacks[ $widget_control_id ],
			)
		);
	}
}

View all references View on Trac View on GitHub

Used by Description
_wp_dashboard_control_callback()wp-admin/includes/dashboard.php

Outputs controls for the current dashboard widget.
wp_dashboard_setup()wp-admin/includes/dashboard.php

Registers dashboard widgets.

Changelog

Version Description
2.5.0 Introduced.