_wp_block_theme_register_classic_sidebars()


WordPressの_wp_block_theme_register_classic_sidebars()関数は、クラシックテーマのサイドバーをブロックテーマに登録するために使用されます。この関数は、テーマがブロックテーマに移行する際に、従来のサイドバーをサポートするために役立ちます。

構文

_wp_block_theme_register_classic_sidebars( array $sidebars );
  • $sidebars (array) — 登録するサイドバーの配列。各サイドバーは連想配列で定義されます。

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

この例では、1つのサイドバーを登録します。

_wp_block_theme_register_classic_sidebars( array( 'id' => 'sidebar-1', 'name' => 'Main Sidebar', 'description' => 'メインサイドバー', 'before_widget' => '<div id="%1$s" class="widget %2$s">', 'after_widget' => '</div>', 'before_title' => '<h2 class="widgettitle">', 'after_title' => '</h2>' ) );

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

この例では、複数のサイドバーを一度に登録します。

_wp_block_theme_register_classic_sidebars( array( array( 'id' => 'sidebar-1', 'name' => 'Main Sidebar', 'description' => 'メインサイドバー' ), array( 'id' => 'sidebar-2', 'name' => 'Secondary Sidebar', 'description' => 'サブサイドバー' ) ) );

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

この例では、カスタムHTMLタグを使用してサイドバーを登録します。

_wp_block_theme_register_classic_sidebars( array( 'id' => 'sidebar-1', 'name' => 'Custom Sidebar', 'before_widget' => '<section id="%1$s" class="widget %2$s">', 'after_widget' => '</section>', 'before_title' => '<h3 class="widget-title">', 'after_title' => '</h3>' ) );

例4: サイドバーの説明を省略

この例では、サイドバーの説明を省略して登録します。

_wp_block_theme_register_classic_sidebars( array( 'id' => 'sidebar-1', 'name' => 'Simple Sidebar' ) );

例5: サイドバーのIDのみを指定

この例では、サイドバーのIDのみを指定して登録します。

_wp_block_theme_register_classic_sidebars( array( 'id' => 'sidebar-1' ) );

例6: サイドバーの名前を動的に生成

この例では、サイドバーの名前を動的に生成して登録します。

_wp_block_theme_register_classic_sidebars( array( 'id' => 'sidebar-1', 'name' => sprintf( 'Sidebar %d', 1 ) ) );

例7: サイドバーのクラスをカスタマイズ

この例では、サイドバーのクラスをカスタマイズして登録します。

_wp_block_theme_register_classic_sidebars( array( 'id' => 'sidebar-1', 'name' => 'Custom Class Sidebar', 'before_widget' => '<div id="%1$s" class="custom-widget %2$s">', 'after_widget' => '</div>' ) );

注意点

  • この関数は、ブロックテーマでのみ使用することを想定しています。クラシックテーマでは使用しないでください。
  • サイドバーのIDは一意である必要があります。重複したIDを使用すると、予期しない動作が発生する可能性があります。

関連機能：