WP_Post_Type

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 2

Every hook that fires from inside WP_Post_Type, in the order it appears in the class, grouped by the method that fires it.

Properties · 40

$namestringpublic

Post type key.

$labelstringpublic

Name of the post type shown in the menu. Usually plural.

$labelsstdClasspublic

Labels object for this post type.

$default_labels(string|null)[][]protected static

Default labels.

$descriptionstringpublic

A short descriptive summary of what the post type is.

$publicboolpublic

Whether a post type is intended for use publicly either via the admin interface or by front-end users.

$hierarchicalboolpublic

Whether the post type is hierarchical (e.g. page).

$exclude_from_searchboolpublic

Whether to exclude posts with this post type from front end search results.

$publicly_queryableboolpublic

Whether queries can be performed on the front end for the post type as part of parse_request().

$show_uiboolpublic

Whether to generate and allow a UI for managing this post type in the admin.

$show_in_menubool|stringpublic

Where to show the post type in the admin menu.

$show_in_nav_menusboolpublic

Makes this post type available for selection in navigation menus.

$show_in_admin_barboolpublic

Makes this post type available via the admin bar.

$menu_positionintpublic

The position in the menu order the post type should appear.

$menu_iconstringpublic

The URL or reference to the icon to be used for this menu.

$capability_typestringpublic

The string to use to build the read, edit, and delete capabilities.

$map_meta_capboolpublic

Whether to use the internal default meta capability handling.

$register_meta_box_cbcallablepublic

Provide a callback function that sets up the meta boxes for the edit form.

$taxonomiesstring[]public

An array of taxonomy identifiers that will be registered for the post type.

$has_archivebool|stringpublic

Whether there should be post type archives, or if a string, the archive slug to use.

$query_varstring|boolpublic

Sets the query_var key for this post type.

$can_exportboolpublic

Whether to allow this post type to be exported.

$delete_with_userboolpublic

Whether to delete posts of this type when deleting a user.

$templatearray[]public

Array of blocks to use as the default initial state for an editor session.

$template_lockstring|falsepublic

Whether the block template should be locked if $template is set.

$_builtinboolpublic

Whether this post type is a native or "built-in" post_type.

$_edit_linkstringpublic

URL segment to use for edit link of this post type.

$capstdClasspublic

Post type capabilities.

$rewritearray|falsepublic

Triggers the handling of rewrites for this post type.

$supportsarray|boolpublic

The features supported by the post type.

$show_in_restboolpublic

Whether this post type should appear in the REST API.

$rest_basestring|boolpublic

The base path for this post type's REST API endpoints.

$rest_namespacestring|boolpublic

The namespace for this post type's REST API endpoints.

$rest_controller_classstring|boolpublic

The controller for this post type's REST API endpoints.

$rest_controllerWP_REST_Controllerpublic

The controller instance for this post type's REST API endpoints.

$revisions_rest_controller_classstring|boolpublic

The controller for this post type's revisions REST API endpoints.

$revisions_rest_controllerWP_REST_Controllerpublic

The controller instance for this post type's revisions REST API endpoints.

$autosave_rest_controller_classstring|boolpublic

The controller for this post type's autosave REST API endpoints.

$autosave_rest_controllerWP_REST_Controllerpublic

The controller instance for this post type's autosave REST API endpoints.

$late_route_registrationboolpublic

A flag to register the post type REST API controller after its associated autosave / revisions controllers, instead of before. Registration order affects route matching priority.

Methods · 17

• __construct()Constructor.
• set_props()Sets post type properties.
• add_supports()Sets the features support for the post type.
• add_rewrite_rules()Adds the necessary rewrite rules for the post type.
• register_meta_boxes()Registers the post type meta box if a custom callback was specified.
• add_hooks()Adds the future post hook action for the post type.
• register_taxonomies()Registers the taxonomies for the post type.
• remove_supports()Removes the features support for the post type.
• remove_rewrite_rules()Removes any rewrite rules, permastructs, and rules for the post type.
• unregister_meta_boxes()Unregisters the post type meta box if a custom callback was specified.
• unregister_taxonomies()Removes the post type from all taxonomies.
• remove_hooks()Removes the future post hook action for the post type.
• get_rest_controller()Gets the REST API controller for this post type.
• get_revisions_rest_controller()Gets the REST API revisions controller for this post type.
• get_autosave_rest_controller()Gets the REST API autosave controller for this post type.
• get_default_labels()Returns the default labels for post types.
• reset_default_labels()Resets the cache for the default labels.

Source code

View on Trac ↗View on GitHub ↗

17#[AllowDynamicProperties]18final class WP_Post_Type {19	/**20	 * Post type key.21	 *22	 * @since 4.6.023	 * @var string $name24	 */25	public $name;26 27	/**28	 * Name of the post type shown in the menu. Usually plural.29	 *30	 * @since 4.6.031	 * @var string $label32	 */33	public $label;34 35	/**36	 * Labels object for this post type.37	 *38	 * If not set, post labels are inherited for non-hierarchical types39	 * and page labels for hierarchical ones.40	 *41	 * @see get_post_type_labels()42	 *43	 * @since 4.6.044	 * @var stdClass $labels45	 */46	public $labels;47 48	/**49	 * Default labels.50	 *51	 * @since 6.0.052	 * @var (string|null)[][] $default_labels53	 */54	protected static $default_labels = array();55 56	/**57	 * A short descriptive summary of what the post type is.58	 *59	 * Default empty.60	 *61	 * @since 4.6.062	 * @var string $description63	 */64	public $description = '';65 66	/**67	 * Whether a post type is intended for use publicly either via the admin interface or by front-end users.68	 *69	 * While the default settings of $exclude_from_search, $publicly_queryable, $show_ui, and $show_in_nav_menus70	 * are inherited from public, each does not rely on this relationship and controls a very specific intention.71	 *72	 * Default false.73	 *74	 * @since 4.6.075	 * @var bool $public76	 */77	public $public = false;78 79	/**80	 * Whether the post type is hierarchical (e.g. page).81	 *82	 * Default false.83	 *84	 * @since 4.6.085	 * @var bool $hierarchical86	 */87	public $hierarchical = false;88 89	/**90	 * Whether to exclude posts with this post type from front end search91	 * results.92	 *93	 * Default is the opposite value of $public.94	 *95	 * @since 4.6.096	 * @var bool $exclude_from_search

Changelog

Introduced in 4.6.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 6.7.7 tag, from src/wp-includes/class-wp-post-type.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.