register_block_pattern( string $pattern_name, array $pattern_properties )

Registers a new pattern.

Parameters

$pattern_name: (string) (Required) Pattern name including namespace.
$pattern_properties: (array) (Required) Array containing the properties of the pattern.

Return

(bool) True if the pattern was registered with success and false otherwise.

Source

File: wp-includes/class-wp-block-patterns-registry.php

function register_block_pattern( $pattern_name, $pattern_properties ) {
	return WP_Block_Patterns_Registry::get_instance()->register( $pattern_name, $pattern_properties );
}

Uses

Uses	Description
wp-includes/class-wp-block-patterns-registry.php: WP_Block_Patterns_Registry::get_instance()	Utility method to retrieve the main instance of the class.

Used By

Used By	Description
wp-includes/block-patterns.php: _load_remote_block_patterns()	Register Core’s official patterns from wordpress.org/patterns.
wp-includes/block-patterns.php: _register_core_block_patterns_and_categories()	Registers the core block patterns and categories.

Changelog

Version	Description
5.5.0	Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/register_block_pattern