render_block_core_pattern( 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

Block attributes.

Return value

string

Returns the output of the pattern.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

5–51

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• hookthird-party callbacksapply_filters()one call below render_block_core_pattern()

Further down the call graph this can also reach query, option, 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 · 6 distinct outcomes

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

Uses · 4

• __()Retrieves the translation of $text.
• parse_blocks()Parses blocks out of a content string.
• do_blocks()Parses dynamic blocks out of `post_content` and re-renders them.
• WP_Block_Patterns_Registry::get_instance()Utility method to retrieve the main instance of the class.

Source code

View on Trac ↗View on GitHub ↗

33function render_block_core_pattern( $attributes ) {34	static $seen_refs = array();35 36	if ( empty( $attributes['slug'] ) ) {37		return '';38	}39 40	$slug     = $attributes['slug'];41	$registry = WP_Block_Patterns_Registry::get_instance();42 43	if ( ! $registry->is_registered( $slug ) ) {44		return '';45	}46 47	if ( isset( $seen_refs[ $attributes['slug'] ] ) ) {48		// WP_DEBUG_DISPLAY must only be honored when WP_DEBUG. This precedent49		// is set in `wp_debug_mode()`.50		$is_debug = WP_DEBUG && WP_DEBUG_DISPLAY;51 52		return $is_debug ?53			// translators: Visible only in the front end, this warning takes the place of a faulty block. %s represents a pattern's slug.54			sprintf( __( '[block rendering halted for pattern "%s"]' ), $slug ) :55			'';56	}57 58	$pattern = $registry->get_registered( $slug );59	$content = $pattern['content'];60 61	// Backward compatibility for handling Block Hooks and injecting the theme attribute in the Gutenberg plugin.62	// This can be removed when the minimum supported WordPress is >= 6.4.63	if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN && ! function_exists( 'traverse_and_serialize_blocks' ) ) {64		$blocks  = parse_blocks( $content );65		$content = gutenberg_serialize_blocks( $blocks );66	}67 68	$seen_refs[ $attributes['slug'] ] = true;69 70	$content = do_blocks( $content );71 72	global $wp_embed;73	$content = $wp_embed->autoembed( $content );74 75	unset( $seen_refs[ $attributes['slug'] ] );76	return $content;77}

Changelog

Introduced in 6.3.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.7.7 tag, from src/wp-includes/blocks/pattern.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.