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



お勧め

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

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

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

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

開発環境(Windows 8)にimagickを入れる(2012年12月23日 更新)

WordPress 3.5のイメージエディタ(WP_Image_Editor)は、GDだけでなく、imagick(ImageMagick)にも対応している。そんなわけでWindows 8の開発環境にimagickをインストールしてみた。

ページを表示する直前の前処理にtemplate_redirectアクションを(2013年4月13日 更新)

リクエストに応じてページを表示する直前の準備として何かしらの処理を行っておきたいケースがある。そんな時、テーマの各テンプレートファイルの先頭部分に処理内容をずらずらと記述していませんか。

Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。