locate_template

函数


locate_template ( $template_names, $load = false, $require_once = true, $args = array() )
参数
  • (string|array)
    $template_names
    Template file(s) to search for, in order.
    Required:
  • (bool)
    $load
    If true the template file will be loaded if it is found.
    Required:
    Default: false
  • (bool)
    $require_once
    Whether to require_once or require. Has no effect if `$load` is false. Default true.
    Required:
    Default: true
  • (array)
    $args
    Optional. Additional arguments passed to the template. Default empty array.
    Required:
    Default: array()
返回值
  • (string) The template filename if one is located.
定义位置
  • wp-includes/template.php
    , line 699
引入
2.7.0
弃用

Retrieves the name of the highest priority template file that exists.

Searches in the STYLESHEETPATH before TEMPLATEPATH and wp-includes/theme-compat
so that themes which inherit from a parent theme can just overload one file.

function locate_template( $template_names, $load = false, $require_once = true, $args = array() ) {
	$located = '';
	foreach ( (array) $template_names as $template_name ) {
		if ( ! $template_name ) {
			continue;
		}
		if ( file_exists( STYLESHEETPATH . '/' . $template_name ) ) {
			$located = STYLESHEETPATH . '/' . $template_name;
			break;
		} elseif ( file_exists( TEMPLATEPATH . '/' . $template_name ) ) {
			$located = TEMPLATEPATH . '/' . $template_name;
			break;
		} elseif ( file_exists( ABSPATH . WPINC . '/theme-compat/' . $template_name ) ) {
			$located = ABSPATH . WPINC . '/theme-compat/' . $template_name;
			break;
		}
	}

	if ( $load && '' !== $located ) {
		load_template( $located, $require_once, $args );
	}

	return $located;
}