get_template_partはphpファイル内で別のphpファイルを呼び出すときに使用する、WordPressのインクルードタグです。
例えばサイトの前ページの上部に「このサイトをご覧いただいてありがとうございます。」と表示させたいとします。
その場合、一つの方法としてphpファイルを作って、表示させたい部分にget_template_partで呼び出します。
ページ内リンク
get_template_partとは
WordPressにはテンプレートファイル(header.php、footer.php、sidebar.php)をインクルードさせて読み込む機能があります。
header.php
<?php get_header(); ?>
footer.php
<?php get_footer(); ?>
sidebar.php
<?php get_sidebar(); ?>
これらと同じように独自で作ったphpファイルを呼び出すことができます。
それが「get_template_part」です。
get_template_part(); の使い方とパラメータ
<?php get_template_part( $slug ); ?>
<?php get_template_part( $slug, $name ); ?>
| 引数名 | 説明 | デフォルト | 必須 |
|---|---|---|---|
| $slug | テーマスラッグ名 | なし | ○ |
| $name | 特定テンプレート名 | なし |
get_template_part(); のテンプレート例
「onrei.php」というファイルを作ります。
そこに「このサイトをご覧いただいてありがとうございます。」と入力します。
ファイルを保存する場所
「onrei.php」はテーマフォルダ内、style.cssやfunctions.phpが置いてあるフォルダに保存します。
onrei.phpのインクルード例
「onrei.php」ファイルをテーマヘッダーの「header.php」内でget_template_partを使って呼び出します。
<?php get_template_part( 'onrei' ); ?>
を「header.php」内の「div id=”content” class=”site-content”」の下に入力します。
するとこんな感じに表示されます。
「このサイトをご覧いただいてありがとうございます。」が表示されました。
「header.php」にget_template_part( ‘onrei’ )を入力しているので、全てのページに表示されています。
レイアウト的にはとても変なので、CSSでカスタマイズしてください。
onrei-kokyaku.phpのインクルード例
インクルードさせたいファイルの中には例えばonreiの種類を色々作りたい場合があります。
onrei-kokyaku.phpやonrei-hajimete.phpやonrei-touroku.php等など。
このような場合
<?php get_template_part( 'onrei','kokyaku' ); ?>
と入力します。
テーマサブディレクトリでの使用
テーマサブディレクトリ「subsub」にonrei.phpを置いた場合の呼び出し方は
<?php get_template_part( 'subsub/onrei' ); ?>
となります。
「subsub」にonrei-kokyaku.phpを置いた場合の呼び出し方は
<?php get_template_part( 'subsub/onrei','kokyaku' ); ?>
となります。
