WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Block_Templates_Registry::unregister()

WP_Block_Templates_Registry::unregister( string $template_name ): WP_Block_Template|WP_Error

In this article

Back to top

Unregisters a template.

Parameters

$template_namestringrequired
Template name including namespace.

Return

WP_Block_Template|WP_Error The unregistered template on success, or WP_Error on failure.

Source

public function unregister( $template_name ) {
	if ( ! $this->is_registered( $template_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			/* translators: %s: Template name. */
			sprintf( __( 'Template "%s" is not registered.' ), $template_name ),
			'6.7.0'
		);
		/* translators: %s: Template name. */
		return new WP_Error( 'template_not_registered', __( 'Template "%s" is not registered.' ) );
	}

	$unregistered_template = $this->registered_templates[ $template_name ];
	unset( $this->registered_templates[ $template_name ] );

	return $unregistered_template;
}

View all references View on Trac View on GitHub

UsesDescription
WP_Block_Templates_Registry::is_registered()wp-includes/class-wp-block-templates-registry.php

Checks if a template is registered.

_doing_it_wrong()wp-includes/functions.php

Marks something as being incorrectly called.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 1 moreShow less

Changelog

VersionDescription
6.7.0Introduced.

User Contributed Notes

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