WordPressの管理画面にメニューを追加するadd_menu_pageの使い方

Posted on by pugiemonn

WordPress 管理画面に独自メニューを追加できる、add_menu_page() をご紹介します。

add_menu_page() は管理画面に独自のメニューを追加できる関数なので、テーマ開発やプラグイン開発で必ず登場する関数とも言えます。

使い方

add_menu_page() ですが引数が多めです。

add_menu_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '', string $icon_url = '', int $position = null )

引数はストリング型が多いです。最後のポジションが int 型です。

呼び出し関数の中で、表示したい内容を記述すれば、追加したメニューに反映されます。

呼び出すには

add_menu_page() は add_action のアクションフックを使用します。

//管理画面にメニューを追加
function add_my_menu() {
    add_menu_page( 'page_title', 'menu_title', 'administrator', __FILE__, 'function_name', '', 8);
}
add_action('admin_menu', 'add_my_menu');

上記例の中にある、function_name 部分で HTML 出力コードを記載すると良いでしょう。

position について

パラメータの $position には管理画面での表示位置を数字で指定します。

Default: bottom of menu structure #Default: bottom of menu structure
2 – Dashboard
4 – Separator
5 – Posts
10 – Media
15 – Links
20 – Pages
25 – Comments
59 – Separator
60 – Appearance
65 – Plugins
70 – Users
75 – Tools
80 – Settings
99 – Separator

https://developer.wordpress.org/reference/functions/add_menu_page/#menu-structure

例えば管理画面にある設定項目の下に表示するには80を指定します。
ここは実際にコードを書いて試してみるとわかりやすいです。

参考