WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

locate_template()

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

In this article

Back to top

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

Description

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

Parameters

$template_namesstring|arrayrequired
Template file(s) to search for, in order.
$loadbooloptional
If true the template file will be loaded if it is found.

Default:false

$load_oncebooloptional
Whether to require_once or require. Has no effect if $load is false.

Default:true

$argsarrayoptional
Additional arguments passed to the template.

Default:array()

Return

string The template filename if one is located.

Source

function locate_template( $template_names, $load = false, $load_once = true, $args = array() ) {
	global $wp_stylesheet_path, $wp_template_path;

	if ( ! isset( $wp_stylesheet_path ) || ! isset( $wp_template_path ) ) {
		wp_set_template_globals();
	}

	$is_child_theme = is_child_theme();

	$located = '';
	foreach ( (array) $template_names as $template_name ) {
		if ( ! $template_name ) {
			continue;
		}
		if ( file_exists( $wp_stylesheet_path . '/' . $template_name ) ) {
			$located = $wp_stylesheet_path . '/' . $template_name;
			break;
		} elseif ( $is_child_theme && file_exists( $wp_template_path . '/' . $template_name ) ) {
			$located = $wp_template_path . '/' . $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, $load_once, $args );
	}

	return $located;
}

View all references View on Trac View on GitHub

UsesDescription
wp_set_template_globals()wp-includes/template.php

Set up the globals used for template loading.

is_child_theme()wp-includes/theme.php

Whether a child theme is in use.

load_template()wp-includes/template.php

Requires the template file with WordPress environment.

Used byDescription
get_header()wp-includes/general-template.php

Loads header template.

get_footer()wp-includes/general-template.php

Loads footer template.

get_sidebar()wp-includes/general-template.php

Loads sidebar template.

get_template_part()wp-includes/general-template.php

Loads a template part into a template.

get_search_form()wp-includes/general-template.php

Displays search form.

get_query_template()wp-includes/template.php

Retrieves path to a template.

Show 1 moreShow less

Changelog

VersionDescription
5.5.0The $args parameter was added.
2.7.0Introduced.

User Contributed Notes

  1. Skip to note 3 content
    Paul Ryan
    You must log in to vote on the helpfulness of this noteVote results for this note: 9You must log in to vote on the helpfulness of this note

    Note that locate_template() does not prevent directory traversal attacks, so if you’re passing a user-provided template name to the function, be sure to verify that it’s from one of the three appropriate locations (active theme directory, parent theme directory, or /wp-includes/theme-compat/ directory).

    Example:

    $template = locate_template( $template_filename_from_unsanitized_user_input );

// Only allow templates that are in the active theme directory, parent theme
// directory, or the /wp-includes/theme-compat/ directory (prevent directory 
// traversal attacks).
$template_in_theme_or_parent_theme_or_compat = (
	// Template is in current theme folder.
	0 === strpos( realpath( $template ), realpath( STYLESHEETPATH ) ) ||
	// Template is in current or parent theme folder.
	0 === strpos( realpath( $template ), realpath( TEMPLATEPATH ) ) ||
	// Template is in theme-compat folder.
	0 === strpos( realpath( $template ), realpath( ABSPATH . WPINC . '/theme-compat/' ) )
);

if ( $template_in_theme_or_parent_theme_or_compat ) {
	require_once( $template );
}

You must log in before being able to contribute a note or feedback.