dynamic_sidebar

説明

bool dynamic_sidebar( [ mixed $index = 1 ] )
ダイナミックサイドバーを表示する。

パラメータ

  • $index
    ダイナミックサイドバーのID番号または名前を指定(省略時は1)。

返り値

ダイナミックサイドバーを表示できた場合はtrue、表示できなかった場合はfalseを返す。

注意

テーマ内のsidebar.phpで使用することが多い。サイドバー以外でもウィジェットの表示でも利用される。

使用例

  • ID番号が2に設定されているダイナミックサイドバーを表示する。
    <?php dynamic_sidebar( 2 ); ?>
  • 'secondary-widget-area'のウィジェットを表示する。
    <?php dynamic_sidebar( 'secondary-widget-area' ); ?>

フィルター

[2.5.0]登録されているウィジェットごとに'dynamic_sidebar_params'フィルターを呼び出す(ウィジェットがある場合のみ)。パラメータ$paramsはそのウィジェットのプロパティ値となる。
$params = apply_filters( 'dynamic_sidebar_params', $params );
[3.9.0]本関数の終了直前に'dynamic_sidebar_has_widgets'フィルターを呼び出す。パラメータ$did_oneにウィジェットの有無(存在した場合はtrue、存在しない場合はfalse)が、$indexには本関数が受け取ったサイドバーのIDまたは名前が格納されている。
return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index );

アクション

[3.9.0]ウィジェットの表示前に'dynamic_sidebar_before'アクションを呼び出す。パラメータ$indexには本関数が受け取ったサイドバーのIDまたは名前が、$has_widgetsにはウィジェットの有無がそれぞれ格納されている。
do_action( 'dynamic_sidebar_before', $index, $has_widgets );
[3.0.0]各ウィジェットの表示直前に'dynamic_sidebar'アクションを呼び出す(ウィジェットがある場合のみ)。パラメータ$widgetにはウィジェット情報が格納されている。
do_action( 'dynamic_sidebar', $widget );
[3.9.0]ウィジェットの表示後に'dynamic_sidebar_after'アクションを呼び出す。パラメータ$indexには本関数が受け取ったサイドバーのIDまたは名前が、$has_widgetsにはウィジェットの有無がそれぞれ格納されている。
do_action( 'dynamic_sidebar_after', $index, $has_widgets );

ソースファイル

/wp-includes/widgets.php

最終更新 : 2018年05月27日 10:49



お勧め

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

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

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

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。