get_template_part

（3.0.0以降）
get_template_part - 任意のテンプレートファイルを読み込む

説明

void | false get_template_part( string $slug [ , string $name = null [ , array $args = array() ] ] )
任意のテンプレートファイルを読み込む（表示する）。

パラメータ

  • $slug
    任意のテンプレート名。
  • $name
    テーマ名など（省略時はnull）。
  • $args
    [5.5.0]テンプレートファイルに引き継ぐパラメータを指定（省略時はarray()）。

返り値

返り値はありません。

[5.5.0]テンプレートファイルが見つからなかった場合はfalseを返す。

注意

WordPress 3.0の標準テーマ「Twenty Ten」で使用されている新しいWordPressタグです。従来、各テンプレートで共通していたパートファイルを読み込む場合に使用されます。

テンプレートファイルは、STYLESHEETPATH、TEMPLATEPATHの順に検索され、最初に見つかったファイルが読み込まれる。

[5.5.0]パラメータ$argsが追加され、サイドバーファイルが見つからなかった場合のみfalseを返すように変更された。

使用例

  • テンプレートファイル'loop.php'を読み込む。
    <?php get_template_part( 'loop' ); ?>
  • テンプレートファイル'loop-search.php'または'loop.php'を読み込む。
    <?php get_template_part( 'loop', 'search' ); ?>

フィルター

直接実行するフィルターはありません。

アクション

[3.0.0]テンプレートファイルのファイル名を配列に格納する前に"get_template_part_{$slug}"アクションを呼び出す。パラメータ$slugと$nameには本関数が受け取った内容が格納されている。[5.5.0]パラメータ$argsが追加され、本関数が受け取った内容が格納されている。 
do_action( "get_template_part_{$slug}", $slug, $name, $args );
[5.2.0]テンプレートファイルをロードする前に'get_template_part'アクションを呼び出す。パラメータ$slugには本関数が受け取った内容が、$nameには受け取った内容を文字列でキャストした内容が、$templatesにはテンプレートファイルのファイル名を格納した配列が格納されている。[5.5.0]パラメータ$argsが追加され、本関数が受け取った内容が格納されている。 
do_action( 'get_template_part', $slug, $name, $templates, $args );

ソースファイル

/wp-includes/general-template.php

最終更新 : 2020年08月18日 11:30

関連

参考

Code Reference: get_template_part

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。