【WordPress】PHPファイルを読み込む方法

2018年8月12日
WordPress

複数の方法が存在したので分かりやすいようにまとめた。

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多重読み込みを防止するか判断する値。
$loadfalseの場合、無視する。

戻り値

ファイルが見つかった場合はテンプレートファイルのパス、見つからなかった場合は空文字を返す。

優先順位

  1. 子テーマのディレクトリ内
  2. 親テーマのディレクトリ内
  3. 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の標準機能であるincluderequireなどの文でもファイルを読み込むことができる。

参考