WP_Block_Patterns_Registry::unregister() WordPress Method

The WP_Block_Patterns_Registry::unregister() method is used to unregister a block pattern.

WP_Block_Patterns_Registry::unregister( string $pattern_name ) #

Unregisters a block pattern.


Parameters

$pattern_name

(string)(Required)Block pattern name including namespace.


Top ↑

Return

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


Top ↑

Source

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

	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;
	}


Top ↑

Changelog

Changelog
VersionDescription
5.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.