概要
add_dashboard_page関数は、ワードプレスのダッシュボードメニューにカスタムサブメニューを追加するための関数です。この関数を使用することで、プラグインやテーマの設定ページなど、ユーザーがアクセスできるカスタム機能をダッシュボードに統合することができます。
機能の利用例
以下は、add_dashboard_page関数がよく使われる機能の例です。
- プラグイン設定ページの追加
- サイト統計情報の表示
- ユーザー管理機能のカスタマイズ
- カスタム投稿タイプの管理ページの作成
- 特定の機能やサービスの統計データ表示
- プラグインアクティビティログの表示
- サイトのコンテンツ管理
- ショートコード管理ページの作成
構文
add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function );
パラメータ
$page_title(string) : サブメニューのページタイトル$menu_title(string) : ダッシュボードメニューに表示されるタイトル$capability(string) : サブメニューへのアクセス権限（例：’manage_options’）$menu_slug(string) : サブメニューの一意なスラグ$function(callable) : 出力するコールバック関数
戻り値
この関数は値を返しません。
関連する関数
使用可能なバージョン
add_dashboard_page関数は、WordPress 2.5以降で使用可能です。
コアファイルのパス
当関数は、wp-admin/includes/plugin.phpの中に含まれています。
サンプルコード
サンプルコード1: プラグインの設定ページを追加
function my_custom_dashboard_page() {
add_dashboard_page(
'My Custom Dashboard',
'Custom Dashboard',
'manage_options',
'my-custom-dashboard',
'my_custom_dashboard_callback'
);
}
function my_custom_dashboard_callback() {
echo '<h1>Welcome to My Custom Dashboard!</h1>';
}
add_action('admin_menu', 'my_custom_dashboard_page');
このコードは、カスタムダッシュボードページを追加し、特定の権限を持つユーザーがアクセスできるようにします。
サンプルコード2: ダッシュボードにグラフを表示
function my_graph_dashboard_page() {
add_dashboard_page(
'Site Performance',
'Performance Graph',
'manage_options',
'site-performance',
'render_performance_graph'
);
}
function render_performance_graph() {
echo '<h2>Performance Graph</h2>';
echo '<div id="graph">[Your Graph Here]</div>';
}
add_action('admin_menu', 'my_graph_dashboard_page');
このコードは、サイトのパフォーマンスを示すグラフの表示を追加します。
サンプルコード3: ユーザー統計情報をダッシュボードに表示
function user_stats_dashboard_page() {
add_dashboard_page(
'User Statistics',
'User Stats',
'manage_options',
'user-statistics',
'render_user_statistics'
);
}
function render_user_statistics() {
echo '<h2>User Statistics</h2>';
// ユーザー統計情報を表示するコードをここに追加
}
add_action('admin_menu', 'user_stats_dashboard_page');
このコードは、ユーザーに関する統計情報を表示するダッシュボードページを作成します。
サンプルコード4: カスタム投稿タイプの管理ページを追加
function custom_post_type_dashboard_page() {
add_dashboard_page(
'Custom Post Types',
'Custom Posts',
'manage_options',
'custom-post-types',
'render_custom_post_types'
);
}
function render_custom_post_types() {
echo '<h2>Manage Custom Post Types</h2>';
// カスタム投稿タイプの管理機能を追加
}
add_action('admin_menu', 'custom_post_type_dashboard_page');
このコードは、カスタム投稿タイプを管理するためのページをダッシュボードに追加します。
サンプルコード5: プラグインアクティティログを表示
function plugin_activity_log_dashboard_page() {
add_dashboard_page(
'Plugin Activity Log',
'Activity Log',
'manage_options',
'plugin-activity-log',
'render_activity_log'
);
}
function render_activity_log() {
echo '<h2>Plugin Activity Log</h2>';
// プラグインのアクティビティログを表示するコード
}
add_action('admin_menu', 'plugin_activity_log_dashboard_page');
このコードは、プラグインのアクティビティログを表示するダッシュボードページを作成します。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
add_dashboard_page関数は、特定のワードプレスバージョンで非推奨または削除されたことはありません。