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



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

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

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

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

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

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。