_add_block_template_part_area_info()


WordPressの_add_block_template_part_area_info()関数は、ブロックテンプレートパーツのエリア情報を追加するために使用されます。この関数は、テーマ開発者がブロックテンプレートの特定のエリアに情報を追加する際に役立ちます。

構文

_add_block_template_part_area_info( string $area, array $info );

引数の説明:

  • $area(string) — テンプレートパーツのエリアを指定します。
  • $info(array) — エリアに追加する情報を配列で指定します。

例1: 基本的なエリア情報の追加

この例では、ヘッダーエリアに情報を追加します。

_add_block_template_part_area_info( 'header', array( 'label' => 'ヘッダーエリア' ) );

例2: フッターエリアにカスタム情報を追加

フッターエリアにカスタムラベルと説明を追加します。

_add_block_template_part_area_info( 'footer', array( 'label' => 'フッターエリア', 'description' => 'ここにフッターの説明を追加します。' ) );

例3: サイドバーエリアに複数の情報を追加

サイドバーエリアに複数の情報を一度に追加します。

_add_block_template_part_area_info( 'sidebar', array( 'label' => 'サイドバー', 'icon' => 'sidebar', 'description' => 'サイドバーの説明です。' ) );

例4: カスタムエリアの作成

カスタムエリアを作成し、情報を追加します。

_add_block_template_part_area_info( 'custom_area', array( 'label' => 'カスタムエリア', 'description' => 'カスタムエリアの説明です。' ) );

例5: エリア情報の上書き

既存のエリア情報を上書きします。

_add_block_template_part_area_info( 'header', array( 'label' => '新しいヘッダーラベル' ) );

例6: エリア情報の削除

エリア情報を削除するために空の配列を渡します。

_add_block_template_part_area_info( 'footer', array() );

例7: 複数のエリアに情報を追加

複数のエリアに一度に情報を追加します。

_add_block_template_part_area_info( 'header', array( 'label' => 'ヘッダー' ) ); _add_block_template_part_area_info( 'footer', array( 'label' => 'フッター' ) );

注意点

  • この関数は、テーマ開発者がブロックテンプレートのエリア情報をカスタマイズするために使用されます。
  • エリア名は一意である必要があります。
  • 既存のエリア情報を上書きする場合は注意が必要です。

関連機能：