概要
is_admin_bar_showing関数は、WordPressのツールバー（admin bar）の表示状態を調べるために使用される関数です。この関数は、管理画面やフロントエンドでのツールバーの表示・非表示を確認するために利用されます。具体的には、以下のような機能を実装する際によく使われます。
- ユーザーインターフェースのカスタマイズ
- ツールバーが表示されているかに応じたスタイルの適用
- コンテンツやウィジェットの表示条件の制御
- ユーザーアクセス権に基づくロジックの実装
- ツールバーに関連する要素の追加・削除
- 特定のページでのツールバーの動作のカスタマイズ
- 非表示状態における追加情報の提供
- プラグインやテーマによる動的なデザイン調整
構文
is_admin_bar_showing();
パラメータ
この関数は引数を持ちません。
戻り値
is_admin_bar_showing関数は、ツールバーが表示されている場合はtrueを、表示されていない場合はfalseを返します。
関連する関数
この関数に関連するその他の関数には以下があります。
使用可能なバージョン
is_admin_bar_showing関数は、WordPress 3.1以降で使用可能です。
コアファイルのパス
この関数は、wp-includes/admin-bar.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_admin_bar_showing()) {
echo '<style>.my-element { display: block; }</style>';
}
ツールバーが表示されているとき、特定のCSSスタイルを適用しています。
サンプル 2: ツールバーとコンテンツの表示
このサンプルでは、ツールバーの表示状態に基づいてコンテンツを表示・非表示にします。
if (is_admin_bar_showing()) {
echo '<p>This is admin bar content.</p>';
} else {
echo '<p>This content is shown without admin bar.</p>';
}
ツールバーが表示されている時とそうでない時で異なるメッセージを表示します。
サンプル 3: フロントエンドでの条件分岐
このサンプルは、フロントエンドでの条件に応じて異なるメッセージを表示します。
if (is_admin_bar_showing()) {
echo '<div class="admin-bar-message">Admin bar is active.</div>';
} else {
echo '<div class="no-admin-bar-message">Admin bar is not active.</div>';
}
フロントエンドでのツールバーの状態に基づいて異なるメッセージを表示します。
サンプル 4: ツールバーのカスタムボタンの表示
このサンプルでは、ツールバーが表示されている場合のみカスタムボタンを表示します。
add_action('admin_bar_menu', function($admin_bar) {
if (is_admin_bar_showing()) {
$admin_bar->add_node([
'id' => 'custom-button',
'title' => 'Custom Button',
'href' => '#',
]);
}
}, 100);
ツールバーが表示されている時にのみカスタムボタンを追加します。
サンプル 5: ツールバーの制御
このサンプルでは、特定の条件下でツールバーを非表示にします。
add_filter('show_admin_bar', function($show) {
if (!is_admin_bar_showing()) {
return false;
}
return $show;
});
ツールバーが表示されていない場合、ツールバーを非表示にするフィルターを設定しています。