get_block_file_template( string $id, string $template_type = 'wp_template' ): WP_Block_Template|null

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

$idstring

Template unique identifier (example: 'theme_slug//template_slug').

$template_typestringoptional

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

Return value

WP_Block_Template|null

The found block template, or null if there isn't one.

Performance profile

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

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

12–58

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

Plugin surface

2 hooks

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

Called by

3

3 places 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
• optionoption read or writeget_option()one call below get_block_file_template()
• querycontent queryget_post()one call below get_block_file_template()

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

What one call costs · 7 distinct outcomes

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

Hooks and filters fired · 4

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

1. 1
   apply_filters( pre_get_block_file_template )filterline 1364 (+13 into the body)

   Filters the block template object before the theme file discovery takes place.

2. 2
   apply_filters( get_block_file_template )filterline 1372 (+21 into the body)

   Filters the block template object after it has been (potentially) fetched from the theme file.

3. 3
   apply_filters( get_block_file_template )filterline 1382 (+31 into the body)

   Filters the block template object after it has been (potentially) fetched from the theme file.

4. 4
   apply_filters( get_block_file_template )filterline 1405 (+54 into the body)

   Filters the block template object after it has been (potentially) fetched from the theme file.

Uses · 7

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_stylesheet()Retrieves name of the current stylesheet.
• _get_block_template_file()Retrieves the template file from the theme for a given slug.
• _build_block_template_result_from_file()Builds a unified template object based on a theme file.
• apply_block_hooks_to_content()Runs the hooked blocks algorithm on the given content.
• WP_Block_Templates_Registry::get_instance()::get_by_slug()
• WP_Block_Templates_Registry::get_instance()Utility method to retrieve the main instance of the class.

Used by · 3

• WP_REST_Templates_Controller::get_item()Returns the given template
• get_block_template()Retrieves a single unified template object using its id.
• render_block_core_template_part()Renders the `core/template-part` block on the server.

Source code

View on Trac ↗View on GitHub ↗

1351function get_block_file_template( $id, $template_type = 'wp_template' ) {1352	/**1353	 * Filters the block template object before the theme file discovery takes place.1354	 *1355	 * Return a non-null value to bypass the WordPress theme file discovery.1356	 *1357	 * @since 5.9.01358	 *1359	 * @param WP_Block_Template|null $block_template Return block template object to short-circuit the default query,1360	 *                                               or null to allow WP to run its normal queries.1361	 * @param string                 $id             Template unique identifier (example: 'theme_slug//template_slug').1362	 * @param string                 $template_type  Template type. Either 'wp_template' or 'wp_template_part'.1363	 */1364	$block_template = apply_filters( 'pre_get_block_file_template', null, $id, $template_type );1365	if ( ! is_null( $block_template ) ) {1366		return $block_template;1367	}1368 1369	$parts = explode( '//', $id, 2 );1370	if ( count( $parts ) < 2 ) {1371		/** This filter is documented in wp-includes/block-template-utils.php */1372		return apply_filters( 'get_block_file_template', null, $id, $template_type );1373	}1374	list( $theme, $slug ) = $parts;1375 1376	if ( get_stylesheet() === $theme ) {1377		$template_file = _get_block_template_file( $template_type, $slug );1378		if ( null !== $template_file ) {1379			$block_template = _build_block_template_result_from_file( $template_file, $template_type );1380 1381			/** This filter is documented in wp-includes/block-template-utils.php */1382			return apply_filters( 'get_block_file_template', $block_template, $id, $template_type );1383		}1384	}1385 1386	$block_template = WP_Block_Templates_Registry::get_instance()->get_by_slug( $slug );1387 1388	if ( $block_template ) {1389		$block_template->content = apply_block_hooks_to_content(1390			$block_template->content,1391			$block_template,1392			'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata'1393		);1394	}1395 1396	/**1397	 * Filters the block template object after it has been (potentially) fetched from the theme file.1398	 *1399	 * @since 5.9.01400	 *1401	 * @param WP_Block_Template|null $block_template The found block template, or null if there is none.1402	 * @param string                 $id             Template unique identifier (example: 'theme_slug//template_slug').1403	 * @param string                 $template_type  Template type. Either 'wp_template' or 'wp_template_part'.1404	 */1405	return apply_filters( 'get_block_file_template', $block_template, $id, $template_type );1406}

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.9.7 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.