add_pages_page

add_pages_page - 固定ページメニューにサブメニューを登録する

説明

mixed add_pages_page( string $page_title, string $menu_title, mixed string $capability, string $menu_slug [ , mixed $function = '' [, int $position = null ] ] )
固定ページメニューにサブメニューを登録する。

パラメータ

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

返り値

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

注意

この関数は、内部で親メニューのスラッグに'edit.php?post_type=page'を指定して add_submenu_page関数を呼び出している。

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

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

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

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

使用例

  • 固定ページメニューにmytheme_pageサブメニューを登録する。
    <?php add_pages_page( 'テーマ固定ページ', 'テーマ固定ページ', 'edit_themes', 'mytheme_page', 'mytheme_page' ); ?>
  • 固定ページメニューにmytheme_pageサブメニューを登録する（コールバック関数がメソッドの場合）。
    <?php add_pages_page( 'テーマ固定ページ', 'テーマ固定ページ', 'edit_themes', 'mytheme_page', array( &$this, 'mytheme_page' ) ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-admin/includes/plugin.php

最終更新 : 2022年06月27日 09:47

関連

参考

Code Reference: add_pages_page

お勧め

5.5で非推奨になる関数名について（2020年8月12日 更新）

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2（以降Beta 2）」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

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

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

全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）

query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？