WP_Block_Patterns_Registry::register( string $pattern_name, array $pattern_properties ): bool

Registers a block pattern.


Parameters

$pattern_name string Required
Block pattern name including namespace.
$pattern_properties array Required
List of properties for the block pattern.
  • title string
    Required. A human-readable title for the pattern.
  • content string
    Required. Block HTML markup for the pattern.
  • description string
    Optional. Visually hidden text used to describe the pattern in the inserter. A description is optional, but is strongly encouraged when the title does not fully describe what the pattern does. The description will help users discover the pattern while searching.
  • viewportWidth int
    Optional. The intended width of the pattern to allow for a scaled preview within the pattern inserter.
  • categories array
    Optional. A list of registered pattern categories used to group block patterns. Block patterns can be shown on multiple categories.
    A category must be registered separately in order to be used here.
  • blockTypes array
    Optional. A list of block names including namespace that could use the block pattern in certain contexts (placeholder, transforms).
    The block pattern is available in the block editor inserter regardless of this list of block names.
    Certain blocks support further specificity besides the block name (e.g. for core/template-part you can specify areas like core/template-part/header or core/template-part/footer).
  • keywords array
    Optional. A list of aliases or keywords that help users discover the pattern while searching.

Top ↑

Return

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


Top ↑

Source

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

public function register( $pattern_name, $pattern_properties ) {
	if ( ! isset( $pattern_name ) || ! is_string( $pattern_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Pattern name must be a string.' ),
			'5.5.0'
		);
		return false;
	}

	if ( ! isset( $pattern_properties['title'] ) || ! is_string( $pattern_properties['title'] ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Pattern title must be a string.' ),
			'5.5.0'
		);
		return false;
	}

	if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) {
		_doing_it_wrong(
			__METHOD__,
			__( 'Pattern content must be a string.' ),
			'5.5.0'
		);
		return false;
	}

	$pattern = array_merge(
		$pattern_properties,
		array( 'name' => $pattern_name )
	);

	$this->registered_patterns[ $pattern_name ] = $pattern;

	// If the pattern is registered inside an action other than `init`, store it
	// also to a dedicated array. Used to detect deprecated registrations inside
	// `admin_init` or `current_screen`.
	if ( current_action() && 'init' !== current_action() ) {
		$this->registered_patterns_outside_init[ $pattern_name ] = $pattern;
	}

	return true;
}


Top ↑

Changelog

Changelog
Version Description
5.8.0 Added support for the blockTypes property.
5.5.0 Introduced.

Top ↑

User Contributed Notes

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