locate_template

説明

string locate_template( array $template_names [ , bool $load = false [ , bool $require_once = true [ , array $args = array() ] ] ] )
テンプレートファイルが存在するか確認する。パラメータ$loadtrueの場合は、見つかったテンプレートファイルを読み込む。

パラメータ

  • $template_names
    テンプレート名が格納された配列を指定。
  • $load
    テンプレート名を読み込む場合はtrue、確認のみの場合はfalseを指定(省略時はfalse)。
  • $require_once
    テンプレートファイルを一度しか読み込まない場合はtrue、何度も読み込む場合はfalseを指定(省略時はtrue)。
  • $args
    [5.5.0]テンプレートファイルを読み込む際に引継ぎデータを指定(省略時はarray)。

返り値

テンプレートが見つかった場合はそのテンプレートファイルのパス名を、見つからなかった場合は''を返す。

注意

テンプレートファイルは、STYLESHEETPATH、TEMPLATEPATHの順に検索される。[4.5.0]TEMPLATEPATHの後に/wp-includes/theme-compat/ディレクトリも検索されるようになった。

[5.5.0] get_header関数や get_template_part関数などの変更に合わせてパラメータ$argsが追加された。このパラメータは load_template関数へ渡される。


使用例

  • テンプレートファイル'loop.php'が存在するか確認する。
    <?php if ( locate_template( array( 'loop.php' ) ) ) { ?>
  • テンプレートファイル'loop.php'を読み込む。
    <?php locate_template( array( 'loop.php' ), true, true ); ?>

フィルター

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

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/template.php

最終更新 : 2024年04月04日 12:52



お勧め

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クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。