Changeset 39104 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Timestamp:

11/03/2016 01:45:48 AM (8 years ago)

Author:

joehoyle

Message:

REST API: Support querying for multiple post statuses.

Multiple post statuses can be specified by the usual CSV or array-propper format.

Props jnylen0, kadamwhite, websupporter.
Fixes #38420.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -2121 +2121 @@
         $params['status'] = array(
             'default'           => 'publish',
-            'description'       => __( 'Limit result set to posts assigned a specific status; can be comma-delimited list of status types.' ),
-            'enum'              => array_merge( array_keys( get_post_stati() ), array( 'any' ) ),
-            'sanitize_callback' => 'sanitize_key',
-            'type'              => 'string',
-            'validate_callback' => array( $this, 'validate_user_can_query_private_statuses' ),
+            'description'       => __( 'Limit result set to posts assigned one or more statuses.' ),
+            'type'              => 'array',
+            'items'             => array(
+                'enum'          => array_merge( array_keys( get_post_stati() ), array( 'any' ) ),
+                'type'          => 'string',
+            ),
+            'sanitize_callback' => array( $this, 'sanitize_post_statuses' ),
         );
 
@@ -2153 +2155 @@
 
     /**
-     * Validates whether the user can query private statuses.
+     * Sanitizes and validates the list of post statuses, including whether the
+     * user can query private statuses.
      *
      * @since 4.7.0
      * @access public
      *
-     * @param  mixed           $value     Post status.
+     * @param  string|array    $statuses  One or more post statuses.
      * @param  WP_REST_Request $request   Full details about the request.
      * @param  string          $parameter Additional parameter to pass to validation.
-     * @return bool|WP_Error Whether the request can query private statuses, otherwise WP_Error object.
-     */
-    public function validate_user_can_query_private_statuses( $value, $request, $parameter ) {
-        if ( 'publish' === $value ) {
-            return rest_validate_request_arg( $value, $request, $parameter );
-        }
-
-        $post_type_obj = get_post_type_object( $this->post_type );
-
-        if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
-            return rest_validate_request_arg( $value, $request, $parameter );
-        }
-
-        return new WP_Error( 'rest_forbidden_status', __( 'Status is forbidden.' ), array( 'status' => rest_authorization_required_code() ) );
+     * @return array|WP_Error A list of valid statuses, otherwise WP_Error object.
+     */
+    public function sanitize_post_statuses( $statuses, $request, $parameter ) {
+        $statuses = wp_parse_slug_list( $statuses );
+
+        // The default status is different in WP_REST_Attachments_Controller
+        $attributes = $request->get_attributes();
+        $default_status = $attributes['args']['status']['default'];
+
+        foreach ( $statuses as $status ) {
+            if ( $status === $default_status ) {
+                continue;
+            }
+
+            $post_type_obj = get_post_type_object( $this->post_type );
+
+            if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
+                $result = rest_validate_request_arg( $status, $request, $parameter );
+                if ( is_wp_error( $result ) ) {
+                    return $result;
+                }
+            } else {
+                return new WP_Error( 'rest_forbidden_status', __( 'Status is forbidden.' ), array( 'status' => rest_authorization_required_code() ) );
+            }
+        }
+
+        return $statuses;
     }
 }