render_block_core_template_part( array $attributes ): string

Compatibility

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

Parameters

$attributesarray

The block attributes.

Return value

string

The render.

Performance profile

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

Scales with input

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

Instructions

17–147

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

Plugin surface

3 hooks

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()one call below render_block_core_template_part()
• querycontent queryget_post()one call below render_block_core_template_part()

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 · 42 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 3

3 hooks fire while render_block_core_template_part() runs, in this order:

1. 1
   do_action( render_block_core_template_part_post )actionline 65 (+46 into the body)

   Fires when a block template part is loaded from a template post stored in the database.

2. 2
   do_action( render_block_core_template_part_file )actionline 98 (+79 into the body)

   Fires when a block template part is loaded from a template part in the theme.

3. 3
   do_action( render_block_core_template_part_none )actionline 109 (+90 into the body)

   Fires when a requested block template part does not exist in the database nor in the theme.

Uses · 13

• get_stylesheet()Retrieves name of the current stylesheet.
• _build_block_template_result_from_post()Builds a unified template object based a post Object.
• do_action()Calls the callback functions that have been added to an action hook.
• validate_file()Validates a file name and path against an allowed set of rules.
• get_block_file_template()Retrieves a unified template object based on a theme file or plugin registration.
• _get_block_template_file()Retrieves the template file from the theme for a given slug.
• __()Retrieves the translation of $text.
• get_allowed_block_template_part_areas()Returns a filtered list of allowed area values for template parts.
• _wp_apply_block_content_filters()Applies standard content filters similar to the 'the_content' filter.
• tag_escape()Escapes an HTML tag name.
• esc_attr()Escaping for HTML attributes.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.

Source code

View on Trac ↗View on GitHub ↗

19function render_block_core_template_part( $attributes ) {20	static $seen_ids = array();21 22	$template_part_id = null;23	$content          = null;24	$area             = WP_TEMPLATE_PART_AREA_UNCATEGORIZED;25	$theme            = $attributes['theme'] ?? get_stylesheet();26 27	if ( isset( $attributes['slug'] ) && get_stylesheet() === $theme ) {28		$template_part_id    = $theme . '//' . $attributes['slug'];29		$template_part_query = new WP_Query(30			array(31				'post_type'           => 'wp_template_part',32				'post_status'         => 'publish',33				'post_name__in'       => array( $attributes['slug'] ),34				'tax_query'           => array(35					array(36						'taxonomy' => 'wp_theme',37						'field'    => 'name',38						'terms'    => $theme,39					),40				),41				'posts_per_page'      => 1,42				'no_found_rows'       => true,43				'lazy_load_term_meta' => false, // Do not lazy load term meta, as template parts only have one term.44			)45		);46		$template_part_post  = $template_part_query->have_posts() ? $template_part_query->next_post() : null;47		if ( $template_part_post ) {48			// A published post might already exist if this template part was customized elsewhere49			// or if it's part of a customized template.50			$block_template = _build_block_template_result_from_post( $template_part_post );51			$content        = $block_template->content;52			if ( isset( $block_template->area ) ) {53				$area = $block_template->area;54			}55			/**56			 * Fires when a block template part is loaded from a template post stored in the database.57			 *58			 * @since 5.9.059			 *60			 * @param string  $template_part_id   The requested template part namespaced to the theme.61			 * @param array   $attributes         The block attributes.62			 * @param WP_Post $template_part_post The template part post object.63			 * @param string  $content            The template part content.64			 */65			do_action( 'render_block_core_template_part_post', $template_part_id, $attributes, $template_part_post, $content );66		} else {67			$template_part_file_path = '';68			// Else, if the template part was provided by the active theme,69			// render the corresponding file content.70			if ( 0 === validate_file( $attributes['slug'] ) ) {71				$block_template = get_block_file_template( $template_part_id, 'wp_template_part' );72 73				if ( isset( $block_template->content ) ) {74					$content = $block_template->content;75				}76				if ( isset( $block_template->area ) ) {77					$area = $block_template->area;78				}79 80				// Needed for the `render_block_core_template_part_file` and `render_block_core_template_part_none` actions below.81				$block_template_file = _get_block_template_file( 'wp_template_part', $attributes['slug'] );82				if ( $block_template_file ) {83					$template_part_file_path = $block_template_file['path'];84				}85			}86 87			if ( '' !== $content && null !== $content ) {88				/**89				 * Fires when a block template part is loaded from a template part in the theme.90				 *91				 * @since 5.9.092				 *93				 * @param string $template_part_id        The requested template part namespaced to the theme.94				 * @param array  $attributes              The block attributes.95				 * @param string $template_part_file_path Absolute path to the template path.96				 * @param string $content                 The template part content.97				 */98				do_action( 'render_block_core_template_part_file', $template_part_id, $attributes, $template_part_file_path, $content );

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 7.1.0 tag, from src/wp-includes/blocks/template-part.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.