is_admin_bar_showing() – ツールバー（アドミンバー）を表示しているか判定する関数

WordPress の管理画面にアクセスしたことがある方の多くは見たことがあるであろうツールバー（アドミンバーとも呼んだりします）はご存じですか？このように画面上部に常時表示され、ダッシュボードや各種メニューにアクセスしやすいツールバーのことです。

こちらのツールバーが表示されているかを判定する is_admin_bae_showing() 関数を本記事では紹介します。

is_admin_bar_showing() 関数とは

ツールバー（アドミンバー）を表示しているかを調べる関数です。返り値は true か false です。

使い方

一般的な使い方は以下の通りです。

if ( is_admin_bar_showing() ) {
	// ツールバーが表示された時だけ実行する何かしらを記述
}

ツールバーが表示される際には、サイトヘッダーなどがデザイン的な制約を受ける場合が考えられます。その際に対処するための CSS をツールバーが表示されている時だよ読み込むというような処理は実用的かもしれませんね。

フック

show_admin_bar

apply_filters( ‘show_admin_bar’, bool $show_admin_bar )

ツールバーを表示しているかどうかをフィルターできます。

以下のようなコードで動きを確認することができます。

add_filter(
	'show_admin_bar',
	function ( $show_admin_bar ) {
		echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
		echo( '<pre>' );
		var_dump( $show_admin_bar );
		echo( '</pre>' );
		echo '<hr>';

		return $show_admin_bar;
	},
	10,
	1
);

まとめ

なかなか目にすることがない関数ではありますが、WordPress は痒いところにも手が届くものを用意してくれていますね。

こういった細かい部分ですが、知識として持っておくことで、何かアイデアを実現するときや相談をされた時などに、チリも積もればで役立つのかもしれませんね。

is_admin_bar_showing() – Function | Developer.WordPress.org

Determines whether the admin bar should be showing.

developer.wordpress.org