概要
register_block_template関数は、特定のカスタム投稿タイプに対してブロックテンプレートを登録するための関数です。この関数は、テーマ内でのカスタマイズや、カスタム投稿タイプに特有のテンプレートを簡単に作成したり使用したりする際に非常に役立ちます。この関数を使用することによって、開発者はエンドユーザーに対して、特定のレイアウトや構成を簡単に提案できるようになります。
よく使われる機能
- カスタム投稿タイプのブロックテンプレートを登録する
- デフォルトのテンプレートを提供することでユーザー体験を向上させる
- 特定の投稿タイプにカスタムスタイルを適用する
- 編集者向けに直感的なページ構成を提案する
- テンプレートの一貫性を持たせることで、Webサイト全体のデザインを統一する
- 開発時の反復作業を削減する
- ユーザーが簡単に特定のレイアウトを選択できるようにする
- 特定のビジネスニーズに対応するためのテンプレートを提供する
構文
register_block_template( $post_type, $templates, $args );
パラメータ
$post_type(string) — 登録したいカスタム投稿タイプのスラグ。$templates(array) — ブロックテンプレートの配列。各テンプレートは以下の形式を持つ必要があります：title(string) — テンプレートのタイトル。content(string) — テンプレートの内容（ブロックのスラグ）。
$args(array) — オプションの引数。例えば__return_falseなど。
戻り値
この関数は、登録が成功した場合には何も返しません。
関連する関数
ワードプレスのバージョン
register_block_template関数は、WordPress 5.8以降で利用可能です。
コアファイルのパス
この関数は、WordPressのコアファイルの中で以下のファイル内に含まれています：
wp-includes/block-template.php
サンプルコード
サンプル1
add_action( 'init', function() {
register_block_template( 'post', array(
array( 'core/paragraph', array( 'placeholder' => 'Your text here...' ) ),
array( 'core/image', array() ),
) );
} );
説明：カスタム投稿タイプ「post」に対して、段落と画像のブロックを含むブロックテンプレートを登録します。
サンプル2
add_action( 'init', function() {
register_block_template( 'page', array(
array( 'core/heading', array( 'level' => 1, 'content' => 'Welcome to My Page' ) ),
array( 'core/paragraph' ),
) );
} );
説明：カスタム投稿タイプ「page」に、見出しと段落ブロックのテンプレートを登録します。
サンプル3
add_action( 'init', function() {
register_block_template( 'event', array(
array( 'core/event-details' ),
array( 'core/rsvp-form' ),
) );
} );
説明：カスタム投稿タイプ「event」に、イベントの詳細とRSVPフォームを含むブロックテンプレートを登録します。
サンプル4
add_action( 'init', function() {
register_block_template( 'portfolio', array(
array( 'core/gallery' ),
array( 'core/paragraph' ),
) );
} );
説明：カスタム投稿タイプ「portfolio」に、ギャラリーと段落ブロックを含むテンプレートを登録します。
サンプル5
add_action( 'init', function() {
register_block_template( 'testimonial', array(
array( 'core/quote' ),
array( 'core/image' ),
) );
} );
説明：カスタム投稿タイプ「testimonial」に、引用と画像のブロックを含むブロックテンプレートを登録します。
この関数のアクションでの使用可能性
| アクション | 使用可能 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | 〇 |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
この関数は、特定のバージョンで非推奨または削除された情報はありません。