概要
add_menu_pageアクションは、WordPressの管理画面に新しいメニュー項目を追加するために使用される関数です。この関数は、プラグインやテーマの開発者が自分の機能や設定をユーザーが管理できるようにする際によく使われます。具体的には、以下のような機能を実装する際に役立ちます:
- プラグインの設定ページ
- 独自のコンテンツ管理ページ
- ダッシュボードウィジェット設定
- 外部サービスとの連携設定
- カスタムポストタイプの管理
- ユーザー管理ページ
- ショートコード設定
- SEO設定や解析データの表示
構文
add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $position );
パラメータ
$page_title(string): 管理画面に表示されるページのタイトル。$menu_title(string): 管理メニューに表示される項目のタイトル。$capability(string): このメニュー項目を表示するために必要なユーザーの権限。$menu_slug(string): メニュー項目の一意の識別子。$function(callable): メニュー項目がクリックされたときに実行される関数。$icon_url(string|null): アイコンのURL(任意)。$position(int|null): メニューの表示位置(任意)。
戻り値
戻り値は真偽値で、メニュー項目が正常に追加された場合にはtrueを返します。
関連する関数
使用可能なバージョン
add_menu_pageアクションは、すべてのWordPressのバージョンで使用可能です。
コアファイルのパス
WordPressのコアファイルにおけるこのアクションは、wp-admin/includes/plugin.phpに含まれています。
この関数のアクションでの使用可能性
| アクション名 | 使用例 |
|---|---|
| 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_menu_pageアクションは特定のバージョンで非推奨または削除されたことはありません。