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



お勧め

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

投稿日の検索が自由自在に(2015年3月7日 更新)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。