WordPressの管理画面にメニューを追加するadd_menu

WordPressでプラグインなどを追加したときに管理画面のメニューが追加されることがあると思います。実は管理画面のメニューはとある関数を追加することで簡単に追加することが出来ます。今回は、WordPressの管理画面にメニューを追加する関数を紹介します。

WordPressの管理画面にメニュー追加する関数はadd_menu_pageです。add_menu_pageを使ってadmin_menuフックで呼び出せば使えるようになります。

add_menu_pageの仕様は以下の通りです。

add_menu_pageの仕様

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	メニューのURLスラッグ。ユニークであるかつ、小文字の英数字、ハイフン(-)、アンダースコア(_)のみ可能(必須)	なし
function	callable	設定ページのコールバック関数	”
icon_url	string	管理画面のメニューに表示するアイコン画像のURL	”
position	int	メニューに表示する順序	null

add_menu_pageのサンプル

add_menu_pageの使い方は以下のようにすればとりあえずのメニューの表示が出来ます。

functions.php

function add_admin_menu() {
    add_menu_page(
        'オリジナル設定',
        'オリジナル設定',
        'manage_options',
        'original_setting_config'
    );
}
add_action('admin_menu', 'add_admin_menu');

まとめ

今回は、WordPressの管理画面に独自のメニューを追加できるadd_menu_pageについて紹介しました。WordPressプラグインなんかでどんな関数を使って表示しているのかなーって思って調べたらadd_menu_pageを使えば簡単にメニューを追加できることがわかりました。

あまり使うような機会はないと思いますが、プラグインや独自テーマの開発で設定メニューとか追加するのに調べたら出てきたので今後活用していきたいなと思いました。