resolve_pattern_blocks( array $blocks ): array

Compatibility

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

Parameters

$blocksarray

An array blocks.

Return value

array

An array of blocks with patterns replaced by their content.

Performance profile

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

9

Executed per call on PHP 8.5. The body compiles to 150.

Plugin surface

None

Nothing here hands control to plugin code.

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()one call below resolve_pattern_blocks()

Further down the call graph this can also reach option, cache, serialize, query 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 · 1 distinct outcome

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

Uses · 4

• parse_blocks()Parses blocks out of a content string.
• sanitize_text_field()Sanitizes a string from user input or from the database.
• resolve_pattern_blocks()Replaces patterns in a block tree with their content.
• WP_Block_Patterns_Registry::get_instance()Utility method to retrieve the main instance of the class.

Used by · 3

• WP_REST_Block_Patterns_Controller::prepare_item_for_response()Prepare a raw block pattern before it gets output in a REST API response.
• WP_REST_Templates_Controller::prepare_item_for_response()Prepare a single template output for response
• resolve_pattern_blocks()Replaces patterns in a block tree with their content.

Source code

View on Trac ↗View on GitHub ↗

1935function resolve_pattern_blocks( $blocks ) {1936	static $inner_content;1937	// Keep track of seen references to avoid infinite loops.1938	static $seen_refs = array();1939	$i                = 0;1940	while ( $i < count( $blocks ) ) {1941		if ( 'core/pattern' === $blocks[ $i ]['blockName'] ) {1942			$attrs = $blocks[ $i ]['attrs'];1943 1944			if ( empty( $attrs['slug'] ) ) {1945				++$i;1946				continue;1947			}1948 1949			$slug = $attrs['slug'];1950 1951			if ( isset( $seen_refs[ $slug ] ) ) {1952				// Skip recursive patterns.1953				array_splice( $blocks, $i, 1 );1954				continue;1955			}1956 1957			$registry = WP_Block_Patterns_Registry::get_instance();1958			$pattern  = $registry->get_registered( $slug );1959 1960			// Skip unknown patterns.1961			if ( ! $pattern ) {1962				++$i;1963				continue;1964			}1965 1966			$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );1967 1968			/*1969			 * For single-root patterns, add the pattern name to make this a pattern instance in the editor.1970			 * If the pattern has metadata, merge it with the existing metadata.1971			 */1972			if ( count( $blocks_to_insert ) === 1 ) {1973				$block_metadata                = $blocks_to_insert[0]['attrs']['metadata'] ?? array();1974				$block_metadata['patternName'] = $slug;1975 1976				/*1977				 * Merge pattern metadata with existing block metadata.1978				 * Pattern metadata takes precedence, but existing block metadata1979				 * is preserved as a fallback when the pattern doesn't define that field.1980				 * Only the defined fields (name, description, categories) are updated;1981				 * other metadata keys are preserved.1982				 */1983				foreach ( array(1984					'name'        => 'title', // 'title' is the field in the pattern object 'name' is the field in the block metadata.1985					'description' => 'description',1986					'categories'  => 'categories',1987				) as $key => $pattern_key ) {1988					$value = $pattern[ $pattern_key ] ?? $block_metadata[ $key ] ?? null;1989					if ( $value ) {1990						$block_metadata[ $key ] = is_array( $value )1991							? array_map( 'sanitize_text_field', $value )1992							: sanitize_text_field( $value );1993					}1994				}1995 1996				$blocks_to_insert[0]['attrs']['metadata'] = $block_metadata;1997			}1998 1999			$seen_refs[ $slug ] = true;2000			$prev_inner_content = $inner_content;2001			$inner_content      = null;2002			$blocks_to_insert   = resolve_pattern_blocks( $blocks_to_insert );2003			$inner_content      = $prev_inner_content;2004			unset( $seen_refs[ $slug ] );2005			array_splice( $blocks, $i, 1, $blocks_to_insert );2006 2007			// If we have inner content, we need to insert nulls in the2008			// inner content array, otherwise serialize_blocks will skip2009			// blocks.2010			if ( $inner_content ) {2011				$null_indices  = array_keys( $inner_content, null, true );2012				$content_index = $null_indices[ $i ];2013				$nulls         = array_fill( 0, count( $blocks_to_insert ), null );2014				array_splice( $inner_content, $content_index, 1, $nulls );

Changelog

Introduced in 6.6.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.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.