【WordPress】PHPファイルを読み込む方法
複数の方法が存在したので分かりやすいようにまとめた。
load_template
function load_template( $_template_file, $require_once = true )
テンプレートファイルを読み込む関数。
関数内でrequire
およびrequire_once
によりファイルを読み込んでいる。そのため、ファイルが存在しない場合は致命的なエラーを発生し、処理を止める。
引数
名前 | 説明 |
---|---|
$_template_file | テンプレートファイルのパス。 |
$require_once | 多重読み込みを防止するか判断する値。 |
locate_template
function locate_template( $template_names, $load = false, $require_once = true )
優先度の高いテンプレートファイルを読み込み、そのファイルパスを取得する関数。
引数
名前 | 説明 |
---|---|
$template_names | 優先度順に並べたテンプレートファイル名の配列。 |
$load | ファイルを読み込むか判断する値。true を指定した場合、load_templete 関数を用いてファイルを読み込む。 |
$require_once | 多重読み込みを防止するか判断する値。$load がfalse の場合、無視する。 |
戻り値
ファイルが見つかった場合はテンプレートファイルのパス、見つからなかった場合は空文字を返す。
優先順位
- 子テーマのディレクトリ内
- 親テーマのディレクトリ内
wordpress/wp-include/theme-compat/
内
get_template_part
function get_template_part( $slug, $name = null )
テンプレートパーツを読み込む関数。
関数内で引数に指定した$slug
と$name
より、"{$slug}-{$name}.php"
、"{$slug}.php"
の2つの文字列を格納した配列を作成。その配列をlocate_template
に渡し、ファイルを読み込んでいる。
引数
名前 | 説明 |
---|---|
$slug | スラッグ名 |
$name | テンプレート |
PHPの標準機能
PHPの標準機能であるinclude
やrequire
などの文でもファイルを読み込むことができる。