WordPress 仪表盘小工具接口（Dashboard Widgets API）

wp_add_dashboard_widget($widget_id, $widget_name, $callback, $control_callback = null)

 do_action( 'wp_dashboard_setup' );

// 创建一个函数来输出仪表盘小工具的内容

function example_dashboard_widget_function() {
	// 输出任何你想要的内容
	echo "你好，我是一个仪表盘小工具";
} 

// 创建用语动作钩子的函数

function example_add_dashboard_widgets() {
	wp_add_dashboard_widget('example_dashboard_widget', 'Example Dashboard Widget', 'example_dashboard_widget_function');	
} 

// 挂载到 'wp_dashboard_setup' 钩子来注册我们其他的函数

add_action('wp_dashboard_setup', 'example_add_dashboard_widgets' ); // 提示：如果是多站点网络管理仪表盘，请使用 wp_network_dashboard_setup 替换 wp_dashboard_setup

function example_add_dashboard_widgets() {
	wp_add_dashboard_widget('example_dashboard_widget', 'Example Dashboard Widget', 'example_dashboard_widget_function');

	// 全局化 metaboxes 数组, 应用于所有 wp-admin 的小工具

	global $wp_meta_boxes;

	// 获取常规仪表盘小工具数组 
	// (其中已经包含我们的新的小工具，只是在最底部罢了)

	$normal_dashboard = $wp_meta_boxes['dashboard']['normal']['core'];

	// 在数组的末端备份并删除我们新的仪表盘小工具

	$example_widget_backup = array('example_dashboard_widget' => $normal_dashboard['example_dashboard_widget']);
	unset($normal_dashboard['example_dashboard_widget']);

	// 合并这两个数组，使我们的小工具在前面

	$sorted_dashboard = array_merge($example_widget_backup, $normal_dashboard);

	// 保存排序后的数组到原来的 metaboxes 

	$wp_meta_boxes['dashboard']['normal']['core'] = $sorted_dashboard;
}

// 主栏:
$wp_meta_boxes['dashboard']['normal']['high']['dashboard_browser_nag']
$wp_meta_boxes['dashboard']['normal']['core']['dashboard_right_now']
$wp_meta_boxes['dashboard']['normal']['core']['dashboard_recent_comments']
$wp_meta_boxes['dashboard']['normal']['core']['dashboard_incoming_links']
$wp_meta_boxes['dashboard']['normal']['core']['dashboard_plugins']

// 侧栏:
$wp_meta_boxes['dashboard']['side']['core']['dashboard_quick_press']
$wp_meta_boxes['dashboard']['side']['core']['dashboard_recent_drafts']
$wp_meta_boxes['dashboard']['side']['core']['dashboard_primary']
$wp_meta_boxes['dashboard']['side']['core']['dashboard_secondary']

// 创建用于动作钩子的函数

function example_remove_dashboard_widgets() {
	remove_meta_box( 'dashboard_quick_press', 'dashboard', 'side' );
	remove_meta_box( 'dashboard_incoming_links', 'dashboard', 'normal' );
} 

// 挂载到 'wp_dashboard_setup'钩子来注册我们的函数

add_action('wp_dashboard_setup', 'example_remove_dashboard_widgets' );

// 全局化 $wp_meta_boxes 变量（这将允许我们改变数组）
 global $wp_meta_boxes;

 // 备份你的小工具
 $my_widget = $wp_meta_boxes['dashboard']['normal']['core']['{widget id here}'];

 // 取消数组中的某些部分
 unset($wp_meta_boxes['dashboard']['normal']['core']['{widget id here}']);

 // 加载你想要的小工具
 $wp_meta_boxes['dashboard']['side']['core']['{widget id here}'] = $my_widget;

/**
 * 获取所有小工具的选项，或者某个已经给出ID的特定小工具的选项
 *
 * @param string $widget_id Optional. If provided, will only get options for that widget.
 * @return array An associative array
 */
public static function get_dashboard_widget_options( $widget_id='' )
{
    //从数据库中获取所有小工具的选项
    $opts = get_option( 'dashboard_widget_options' );

    //如果没有指定特定小工具的ID，返回所有选项
    if ( empty( $widget_id ) )
        return $opts;

    //如果存在我们所检索的小工具选项，就返回
    if ( isset( $opts[$widget_id] ) )
        return $opts[$widget_id];

    //当初错时……
    return false;
}

/**
 * 获取特定小工具的一个单独的选项
 * @param $widget_id
 * @param $option
 * @param null $default
 *
 * @return string
 */
public static function get_dashboard_widget_option( $widget_id, $option, $default=NULL ) {

    $opts = get_dashboard_widget_options($widget_id);

    //如果小工具选项不存在，返回false
    if ( ! $opts )
        return false;

    //否则获取选项或默认选项
    if ( isset( $opts[$option] ) && ! empty($opts[$option]) )
        return $opts[$option];
    else
        return ( isset($default) ) ? $default : false;

}

/**
 * 保存单个小工具的选项数组到数据库
 * 也可用来设定小工具的默认值
 *
 * @param string $widget_id The name of the widget being updated
 * @param array $args An associative array of options being saved.
 * @param bool $add_only Set to true if you don't want to override any existing options.
 */
public static function update_dashboard_widget_options( $widget_id , $args=array(), $add_only=false )
{
    //从数据库中获取所有仪表盘小工具的选项
    $opts = get_option( 'dashboard_widget_options' );

    //获取我们所需的小工具选项，或者设置空数组
    $w_opts = ( isset( $opts[$widget_id] ) ) ? $opts[$widget_id] : array();

    if ( $add_only ) {
        //获取缺失的选项(现有的覆盖新的)
        $opts[$widget_id] = array_merge($args,$w_opts);
    }
    else {
        //合并新选项和已有选项，并且返回到小工具数组中
        $opts[$widget_id] = array_merge($w_opts,$args);
    }

    //保存整个小工具数组到数据库中
    return update_option('dashboard_widget_options', $opts);
}