WP_Block_Patterns_Registry::unregister() – Method

WP_Block_Patterns_Registry::unregister( string $pattern_name ): bool

Unregisters a block pattern.

Parameters

$pattern_namestringrequired: Block pattern name including namespace.

Return

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

Source

public function unregister( $pattern_name ) {
	if ( ! $this->is_registered( $pattern_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			/* translators: %s: Pattern name. */
			sprintf( __( 'Pattern "%s" not found.' ), $pattern_name ),
			'5.5.0'
		);
		return false;
	}

	unset( $this->registered_patterns[ $pattern_name ] );
	unset( $this->registered_patterns_outside_init[ $pattern_name ] );

	return true;
}

View all references View on Trac View on GitHub

Uses	Description
WP_Block_Patterns_Registry::is_registered()`wp-includes/class-wp-block-patterns-registry.php`	Checks if a block pattern is registered.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
_doing_it_wrong()`wp-includes/functions.php`	Marks something as being incorrectly called.

Show 1 more Show less

Changelog

Version	Description
5.5.0	Introduced.

User Contributed Notes

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