Registers a post type.
Description
Note: Post type registrations should not be hooked before the ‘init’ action. Also, any taxonomy connections should be registered via the $taxonomies argument to ensure consistency when hooks such as ‘parse_query’ or ‘pre_get_posts’ are used.
Post types can support any number of built-in core features such as meta boxes, custom fields, post thumbnails, post statuses, comments, and more. See the $supports argument for a complete list of supported features.
Parameters
$post_typestringrequired- Post type key. Must not exceed 20 characters and may only contain lowercase alphanumeric characters, dashes, and underscores. See sanitize_key() .
$argsarray|stringoptional- Array or string of arguments for registering a post type.
labelstringName of the post type shown in the menu. Usually plural.
Default is value of $labels['name'].labelsstring[]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.descriptionstringA short descriptive summary of what the post type is.
publicboolWhether 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.hierarchicalboolWhether the post type is hierarchical (e.g. page). Default false.exclude_from_searchboolWhether to exclude posts with this post type from front end search results. Default is the opposite value of $public.publicly_queryableboolWhether 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_uiboolWhether to generate and allow a UI for managing this post type in the admin. Default is value of $public.show_in_menubool|stringWhere 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_menusboolMakes this post type available for selection in navigation menus.
Default is value of $public.show_in_admin_barboolMakes this post type available via the admin bar. Default is value of $show_in_menu.show_in_restboolWhether 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_basestringTo change the base URL of REST API route. Default is $post_type.rest_namespacestringTo change the namespace URL of REST API route. Default is wp/v2.rest_controller_classstringREST API controller class name. Default is ‘WP_REST_Posts_Controller‘.autosave_rest_controller_classstring|boolREST API controller class name. Default is ‘WP_REST_Autosaves_Controller‘.revisions_rest_controller_classstring|boolREST API controller class name. Default is ‘WP_REST_Revisions_Controller‘.late_route_registrationboolA flag to direct the REST API controllers for autosave / revisions should be registered before/after the post type controller.menu_positionintThe position in the menu order the post type should appear. To work, $show_in_menu must be true. Default null (at the bottom).menu_iconstringThe 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_typestring|arrayThe 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'.capabilitiesstring[]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_capboolWhether to use the internal default meta capability handling.
Default false.supportsarray|falseCore 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, the'autosave'feature dictates whether the post type will be autosaved, and the'comments'feature dictates whether the comments count will show on the edit screen. For backward compatibility reasons, adding'editor'support implies'autosave'support too. 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_cbcallableProvide 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.taxonomiesstring[]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_archivebool|stringWhether 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.rewritebool|arrayTriggers 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:slugstringCustomize the permastruct slug. Defaults to $post_type key.with_frontboolWhether the permastruct should be prepended with WP_Rewrite::$front.
Default true.feedsboolWhether the feed permastruct should be built for this post type.
Default is value of $has_archive.pagesboolWhether the permastruct should provide for pagination. Default true.ep_maskintEndpoint 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_varstring|boolSets 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_exportboolWhether to allow this post type to be exported. Default true.delete_with_userboolWhether 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.
templatearrayArray 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_lockstring|falseWhether 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.
- If set to
_builtinboolFOR INTERNAL USE ONLY! True if this post type is a native or "built-in" post_type. Default false._edit_linkstringFOR 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
* } * @return WP_Post_Type|WP_Error The registered post type object on success, * WP_Error object on failure. */ 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. */Changelog
Show 3 moreShow lessVersion Description 5.9.0 The rest_namespaceargument was added.5.3.0 The supportsargument will now accept an array of arguments for a feature.5.0.0 The templateandtemplate_lockarguments were added.4.7.0 Introduced show_in_rest,rest_baseandrest_controller_classarguments 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_uiargument is now enforced on the post type listing screen and post editing screen.3.0.0 The show_uiargument is now enforced on the new post screen.2.9.0 Introduced. User Contributed Notes
You must log in before being able to contribute a note or feedback.
Register a ‘book’ post type, using new labels introduced in 4.3 and 4.4.
To add Gutenberg compatibility in your custom post type, it require two things
1.
supportsmust haveeditorin it2.
show_in_restset to trueuse
'show_in_rest' => true,to enable blocks in your custom post type.
This documentation is currently missing the “template” and “template_lock” arguments which I’ve seen used in some projects. The purpose of which is to automatically load a certain block or block template into the Gutenberg editor, or to lock the usage of blocks.
The documentation for these arguments can be found in this doc section about Gutenberg blocks at Block Editor Handbook > Templates
textorcontentattributes to set default content in a block template.Customize the post update messages of the ‘book’ custom post type:
Using Dashicons for a custom menu icon
To use one of the existing Dashicons for your custom post type in the menu (instead of the push-pin default), go to Developer Resources: Dashicons and click on your favorite icon. The class name will show up top — just copy and use. So for, instance, for your custom post type “Book,” you might use
dashicons-book.As of v6.1 – this gives more of a full comprehensive boilerplate to copy and adjust to your needs (and in order from documentation) – which includes labels – so that I can then easily do a find and replace to match the wording that I need when registering a new CPT.
register_post_type(“wpdocs_register_announcement_cpt”) must not exceed 20 characters.As of WordPress 4.3 and 4.4, a number of new labels have been added.
Introduced in 4.3:
featured_image– defaults to “Featured Image”set_featured_image– defaults to “Set featured image”remove_featured_image– defaults to “Remove featured image”use_featured_image– defaults to “Use as featured image”Introduced in 4.4:
archives– defaults to “Post Archives” or “Page Archives”insert_into_item– defaults to “Insert into post” or “Insert into page”uploaded_to_this_item– defaults to “Uploaded to this post” or “Uploaded to this page”filter_items_list– defaults to “Filter posts list” or “Filter pages list”items_list_navigation– defaults to “Posts list navigation” or “Pages list navigation”items_list– defaults to “Posts list” or “Pages list”See https://make.wordpress.org/core/2015/12/11/additional-labels-for-custom-post-types-and-custom-taxonomies/ for more information.
To use an svg which colors are always correct embed it inline like:
The
fill="black"is important.Source: https://stackoverflow.com/a/42265057/933065
The following guidelines ensure consistency with the default post types and help to avoid conflict with post types registered by other developers.
$post_typeto a singular noun (e.g.testimonial,portfolio,event). Remember you can always use the plural form for other parameters that affect the labels and rewrite slug.sports_team,video_game).kwh_testimonial).Never create a custom post type “author”
The archive page and posts pages will conflict with wordpress’ builtin
/author/{username}routes.Even if you
'rewrite' => ['slug' => 'writer'], there will be some confusion and your custom author posts will not be accessible.This function doesn’t check if
key is unique. If the post type with existing key is registered it overwrites
global array element without calling
function. It still resides in memory, rewrite rules, and hooks are not removed. Function
doesn’t allow to unregister builtin post types, but
allows to register them more than once.
Post type as submenu is possible.
You can put a custom post type in the menu of another CPT!
The documentation isn’t that obvious!
But it is perfectly possible to make a post type a submenu of another post type!
The option “show_in_menu” is the key to accomplish that. (Other than the suggested menu_position parameter)
You only have to give “show_in_menu” this parameter: “edit.php?post_type=page”
Where “page” could be a built in post type or any post type you create!
Here is an example code snippet
This example adds WordPress 3.3+ Help Tab to the ‘book’ post type.
When using a base64-encoded SVG for the
menu_iconargument, your SVG must have afillattribute. Without thefillattribute, WordPress won’t be able to match the admin color scheme.These are the built-in post types:
If you want to view the info for all built-in and or custom post types, you can get it from
$wp_post_typesglobal variable.Example:
wp_blockThe argument ‘with_front’ in old Codex is more clearly explained with example.
‘with_front’ => bool Should the permalink structure be prepended with the front base.
(example: if your permalink structure is /blog/, then your links will be: false->/news/, true->/blog/news/). Defaults to true
This basic example registers a ‘book’ post type.
This is example adds contextual help to the ‘book’ post type.
about hierarchical post type performance issues note : ” With this parameter set to true WordPress will fetch all IDs of that particular post type on each administration page load for your post type. ”
The phrasing is a little bit confusing. WP will fetch all the child IDs of this particular post of this post type and not “all IDs” of “the post type” which is a term describing the type of a post and not a specific post.
There is a mistake in this document.
The param supports also accept the boolean value false.
When supports is set to false the post type don’t use any of the build in feature like editor.
Only the submit metabox is automatically registered.
So I would really appreticate if someone could update the info so other developers could benefit from my research.
If for some reason your pages with a custom post type give a 404 on the frontend, you might need to flush your rewrite rules. You can do this manually by going to Settings –> Permalinks and hitting ‘Save Changes’ or by calling
flush_rewrite_rules(). Note that you shouldn’t callflush_rewrite_rules()because it’s expensive. Only run it on plugin activation. See the section above.A specific issue I would like to address here for beginners, about the Custom Post Type (CPT) parent menu and immediate child menu label.
For example –
Your CPT main menu label is “Videos” As a default the immediate child menu label will show also “Videos” but you don’t want it. You just want, the parent menu label “Videos” and the immediate child menu label “All Videos”. For that case, you should use ‘all_items’ => ‘All Videos’
Complete code below –
Note that although the
$publicattribute is optional, the inputs passed to theregister_post_type()function are exactly what is queried by theget_post_types()function. So if you verbosely set the equivalent options forpublicly_queriable,show_ui,show_in_nav_menus, andexclude_from_search, this will not be handled the same as if you had set the$publicattribute. See bug https://core.trac.wordpress.org/ticket/18950A note regarding the usage of
show_in_menuwith a string value: As described in the docs this will add your Custom Post Type (CPT) menu items as submenu items to any other existing top menu item.Independent of the given
capability_typeof your CPT (usuallypostorpage) the access to the edit page (/wp-admin/edit.php?post_type=my-custom-post-type) of your CPT will be as well determined by the capability set inadd_menu_pageofmy-custom-menu.Example:
If your
add_menu_pageregisters with a capability ofmanage_optionsand your CPT will usepostascapability_typeany user will see the top level and submenu items if they have theedit_postscap. But if they don’t have themanage_optionscap they cannot access the CPT edit view as the cap check resolves tomanage_optionsof the top level menu page instead ofedit_postsas one might expect.Refer to
user_can_access_admin_pagein /wp-admin/includes/plugin.phpThis scenario will trigger this code block in there:
Custom post types with
publicly_queryableset to false don’t expose the post slug for editing. However,supportshas a hidden attribute ofslugwhich does expose the post slug field on the editor (but not for quick edit).To have the Permalink and the Permalink Edit button displayed under the Post Title in the Edit Post screen, you must set the
publicparameter totrueand, if specified, thepublicly_queryableandrewriteparameters must not be set tofalse.I was extending a post type when I ran into a problem related to the
register_meta_box_cbargument. I needed to add my own callback, but also make sure so that the original (if any) callback was still fired. I think this is pretty undocumented but you can actually add an array with callbacks for this argument e.g:To use a custom SVG in
menu_iconfind or create the SVG you want to use, and then you can use a site like https://www.base64-image.de/ to convert it to base64 code.In order for the SVG icon to match the admin color scheme, it must have the
fillattribute set in anypathelements in the SVG file.Edit the SVG file with an editor and add fill attribute to any `path` elements before converting to base64.
should be
You can use any color you want, including using
noneinstead of a color, as WordPress will automatically update it to match the color scheme.https://css-tricks.com/almanac/properties/f/fill/
When you register a new Custom Post Type I’d highly recommend setting
with_front => trueas it’s false by default in core. This change to your CPT registration will be helpful if a user/client ever changes their permalinks to/blog/%category%/%postname%/because all your registered CPTs will have/blog/your-cpt