Changeset 39957 for branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Timestamp:

01/26/2017 01:46:54 PM (10 years ago)

Author:

ocean90

Message:

REST API: Unify object access handling for simplicity.

Rather than repeating ourselves, unifying the access into a single method keeps everything tidy. While we're at it, add in additional schema handling for common parameters.

Merge of [39954] to the 4.7 branch.

See #38792.

Location:

branches/4.7

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php (modified) (11 diffs)

branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

@@ -72 +72 @@
 
                 register_rest_route( $this->namespace, '/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base, array(
+                        'args' => array(
+                                'parent' => array(
+                                        'description' => __( 'The ID for the parent of the object.' ),
+                                        'type'        => 'integer',
+                                ),
+                        ),
                         array(
                                 'methods'             => WP_REST_Server::READABLE,
@@ -82 +88 @@
 
                 register_rest_route( $this->namespace, '/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base . '/(?P<id>[\d]+)', array(
+                        'args' => array(
+                                'parent' => array(
+                                        'description' => __( 'The ID for the parent of the object.' ),
+                                        'type'        => 'integer',
+                                ),
+                                'id' => array(
+                                        'description' => __( 'Unique identifier for the object.' ),
+                                        'type'        => 'integer',
+                                ),
+                        ),
                         array(
                                 'methods'             => WP_REST_Server::READABLE,
@@ -108 +124 @@
 
         /**
+         * Get the parent post, if the ID is valid.
+         *
+         * @since 4.7.2
+         *
+         * @param int $id Supplied ID.
+         * @return WP_Post|WP_Error Post object if ID is valid, WP_Error otherwise.
+         */
+        protected function get_parent( $parent ) {
+                $error = new WP_Error( 'rest_post_invalid_parent', __( 'Invalid post parent ID.' ), array( 'status' => 404 ) );
+                if ( (int) $parent <= 0 ) {
+                        return $error;
+                }
+
+                $parent = get_post( (int) $parent );
+                if ( empty( $parent ) || empty( $parent->ID ) || $this->parent_post_type !== $parent->post_type ) {
+                        return $error;
+                }
+
+                return $parent;
+        }
+
+        /**
          * Checks if a given request has access to get revisions.
          *
@@ -117 +155 @@
          */
         public function get_items_permissions_check( $request ) {
-
-                $parent = get_post( $request['parent'] );
-                if ( ! $parent ) {
-                        return true;
-                }
+                $parent = $this->get_parent( $request['parent'] );
+                if ( is_wp_error( $parent ) ) {
+                        return $parent;
+                }
+
                 $parent_post_type_obj = get_post_type_object( $parent->post_type );
                 if ( ! current_user_can( $parent_post_type_obj->cap->edit_post, $parent->ID ) ) {
@@ -131 +169 @@
 
         /**
+         * Get the revision, if the ID is valid.
+         *
+         * @since 4.7.2
+         *
+         * @param int $id Supplied ID.
+         * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise.
+         */
+        protected function get_revision( $id ) {
+                $error = new WP_Error( 'rest_post_invalid_id', __( 'Invalid revision ID.' ), array( 'status' => 404 ) );
+                if ( (int) $id <= 0 ) {
+                        return $error;
+                }
+
+                $revision = get_post( (int) $id );
+                if ( empty( $revision ) || empty( $revision->ID ) || 'revision' !== $revision->post_type ) {
+                        return $error;
+                }
+
+                return $revision;
+        }
+
+        /**
          * Gets a collection of revisions.
          *
@@ -140 +200 @@
          */
         public function get_items( $request ) {
-                $parent = get_post( $request['parent'] );
-                if ( ! $request['parent'] || ! $parent || $this->parent_post_type !== $parent->post_type ) {
-                        return new WP_Error( 'rest_post_invalid_parent', __( 'Invalid post parent ID.' ), array( 'status' => 404 ) );
+                $parent = $this->get_parent( $request['parent'] );
+                if ( is_wp_error( $parent ) ) {
+                        return $parent;
                 }
 
@@ -178 +238 @@
          */
         public function get_item( $request ) {
-                $parent = get_post( $request['parent'] );
-                if ( ! $request['parent'] || ! $parent || $this->parent_post_type !== $parent->post_type ) {
-                        return new WP_Error( 'rest_post_invalid_parent', __( 'Invalid post parent ID.' ), array( 'status' => 404 ) );
-                }
-
-                $revision = get_post( $request['id'] );
-                if ( ! $revision || 'revision' !== $revision->post_type ) {
-                        return new WP_Error( 'rest_post_invalid_id', __( 'Invalid revision ID.' ), array( 'status' => 404 ) );
+                $parent = $this->get_parent( $request['parent'] );
+                if ( is_wp_error( $parent ) ) {
+                        return $parent;
+                }
+
+                $revision = $this->get_revision( $request['id'] );
+                if ( is_wp_error( $revision ) ) {
+                        return $revision;
                 }
 
@@ -202 +262 @@
          */
         public function delete_item_permissions_check( $request ) {
+                $parent = $this->get_parent( $request['parent'] );
+                if ( is_wp_error( $parent ) ) {
+                        return $parent;
+                }
+
+                $revision = $this->get_revision( $request['id'] );
+                if ( is_wp_error( $revision ) ) {
+                        return $revision;
+                }
 
                 $response = $this->get_items_permissions_check( $request );
@@ -208 +277 @@
                 }
 
-                $post = get_post( $request['id'] );
-                if ( ! $post ) {
-                        return new WP_Error( 'rest_post_invalid_id', __( 'Invalid revision ID.' ), array( 'status' => 404 ) );
-                }
                 $post_type = get_post_type_object( 'revision' );
-                return current_user_can( $post_type->cap->delete_post, $post->ID );
+                return current_user_can( $post_type->cap->delete_post, $revision->ID );
         }
 
@@ -226 +291 @@
          */
         public function delete_item( $request ) {
+                $revision = $this->get_revision( $request['id'] );
+                if ( is_wp_error( $revision ) ) {
+                        return $revision;
+                }
+
                 $force = isset( $request['force'] ) ? (bool) $request['force'] : false;
 
@@ -233 +303 @@
                 }
 
-                $revision = get_post( $request['id'] );
                 $previous = $this->prepare_item_for_response( $revision, $request );