WP_Block_Type_Registry::unregister() – Method

WP_Block_Type_Registry::unregister( string|WP_Block_Type $name ): WP_Block_Type|false

Unregisters a block type.

Parameters

$namestring|WP_Block_Typerequired: Block type name including namespace, or alternatively a complete WP_Block_Type instance.

Return

WP_Block_Type|false The unregistered block type on success, or false on failure.

Source

public function unregister( $name ) {
	if ( $name instanceof WP_Block_Type ) {
		$name = $name->name;
	}

	if ( ! $this->is_registered( $name ) ) {
		_doing_it_wrong(
			__METHOD__,
			/* translators: %s: Block name. */
			sprintf( __( 'Block type "%s" is not registered.' ), $name ),
			'5.0.0'
		);
		return false;
	}

	$unregistered_block_type = $this->registered_block_types[ $name ];
	unset( $this->registered_block_types[ $name ] );

	return $unregistered_block_type;
}

View all references View on Trac View on GitHub

Uses	Description
WP_Block_Type_Registry::is_registered()`wp-includes/class-wp-block-type-registry.php`	Checks if a block type 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.0.0	Introduced.

User Contributed Notes

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