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



お勧め

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

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

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

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

Login rebuilder 2.4.1の新機能紹介(2018年12月10日 更新)

少し前にLogin rebuilderをアップデートし、oEmbedに関連する情報を制限できる機能を追加。この機能は、oEmbed関連情報によってユーザーIDが類推されることを防ぐことが目的としている。

「テキスト」モードと「ビジュアル」モードを行き来すると投稿内容の一部が消える(2018年5月27日 更新)

仕事がらサイトの引っ越し作業のお手伝いをすることがあるのですが、今回は引っ越しにあわせてWordPressを「3.7.1」から最新版「4.1.1」にアップデートすることになりました。ここで紹介するのはこの案件で発生したトラブルの話です。