概要
is_blog_admin関数は、リクエストページがブログ管理者ページかどうかを調べるために使用されます。主に管理領域において、特定の処理を実行するための条件判定に利用されます。この関数は、以下のような機能を持つエリアでよく使われます：
- プラグインの管理画面の表示制御
- カスタム管理パネルの作成
- ユーザーのアクセス制御
- 特定のデータを管理者のみがアクセスできるようにする
- 管理ページに特化したスタイルやスクリプトの読み込み
- 自動更新やバックアップなどの管理機能の実装
- メッセージや通知の表示
- ダッシュボードウィジェットの条件分岐
構文
is_blog_admin();
パラメータ
この関数はパラメータを受け取りません。
戻り値
true：リクエストが管理者ページに対するものである場合false：リクエストが管理者ページに対するものでない場合
関連する関数
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
使用可能なバージョン
is_blog_adminはWordPress 3.0以降で使用可能です。
コアファイルのパス
wp-includes/capabilities.php
サンプルコード
サンプルコード 1
if ( is_blog_admin() ) {
// 管理者ページにいる場合の処理
echo "管理者ページです";
}
このサンプルは、現在のページが管理者ページである場合にメッセージを表示します。
サンプルコード 2
add_action( 'admin_init', function() {
if ( is_blog_admin() ) {
// 管理者ページに対してのみ実行する処理
// 例えば、特定の設定を取得する
}
});
このサンプルは、admin_initアクションで管理者ページにいる場合のみ特定の処理を実行します。
サンプルコード 3
function my_custom_admin_notice() {
if ( is_blog_admin() ) {
echo "<div class='notice notice-success'>管理者ページにようこそ！</div>";
}
}
add_action( 'admin_notices', 'my_custom_admin_notice' );
このコードは、管理者ページにメッセージを表示するためのカスタム通知を作成します。
サンプルコード 4
function load_custom_admin_scripts() {
if ( is_blog_admin() ) {
wp_enqueue_style( 'custom-admin-css', plugin_dir_url(__FILE__) . 'css/admin.css' );
}
}
add_action( 'admin_enqueue_scripts', 'load_custom_admin_scripts' );
このサンプルは、管理者ページでのみカスタムCSSを読み込む処理を実装しています。
サンプルコード 5
function redirect_non_admin_users() {
if ( ! is_blog_admin() && is_admin() ) {
wp_redirect( home_url() ); // 管理者でない場合はホームページにリダイレクト
exit;
}
}
add_action( 'admin_init', 'redirect_non_admin_users' );
このコードは、非管理者ユーザーが管理者ページにアクセスした場合にホームページにリダイレクトします。
この関数のアクションでの使用可能性
| アクション名 | 使用可能 |
|---|---|
| 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 |
非推奨または削除されたバージョン
現在のところ、is_blog_adminは非推奨または削除されたバージョンはありません。