W3cubDocs

/WordPress

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

Retrieve 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

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

$load

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

Default value: false

$require_once

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

Default value: true

$args

(array) (Optional) Additional arguments passed to the template.

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

Uses

Uses Description
wp-includes/template.php: load_template()

Require the template file with WordPress environment.

Used By

Used By Description
wp-includes/general-template.php: get_header()

Load header template.
wp-includes/general-template.php: get_footer()

Load footer template.
wp-includes/general-template.php: get_sidebar()

Load sidebar template.
wp-includes/general-template.php: get_template_part()

Loads a template part into a template.
wp-includes/general-template.php: get_search_form()

Display search form.
wp-includes/template.php: get_query_template()

Retrieve path to a template

Changelog

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

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/locate_template