9 views 
Summery Summery
Retrieve the name of the highest priority template file that exists.
Syntax Syntax
Description 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 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
- $require_once
-
(Optional) Whether to require_once or require. Has no effect if $load is false.
Default value: true
Return Return
(string) The template filename if one is located.
Source Source
File: wp-includes/template.php
* @param array $args Optional. Additional arguments passed to the template.
* Default empty array.
* @return string The template filename if one is located.
*/
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 );
Advertisement
Changelog Changelog
| Version | Description |
|---|---|
| 2.7.0 | Introduced. |