WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Block_Patterns_Registry::prepare_content()

WP_Block_Patterns_Registry::prepare_content( array $pattern, array $hooked_blocks ): string

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Prepares the content of a block pattern. If hooked blocks are registered, they get injected into the pattern, when they met the defined criteria.

Parameters

$patternarrayrequired
Registered pattern properties.
$hooked_blocksarrayrequired
The list of hooked blocks.

Return

string The content of the block pattern.

Source

private function prepare_content( $pattern, $hooked_blocks ) {
	$content = $pattern['content'];

	$before_block_visitor = '_inject_theme_attribute_in_template_part_block';
	$after_block_visitor  = null;
	if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
		$before_block_visitor = make_before_block_visitor( $hooked_blocks, $pattern, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' );
		$after_block_visitor  = make_after_block_visitor( $hooked_blocks, $pattern, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' );
	}
	$blocks  = parse_blocks( $content );
	$content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );

	return $content;
}

View all references View on Trac View on GitHub

UsesDescription
traverse_and_serialize_blocks()wp-includes/blocks.php

Given an array of parsed block trees, applies callbacks before and after serializing them and returns their concatenated output.

make_after_block_visitor()wp-includes/blocks.php

Returns a function that injects the hooked blocks after a given block.

make_before_block_visitor()wp-includes/blocks.php

Returns a function that injects the theme attribute into, and hooked blocks before, a given block.

parse_blocks()wp-includes/blocks.php

Parses blocks out of a content string.

has_filter()wp-includes/plugin.php

Checks if any filter has been registered for a hook.

Used byDescription
WP_Block_Patterns_Registry::get_registered()wp-includes/class-wp-block-patterns-registry.php

Retrieves an array containing the properties of a registered block pattern.

WP_Block_Patterns_Registry::get_all_registered()wp-includes/class-wp-block-patterns-registry.php

Retrieves all registered block patterns.

Changelog

VersionDescription
6.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.