locate_template

説明

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

パラメータ

  • $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

最終更新 : 2020年08月19日 11:51



お勧め

自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)

標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

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

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。