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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。