From 85781eaed2d34796e43f9a00af3ffb678c9fee02 Mon Sep 17 00:00:00 2001 From: ryan Date: Mon, 7 May 2012 16:25:06 +0000 Subject: [PATCH] phpdoc updates for register_post_type(). Props jeremyfelt. fixes #20622 git-svn-id: http://core.svn.wordpress.org/trunk@20734 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/post.php | 90 +++++++++++++++++++++++++++++--------------- 1 file changed, 59 insertions(+), 31 deletions(-) diff --git a/wp-includes/post.php b/wp-includes/post.php index 4e132ab41..1b333ee3d 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -870,52 +870,80 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) * Optional $args contents: * * - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used. + * - labels - 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. + * * You can see accepted values in {@link get_post_type_labels()}. * - description - A short descriptive summary of what the post type is. Defaults to blank. - * - public - Whether posts of this type should be shown in the admin UI. Defaults to false. - * - exclude_from_search - Whether to exclude posts with this post type from search results. - * Defaults to true if the type is not public, false if the type is public. - * - publicly_queryable - Whether post_type queries can be performed from the front page. - * Defaults to whatever public is set as. - * - show_ui - Whether to generate a default UI for managing this post type. Defaults to true - * if the type is public, false if the type is not public. - * - show_in_menu - Where to show the post type in the admin menu. True for a top level menu, - * false for no menu, or can be a top level page like 'tools.php' or 'edit.php?post_type=page'. - * show_ui must be true. - * - menu_position - The position in the menu order the post type should appear. Defaults to the bottom. + * - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users. + * * Defaults to false. + * * 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. + * - exclude_from_search - Whether to exclude posts with this post type from front end search results. + * * If not set, the the opposite of public's current value is used. + * - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request(). + * * ?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 - Whether to generate a default UI for managing this post type in the admin. + * * If not set, the default is inherited from public. + * - show_in_nav_menus - Makes this post type available for selection in navigation menus. + * * If not set, the default is inherited from public. + * - show_in_menu - Where to show the post type in the admin menu. + * * 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 (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will + * be placed as a sub menu of that. + * * show_ui must be true. + * * If not set, the default is inherited from show_ui + * - show_in_admin_bar - Makes this post type available via the admin bar. + * * If not set, the default is inherited from show_in_menu + * - menu_position - The position in the menu order the post type should appear. + * * show_in_menu must be true + * * Defaults to null, which places it at the bottom of its area. * - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon. * - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'. - * 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'). - * - capabilities - Array of capabilities for this post type. By default the capability_type is used - * as a base to construct capabilities. You can see accepted values in {@link get_post_type_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'). + * - capabilities - Array of capabilities for this post type. + * * By default the capability_type is used as a base to construct capabilities. + * * You can see accepted values in {@link get_post_type_capabilities()}. * - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false. - * - hierarchical - Whether the post type is hierarchical. Defaults to false. - * - supports - An alias for calling add_post_type_support() directly. See {@link add_post_type_support()} - * for documentation. Defaults to none. + * - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false. + * - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor. + * * See {@link add_post_type_support()} for documentation. * - register_meta_box_cb - Provide a callback function that will be called when setting up the * meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback. * - taxonomies - An array of taxonomy identifiers that will be registered for the post type. - * Default is no taxonomies. Taxonomies can be registered later with register_taxonomy() or - * register_taxonomy_for_object_type(). - * - labels - An array of labels for this post type. By default post labels are used for non-hierarchical - * types and page labels for hierarchical ones. You can see accepted values in {@link get_post_type_labels()}. - * - has_archive - True to enable post type archives. Will generate the proper rewrite rules if rewrite is enabled. - * - rewrite - false to prevent rewrite. Defaults to true. Use array('slug'=>$slug) to customize permastruct; - * default will use $post_type as slug. Other options include 'with_front', 'feeds', 'pages', and 'ep_mask'. - * - query_var - false to prevent queries, or string to value of the query var to use for this post type - * - can_export - true allows this post type to be exported. - * - show_in_nav_menus - true makes this post type available for selection in navigation menus. + * * Default is no taxonomies. + * * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type(). + * - has_archive - True to enable post type archives. Default is false. + * * Will generate the proper rewrite rules if rewrite is enabled. + * - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug. + * * To prevent rewrite, set to false. + * * 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 Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true. + * * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive. + * * 'pages' => bool Should the permastruct provide for pagination. Defaults to true. + * * 'ep_mask' => const Assign an endpoint mask. + * * 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 - 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 - Allows this post type to be exported. Defaults to true. * - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY! * - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY! * * @since 2.9.0 * @uses $wp_post_types Inserts new post type object into the list * - * @param string $post_type Name of the post type. - * @param array|string $args See above description. + * @param string $post_type Post type key, must not exceed 20 characters + * @param array|string $args See optional args description above. * @return object|WP_Error the registered post type object, or an error object */ -function register_post_type($post_type, $args = array()) { +function register_post_type( $post_type, $args = array() ) { global $wp_post_types, $wp_rewrite, $wp; if ( !is_array($wp_post_types) )