概要
is_user_admin関数は、リクエストページがユーザ管理者ページか調べるために使用されます。この関数は、WordPressの管理画面の特定のセクションでユーザーが管理者であるかどうかを確認するために便利です。一般的に、以下のような機能を実装する際によく使われます：
- ユーザープロファイル編集ページの表示
- ユーザー管理関連のカスタマイズ
- ロールや権限のチェック
- 管理ダッシュボードのカスタマイズ
- プラグインの設定ページの表示
- ユーザー一覧のカスタマイズ
- 特定のユーザー向けの通知メッセージの表示
- アクセス制限の実装
構文
is_user_admin();
パラメータ
この関数はパラメータを受け取りません。
戻り値
is_user_admin関数は、リクエストがユーザー管理者ページである場合はtrueを、それ以外の場合はfalseを返します。
関連する関数
使用可能なバージョン
is_user_admin関数はWordPress 4.1.0以降で使用可能です。
コアファイルのパス
この関数はwp-includes/user.phpに含まれています。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプルコード1：ユーザーのプロファイルを取得
このサンプルは、管理者ページでのみユーザーのプロファイル情報を表示します。
if (is_user_admin()) {
$user = wp_get_current_user();
echo 'Hello, ' . $user->display_name;
}
引用元: https://developer.wordpress.org/reference/functions/get_current_user/
サンプルコード2：管理者専用のオプションページを作成
このコードは、ユーザーが管理者である場合にのみオプションページを表示します。
add_action('admin_menu', 'custom_plugin_menu');
function custom_plugin_menu() {
if (is_user_admin()) {
add_options_page('Custom Plugin Settings', 'Custom Plugin', 'manage_options', 'custom-plugin', 'custom_plugin_options');
}
}
引用元: https://developer.wordpress.org/plugins/admin/settings/
サンプルコード3：管理者からのメッセージ表示
このサンプルは、ユーザーが管理者のときに特定のメッセージを表示します。
if (is_user_admin()) {
add_action('admin_notices', function() {
echo '<div class="notice notice-success"><p>管理者専用メッセージです。</p></div>';
});
}
引用元: https://developer.wordpress.org/plugins/admin/creating-admin-notices/
サンプルコード4：ユーザーのロールチェック
このコードは、ユーザーが管理者かどうかを確認し、特定の機能を許可します。
if (is_user_admin() && current_user_can('edit_users')) {
// ユーザー管理機能を実行
}
引用元: https://developer.wordpress.org/reference/functions/current_user_can/
サンプルコード5：管理者専用スタイルシートの読み込み
このサンプルは、管理者のためだけに特定のスタイルシートを読み込みます。
add_action('admin_enqueue_scripts', 'load_admin_styles');
function load_admin_styles() {
if (is_user_admin()) {
wp_enqueue_style('custom-admin-styles', plugins_url('admin-style.css', __FILE__));
}
}
引用元: https://developer.wordpress.org/plugins/assets/
このページでは、is_user_admin関数について解説し、使い方のサンプルコードを示しました。これを基に、WordPressの開発での適切な使用を検討してみてください。