管理メニュー

PHP

【WordPress】管理メニューの『ユーザー』に独自サブページを追加する方法

更新日:2023/02/13

WordPressの親メニューにサブメニューを追加する関数としてadd_submenu_page()があります。
しかし『ユーザー』メニューに自作のサブメニューを追加する関数が、別途用意されています。
使用する機会はほとんどないような気がしますが、せっかく用意されているので紹介します。

関数を使用すると、次のようなイメージになります。

『ユーザー』に追加したサブページ

 

add_users_page()を使う

『ユーザー』メニューにサブメニューを追加するときは、add_users_page()を使用します。

この関数はadd_submenu_page()と機能は全く同じです。

それもそのはず。関数の中身は、add_submenu_page()に引数を丸投げしているだけです。

function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) {
	if ( current_user_can( 'edit_users' ) ) {
		$parent = 'users.php';
	} else {
		$parent = 'profile.php';
	}
	return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $callback, $position );
}

ログインユーザーで親ページを切り分けているようですが、サブメニュー側の処理はadd_submenu_page()を使用するパターンと同じものになります。
詳しくは、次のページを読んでみてください。

 

add_users_page()の構文

add_users_page()の構文は、次のようになっています。

add_users_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null )
  • $page_title:

    head内のtitleタグに出力される文字列。

  • $menu_title:

    管理画面左側のメニュー欄に表示される文字列。

  • $capability:

    メニュー欄に表示するためのユーザー権限。

    権限の種類については、次のWordPressサポートページを見てください。
    https://ja.wordpress.org/support/article/roles-and-capabilities/#%e6%a8%a9%e9%99%90
  • $menu_slug:

    メニューのスラッグ名。
    他と重複してはダメ。

  • $callback:

    メニュー画面のhtmlを生成する関数。

  • $position:

    左側のメニューに挿入する位置。
    整数で指定します。

    既存メニューの前に挿入されます。

 

$positionの値

『ユーザー』の各サブメニューの位置は、次のようになっています。

[0]→slug:[users.php]title[ユーザー一覧]
[1]→slug:[user-new.php]title[新規追加]
[2]→slug:[profile.php]title[プロフィール]

【WordPress】管理画面の各メニュー項目の表示位置(番号)・スラッグを確認する。より

左端の数値が位置です。

例えば新規追加の前にサブメニューを挿入するときは、$positionに1を指定します。

 

コード例

管理メニューの『ユーザー』に独自サブページを追加する単純な例です。

add_action('admin_menu', function (){

	add_users_page( 'subメニュー' , 'subメニュー' , 'manage_options' , 'my_sub_menu'
			  , 'echo_my_sub_menu'  );
	register_setting( 'my_sub_option_group' , 'my_sub_option_1' );
});
function echo_my_sub_menu() {
	?>
	<div class="wrap">
		<h2>subメニュー</h2>
		<form method="post" action="options.php">
	<?php 
		settings_fields( 'my_sub_option_group' );
	?>
		<table class="form-table">
		<tr><th scope="row" >項目1</th>
		<td>
		<?php $value = esc_textarea( get_option('my_sub_option_1','') ); ?>
		<textarea id="my_sub_option_1" name="my_sub_option_1" cols="160" rows="7"><?= $value ?></textarea>
		</td></tr>
		</table>
		<?php submit_button(); ?>
		</form>
	</div>
<?php
}

 

その他のサブメニュー追加関数

WordPressはその他の既存メニューにも、専用のサブメニュー追加関数が用意されています。
次の表は、その一覧です。

メニュー名関数
ダッシュボードadd_dashboard_page()解説ページ
投稿add_posts_page()解説ページ
メディアadd_media_page()解説ページ
固定ページadd_pages_page()解説ページ
コメントadd_comments_page()解説ページ
外観add_theme_page()解説ページ
プラグインadd_plugins_page()解説ページ
ユーザーadd_users_page()
ツールadd_management_page()解説ページ
設定add_options_page()解説ページ

WordPressはHTMやCSSの知識も必要。総合的な知識を身につけよう。

更新日:2023/02/13

書いた人(管理人):けーちゃん

スポンサーリンク

記事の内容について

null

こんにちはけーちゃんです。
説明するのって難しいですね。

「なんか言ってることおかしくない?」
たぶん、こんなご意見あると思います。

裏付けを取りながら記事を作成していますが、僕の勘違いだったり、そもそも情報源の内容が間違えていたりで、正確でないことが多いと思います。
そんなときは、ご意見もらえたら嬉しいです。

掲載コードについては事前に動作確認をしていますが、貼り付け後に体裁を整えるなどをした結果動作しないものになっていることがあります。
生暖かい視線でスルーするか、ご指摘ください。

ご意見、ご指摘はこちら。
https://note.affi-sapo-sv.com/info.php

 

このサイトは、リンクフリーです。大歓迎です。