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

お勧め

サイトヘルス機能を使ってみた（2019年4月12日 更新）

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2（以降5.2Beta2）が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

管理者ページに文言を表示する（2012年4月19日 更新）

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。

Widgets on dashboard：プラグイン作ってみました（2014年5月7日 更新）

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

5.7の機能拡張：投稿一覧画面向けのフィルター（2021年2月18日 更新）

昨日、予定通り公開された「WordPress 5.7 Beta 3（以降Beta 3）」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。