unregister_post_type( string $post_type )
Unregisters a post type.
Description
Can not be used to unregister built-in post types.
Parameters
- $post_type
-
(string) (Required) Post type to unregister.
Return
(true|WP_Error) True on success, WP_Error on failure or if the post type doesn't exist.
Source
File: wp-includes/post.php
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;
}
Expand full source code Collapse full source code View on Trac View on GitHub
Changelog
| Version | Description |
|---|---|
| 4.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
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');