register_block_template()


WordPress関数register_block_template()は、ブロックエディターで使用するためのブロックテンプレートを登録するためのものです。この関数を使用すると、特定のページや投稿タイプに適用できる事前定義されたブロック構造を作成できます。

シンタックス

register_block_template( string $post_type, array $template );

引数の説明:

  • $post_type (string) — テンプレートを登録する投稿タイプ。
  • $template (array) — テンプレートの構造を定義する配列。

例1: 投稿タイプ「page」のテンプレートを登録

次のコードは、投稿タイプ「page」にテンプレートを登録します。

register_block_template( 'page', array(
    array( 'core/paragraph', array(
        'placeholder' => 'ここにテキストを入力してください。',
    ) ),
    array( 'core/image' ),
) );

例2: 投稿タイプ「post」のカスタムテンプレート

「post」投稿タイプにカスタムテンプレートを登録する例です。

register_block_template( 'post', array(
    array( 'core/heading', array(
        'level' => 2,
        'placeholder' => '見出しを入力してください。',
    ) ),
    array( 'core/list' ),
) );

例3: 固定ページに特定のレイアウトを設定

固定ページで特定のレイアウトを使用するためのテンプレートを設定します。

register_block_template( 'page', array(
    array( 'core/columns', array(), array(
        array( 'core/column', array(), array(
            array( 'core/paragraph', array(
                'placeholder' => '左側のテキストを入力してください。',
            ) ),
        ) ),
        array( 'core/column', array(), array(
            array( 'core/image' ),
        ) ),
    ) ),
) );

例4: カスタム投稿タイプのテンプレート

カスタム投稿タイプ「book」にテンプレートを登録する例です。

register_block_template( 'book', array(
    array( 'core/quote', array(
        'value' => 'ここに引用を入力してください。',
    ) ),
) );

例5: 複数ブロックを含むテンプレート

複数のブロックで構成されるテンプレートを登録します。

register_block_template( 'custom', array(
    array( 'core/paragraph', array(
        'placeholder' => '最初の段落を入力してください。',
    ) ),
    array( 'core/image' ),
    array( 'core/paragraph', array(
        'placeholder' => '最後の段落を入力してください。',
    ) ),
) );

関連機能：