add_plugins_page

説明

mixed add_plugins_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を返す。

注意

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

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

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

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

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


使用例

  • プラグインメニューにmyplugin_settingサブメニューを登録する。
    <?php add_plugins_page( 'マイプラグイン設定', 'マイプラグイン設定', 'edit_themes', 'myplugin_setting', 'myplugin_setting' ); ?>
  • プラグインメニューにmyplugin_settingサブメニューを登録する(コールバック関数がメソッドの場合)。
    <?php add_plugins_page( 'マイプラグイン設定', 'マイプラグイン設定', 'edit_themes', 'myplugin_setting', array( &$this, 'myplugin_setting' ) ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-admin/includes/plugin.php

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



お勧め

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

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

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

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

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

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