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

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

関連

参考

Code Reference: dynamic_sidebar

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。