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



お勧め

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

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

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

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。