関数リファレンス/register sidebars

説明

複数のサイドバーを作成します。

テーマで使用するサイドバーを1個または複数個登録します。ほとんどのテーマはサイドバーが1個です。このため、数パラメータはオプションで、デフォルト値は1です。

args 配列パラメータは 'name' を含み、複数のサイドバーがある場合は、これがサイドバーの番号の前に付加されます。

使い方

<?php register_sidebars( $number, $args ); ?>

デフォルトの使い方

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

パラメータ

number

（integer） （オプション） 作成するサイドバーの数

初期値： 1

args

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

初期値： なし

• name - サイドバー名
• id - サイドバーのid　(注: "%d" is added automatically to supplied 'id' value after the first; e.g., "Sidebar", "Sidebar-2", "Sidebar-3", etc.)
• description - Text description of what/where the sidebar is. Shown on widget management screen. (2.9以降) (デフォルトは空)
• class - ウィジェットのHTMLに割り当てるCSSクラス名 (デフォルトは空)
• before_widget - ウィジェットの前のテキスト
• after_widget - ウィジェットの後のテキスト
• before_title - タイトルの前のテキスト
• after_title -タイトルの後のテキスト

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

戻り値

なし

用例

この例は、1個のサイドバー(名前 Sidebar)を作成します。

register_sidebars();

この例は、2個のサイドバー(名前 “Foobar 1″ と “Foobar 2″) を作成します。

register_sidebars(2, array('name'=>'Foobar %d'));

この例は、2個のサイドバー(タイトルの前後が <h1> と </h1>)を作成します。

register_sidebars(2, array('before_title'=>'<h1>','after_title'=>'</h1>'));

変更履歴

• 2.2.0 : 新規追加

ソースファイル

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

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

関連

サイドバー: is_active_sidebar(), is_dynamic_sidebar(), dynamic_sidebar(), register_sidebars(), register_sidebar(), unregister_sidebar(), wp_register_sidebar_widget() / en, wp_unregister_sidebar_widget() / en, wp_get_sidebars_widgets() / en, wp_set_sidebars_widgets() / en,

ウィジェット API: is_active_widget(), the_widget(), register_widget(), unregister_widget() / en, wp_register_widget_control() / en, wp_unregister_widget_control() / en, wp_convert_widget_settings() / en, wp_get_widget_defaults() / en, wp_widget_description() / en

関数リファレンス、テンプレートタグ目次もご覧ください。