add_dashboard_page()
は、WordPress の管理画面の「ダッシュボード」にカスタムページを追加するための関数です。
これを使用すると、独自の情報パネルや設定ページを作成し、管理画面の利便性を向上させることができます。本記事では、この関数の使い方や活用方法について詳しく解説します。
目次
機能の説明
add_dashboard_page()
は、WordPress の管理画面の「ダッシュボード」に新しいページを追加するための関数です。この関数を使用することで、管理者がカスタムの情報ページや統計ページを簡単に作成できます。
- WordPress の管理者用に、独自の統計データや情報を表示するページを作成
- サイト運営者向けのお知らせページを作成
- カスタム設定や管理ツールを提供
シンプルなコード例
function my_custom_dashboard_page() {
add_dashboard_page(
'カスタムダッシュボード', // ページのタイトル
'カスタムダッシュボード', // メニュータイトル
'manage_options', // 権限
'custom-dashboard', // スラッグ
'my_dashboard_content' // コールバック関数
);
}
add_action('admin_menu', 'my_custom_dashboard_page');
function my_dashboard_content() {
echo '<h1>ようこそ!</h1>';
echo '<p>カスタムダッシュボードの内容をここに記述します。</p>';
}
使い方の説明
引数の解説
add_dashboard_page()
は、以下の 5 つの引数を取ります。
- ページタイトル (
$page_title
):ブラウザのタブに表示されるタイトル。 - メニュータイトル (
$menu_title
):WordPress 管理画面のメニューに表示されるテキスト。 - 権限 (
$capability
):このページを表示できるユーザーの権限(例:manage_options
)。 - スラッグ (
$menu_slug
):ページの識別用スラッグ。 - コールバック関数 (
$callback
):ページの内容を表示する関数。
カスタムダッシュボードの実装例
function my_dashboard_page() {
add_dashboard_page('サイト情報', 'サイト情報', 'manage_options', 'site-info', 'site_info_content');
}
add_action('admin_menu', 'my_dashboard_page');
function site_info_content() {
echo '<h1>サイト情報</h1>';
echo '<p>このサイトの基本情報や最新のお知らせを表示します。</p>';
}
一緒に使うことが多い関連タグ
add_menu_page()
add_menu_page('カスタムページ', 'カスタムメニュー', 'manage_options', 'custom-page', 'custom_page_content');
add_menu_page()
は、管理メニューの主要な項目を追加するための関数。
add_submenu_page()
add_submenu_page('tools.php', 'ツール設定', 'ツール設定', 'manage_options', 'tools-settings', 'tools_settings_content');
add_submenu_page()
は、既存のメニューにサブメニューを追加するための関数。
追加情報で取得したい場合
get_current_screen()
を利用する
$current_screen = get_current_screen();
if ($current_screen->id === 'dashboard_page_custom-dashboard') {
echo '<p>カスタムダッシュボード専用の処理を実行</p>';
}
get_current_screen()
を使うと、現在表示中の管理画面の情報を取得できる。
想定されるトラブル
ページが表示されない
add_dashboard_page()
のスラッグが間違っていないか確認する。admin_menu
フックを適切に使用しているか確認する。manage_options
以上の権限を持つユーザーでログインしているか確認する。
Q&A
まとめ
add_dashboard_page()
は、WordPress の管理画面にカスタムページを追加するための便利な関数です。
カスタム情報ページや統計ページを作成し、管理者向けの情報を整理するのに役立ちます。また、add_menu_page()
や get_current_screen()
などと組み合わせることで、より高度な管理機能を実装できます。
コメント