(type)_template_hierarchy
Filters the list of template filenames that are searched for when retrieving a template to use.
The dynamic portion of the hook name, $type, refers to the filename -- minus the file extension and any non-alphanumeric characters delimiting words -- of the file to load. The last element in the array should always be the fallback template for this query type.
Possible hook names include:
- 404_template_hierarchy
- archive_template_hierarchy
- attachment_template_hierarchy
- author_template_hierarchy
- category_template_hierarchy
- date_template_hierarchy
- embed_template_hierarchy
- frontpage_template_hierarchy
- home_template_hierarchy
- index_template_hierarchy
- page_template_hierarchy
- paged_template_hierarchy
- privacypolicy_template_hierarchy
- search_template_hierarchy
- single_template_hierarchy
- singular_template_hierarchy
- tag_template_hierarchy
- taxonomy_template_hierarchy
Usage
add_filter( '(type)_template_hierarchy', 'wp_kama_type_template_hierarchy_filter' ); /** * Function for `(type)_template_hierarchy` filter-hook. * * @param string[] $templates A list of template candidates, in descending order of priority. * * @return string[] */ function wp_kama_type_template_hierarchy_filter( $templates ){ // filter... return $templates; }
- $templates(string[])
- A list of template candidates, in descending order of priority.
Changelog
Since 4.7.0 | Introduced. |
Where the hook is called
(type)_template_hierarchy
wp-includes/template.php 62
$templates = apply_filters( "{$type}_template_hierarchy", $templates );