add_submenu_page

説明

mixed add_submenu_page( string $parent_slug, string $page_title, string $menu_title, mixed string $capability, string $menu_slug [ , mixed $function = '' [, int $position = null ] ] )
サブメニューを登録する。

パラメータ

  • $parent_slug
    親メニューのスラッグ。
  • $page_title
    サブメニューページのタイトル。
  • $menu_title
    プルダウンに表示されるメニュー名。
  • $capability
    サブメニューの権限(レベル数または権限名)。
  • $menu_slug
    サブメニューのスラッグ。
  • $function
    サブメニューページのコールバック関数(省略時は'')。
  • $position
    [5.3.0]サブメニューの位置を数値で指定(省略時はnull)。

返り値

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

注意

パラメータ$parent_slugは親メニューのスラッグで、 add_menu_page関数で登録できるプラグインやテーマの専用メニューの場合には__FILE__が利用されることが多い。

パラメータ$capabilityは、サブメニューを使用できるレベルまたは権限を指定できる(「LevelとCapability」を参照)。

パラメータ$menu_slugにはサイト内でユニークなサブメニューのスラッグを指定する(このスラッグは、サブメニューページのURLのパラメータとなる)。

http://ドメイン/wp-admin/admin.php?page=[$menu_slugの値]

[5.3.0]パラメータ$positionが追加された。0が指定された場合はサブメニューの最上位に、nullかサブメニュー数以上の場合は末尾に追加される。メニュー数未満の場合、array_slice関数を使ってサブメニューの配列が分割され、分割された位置に挿入される(1の場合なら2番目となる)。


使用例

  • プライベートのmytheme_propertiesメニューにmytheme_settingサブメニューを登録する。
    <?php add_submenu_page( 'mytheme_properties', '基本設定', '基本設定', 'edit_themes', 'mytheme_setting', 'mytheme_setting' ); ?>
  • プライベートのmytheme_propertiesメニューにmytheme_settingサブメニューを登録する(コールバック関数がメソッドの場合)。
    <?php add_submenu_page( 'mytheme_properties', '基本設定', '基本設定', 'edit_themes', 'mytheme_setting', array( &$this, 'mytheme_setting' ) ); ?>
  • カスタム投稿タイプ'tools'のメニューにadvanced_settingサブメニューを登録する(コールバック関数がメソッドの場合)。
    <?php add_submenu_page( 'edit.php?post_type=tools', 'ツールの拡張設定', '拡張設定', 'edit_themes', 'advanced_setting', array( &$this, 'advanced_setting' ) ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-admin/includes/plugin.php

最終更新 : 2022年06月24日 15:01



お勧め

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

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

5.3の機能強化:ナビゲーションにaria-label属性が追加される(2019年9月26日 更新)

先日「WordPress 5.3 Beta 1」が投稿され、アップデート内容は多い感じ。さっそく開発環境にインストールしてみると、管理画面全体の見た目が変わり、ブロックエディターが進化した印象である。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

Login rebuilderで第2ログインページのURLを取得する(2018年5月27日 更新)

先週のこと、「Login rebuilder」のユーザから「 wp_login_url関数のように第2ログインページのURLを取得できないか」という問い合わせがありました。その時点ではそのような関数やメソッドを用意していなかったのですが、まあニーズがあるなら作ってみようと思い、対応するメソッドを追加したLogin rebuilderバージョン1.4.3をリリースしました。