unregister_taxonomy() – Function | Developer.WordPress.org

Unregisters a taxonomy.

Description

Can not be used to unregister built-in taxonomies.

Parameters

$taxonomystringrequired: Taxonomy name.

Return

true|WP_Error True on success, WP_Error on failure or if the taxonomy doesn’t exist.

Source

function unregister_taxonomy( $taxonomy ) {
	global $wp_taxonomies;

	if ( ! taxonomy_exists( $taxonomy ) ) {
		return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
	}

	$taxonomy_object = get_taxonomy( $taxonomy );

	// Do not allow unregistering internal taxonomies.
	if ( $taxonomy_object->_builtin ) {
		return new WP_Error( 'invalid_taxonomy', __( 'Unregistering a built-in taxonomy is not allowed.' ) );
	}

	$taxonomy_object->remove_rewrite_rules();
	$taxonomy_object->remove_hooks();

	// Remove the taxonomy.
	unset( $wp_taxonomies[ $taxonomy ] );

	/**
	 * Fires after a taxonomy is unregistered.
	 *
	 * @since 4.5.0
	 *
	 * @param string $taxonomy Taxonomy name.
	 */
	do_action( 'unregistered_taxonomy', $taxonomy );

	return true;
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘unregistered_taxonomy’, string $taxonomy ): Fires after a taxonomy is unregistered.

Uses	Description
taxonomy_exists()`wp-includes/taxonomy.php`	Determines whether the taxonomy name exists.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
get_taxonomy()`wp-includes/taxonomy.php`	Retrieves the taxonomy object of $taxonomy.
do_action()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook.
WP_Error::__construct()`wp-includes/class-wp-error.php`	Initializes the error.

Show 3 more Show less

Changelog

Version	Description
4.5.0	Introduced.

User Contributed Notes

Skip to note 3 content

Daniyal Ahmed (a11n) 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
```
add_action( 'init', 'wpname_unregister_taxonomy' );

function wpname_unregister_taxonomy() {
    unregister_taxonomy( 'product_category');
}
```
Log in to add feedback
Skip to note 4 content

Mehadi Hasan Juber 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Unregister the Taxonomy simple example:
```
if( !function_exists( 'plugin_prefix_unregister_taxonomy' ) ) {
	function plugin_prefix_unregister_taxonomy(){
    	unregister_taxonomy( 'project-type' );
	}
}
add_action('init','plugin_prefix_unregister_taxonomy');
```
Log in to add feedback

unregister_taxonomy( string $taxonomy ): true|WP_Error

In this article

Description

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes