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



お勧め

Login rebuilder 2.8.0の変更内容を紹介(2022年7月20日 更新)

先々週のアップデート」では、ダッシュボードの「ログインのログ」ウィジェット内に現在のユーザー(管理者のみ)のログイン状況を簡潔なメッセージで表示しましたが、一週間ほど使ってみると、もう少し詳しい情報が欲しくなりました。そんなわけで、ログイン中のユーザー情報を表示する新しいウィジェットを用意しました。

バージョン6.8へのアップデートに伴いユーザーのパスワードハッシュが更新される件について(2025年4月14日 更新)

WordPressバージョン6.8では、ユーザーのパスワードハッシュの生成方法が変更される。これに関連して、既存ユーザーのパスワードハッシュも更新されることがアナウンスされており、少し気になった。

カスタムフィールドで並び替え(2013年8月9日 更新)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

5.5の新機能:XMLサイトマップの生成(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてついにRC 1が公開がされました。新機能であるXMLサイトマップについて「WordPress 5.5 RC 1(以降RC 1)」のソースコードを見ながら確認した。