_get_block_template_file( string $template_type, string $slug ): array|null

Compatibility

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

Parameters

$template_typestring

Template type. Either 'wp_template' or 'wp_template_part'.

$slugstring

Template slug.

Return value

array|null

Array with template metadata if $template_type is one of 'wp_template' or 'wp_template_part', null otherwise.

• $slugstring

  Template slug.

• $pathstring

  Template file path.

• $themestring

  Theme slug.

• $typestring

  Template type.

• $areastring

  Template area. Only for 'wp_template_part'.

• $titlestring

  Optional. Template title.

• $postTypesstring[]

  Optional. List of post types that the template supports. Only for 'wp_template'.

Performance profile

How much work a call to _get_block_template_file() 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

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Scales with input

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

Instructions

7–49

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

5

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

What it touches

• filesystemfilesystem accessfile_exists()called directly
• hookthird-party callbacksapply_filters()one call below _get_block_template_file()
• optionoption read or writeget_option()one call below _get_block_template_file()

Further down the call graph this can also reach cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 5 distinct outcomes

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

Uses · 7

• get_stylesheet()Retrieves name of the current stylesheet.
• get_stylesheet_directory()Retrieves stylesheet directory path for the active theme.
• get_template()Retrieves name of the active theme.
• get_template_directory()Retrieves template directory path for the active theme.
• get_block_theme_folders()For backward compatibility reasons, block themes might be using block-templates or block-template-parts, this function ensures we fallback to these folders properly.
• _add_block_template_part_area_info()Attempts to add the template part's area information to the input template.
• _add_block_template_info()Attempts to add custom template information to the template item.

Used by · 5

• _build_block_template_object_from_post_object()Builds a block template object from a post object.
• get_block_file_template()Retrieves a unified template object based on a theme file.
• locate_block_template()Finds a block template with equal or higher specificity than a given PHP template file.
• render_block_core_template_part()Renders the `core/template-part` block on the server.
• resolve_block_template()Returns the correct 'wp_template' to render for the request template type.

Source code

View on Trac ↗View on GitHub ↗

323function _get_block_template_file( $template_type, $slug ) {324	if ( 'wp_template' !== $template_type && 'wp_template_part' !== $template_type ) {325		return null;326	}327 328	$themes = array(329		get_stylesheet() => get_stylesheet_directory(),330		get_template()   => get_template_directory(),331	);332	foreach ( $themes as $theme_slug => $theme_dir ) {333		$template_base_paths = get_block_theme_folders( $theme_slug );334		$file_path           = $theme_dir . '/' . $template_base_paths[ $template_type ] . '/' . $slug . '.html';335		if ( file_exists( $file_path ) ) {336			$new_template_item = array(337				'slug'  => $slug,338				'path'  => $file_path,339				'theme' => $theme_slug,340				'type'  => $template_type,341			);342 343			if ( 'wp_template_part' === $template_type ) {344				return _add_block_template_part_area_info( $new_template_item );345			}346 347			if ( 'wp_template' === $template_type ) {348				return _add_block_template_info( $new_template_item );349			}350 351			return $new_template_item;352		}353	}354 355	return null;356}

Changelog

Introduced in 5.9.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 6.8.8 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.