get_the_block_template_html()


WordPressのget_the_block_template_html()関数は、ブロックテンプレートのHTMLを取得するために使用されます。この関数は、ブロックテーマやフルサイト編集（FSE）機能を利用する際に特に役立ちます。

構文

get_the_block_template_html( string $template_name, string $template_type = 'wp_template' );

引数の説明:

  • $template_name(string) — 取得するテンプレートの名前を指定します。
  • $template_type(string) — テンプレートのタイプを指定します。デフォルトは’wp_template’です。

例1: 基本的なテンプレートのHTMLを取得

この例では、指定したテンプレートのHTMLを取得します。

<?php echo get_the_block_template_html( 'single-post' ); ?>

例2: カスタムテンプレートタイプのHTMLを取得

カスタムテンプレートタイプのHTMLを取得する例です。

<?php echo get_the_block_template_html( 'custom-template', 'wp_template_part' ); ?>

例3: テンプレートのHTMLを変数に格納

テンプレートのHTMLを変数に格納して後で使用する例です。

<?php $template_html = get_the_block_template_html( 'page' ); ?>

例4: テンプレートのHTMLを直接出力

テンプレートのHTMLを直接出力する例です。

<?php get_the_block_template_html( 'header', 'wp_template_part' ); ?>

例5: 条件付きでテンプレートのHTMLを取得

条件に基づいてテンプレートのHTMLを取得する例です。

<?php if ( is_single() ) { echo get_the_block_template_html( 'single' ); } ?>

例6: テンプレートのHTMLをフィルタリング

テンプレートのHTMLを取得する前にフィルタリングする例です。

<?php echo apply_filters( 'custom_template_filter', get_the_block_template_html( 'archive' ) ); ?>

例7: テンプレートのHTMLをエスケープして出力

テンプレートのHTMLをエスケープして安全に出力する例です。

<?php echo esc_html( get_the_block_template_html( 'footer' ) ); ?>

注意点

  • テンプレート名やタイプが正しく指定されていない場合、関数は空の文字列を返します。
  • テンプレートのHTMLを直接出力する際は、エスケープ処理を忘れずに行いましょう。

関連機能：