get_block_file_template()


WordPressのget_block_file_template()関数は、指定されたブロックテンプレートファイルを取得するために使用されます。この関数は、テーマやプラグイン内のブロックテンプレートを動的に読み込む際に役立ちます。

構文

get_block_file_template( string $slug, string $theme = '', array $args = array() );

引数の説明:

  • $slug(string) — 取得するテンプレートのスラッグを指定します。
  • $theme(string) — テンプレートを検索するテーマを指定します。デフォルトは現在のテーマです。
  • $args(array) — テンプレートに渡す追加の引数を指定します。

例1: 基本的なブロックテンプレートの取得

この例では、指定されたスラッグのブロックテンプレートを取得します。

$template = get_block_file_template( 'my-custom-template' );

例2: 別のテーマからテンプレートを取得

この例では、指定されたテーマからブロックテンプレートを取得します。

$template = get_block_file_template( 'my-custom-template', 'another-theme' );

例3: 追加の引数を渡す

この例では、追加の引数をテンプレートに渡します。

$template = get_block_file_template( 'my-custom-template', '', array( 'custom_var' => 'Hello, World!' ) );

例4: テンプレートの存在確認

この例では、テンプレートが存在するかどうかを確認します。

if ( get_block_file_template( 'my-custom-template' ) ) { echo 'テンプレートが存在します。'; }

例5: テンプレートの内容を表示

この例では、取得したテンプレートの内容を表示します。

$template = get_block_file_template( 'my-custom-template' ); echo $template->content;

例6: テンプレートのパスを取得

この例では、テンプレートのファイルパスを取得します。

$template = get_block_file_template( 'my-custom-template' ); echo $template->path;

例7: テンプレートのスラッグを取得

この例では、テンプレートのスラッグを取得します。

$template = get_block_file_template( 'my-custom-template' ); echo $template->slug;

注意点

  • テンプレートファイルが存在しない場合、関数はnullを返します。
  • テンプレートのスラッグは一意である必要があります。
  • テンプレートファイルは、テーマまたは子テーマのtemplatesディレクトリに配置する必要があります。

関連機能：