get_template_hierarchy( string $slug, bool $is_custom = false, string $template_prefix = '' ): string[]

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$slugstring

The template slug to be created.

$is_custombooloptional

Indicates if a template is custom or part of the template hierarchy. Default false.Default: false

$template_prefixstringoptional

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.Default: ''

Return value

string[]

The template hierarchy.

Performance profile

How much work a call to get_template_hierarchy() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

10–95

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 145.

Plugin surface

4 hooks

Third-party callbacks on 'index_template_hierarchy', 'page_template_hierarchy', 'frontpage_template_hierarchy' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 11 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_template_hierarchy() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 4

4 hooks fire while get_template_hierarchy() runs, in this order:

1. 1
   apply_filters( index_template_hierarchy )filterline 1595 (+3 into the body)
2. 2
   apply_filters( page_template_hierarchy )filterline 1599 (+7 into the body)
3. 3
   apply_filters( frontpage_template_hierarchy )filterline 1603 (+11 into the body)
4. 4
   apply_filters( {$template_type}_template_hierarchy )filterline 1679 (+87 into the body)

Uses · 4

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_post_types()Gets a list of all registered post type objects.
• get_taxonomies()Retrieves a list of registered taxonomy names or objects.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.

Used by · 1

• WP_REST_Templates_Controller::get_template_fallback()Returns the fallback template for the given slug.

Source code

View on Trac ↗View on GitHub ↗

1592function get_template_hierarchy( $slug, $is_custom = false, $template_prefix = '' ) {1593	if ( 'index' === $slug ) {1594		/** This filter is documented in wp-includes/template.php */1595		return apply_filters( 'index_template_hierarchy', array( 'index' ) );1596	}1597	if ( $is_custom ) {1598		/** This filter is documented in wp-includes/template.php */1599		return apply_filters( 'page_template_hierarchy', array( 'page', 'singular', 'index' ) );1600	}1601	if ( 'front-page' === $slug ) {1602		/** This filter is documented in wp-includes/template.php */1603		return apply_filters( 'frontpage_template_hierarchy', array( 'front-page', 'home', 'index' ) );1604	}1605 1606	$matches = array();1607 1608	$template_hierarchy = array( $slug );1609	// Most default templates don't have `$template_prefix` assigned.1610	if ( ! empty( $template_prefix ) ) {1611		list( $type ) = explode( '-', $template_prefix );1612		// We need these checks because we always add the `$slug` above.1613		if ( ! in_array( $template_prefix, array( $slug, $type ), true ) ) {1614			$template_hierarchy[] = $template_prefix;1615		}1616		if ( $slug !== $type ) {1617			$template_hierarchy[] = $type;1618		}1619	} elseif ( preg_match( '/^(author|category|archive|tag|page)-.+$/', $slug, $matches ) ) {1620		$template_hierarchy[] = $matches[1];1621	} elseif ( preg_match( '/^(taxonomy|single)-(.+)$/', $slug, $matches ) ) {1622		$type           = $matches[1];1623		$slug_remaining = $matches[2];1624 1625		$items = 'single' === $type ? get_post_types() : get_taxonomies();1626		foreach ( $items as $item ) {1627			if ( ! str_starts_with( $slug_remaining, $item ) ) {1628					continue;1629			}1630 1631			// If $slug_remaining is equal to $post_type or $taxonomy we have1632			// the single-$post_type template or the taxonomy-$taxonomy template.1633			if ( $slug_remaining === $item ) {1634				$template_hierarchy[] = $type;1635				break;1636			}1637 1638			// If $slug_remaining is single-$post_type-$slug template.1639			if ( strlen( $slug_remaining ) > strlen( $item ) + 1 ) {1640				$template_hierarchy[] = "$type-$item";1641				$template_hierarchy[] = $type;1642				break;1643			}1644		}1645	}1646	// Handle `archive` template.1647	if (1648		str_starts_with( $slug, 'author' ) ||1649		str_starts_with( $slug, 'taxonomy' ) ||1650		str_starts_with( $slug, 'category' ) ||1651		str_starts_with( $slug, 'tag' ) ||1652		'date' === $slug1653	) {1654		$template_hierarchy[] = 'archive';1655	}1656	// Handle `single` template.1657	if ( 'attachment' === $slug ) {1658		$template_hierarchy[] = 'single';1659	}1660	// Handle `singular` template.1661	if (1662		str_starts_with( $slug, 'single' ) ||1663		str_starts_with( $slug, 'page' ) ||1664		'attachment' === $slug1665	) {1666		$template_hierarchy[] = 'singular';1667	}1668	$template_hierarchy[] = 'index';1669 1670	$template_type = '';1671	if ( ! empty( $template_prefix ) ) {

Changelog

Introduced in 6.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/block-template-utils.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.