云策 WordPress 开发者社区

函数文档

_wp_dashboard_control_callback()

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

概述

_wp_dashboard_control_callback() 函数用于输出当前仪表盘小部件的控制界面，包括触发小部件控制回调、添加安全验证字段和提交按钮。

关键要点

  • 函数接受两个参数：$dashboard（混合类型，必需）和 $meta_box（数组类型，必需）。
  • 内部调用 wp_dashboard_trigger_widget_control() 来触发小部件的控制回调。
  • 使用 wp_nonce_field() 生成表单安全验证字段，防止跨站请求伪造。
  • 通过 submit_button() 输出一个“保存更改”的提交按钮。
  • 该函数自 WordPress 2.7.0 版本引入。

代码示例

function _wp_dashboard_control_callback( $dashboard, $meta_box ) {
    echo '';
    wp_dashboard_trigger_widget_control( $meta_box['id'] );
    wp_nonce_field( 'edit-dashboard-widget_' . $meta_box['id'], 'dashboard-widget-nonce' );
    echo '';
    submit_button( __( 'Save Changes' ) );
    echo '';
}

注意事项

  • 函数参数 $meta_box 必须包含 'id' 键，用于生成安全验证字段和触发控制回调。
  • 输出内容直接通过 echo 语句生成，适用于仪表盘小部件的控制界面渲染。
📄 原文内容

Outputs controls for the current dashboard widget.

Parameters

$dashboardmixedrequired
$meta_boxarrayrequired

Source

function _wp_dashboard_control_callback( $dashboard, $meta_box ) {
	echo '<form method="post" class="dashboard-widget-control-form wp-clearfix">';
	wp_dashboard_trigger_widget_control( $meta_box['id'] );
	wp_nonce_field( 'edit-dashboard-widget_' . $meta_box['id'], 'dashboard-widget-nonce' );
	echo '<input type="hidden" name="widget_id" value="' . esc_attr( $meta_box['id'] ) . '" />';
	submit_button( __( 'Save Changes' ) );
	echo '</form>';
}

View all references View on Trac View on GitHub

Uses Description
wp_dashboard_trigger_widget_control()wp-admin/includes/dashboard.php

Calls widget control callback.
submit_button()wp-admin/includes/template.php

Echoes a submit button, with provided text and appropriate class(es).
wp_nonce_field()wp-includes/functions.php

Retrieves or display nonce hidden field for forms.
__()wp-includes/l10n.php

Retrieves the translation of $text.
esc_attr()wp-includes/formatting.php

Escaping for HTML attributes.

Show 2 moreShow less

Changelog

Version Description
2.7.0 Introduced.