wp_add_dashboard_widget() の使い方｜説明・引数・注意点

説明

基本構文

wp_add_dashboard_widget( string $widget_id, string $widget_name, callable $callback, callable $control_callback = null, array $callback_args = null, string $context = 'normal', string $priority = 'core' ): void

引数

• $widget_id：ウィジェットID
• $widget_name：タイトル
• $callback：内容を出力する関数
• $control_callback：設定画面用の関数
• $callback_args：引数
• $context：位置
• $priority：優先度

戻り値

戻り値はありません。

使い方（サンプル）

add_action( 'wp_dashboard_setup', function() {
	wp_add_dashboard_widget( 'my_widget', 'お知らせ', 'my_widget_html' );
} );

注意点

• wp_dashboard_setup フックで呼びます。

実務での使いどころ

• 管理画面の、ダッシュボードに、お知らせや、操作の案内を出すとき。
• クライアント向けの、マニュアルへのリンクを、載せるとき。

よくあるミスと対処

• wp_dashboard_setup フックの外で呼んでいる。
• コールバックの中で、出力を、エスケープしていない。
• マルチサイトの、ネットワーク管理画面では、wp_network_dashboard_setup フックを使う。

NG例

wp_add_dashboard_widget( 'guide', '案内', 'my_guide' ); // フックの外で呼んでいる

OK例

add_action( 'wp_dashboard_setup', function () {
	wp_add_dashboard_widget( 'guide', '更新のご案内', function () {
		echo '<p>' . esc_html( '記事の更新方法は、マニュアルをご覧ください。' ) . '</p>';
	} );
} );

使い分け早見表

関連項目

remove_meta_box()

公式リファレンス：wp_add_dashboard_widget() | Function | WordPress Developer Resources