WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Block_Patterns_Registry::get_all_registered()

WP_Block_Patterns_Registry::get_all_registered( bool $outside_init_only = false ): array[]

In this article

Back to top

Retrieves all registered block patterns.

Parameters

$outside_init_onlybooloptional
Return only patterns registered outside the init action.

Default:false

Return

array[] Array of arrays containing the registered block patterns properties, and per style.

Source

public function get_all_registered( $outside_init_only = false ) {
	$patterns      = $outside_init_only
			? $this->registered_patterns_outside_init
			: $this->registered_patterns;
	$hooked_blocks = get_hooked_blocks();

	foreach ( $patterns as $index => $pattern ) {
		$pattern['content']            = $this->get_content( $pattern['name'], $outside_init_only );
		$patterns[ $index ]['content'] = $this->prepare_content( $pattern, $hooked_blocks );
	}

	return array_values( $patterns );
}

View all references View on Trac View on GitHub

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

Retrieves the content of a registered block pattern.

get_hooked_blocks()wp-includes/blocks.php

Retrieves block types hooked into the given block, grouped by anchor block type and the relative position.

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

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

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

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