WEB制作のための情報サイト / unazuki Library

dynamic_sidebar()

基本構文と使い方(引数・実行結果)

基本構文

サイドバー(ウィジェットを配置するエリア)を表示します。

dynamic_sidebar($index);

引数

引数必須/任意引数に指定するもの
第1引数
$index
任意表示するサイドバーのID(整数)あるいは名前(文字列
初期値1

実行結果

サイドバーを表示します。

例1.IDがsidebar-mainのサイドバーを表示する

functions.phpにて下記の通りregister_sidebar()でサイドバーが登録されていたとします。

function my_theme_register_sidebar() {
	register_sidebar([
		'name'           => 'メインサイドバー',
		'id'             => 'sidebar-main', // サイドバーID
		'description'    => '記事ページ右側に表示されるメインサイドバーです。',
		'before_sidebar' => '<aside id="sidebar-main" class="sidebar-wrapper">',
		'after_sidebar'  => '</aside>',
		'before_widget'  => '<div id="%1$s">',
		'after_widget'   => '</div>',
	]);
}
add_action('widgets_init', 'my_theme_register_sidebar');

任意のテンプレートファイルに下記コードを記述します。(引数にIDを指定)

<?php dynamic_sidebar('sidebar-main') ?>

学習者向け補足情報

【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。

【引数について】

  • 指定できる引数の数はテンプレートタグによって異なります。(引数なしもあり)
  • 引数ごとに必須 / 任意が決まっています。(必須は必ず指定、任意は指定しなければ初期値)
  • 引数名(例:$post)は仕様の便宜上の名前と考えてください。(この名前自体はテンプレートタグ実行に関係しません。各引数に何を指定するのかを理解していればOKです。)

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
register_sidebar() ウィジェットを配置するためのエリアを登録する。
register_taxonomy() カスタムタクソノミーを追加する。
register_post_type() カスタム投稿タイプを登録する。
wp_enqueue_script() スクリプトを登録し、読み込み対象としてキューに追加します。
wp_enqueue_style() スタイルシートを登録し、読み込み対象としてキューに追加します。
add_editor_style() 編集画面でエディタ用のスタイルシートを読み込む。
add_theme_support() 指定した機能をテーマに追加する。