W3cubDocs

/WordPress

get_post_type_object( string $post_type ): WP_Post_Type|null

Retrieves a post type object by name.

Description

See also

Parameters

$post_typestringrequired
The name of a registered post type.

Return

WP_Post_Type|null WP_Post_Type object if it exists, null otherwise.

Source

function get_post_type_object( $post_type ) {
	global $wp_post_types;

	if ( ! is_scalar( $post_type ) || empty( $wp_post_types[ $post_type ] ) ) {
		return null;
	}

	return $wp_post_types[ $post_type ];
}

View all references View on Trac View on GitHub

Changelog

Version Description
4.6.0 Object returned is now an instance of WP_Post_Type.
3.0.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_post_type_object