WordPress.org

Make WordPress Core

Ticket #42117: 42117.2.diff

File 42117.2.diff, 23.1 KB (added by birgire, 4 years ago)
  • src/wp-includes/class-wp-post-type.php

    diff --git src/wp-includes/class-wp-post-type.php src/wp-includes/class-wp-post-type.php
    index ba37a02..56fccb5 100644
    final class WP_Post_Type { 
    359359         * Sets post type properties.
    360360         *
    361361         * @since 4.6.0
    362          *
    363          * @param array|string $args Array or string of arguments for registering a post type.
     362         * @since 3.0.0 The `show_ui` argument is now enforced on the new post screen.
     363         * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing
     364         *              screen and post editing screen.
     365         * @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
     366         *              arguments to register the post type in REST API.
     367         *
     368         * @param array|string $args {
     369         *     Array or string of arguments for registering a post type.
     370         *
     371         *     @type string      $label                 Name of the post type shown in the menu. Usually plural.
     372         *                                              Default is value of $labels['name'].
     373         *     @type array       $labels                An array of labels for this post type. If not set, post
     374         *                                              labels are inherited for non-hierarchical types and page
     375         *                                              labels for hierarchical ones. See get_post_type_labels() for a full
     376         *                                              list of supported labels.
     377         *     @type string      $description           A short descriptive summary of what the post type is.
     378         *                                              Default empty.
     379         *     @type bool        $public                Whether a post type is intended for use publicly either via
     380         *                                              the admin interface or by front-end users. While the default
     381         *                                              settings of $exclude_from_search, $publicly_queryable, $show_ui,
     382         *                                              and $show_in_nav_menus are inherited from public, each does not
     383         *                                              rely on this relationship and controls a very specific intention.
     384         *                                              Default false.
     385         *     @type bool        $hierarchical          Whether the post type is hierarchical (e.g. page). Default false.
     386         *     @type bool        $exclude_from_search   Whether to exclude posts with this post type from front end search
     387         *                                              results. Default is the opposite value of $public.
     388         *     @type bool        $publicly_queryable    Whether queries can be performed on the front end for the post type
     389         *                                              as part of parse_request(). Endpoints would include:
     390         *                                              * ?post_type={post_type_key}
     391         *                                              * ?{post_type_key}={single_post_slug}
     392         *                                              * ?{post_type_query_var}={single_post_slug}
     393         *                                              If not set, the default is inherited from $public.
     394         *     @type bool        $show_ui               Whether to generate and allow a UI for managing this post type in the
     395         *                                              admin. Default is value of $public.
     396         *     @type bool        $show_in_menu          Where to show the post type in the admin menu. To work, $show_ui
     397         *                                              must be true. If true, the post type is shown in its own top level
     398         *                                              menu. If false, no menu is shown. If a string of an existing top
     399         *                                              level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post
     400         *                                              type will be placed as a sub-menu of that.
     401         *                                              Default is value of $show_ui.
     402         *     @type bool        $show_in_nav_menus     Makes this post type available for selection in navigation menus.
     403         *                                              Default is value $public.
     404         *     @type bool        $show_in_admin_bar     Makes this post type available via the admin bar. Default is value
     405         *                                              of $show_in_menu.
     406         *     @type bool        $show_in_rest          Whether to add the post type route in the REST API 'wp/v2' namespace.
     407         *     @type string      $rest_base             To change the base url of REST API route. Default is $post_type.
     408         *     @type string      $rest_controller_class REST API Controller class name. Default is 'WP_REST_Posts_Controller'.
     409         *     @type int         $menu_position         The position in the menu order the post type should appear. To work,
     410         *                                              $show_in_menu must be true. Default null (at the bottom).
     411         *     @type string      $menu_icon             The url to the icon to be used for this menu. Pass a base64-encoded
     412         *                                              SVG using a data URI, which will be colored to match the color scheme
     413         *                                              -- this should begin with 'data:image/svg+xml;base64,'. Pass the name
     414         *                                              of a Dashicons helper class to use a font icon, e.g.
     415         *                                              'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty
     416         *                                              so an icon can be added via CSS. Defaults to use the posts icon.
     417         *     @type string      $capability_type       The string to use to build the read, edit, and delete capabilities.
     418         *                                              May be passed as an array to allow for alternative plurals when using
     419         *                                              this argument as a base to construct the capabilities, e.g.
     420         *                                              array('story', 'stories'). Default 'post'.
     421         *     @type array       $capabilities          Array of capabilities for this post type. $capability_type is used
     422         *                                              as a base to construct capabilities by default.
     423         *                                              See get_post_type_capabilities().
     424         *     @type bool        $map_meta_cap          Whether to use the internal default meta capability handling.
     425         *                                              Default false.
     426         *     @type array       $supports              Core feature(s) the post type supports. Serves as an alias for calling
     427         *                                              add_post_type_support() directly. Core features include 'title',
     428         *                                              'editor', 'comments', 'revisions', 'trackbacks', 'author', 'excerpt',
     429         *                                              'page-attributes', 'thumbnail', 'custom-fields', and 'post-formats'.
     430         *                                              Additionally, the 'revisions' feature dictates whether the post type
     431         *                                              will store revisions, and the 'comments' feature dictates whether the
     432         *                                              comments count will show on the edit screen. Defaults is an array
     433         *                                              containing 'title' and 'editor'.
     434         *     @type callable    $register_meta_box_cb  Provide a callback function that sets up the meta boxes for the
     435         *                                              edit form. Do remove_meta_box() and add_meta_box() calls in the
     436         *                                              callback. Default null.
     437         *     @type array       $taxonomies            An array of taxonomy identifiers that will be registered for the
     438         *                                              post type. Taxonomies can be registered later with register_taxonomy()
     439         *                                              or register_taxonomy_for_object_type().
     440         *                                              Default empty array.
     441         *     @type bool|string $has_archive           Whether there should be post type archives, or if a string, the
     442         *                                              archive slug to use. Will generate the proper rewrite rules if
     443         *                                              $rewrite is enabled. Default false.
     444         *     @type bool|array  $rewrite              {
     445         *         Triggers the handling of rewrites for this post type. To prevent rewrite, set to false.
     446         *         Defaults to true, using $post_type as slug. To specify rewrite rules, an array can be
     447         *         passed with any of these keys:
     448         *
     449         *         @type string $slug       Customize the permastruct slug. Defaults to $post_type key.
     450         *         @type bool   $with_front Whether the permastruct should be prepended with WP_Rewrite::$front.
     451         *                                  Default true.
     452         *         @type bool   $feeds      Whether the feed permastruct should be built for this post type.
     453         *                                  Default is value of $has_archive.
     454         *         @type bool   $pages      Whether the permastruct should provide for pagination. Default true.
     455         *         @type const  $ep_mask    Endpoint mask to assign. If not specified and permalink_epmask is set,
     456         *                                  inherits from $permalink_epmask. If not specified and permalink_epmask
     457         *                                  is not set, defaults to EP_PERMALINK.
     458         *     }
     459         *     @type string|bool $query_var             Sets the query_var key for this post type. Defaults to $post_type
     460         *                                              key. If false, a post type cannot be loaded at
     461         *                                              ?{query_var}={post_slug}. If specified as a string, the query
     462         *                                              ?{query_var_string}={post_slug} will be valid.
     463         *     @type bool        $can_export            Whether to allow this post type to be exported. Default true.
     464         *     @type bool        $delete_with_user      Whether to delete posts of this type when deleting a user. If true,
     465         *                                              posts of this type belonging to the user will be moved to trash
     466         *                                              when then user is deleted. If false, posts of this type belonging
     467         *                                              to the user will *not* be trashed or deleted. If not set (the default),
     468         *                                              posts are trashed if post_type_supports('author'). Otherwise posts
     469         *                                              are not trashed or deleted. Default null.
     470         *     @type bool        $_builtin              FOR INTERNAL USE ONLY! True if this post type is a native or
     471         *                                              "built-in" post_type. Default false.
     472         *     @type string      $_edit_link            FOR INTERNAL USE ONLY! URL segment to use for edit link of
     473         *                                              this post type. Default 'post.php?post=%d'.
     474         * }
    364475         */
    365476        public function set_props( $args ) {
    366477                $args = wp_parse_args( $args );
  • src/wp-includes/post.php

    diff --git src/wp-includes/post.php src/wp-includes/post.php
    index e6f1340..bb548f7 100644
    function get_page_statuses() { 
    744744 * @param string $post_status Name of the post status.
    745745 * @param array|string $args {
    746746 *     Optional. Array or string of post status arguments.
     747 *     See WP_Post_Type::set_props() for all available arguments.
    747748 *
    748749 *     @type bool|string $label                     A descriptive name for the post status marked
    749750 *                                                  for translation. Defaults to value of $post_status.
    function get_post_types( $args = array(), $output = 'names', $operator = 'and' ) 
    996997 * list of supported features.
    997998 *
    998999 * @since 2.9.0
    999  * @since 3.0.0 The `show_ui` argument is now enforced on the new post screen.
    1000  * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing
    1001  *              screen and post editing screen.
    10021000 * @since 4.6.0 Post type object returned is now an instance of WP_Post_Type.
    1003  * @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
    1004  *              arguments to register the post type in REST API.
    10051001 *
    10061002 * @global array $wp_post_types List of post types.
    10071003 *
    10081004 * @param string $post_type Post type key. Must not exceed 20 characters and may
    10091005 *                          only contain lowercase alphanumeric characters, dashes,
    10101006 *                          and underscores. See sanitize_key().
    1011  * @param array|string $args {
    1012  *     Array or string of arguments for registering a post type.
    1013  *
    1014  *     @type string      $label                 Name of the post type shown in the menu. Usually plural.
    1015  *                                              Default is value of $labels['name'].
    1016  *     @type array       $labels                An array of labels for this post type. If not set, post
    1017  *                                              labels are inherited for non-hierarchical types and page
    1018  *                                              labels for hierarchical ones. See get_post_type_labels() for a full
    1019  *                                              list of supported labels.
    1020  *     @type string      $description           A short descriptive summary of what the post type is.
    1021  *                                              Default empty.
    1022  *     @type bool        $public                Whether a post type is intended for use publicly either via
    1023  *                                              the admin interface or by front-end users. While the default
    1024  *                                              settings of $exclude_from_search, $publicly_queryable, $show_ui,
    1025  *                                              and $show_in_nav_menus are inherited from public, each does not
    1026  *                                              rely on this relationship and controls a very specific intention.
    1027  *                                              Default false.
    1028  *     @type bool        $hierarchical          Whether the post type is hierarchical (e.g. page). Default false.
    1029  *     @type bool        $exclude_from_search   Whether to exclude posts with this post type from front end search
    1030  *                                              results. Default is the opposite value of $public.
    1031  *     @type bool        $publicly_queryable    Whether queries can be performed on the front end for the post type
    1032  *                                              as part of parse_request(). Endpoints would include:
    1033  *                                              * ?post_type={post_type_key}
    1034  *                                              * ?{post_type_key}={single_post_slug}
    1035  *                                              * ?{post_type_query_var}={single_post_slug}
    1036  *                                              If not set, the default is inherited from $public.
    1037  *     @type bool        $show_ui               Whether to generate and allow a UI for managing this post type in the
    1038  *                                              admin. Default is value of $public.
    1039  *     @type bool        $show_in_menu          Where to show the post type in the admin menu. To work, $show_ui
    1040  *                                              must be true. If true, the post type is shown in its own top level
    1041  *                                              menu. If false, no menu is shown. If a string of an existing top
    1042  *                                              level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post
    1043  *                                              type will be placed as a sub-menu of that.
    1044  *                                              Default is value of $show_ui.
    1045  *     @type bool        $show_in_nav_menus     Makes this post type available for selection in navigation menus.
    1046  *                                              Default is value $public.
    1047  *     @type bool        $show_in_admin_bar     Makes this post type available via the admin bar. Default is value
    1048  *                                              of $show_in_menu.
    1049  *     @type bool        $show_in_rest          Whether to add the post type route in the REST API 'wp/v2' namespace.
    1050  *     @type string      $rest_base             To change the base url of REST API route. Default is $post_type.
    1051  *     @type string      $rest_controller_class REST API Controller class name. Default is 'WP_REST_Posts_Controller'.
    1052  *     @type int         $menu_position         The position in the menu order the post type should appear. To work,
    1053  *                                              $show_in_menu must be true. Default null (at the bottom).
    1054  *     @type string      $menu_icon             The url to the icon to be used for this menu. Pass a base64-encoded
    1055  *                                              SVG using a data URI, which will be colored to match the color scheme
    1056  *                                              -- this should begin with 'data:image/svg+xml;base64,'. Pass the name
    1057  *                                              of a Dashicons helper class to use a font icon, e.g.
    1058  *                                              'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty
    1059  *                                              so an icon can be added via CSS. Defaults to use the posts icon.
    1060  *     @type string      $capability_type       The string to use to build the read, edit, and delete capabilities.
    1061  *                                              May be passed as an array to allow for alternative plurals when using
    1062  *                                              this argument as a base to construct the capabilities, e.g.
    1063  *                                              array('story', 'stories'). Default 'post'.
    1064  *     @type array       $capabilities          Array of capabilities for this post type. $capability_type is used
    1065  *                                              as a base to construct capabilities by default.
    1066  *                                              See get_post_type_capabilities().
    1067  *     @type bool        $map_meta_cap          Whether to use the internal default meta capability handling.
    1068  *                                              Default false.
    1069  *     @type array       $supports              Core feature(s) the post type supports. Serves as an alias for calling
    1070  *                                              add_post_type_support() directly. Core features include 'title',
    1071  *                                              'editor', 'comments', 'revisions', 'trackbacks', 'author', 'excerpt',
    1072  *                                              'page-attributes', 'thumbnail', 'custom-fields', and 'post-formats'.
    1073  *                                              Additionally, the 'revisions' feature dictates whether the post type
    1074  *                                              will store revisions, and the 'comments' feature dictates whether the
    1075  *                                              comments count will show on the edit screen. Defaults is an array
    1076  *                                              containing 'title' and 'editor'.
    1077  *     @type callable    $register_meta_box_cb  Provide a callback function that sets up the meta boxes for the
    1078  *                                              edit form. Do remove_meta_box() and add_meta_box() calls in the
    1079  *                                              callback. Default null.
    1080  *     @type array       $taxonomies            An array of taxonomy identifiers that will be registered for the
    1081  *                                              post type. Taxonomies can be registered later with register_taxonomy()
    1082  *                                              or register_taxonomy_for_object_type().
    1083  *                                              Default empty array.
    1084  *     @type bool|string $has_archive           Whether there should be post type archives, or if a string, the
    1085  *                                              archive slug to use. Will generate the proper rewrite rules if
    1086  *                                              $rewrite is enabled. Default false.
    1087  *     @type bool|array  $rewrite              {
    1088  *         Triggers the handling of rewrites for this post type. To prevent rewrite, set to false.
    1089  *         Defaults to true, using $post_type as slug. To specify rewrite rules, an array can be
    1090  *         passed with any of these keys:
    1091  *
    1092  *         @type string $slug       Customize the permastruct slug. Defaults to $post_type key.
    1093  *         @type bool   $with_front Whether the permastruct should be prepended with WP_Rewrite::$front.
    1094  *                                  Default true.
    1095  *         @type bool   $feeds      Whether the feed permastruct should be built for this post type.
    1096  *                                  Default is value of $has_archive.
    1097  *         @type bool   $pages      Whether the permastruct should provide for pagination. Default true.
    1098  *         @type const  $ep_mask    Endpoint mask to assign. If not specified and permalink_epmask is set,
    1099  *                                  inherits from $permalink_epmask. If not specified and permalink_epmask
    1100  *                                  is not set, defaults to EP_PERMALINK.
    1101  *     }
    1102  *     @type string|bool $query_var             Sets the query_var key for this post type. Defaults to $post_type
    1103  *                                              key. If false, a post type cannot be loaded at
    1104  *                                              ?{query_var}={post_slug}. If specified as a string, the query
    1105  *                                              ?{query_var_string}={post_slug} will be valid.
    1106  *     @type bool        $can_export            Whether to allow this post type to be exported. Default true.
    1107  *     @type bool        $delete_with_user      Whether to delete posts of this type when deleting a user. If true,
    1108  *                                              posts of this type belonging to the user will be moved to trash
    1109  *                                              when then user is deleted. If false, posts of this type belonging
    1110  *                                              to the user will *not* be trashed or deleted. If not set (the default),
    1111  *                                              posts are trashed if post_type_supports('author'). Otherwise posts
    1112  *                                              are not trashed or deleted. Default null.
    1113  *     @type bool        $_builtin              FOR INTERNAL USE ONLY! True if this post type is a native or
    1114  *                                              "built-in" post_type. Default false.
    1115  *     @type string      $_edit_link            FOR INTERNAL USE ONLY! URL segment to use for edit link of
    1116  *                                              this post type. Default 'post.php?post=%d'.
    1117  * }
     1007 * @param array|string $args  Array or string of arguments for registering a post type.
     1008 *                            See WP_Post_Type::set_props() for for all available arguments.
    11181009 * @return WP_Post_Type|WP_Error The registered post type object, or an error object.
    11191010 */
    11201011function register_post_type( $post_type, $args = array() ) {