register_sidebars()


WordPressのregister_sidebars()関数は、一つ以上のサイドバーを登録するために使用されます。この関数を使うことで、テーマ内で複数のサイドバーを簡単に管理できます。

構文

register_sidebars( int $number = 1, array|string $args = array() );

引数の説明:

  • $number (int) — 登録するサイドバーの数。デフォルトは1。
  • $args (array|string) — サイドバーの設定を指定する配列または文字列。以下のキーを持つ配列を指定できます：
    • name — サイドバーの名前。
    • id — サイドバーの一意のID。
    • description — サイドバーの説明。
    • class — サイドバーに追加するCSSクラス。
    • before_widget — 各ウィジェットの前に表示するHTML。
    • after_widget — 各ウィジェットの後に表示するHTML。
    • before_title — 各ウィジェットのタイトルの前に表示するHTML。
    • after_title — 各ウィジェットのタイトルの後に表示するHTML。

例1: 基本的なサイドバーの登録

1つのサイドバーを登録する基本的な例です。

register_sidebars(1, array('name' => 'メインサイドバー', 'id' => 'main-sidebar'));

例2: 複数のサイドバーを登録

3つのサイドバーを一度に登録する例です。

register_sidebars(3, array('name' => 'サイドバー %d', 'id' => 'sidebar-%d'));

例3: カスタムHTMLを使用したサイドバーの登録

各ウィジェットの前後にカスタムHTMLを追加する例です。

register_sidebars(1, array('name' => 'カスタムサイドバー', 'before_widget' => '<div class="widget">', 'after_widget' => '</div>', 'before_title' => '<h2 class="widgettitle">', 'after_title' => '</h2>'));

例4: 説明付きのサイドバー

サイドバーに説明を追加する例です。

register_sidebars(1, array('name' => '説明付きサイドバー', 'description' => 'これは説明付きのサイドバーです。'));

例5: 特定のIDを持つサイドバー

特定のIDを持つサイドバーを登録する例です。

register_sidebars(1, array('name' => '特定IDサイドバー', 'id' => 'special-sidebar'));

例6: 複数のサイドバーを異なる設定で登録

異なる設定を持つ複数のサイドバーを登録する例です。

register_sidebars(2, array('name' => 'サイドバー %d', 'id' => 'sidebar-%d', 'before_widget' => '<div class="widget %2$s">', 'after_widget' => '</div>', 'before_title' => '<h3 class="widget-title">', 'after_title' => '</h3>'));

注意点

  • サイドバーのIDは一意である必要があります。重複すると予期しない動作が発生する可能性があります。
  • before_widgetやafter_widgetに指定するHTMLは、テーマのスタイルに合わせて調整してください。
  • サイドバーの数が多い場合、管理画面での表示が煩雑になることがあるため、適切な命名規則を設定することが推奨されます。

関連機能：