unregister_post_type( string $post_type ): true|WP_Error

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$post_typestring

Post type to unregister.

Return value

true|WP_Error

True on success, WP_Error on failure or if the post type doesn't exist.

Performance profile

How much work a call to unregister_post_type() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

14–28

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 44.

Plugin surface

1 hook

Third-party callbacks on 'unregistered_post_type' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost unregister_post_type() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while unregister_post_type() runs, in this order:

1. 1
   do_action( unregistered_post_type )actionline 1954 (+29 into the body)

   Fires after a post type was unregistered.

Uses · 5

• post_type_exists()Determines whether a post type is registered.
• __()Retrieves the translation of $text.
• get_post_type_object()Retrieves a post type object by name.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

1925function unregister_post_type( $post_type ) {1926	global $wp_post_types;1927 1928	if ( ! post_type_exists( $post_type ) ) {1929		return new WP_Error( 'invalid_post_type', __( 'Invalid post type.' ) );1930	}1931 1932	$post_type_object = get_post_type_object( $post_type );1933 1934	// Do not allow unregistering internal post types.1935	if ( $post_type_object->_builtin ) {1936		return new WP_Error( 'invalid_post_type', __( 'Unregistering a built-in post type is not allowed' ) );1937	}1938 1939	$post_type_object->remove_supports();1940	$post_type_object->remove_rewrite_rules();1941	$post_type_object->unregister_meta_boxes();1942	$post_type_object->remove_hooks();1943	$post_type_object->unregister_taxonomies();1944 1945	unset( $wp_post_types[ $post_type ] );1946 1947	/**1948	 * Fires after a post type was unregistered.1949	 *1950	 * @since 4.5.01951	 *1952	 * @param string $post_type Post type key.1953	 */1954	do_action( 'unregistered_post_type', $post_type );1955 1956	return true;1957}

Changelog

Introduced in 4.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.