説明
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 );
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 );
do_action( 'dynamic_sidebar', $widget );
do_action( 'dynamic_sidebar_after', $index, $has_widgets );
ソースファイル
/wp-includes/widgets.php最終更新 : 2018年05月27日 10:49
関連
お勧め
5.5で非推奨になる関数名について(2020年8月12日 更新)
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい(2013年11月27日 更新)
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)
query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?