関数リファレンス/register sidebar

目次 1 説明 2 使い方 2.1 デフォルトの使い方 3 パラメータ 4 注 5 用例 6 更新履歴 7 ソースファイル 8 関連

説明

単一サイドバーを定義し、ID を返します。

使い方

<?php register_sidebar( $args ); ?>

デフォルトの使い方

<?php $args = array(
	'name'          => sprintf(__('Sidebar %d'), $i ),
	'id'            => 'sidebar-$i',
	'description'   => ''
	'before_widget' => '<li id="%1$s" class="widget %2$s">',
	'after_widget'  => '</li>',
	'before_title'  => '<h2 class="widgettitle">',
	'after_title'   => '</h2>' ); ?>

パラメータ

$args

（文字列/配列） （オプション） 'name' と 'id' 値からサイドバーを作成

初期値： なし

• name - サイドバー名
• id - サイドバー id
• description - サイドバーの説明 (2.9以降)
• before_widget - ウィジェットの前のテキスト
• after_widget - ウィジェットの後のテキスト
• before_title - タイトルの前のテキスト
• after_title - タイトルの後のテキスト

オプション $args パラメータは連想配列で、アクティブウィジェットコールバックの最初の引数として渡されます。 (配列でなく文字列が渡された場合は、parse_str() を経て連想配列として渡されます。) これらの引数の基本的な使い方は、ウィジェットとタイトルを包む、テーマ固有の HTML タグを渡すことです。

注

• register_sidebars() ではなく、この関数を呼び出す必要があるケースは、サイドバーに一意の名前、たとえば “Right Sidebar” や “Left Sidebar” を与えるときや、異なるマークアップが必要なときに限られます。名前は、管理画面でのみ表示されますが、サイドバーの変更を保存するインデックスとしても使用されます。このため、サイドバーに加えた変更は、同じ名前を使用する別テーマを選択した時に、再利用され、上書きされます。

• before/after のデフォルト値は、リストを h2 タイトルでマークアップするサイドバーを生成することを想定しています。これは、全てのテーマに推奨される規約で、このように設計されたテーマなら、これらのタグを気にすることなくサイドバーを登録できます。もし、何らかの理由でこのようにマークアップしない場合は、サイドバーを登録するときに、タグを指定する必要があります。id と class 属性はコピーして、内部 sprintf コールが機能するようにし、CSS スタイルが個々のウィジェットに適用できるようにすることを推奨します。

用例

名前が "RightSideBar" で、タイトルの前後が <h1> と </h1> のサイドバーを作成します。

register_sidebar(array(
'name' => 'RightSideBar',
'description' => 'Widgets in this area will be shown on the right-hand side.',
'before_title' => '<h1>',
'after_title' => '</h1>'));

更新履歴

• 2.2.0 以降
• 2.9.0 : description プロパティが追加された

ソースファイル

register_sidebar() は、wp-includes/widgets.php にあります。

最新英語版： WordPress Codex » Function Reference/register_sidebar （最新版との差分）

関連

ウィジェット API: is_active_sidebar, register_sidebars, register_sidebar, unregister_sidebar, is_dynamic_sidebar, dynamic_sidebar, register_sidebar_widget, unregister_sidebar_widget, wp_register_sidebar_widget, wp_unregister_sidebar_widget, wp_get_sidebars_widgets, wp_set_sidebars_widgets, is_active_widget, the_widget, register_widget, unregister_widget, register_widget_control, unregister_widget_control, wp_register_widget_control, wp_unregister_widget_control, wp_convert_widget_settings, wp_get_widget_defaults, wp_widget_description