WP_Block_Pattern_Categories_Registry::unregister() WordPress Method

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

WP_Block_Pattern_Categories_Registry::unregister( string $category_name ) #

Unregisters a pattern category.


Parameters

$category_name

(string)(Required)Pattern category 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-pattern-categories-registry.php

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

		unset( $this->registered_categories[ $category_name ] );
		unset( $this->registered_categories_outside_init[ $category_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.