説明
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最終更新 : 2024年04月04日 12:52
関連
お勧め
ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）
投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。リクエスト応答を終了する前に何かを処理する（2013年9月26日 更新）
PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。
投稿情報を連想配列で参照する（2018年5月27日 更新）
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。
段落ブロックに日付・時刻の入力支援を実装した（2023年1月25日 更新）
ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。
ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日 更新）
ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。