Description
Parameters
$post_type string required Post type key. Must not exceed 20 characters and may only contain lowercase alphanumeric characters, dashes, and underscores. See sanitize_key() . $args array | string optional Array or string of arguments for registering a post type.
label string Name of the post type shown in the menu. Usually plural.
Default is value of $labels[ 'name' ]. labels string[] An array of labels for this post type. If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones. See get_post_type_labels() for a full list of supported labels. description string A short descriptive summary of what the post type is.
public bool Whether a post type is intended for use publicly either via the admin interface or by front-end users. While the default settings of $exclude_from_search, $publicly_queryable, $show_ui, and $show_in_nav_menus are inherited from $public, each does not rely on this relationship and controls a very specific intention.
Default false. hierarchical bool Whether the post type is hierarchical (e.g. page). Default false. exclude_from_search bool Whether to exclude posts with this post type from front end search results. Default is the opposite value of $public. publicly_queryable bool Whether queries can be performed on the front end for the post type as part of parse_request(). Endpoints would include: * ?post_type={post_type_key} * ? {post_type_key}={single_post_slug} * ? {post_type_query_var}={single_post_slug} If not set, the default is inherited from $public. show_ui bool Whether to generate and allow a UI for managing this post type in the admin. Default is value of $public. show_in_menu bool|string Where to show the post type in the admin menu. To work, $show_ui must be true. If true, the post type is shown in its own top level menu. If false, no menu is shown. If a string of an existing top level menu ( 'tools.php' or 'edit.php? post_type=page' , for example), the post type will be placed as a sub-menu of that.
Default is value of $show_ui. show_in_nav_menus bool Makes this post type available for selection in navigation menus.
Default is value of $public. show_in_admin_bar bool Makes this post type available via the admin bar. Default is value of $show_in_menu. show_in_rest bool Whether to include the post type in the REST API. Set this to true for the post type to be available in the block editor. rest_base string To change the base URL of REST API route. Default is $post_type. rest_namespace string To change the namespace URL of REST API route. Default is wp/v2. rest_controller_class string autosave_rest_controller_class string|bool revisions_rest_controller_class string|bool late_route_registration bool A flag to direct the REST API controllers for autosave / revisions should be registered before/after the post type controller. menu_position int The position in the menu order the post type should appear. To work, $show_in_menu must be true. Default null (at the bottom). menu_icon string The URL to the icon to be used for this menu. Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme — this should begin with 'data:image/svg+xml; base64,' . Pass the name of a Dashicons helper class to use a font icon, e.g.
'dashicons-chart-pie' . Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS. Defaults to use the posts icon. capability_type string|array The string to use to build the read, edit, and delete capabilities.
May be passed as an array to allow for alternative plurals when using this argument as a base to construct the capabilities, e.g.
array( 'story' , 'stories' ). Default 'post' . capabilities string[] Array of capabilities for this post type. $capability_type is used as a base to construct capabilities by default.
See get_post_type_capabilities() . map_meta_cap bool Whether to use the internal default meta capability handling.
Default false. supports array|false Core feature(s) the post type supports. Serves as an alias for calling add_post_type_support() directly. Core features include 'title' , 'editor' , 'comments' , 'revisions' , 'trackbacks' , 'author' , 'excerpt' , 'page-attributes' , 'thumbnail' , 'custom-fields' , and 'post-formats' .
Additionally, the 'revisions' feature dictates whether the post type will store revisions, and the 'comments' feature dictates whether the comments count will show on the edit screen. A feature can also be specified as an array of arguments to provide additional information about supporting that feature.
Example: array( 'my_feature', array( 'field' => 'value' ) ) .
If false, no features will be added.
Default is an array containing 'title' and 'editor' . register_meta_box_cb callable Provide a callback function that sets up the meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback. Default null. taxonomies string[] An array of taxonomy identifiers that will be registered for the post type. Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type() .
has_archive bool|string Whether there should be post type archives, or if a string, the archive slug to use. Will generate the proper rewrite rules if $rewrite is enabled. Default false. rewrite bool|array Triggers the handling of rewrites for this post type. To prevent rewrite, set to false.
Defaults to true, using $post_type as slug. To specify rewrite rules, an array can be passed with any of these keys: slug string Customize the permastruct slug. Defaults to $post_type key. with_front bool Whether the permastruct should be prepended with WP_Rewrite::$front.
Default true. feeds bool Whether the feed permastruct should be built for this post type.
Default is value of $has_archive. pages bool Whether the permastruct should provide for pagination. Default true. ep_mask int Endpoint mask to assign. If not specified and permalink_epmask is set, inherits from $permalink_epmask. If not specified and permalink_epmask is not set, defaults to EP_PERMALINK.
query_var string|bool Sets the query_var key for this post type. Defaults to $post_type key. If false, a post type cannot be loaded at ? {query_var}={post_slug}. If specified as a string, the query ? {query_var_string}={post_slug} will be valid. can_export bool Whether to allow this post type to be exported. Default true. delete_with_user bool Whether to delete posts of this type when deleting a user.
-
If true, posts of this type belonging to the user will be moved to Trash when the user is deleted. -
If false, posts of this type belonging to the user will *not* be trashed or deleted. -
If not set (the default), posts are trashed if post type supports the 'author' feature. Otherwise posts are not trashed or deleted.
Default null. -
template array Array of blocks to use as the default initial state for an editor session. Each item should be an array containing block name and optional attributes. template_lock string|false Whether the block template should be locked if $template is set.
-
If set to 'all' , the user is unable to insert new blocks, move existing blocks and delete blocks. -
If set to 'insert' , the user is able to move existing blocks but is unable to insert new blocks and delete blocks.
Default false. -
_builtin bool FOR INTERNAL USE ONLY! True if this post type is a native or "built-in" post_type. Default false. _edit_link string FOR INTERNAL USE ONLY! URL segment to use for edit link of this post type. Default 'post.php? post=%d' .
More Arguments from get_post_type_capabilities( … $args ) Post type registration arguments. Default: array() Source function register_post_type( $post_type, $args = array() ) { global $wp_post_types; if ( ! is_array( $wp_post_types ) ) { $wp_post_types = array(); } // Sanitize post type name. $post_type = sanitize_key( $post_type ); if ( empty( $post_type ) || strlen( $post_type ) > 20 ) { _doing_it_wrong( __FUNCTION__, __( 'Post type names must be between 1 and 20 characters in length.' ), '4.2.0' ); return new WP_Error( 'post_type_length_invalid', __( 'Post type names must be between 1 and 20 characters in length.' ) ); } $post_type_object = new WP_Post_Type( $post_type, $args ); $post_type_object->add_supports(); $post_type_object->add_rewrite_rules(); $post_type_object->register_meta_boxes(); $wp_post_types[ $post_type ] = $post_type_object; $post_type_object->add_hooks(); $post_type_object->register_taxonomies(); /** * Fires after a post type is registered. * * @since 3.3.0 * @since 4.6.0 Converted the `$post_type` parameter to accept a `WP_Post_Type` object. * * @param string $post_type Post type. * @param WP_Post_Type $post_type_object Arguments used to register the post type. */ do_action( 'registered_post_type', $post_type, $post_type_object ); /** * Fires after a specific post type is registered. * * The dynamic portion of the filter name, `$post_type`, refers to the post type key. * * Possible hook names include: * * - `registered_post_type_post` * - `registered_post_type_page` * * @since 6.0.0 * * @param string $post_type Post type. * @param WP_Post_Type $post_type_object Arguments used to register the post type. */ do_action( "registered_post_type_{$post_type}", $post_type, $post_type_object ); return $post_type_object; } Hooks -
do_action ( ‘registered_post_type’, string $post_type , WP_Post_Type $post_type_object ) Fires after a post type is registered. -
do_action ( “registered_post_type_{$post_type}”, string $post_type , WP_Post_Type $post_type_object ) Fires after a specific post type is registered.
Changelog Version Description 5.9.0 The rest_namespace argument was added. 5.3.0 The supports argument will now accept an array of arguments for a feature. 5.0.0 The template and template_lock arguments were added. 4.7.0 Introduced show_in_rest , rest_base and rest_controller_class arguments to register the post type in REST API. 4.6.0 Post type object returned is now an instance of WP_Post_Type . 4.4.0 The show_ui argument is now enforced on the post type listing screen and post editing screen. 3.0.0 The show_ui argument is now enforced on the new post screen. 2.9.0 Introduced. Show 3 more Show less User Contributed Notes -
Skip to note 31 content You must log in to vote on the helpfulness of this note Vote results for this note: thirty-two You must log in to vote on the helpfulness of this note -
Skip to note 32 content You must log in to vote on the helpfulness of this note Vote results for this note: seventeen You must log in to vote on the helpfulness of this note -
Skip to note 33 content You must log in to vote on the helpfulness of this note Vote results for this note: ten You must log in to vote on the helpfulness of this note -
Skip to note 34 content You must log in to vote on the helpfulness of this note Vote results for this note: eight You must log in to vote on the helpfulness of this note -
Skip to note 35 content You must log in to vote on the helpfulness of this note Vote results for this note: seven You must log in to vote on the helpfulness of this note -
Skip to note 36 content You must log in to vote on the helpfulness of this note Vote results for this note: six You must log in to vote on the helpfulness of this note -
Skip to note 37 content You must log in to vote on the helpfulness of this note Vote results for this note: five You must log in to vote on the helpfulness of this note -
Skip to note 38 content You must log in to vote on the helpfulness of this note Vote results for this note: five You must log in to vote on the helpfulness of this note -
Skip to note 39 content You must log in to vote on the helpfulness of this note Vote results for this note: five You must log in to vote on the helpfulness of this note -
Skip to note 40 content You must log in to vote on the helpfulness of this note Vote results for this note: four You must log in to vote on the helpfulness of this note -
Skip to note 41 content You must log in to vote on the helpfulness of this note Vote results for this note: four You must log in to vote on the helpfulness of this note -
Skip to note 42 content You must log in to vote on the helpfulness of this note Vote results for this note: four You must log in to vote on the helpfulness of this note -
Skip to note 43 content You must log in to vote on the helpfulness of this note Vote results for this note: three You must log in to vote on the helpfulness of this note -
Skip to note 44 content You must log in to vote on the helpfulness of this note Vote results for this note: two You must log in to vote on the helpfulness of this note -
Skip to note 45 content You must log in to vote on the helpfulness of this note Vote results for this note: two You must log in to vote on the helpfulness of this note -
Skip to note 46 content You must log in to vote on the helpfulness of this note Vote results for this note: two You must log in to vote on the helpfulness of this note -
Skip to note 47 content You must log in to vote on the helpfulness of this note Vote results for this note: two You must log in to vote on the helpfulness of this note -
Skip to note 48 content You must log in to vote on the helpfulness of this note Vote results for this note: one You must log in to vote on the helpfulness of this note -
Skip to note 49 content You must log in to vote on the helpfulness of this note Vote results for this note: one You must log in to vote on the helpfulness of this note -
Skip to note 50 content You must log in to vote on the helpfulness of this note Vote results for this note: one You must log in to vote on the helpfulness of this note -
Skip to note 51 content You must log in to vote on the helpfulness of this note Vote results for this note: one You must log in to vote on the helpfulness of this note -
Skip to note 52 content You must log in to vote on the helpfulness of this note Vote results for this note: one You must log in to vote on the helpfulness of this note -
Skip to note 53 content You must log in to vote on the helpfulness of this note Vote results for this note: one You must log in to vote on the helpfulness of this note -
Skip to note 54 content You must log in to vote on the helpfulness of this note Vote results for this note: zero You must log in to vote on the helpfulness of this note -
Skip to note 55 content You must log in to vote on the helpfulness of this note Vote results for this note: zero You must log in to vote on the helpfulness of this note -
Skip to note 56 content You must log in to vote on the helpfulness of this note Vote results for this note: zero You must log in to vote on the helpfulness of this note -
Skip to note 57 content You must log in to vote on the helpfulness of this note Vote results for this note: zero You must log in to vote on the helpfulness of this note -
Skip to note 58 content You must log in to vote on the helpfulness of this note Vote results for this note: zero You must log in to vote on the helpfulness of this note -
Skip to note 59 content You must log in to vote on the helpfulness of this note Vote results for this note: -4 You must log in to vote on the helpfulness of this note -
Skip to note 60 content You must log in to vote on the helpfulness of this note Vote results for this note: -11 You must log in to vote on the helpfulness of this note
You must log in before being able to contribute a note or feedback.