• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/locate template

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/locate template」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

存在する中で最高優先度のテンプレートファイルを取得します。そのファイルを読み込むこともできます。

STYLESHEETPATHTEMPLATEPATH より前に検索するので、子テーマのファイルで親テーマを上書きできます。

使い方

<?php locate_template( $template_names, $load, $require_once ) ?>

パラメータ

$template_names
配列) (必須) 検索するテンプレートファイルを優先度順に並べた配列。(拡張子が必要。)
初期値: なし
$load
真偽値) (オプションtrue なら、見つかったテンプレートファイルを読み込みます。
初期値: false
$require_once
真偽値) (オプションtrue なら PHP の require_once 関数でテンプレートファイルを読み込みます。false なら PHP の require 関数を使います。$loadfalse の時は無視されます。
初期値: true

戻り値

(文字列) 
見つかればテンプレートのファイル名。見つからなければ空文字列。

用例

現在のページ名に基づいて特定のテンプレート部品を読み込みます:

if ( locate_template( 'content-' . $pageName . '.php' ) != '' ) {
	// あったのでページテンプレートを読み込む
	get_template_part( 'content', $pageName );
} else {
	// なかったのでページの本文を読み込む
	the_content();
}

参考

変更履歴

新規導入: 2.7.0

ソースファイル

locate_template()wp-includes/template.php にあります。


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/locate_template最新版との差分