locate_template( string|array $template_names, bool $load = false, bool $load_once = true, array $args = array() )

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


Description

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.


Parameters

$template_names

(Required) Template file(s) to search for, in order.

$load

(Optional) If true the template file will be loaded if it is found.

Default value: false

$load_once

(Optional) Whether to require_once or require. Has no effect if $load is false.<br>

Default value: true

$args

(Optional) Additional arguments passed to the template.<br>

Default value: array()


Return

(string) The template filename if one is located.


Source

File: wp-includes/template.php

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;
}


Changelog

Changelog
Version Description
5.5.0 The $args parameter was added.
2.7.0 Introduced.