register_sidebar

パラメータ

• $args
  サイドバーの属性情報を連想配列または文字列で指定。属性情報の内容は次の通り。

  属性名	意味	省略時の値
  name	サイドバー名	__('Sidebar #n')
  id	サイドバーID	sidebar-#n
  description	サイドバーの説明	''
  class	サイドバーに追加するクラス名	''
  before_widget	ウィジェットの前タグ	<li id="%1$s" class="widget %2$s">
  after_widget	ウィジェットの後タグ	</li>\n
  before_title	サイドバータイトルの前タグ	<h2 class="widgettitle">
  after_title	サイドバータイトルの後タグ	</h2>\n
  before_sidebar	[5.6.0]サイドバーの前タグ	''
  after_sidebar	[5.6.0]サイドバーの後タグ	''

  ※#nにはサイドバーのシリアル番号が入る（例：登録時に2つのサイドバーが登録されている場合は3が入る）。

返り値

注意

内部では add_theme_support( 'widgets' )を実行し、テーマで「ウィジェット」メニューが有効になる。
デフォルトではタイトルは<h2>タグになるので、ページのHTML構造にあわせてパラメータ$argsの'before_title'と'after_title'に適切なタグを指定する。

[4.2.0]パラメータで'id'要素を指定することが推奨となった。

[5.6.0]パラメータ$argsに'before_sidebar'と'after_sidebar'が追加された。

使用例

• サイドバーを登録する。
  <?php register_sidebar( ); ?>
• 属性を指定してサイドバーを登録する。
  <?php register_sidebar( array( 'name'=>'メインサイドバー' ) ); ?>

フィルター

$sidebar = wp_parse_args( $args, apply_filters( 'register_sidebar_defaults', $defaults ) );

アクション

ソースファイル