Filter hook '{$type}_template_hierarchy'

in WP Core File wp-includes/template.php at line 62

View Source

{$type}_template_hierarchy

Filter Hook
Description
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`

Hook Information

File Location wp-includes/template.php View on GitHub
Hook Type Filter
Line Number 62

Hook Parameters

Type Name Description
string[] $templates A list of template candidates, in descending order of priority.

Usage Examples

Basic Usage
<?php
// Hook into {$type}_template_hierarchy
add_filter('{$type}_template_hierarchy', 'my_custom_filter', 10, 1);

function my_custom_filter($templates) {
    // Your custom filtering logic here
    return $templates;
}

Source Code Context

wp-includes/template.php:62 - How this hook is used in WordPress core
<?php
  57  	 *
  58  	 * @since 4.7.0
  59  	 *
  60  	 * @param string[] $templates A list of template candidates, in descending order of priority.
  61  	 */
  62  	$templates = apply_filters( "{$type}_template_hierarchy", $templates );
  63  
  64  	$template = locate_template( $templates );
  65  
  66  	$template = locate_block_template( $template, $type, $templates );
  67  

PHP Documentation

<?php
/**
	 * 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`
	 *
	 * @since 4.7.0
	 *
	 * @param string[] $templates A list of template candidates, in descending order of priority.
	 */
Quick Info
  • Hook Type: Filter
  • Parameters: 1
  • File: wp-includes/template.php
Related Hooks

Related hooks will be displayed here in future updates.