- サイトデザイン工事中です。ご意見をお寄せください。
- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
関数リファレンス/register sidebars
目次 |
説明
複数のサイドバーを作成します。
テーマで使用するサイドバーを1個または複数個登録します。ほとんどのテーマはサイドバーが1個です。このため、数パラメータはオプションで、デフォルト値は1です。
args 配列パラメータは 'name' を含み、複数のサイドバーがある場合は、これがサイドバーの番号の前に付加されます。
使い方
<?php register_sidebars( $number, $args ); ?>
デフォルトの使い方
<?php $args = array(
'name' => sprintf(__('Sidebar %d'), $i ),
'id' => 'sidebar-$i',
'before_widget' => '<li id="%1$s" class="widget %2$s">',
'after_widget' => '</li>',
'before_title' => '<h2 class="widgettitle">',
'after_title' => '</h2>' ); ?>
パラメータ
- $number
- （整数） （必須） 作成するサイドバーの数
- 初期値： なし
- $args
- （数値/配列） （オプション） 'name' と 'id' 値からサイドバーを作成
- 初期値： なし
- name - サイドバー名
- id - サイドバー id
- 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 （最新版との差分）
関連
ウィジェット 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
