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



お勧め

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。