get_template_part()
は、テーマのパーツテンプレートファイルを再利用するためのテンプレートタグです。共通するコンテンツやコードを一箇所で管理でき、ページの一部として他のテンプレートファイルに簡単に挿入できます。
機能の説明
get_template_part()
は、指定したテンプレートパーツファイルを呼び出し、その内容を表示します。よく使うレイアウトやコードをまとめて、再利用可能な部品として扱うために便利です。
<?php get_template_part('content'); ?>
この例では、content.php
ファイルが呼び出され、テンプレートの指定箇所に挿入されます。
使い方の解説
get_template_part()
は、テーマ内で共通のコード部分やコンポーネント(例: 投稿ループ、ヘッダー、フッターなど)を再利用するために使用します。テンプレートパーツファイル名を指定することで、その内容を簡単に他のテンプレートファイルに挿入できます。
使用例
<?php get_template_part('content', 'single'); ?>
このコードは、content-single.php
ファイルを読み込み、single.php
のような個別投稿ページ用の特定のテンプレートパーツを表示します。2番目の引数に 'single'
を指定することで、content-single.php
が優先され、無ければ content.php
が呼び出されます。
一緒に使うことが多い関連タグ
get_header()
get_header()
は、ページのヘッダー部分を表示するテンプレートタグで、ページの共通ヘッダーを簡単に挿入できます。get_template_part()
と共に使って、より細分化されたテンプレートを管理できます。
get_footer()
get_footer()
は、ページのフッター部分を表示するためのテンプレートタグで、get_template_part()
と共に使うことが多いです。サイドバーやフッターなど、ページごとの共通部分の再利用に役立ちます。
使用例
<?php get_header(); ?>
<main>
<?php get_template_part('content', 'page'); ?>
</main>
<?php get_footer(); ?>
このコードでは、get_header()
でヘッダーを表示し、メインコンテンツ内で get_template_part('content', 'page')
を使って content-page.php
を読み込み、最後に get_footer()
でフッターを表示します。このように、各テンプレートパーツを分割して管理することで、コードの再利用性が向上します。
追加情報を取得したい場合
get_template_part()
で取得できる情報
get_template_part()
と組み合わせて、the_post()
や the_title()
などの投稿情報を取得することができます。
<?php get_template_part('content', get_post_format()); ?>
このコードは、get_post_format()
関数を使って、投稿フォーマットに応じたテンプレートパーツ(例: content-gallery.php
や content-video.php
)を読み込みます。フォーマットごとに異なるデザインやレイアウトを適用したい場合に便利です。
出力できる情報
- 投稿フォーマット:
get_post_format()
によって、gallery
やvideo
などの投稿フォーマットを取得します。 - カスタムテンプレート:
get_template_part()
でテンプレートパーツをカスタム化して出力できます。
想定されるトラブル
テンプレートファイルが見つからない
指定したテンプレートファイルが見つからない場合。
解決方法
- テーマディレクトリに指定したテンプレートパーツファイル(例:
content.php
またはcontent-single.php
)が存在するか確認してください。 - ファイル名のスペルミスやパスの間違いを確認します。
間違ったテンプレートファイルが読み込まれる
get_template_part()
で間違ったテンプレートが読み込まれる場合。
解決方法
2番目の引数が正しく指定されているか確認してください。正しいテンプレートファイルが存在するかも確認します。
Q&A
まとめ
get_template_part()
は、WordPressテーマ内でコードの再利用性を高めるための非常に便利なテンプレートタグです。
特定のページやコンポーネントごとにテンプレートを分割し、管理しやすくすることが可能です。また、get_header()
や get_footer()
などの関連タグと組み合わせることで、テンプレート全体をより効率的に管理することができます。
コメント