dynamic_sidebar

(2.2.0以降)
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

関連

お勧めコンテンツ

「テキスト」モードと「ビジュアル」モードを行き来すると投稿内容の一部が消える(2015年3月14日 登録)

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

Paste JSON text:プラグイン作ってみました(2012年1月19日 登録)

動作検証用のサーバーと本番サーバーで投稿データの同期作業(コピー&ペースト)を支援するプラグインです。動作検証用のサーバーで投稿記事をJSONテキストに変換してクリップボードにコピー。本番サーバーの新規投稿ページでクリップボードにコピーしたJSONテキストをペーストして、投稿記事のコピー&ペーストを実現します。複数サーバー間で投稿記事の同期を行っている方は、お試しあれ。

コメントの「ウェブサイト」止めました(2014年4月14日 登録)

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

全投稿を取得するのはnopaging=1でいい(2011年8月29日 登録)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

WordPressの鼓動(2013年10月1日 登録)

WordPressでは、Ajaxを利用する方法の1つとしてadd_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

最終更新日時 : 2014-04-22 09:04