locate_template() WP 1.0

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.

Works based on: load_template()

Basis of: get_query_template(), get_sidebar(), get_header(), get_footer(), get_template_part()

1 time — 0.000039 sec (very fast) | 50000 times — 0.16 sec (very fast) | PHP 7.1.2, WP 4.7.3

No Hooks.

Return

String. The template filename if one is located.

Usage

locate_template( $template_names, $load, $require_once, $args );

$template_names(string|array) (required): Template file(s) to search for, in order.
$load(true|false): If true the template file will be loaded if it is found.
$require_once(true|false): Whether to require_once or require. Has no effect if $load is false.
Default: true
$args(array): Additional arguments passed to the template.
Default: empty array

Changelog

Since 2.7.0	Introduced.
Since 5.5.0	The `$args` parameter was added.

Code of `locate_template() locate template` ^{WP 5.7.2}

wp-includes/template.php

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

locate_template() WP 1.0

Return

Usage

Changelog

Code of locate_template() locate template WP 5.7.2

Related Functions

From category: Theme files connection

Code of `locate_template() locate template` ^{WP 5.7.2}