Filter hook 'index_template_hierarchy'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into index_template_hierarchy
add_filter('index_template_hierarchy', 'my_custom_filter', 10, 3);

function my_custom_filter($slug, $is_custom, $template_prefix) {
    // Your custom filtering logic here
    return $slug;
}

Source Code Context

<?php
1562   * @return string[] The template hierarchy.
1563   */
1564  function get_template_hierarchy( $slug, $is_custom = false, $template_prefix = '' ) {
1565  	if ( 'index' === $slug ) {
1566  		/** This filter is documented in wp-includes/template.php */
1567  		return apply_filters( 'index_template_hierarchy', array( 'index' ) );
1568  	}
1569  	if ( $is_custom ) {
1570  		/** This filter is documented in wp-includes/template.php */
1571  		return apply_filters( 'page_template_hierarchy', array( 'page', 'singular', 'index' ) );
1572  	}

PHP Documentation

<?php
/**
 * Gets the template hierarchy for the given template slug to be created.
 *
 * Note: Always add `index` as the last fallback template.
 *
 * @since 6.1.0
 *
 * @param string $slug            The template slug to be created.
 * @param bool   $is_custom       Optional. Indicates if a template is custom or
 *                                part of the template hierarchy. Default false.
 * @param string $template_prefix Optional. The template prefix for the created template.
 *                                Used to extract the main template type, e.g.
 *                                in `taxonomy-books` the `taxonomy` is extracted.
 *                                Default empty string.
 * @return string[] The template hierarchy.
 */