unregister_post_type() – Function | Developer.WordPress.org

Unregisters a post type.

Description

Cannot be used to unregister built-in post types.

Parameters

$post_typestringrequired: Post type to unregister.

Return

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

Source

function unregister_post_type( $post_type ) {
	global $wp_post_types;

	if ( ! post_type_exists( $post_type ) ) {
		return new WP_Error( 'invalid_post_type', __( 'Invalid post type.' ) );
	}

	$post_type_object = get_post_type_object( $post_type );

	// Do not allow unregistering internal post types.
	if ( $post_type_object->_builtin ) {
		return new WP_Error( 'invalid_post_type', __( 'Unregistering a built-in post type is not allowed' ) );
	}

	$post_type_object->remove_supports();
	$post_type_object->remove_rewrite_rules();
	$post_type_object->unregister_meta_boxes();
	$post_type_object->remove_hooks();
	$post_type_object->unregister_taxonomies();

	unset( $wp_post_types[ $post_type ] );

	/**
	 * Fires after a post type was unregistered.
	 *
	 * @since 4.5.0
	 *
	 * @param string $post_type Post type key.
	 */
	do_action( 'unregistered_post_type', $post_type );

	return true;
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘unregistered_post_type’, string $post_type ): Fires after a post type was unregistered.

Uses	Description
post_type_exists()`wp-includes/post.php`	Determines whether a post type is registered.
do_action()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook.
get_post_type_object()`wp-includes/post.php`	Retrieves a post type object by name.
WP_Error::__construct()`wp-includes/class-wp-error.php`	Initializes the error.

Show 2 more Show less

Changelog

Version	Description
4.5.0	Introduced.

User Contributed Notes

Skip to note 5 content

Mehadi Hasan Juber 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
Unregister the Custom Post Type simple example:
```
if( !function_exists( 'plugin_prefix_unregister_post_type' ) ) {
	function plugin_prefix_unregister_post_type(){
    	unregister_post_type( 'project' );
	}
}
add_action('init','plugin_prefix_unregister_post_type');
```
Log in to add feedback
Skip to note 6 content

Muhammad Saqib Sarwar 1 year 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
Disable announcement CPT if it is not main site.
```
function disable_announcement_cpt_for_subsite(): void {
		if ( ! is_main_site() ) {
			unregister_post_type( 'announcement' );
		}
	}
add_action( 'init', 'disable_announcement_cpt_for_subsite' );
```
Log in to add feedback
Skip to note 7 content

Alen Joseph 9 months 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

Unregister or Disable One or More Custom Post Types with Clean and Optimized Code
function disable_oraiste_custom_post_types() { $post_types = [‘clients’, ‘portfolio’, ‘team’, ‘testimonial’];
foreach ($post_types as $post_type) { if (post_type_exists($post_type)) { unregister_post_type($post_type); } } } add_action(‘init’, ‘disable_oraiste_custom_post_types’, 20);

Log in to add feedback
Skip to note 8 content

vee 1 month 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

From WordPress Uninstall Method document ( https://developer.wordpress.org/plugins/plugin-basics/uninstall-methods/ ), they recommend you to remove data (including options, tables) from DB.
So, unregister custom post type should be called on uninstall method.

Here is example:
‘cpt_customposttype’,
‘numberposts’ => -1,
];
$posts = new WP_Query($args);
while ($posts->have_posts()) {
$posts->the_post();
wp_delete_post(get_the_ID() , true);
}

// unregister custom post type
unregister_post_type(‘cpt_customposttype’);

// flush rewrite rules.
flush_rewrite_rules() ;
}
register_uninstall_hook(__FILE__, ‘cpt_uninstall’);
?>

By default, `unregister_post_type() ` will not flush rewrite rules, will not delete existing posts of its type.
The example above do it all.

Log in to add feedback

unregister_post_type( string $post_type ): true|WP_Error

In this article

Description

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes