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



お勧め

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

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

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

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

投稿日の検索が自由自在に(2015年3月7日 更新)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

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

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