WordPress开发者和主题制作者的搜索引擎



locate_template ›

Since2.7.0
已弃用n/a
locate_template ( $template_names, $load = false, $require_once = true )
参数: (3)
  • (string|array) $template_names Template file(s) to search for, in order.
    Required: Yes
  • (bool) $load If true the template file will be loaded if it is found.
    Required: No
    默认: false
  • (bool) $require_once Whether to require_once or require. Default true. Has no effect if $load is false.
    Required: No
    默认: true
返回:
  • (string) The template filename if one is located.
定义在:
文档:

Retrieve 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 ) {
	$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 );
	}

	return $located;
}