get_template_part()

関数の概要

get_template_part() は、WordPressテーマ内で再利用可能なテンプレートパーツをインクルードするために使用される関数です。この関数は、指定されたテンプレートファイルをテーマの他のテンプレートファイル内に挿入します。テーマの構造をモジュール化し、コードの重複を避けるために非常に役立ちます。特定のコンテンツ部分(例:投稿ループ、ヘッダー、フッターなど)を一箇所にまとめて管理するのに便利です。

パラメータの説明

get_template_part( $slug, $name )

  • $slug (string):必須。テンプレートファイルのスラッグ。例えば、get_template_part('content') とすると、content.php ファイルをインクルードします。
  • $name (string)(省略可能):テンプレートの特定部分を指定します。例えば、get_template_part('content', 'single') とすると、content-single.php ファイルをインクルードします。このパラメータを省略した場合、デフォルトで slug.php が使用されます。

使用例

以下は、get_template_part() 関数を使用してデフォルトのテンプレートパーツを表示する例です:

<?php get_template_part('content'); ?>

特定のテンプレートパーツ(例えば、content-single.php)を表示するには、次のようにします:

<?php get_template_part('content', 'single'); ?>

このようにすると、content-single.php ファイルが存在しない場合には、代わりに content.php が使用されます。

関連する関数

  • locate_template(): 指定されたテンプレートファイルのパスを検索し、見つかった場合はそのパスを返します。
  • load_template(): 指定されたテンプレートファイルを読み込み、表示します。
  • get_header(): テーマのヘッダー部分をインクルードするために使用されます。
  • get_footer(): テーマのフッター部分をインクルードするために使用されます。
  • get_sidebar(): テーマのサイドバー部分をインクルードするために使用されます。

get_template_part() 関数を使用することで、テーマのコードを整理し、同じコードを複数回記述する必要をなくすことができます。これにより、テーマのメンテナンスが容易になり、コードの再利用性が向上します。