wp_admin_bar_render

説明

void wp_admin_bar_render()
ツールバー(admin bar)をレンダリングする。

パラメータ

パラメータはありません。


返り値

返り値はありません。


注意

テーマやプラグインから本関数を呼び出すことはないが、アクションを使用することでツールバーを変更できる。なお各アクションは、ツールバーの表示条件( is_admin_bar_showing関数の返り値がtrueで、グローバル変数$wp_admin_barが(WP_Admin_Barクラスの)オブジェクト)を満たしている場合のみ実行される。

'admin_bar_menu'アクションを使用する場合、 add_action関数の第3パラメータの値によってツールバーの表示位置が変わる。

[5.4.0]'wp_body_open'アクションで呼び出されるようになった('wp_body_open'アクションを使用しないテーマでは従来通り'wp_footer'アクションで呼び出される)。


使用例

  • ツールバーにリンクを追加する。
    <?php
    function admin_bar_my_link( $wp_admin_bar ) {
    	$wp_admin_bar->add_menu( array(
    		'id'    => 'ja-wp',
    		'title' => 'ja.wp',
    		'href'  => 'https://ja.wordpress.org/',
    	) );
    }
    
    add_action( 'admin_bar_menu', 'admin_bar_my_link' ), 100 );
    ?>

フィルター

直接実行するフィルターはありません。

アクション

[3.1.0]ツールバーの表示条件を満たしている場合に'admin_bar_menu'アクションを呼び出す。パラメータにはグローバル変数$wp_admin_bar(のポインタ)が格納されている。
do_action_ref_array( 'admin_bar_menu', array( &$wp_admin_bar ) );
[3.1.0]レンダリングの前に'wp_before_admin_bar_render'アクションを呼び出す。
do_action( 'wp_before_admin_bar_render' );
[3.1.0]レンダリングの後に'wp_after_admin_bar_render'アクションを呼び出す。
do_action( 'wp_after_admin_bar_render' );

ソースファイル

/wp-includes/admin-bar.php

最終更新 : 2020年04月06日 14:09



お勧め

囲み型ショートコードとwpautop(2018年5月27日 更新)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

使っていないか確認しないとね!(フィルター編)(2019年4月24日 更新)

先週末にWordPress 5.2 Beta3(以降5.2Beta3)が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

Login rebuilder 2.5.0の新機能紹介(2018年12月10日 更新)

今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月14日 更新)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。