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



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。