add_menu_page

説明

mixed add_menu_page( string $page_title, string $menu_title, mixed string $capability, string $menu_slug [ , mixed $function = '' [ , string $icon_url = '' [ , int $position = NULL ] ] ] )
メニューを登録する。

パラメータ

  • $page_title
    メニューページのタイトル。
  • $menu_title
    メニュー名。
  • $capability
    メニューの権限(レベル数または権限名)。
  • $menu_slug
    メニューのスラッグ。
  • $function
    メニューページのコールバック関数。
  • $icon_url
    メニュー横に表示されるアイコンファイルのURL(省略時は'')。
  • $position
    メニューの追加位置を示す番号を指定(省略時はNULL)。

返り値

メニューが登録できた場合はフック名を返す。ログインしているユーザーが指定された権限を所有していない場合はfalseを返す。

注意

パラメータ$capabilityは、メニューを使用できるレベルまたは権限を指定できる(「LevelとCapability」を参照)。 パラメータ$menu_slugにはサイト内でユニークなメニューのスラッグを指定する(プラグインの場合は__FILE__を指定することが多い)。 パラメータ$icon_urlに指定するアイコン画像は16×16ピクセルのイメージで、省略した場合は/wp-admin/images/generic.png'(歯車のイメージ)が適用される。

パラメータ$positionは追加するメニューを「ダッシュボード」の上にする場合は1を、「ダッシュボード」の下にする場合は2をといった感じで番号を指定する。$positionを省略した場合はNULLが適用されメニュー情報の末尾に追加される。


使用例

  • メニューを登録する。
    <?php add_menu_page( '基本設定', '基本設定', 'edit_themes', __FILE__, 'myplugin_setting' ); ?>
  • メニューを登録する(コールバック関数がメソッドの場合)。
    <?php add_menu_page( '基本設定', '基本設定', 'edit_themes', __FILE__, array( &$this, 'myplugin_setting' ) ); ?>
  • アイコンを指定してメニューを登録する。
    <?php add_menu_page( '基本設定', '基本設定', 'edit_themes', __FILE__, 'myplugin_setting', WP_PLUGIN_URL.'/myplugin/images/icon.gif' ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-admin/includes/plugin.php

最終更新 : 2017年06月22日 15:22



お勧め

LevelとCapability(2011年4月14日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

プラグインのヘッダー情報を国際化対応しよう(2017年8月4日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

canvasタグを投稿したい(2013年12月27日 更新)

以前「投稿内容のid属性などを保存するための対策」で取り上げたように、WordPressでは投稿に記述できるHTMLタグが制限されている。同コラムでこの制限を調整する対策を紹介しているが、3.5以降ではフィルター関数を登録して対応できるようだ。