resolve_pattern_blocks( array $blocks ): array

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), 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 108.

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

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 · 3

• parse_blocks()Parses blocks out of a content string.
• 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 ↗

1852function resolve_pattern_blocks( $blocks ) {1853	static $inner_content;1854	// Keep track of seen references to avoid infinite loops.1855	static $seen_refs = array();1856	$i                = 0;1857	while ( $i < count( $blocks ) ) {1858		if ( 'core/pattern' === $blocks[ $i ]['blockName'] ) {1859			$attrs = $blocks[ $i ]['attrs'];1860 1861			if ( empty( $attrs['slug'] ) ) {1862				++$i;1863				continue;1864			}1865 1866			$slug = $attrs['slug'];1867 1868			if ( isset( $seen_refs[ $slug ] ) ) {1869				// Skip recursive patterns.1870				array_splice( $blocks, $i, 1 );1871				continue;1872			}1873 1874			$registry = WP_Block_Patterns_Registry::get_instance();1875			$pattern  = $registry->get_registered( $slug );1876 1877			// Skip unknown patterns.1878			if ( ! $pattern ) {1879				++$i;1880				continue;1881			}1882 1883			$blocks_to_insert   = parse_blocks( $pattern['content'] );1884			$seen_refs[ $slug ] = true;1885			$prev_inner_content = $inner_content;1886			$inner_content      = null;1887			$blocks_to_insert   = resolve_pattern_blocks( $blocks_to_insert );1888			$inner_content      = $prev_inner_content;1889			unset( $seen_refs[ $slug ] );1890			array_splice( $blocks, $i, 1, $blocks_to_insert );1891 1892			// If we have inner content, we need to insert nulls in the1893			// inner content array, otherwise serialize_blocks will skip1894			// blocks.1895			if ( $inner_content ) {1896				$null_indices  = array_keys( $inner_content, null, true );1897				$content_index = $null_indices[ $i ];1898				$nulls         = array_fill( 0, count( $blocks_to_insert ), null );1899				array_splice( $inner_content, $content_index, 1, $nulls );1900			}1901 1902			// Skip inserted blocks.1903			$i += count( $blocks_to_insert );1904		} else {1905			if ( ! empty( $blocks[ $i ]['innerBlocks'] ) ) {1906				$prev_inner_content           = $inner_content;1907				$inner_content                = $blocks[ $i ]['innerContent'];1908				$blocks[ $i ]['innerBlocks']  = resolve_pattern_blocks(1909					$blocks[ $i ]['innerBlocks']1910				);1911				$blocks[ $i ]['innerContent'] = $inner_content;1912				$inner_content                = $prev_inner_content;1913			}1914			++$i;1915		}1916	}1917	return $blocks;1918}

Changelog

Introduced in 6.6.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.10 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.