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()
1 time = 0.000039s = very fast | 50000 times = 0.16s = 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.
Default: false - $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.6
Related Functions
From category: Theme files connection
- comments_template()
- get_footer()
- get_header()
- get_parent_theme_file_path()
- get_parent_theme_file_uri()
- get_search_form()