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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

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

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