Changeset 39954 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Timestamp:

01/26/2017 01:38:27 PM (6 years ago)

Author:

joehoyle

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.

See #38792.

File:

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

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

@@ -64 +64 @@
 
         register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array(
+            'args' => array(
+                'id' => array(
+                    'description' => __( 'Unique identifier for the object.' ),
+                    'type'        => 'integer',
+                ),
+            ),
             array(
                 'methods'  => WP_REST_Server::READABLE,
@@ -301 +307 @@
 
     /**
+     * Get the comment, if the ID is valid.
+     *
+     * @since 4.7.2
+     *
+     * @param int $id Supplied ID.
+     * @return WP_Comment|WP_Error Comment object if ID is valid, WP_Error otherwise.
+     */
+    protected function get_comment( $id ) {
+        $error = new WP_Error( 'rest_comment_invalid_id', __( 'Invalid comment ID.' ), array( 'status' => 404 ) );
+        if ( (int) $id <= 0 ) {
+            return $error;
+        }
+
+        $id = (int) $id;
+        $comment = get_comment( $id );
+        if ( empty( $comment ) ) {
+            return $error;
+        }
+
+        if ( ! empty( $comment->comment_post_ID ) ) {
+            $post = get_post( (int) $comment->comment_post_ID );
+            if ( empty( $post ) ) {
+                return new WP_Error( 'rest_post_invalid_id', __( 'Invalid post ID.' ), array( 'status' => 404 ) );
+            }
+        }
+
+        return $comment;
+    }
+
+    /**
      * Checks if a given request has access to read the comment.
      *
@@ -310 +346 @@
      */
     public function get_item_permissions_check( $request ) {
-        $id = (int) $request['id'];
-
-        $comment = get_comment( $id );
-
-        if ( ! $comment ) {
-            return true;
+        $comment = $this->get_comment( $request['id'] );
+        if ( is_wp_error( $comment ) ) {
+            return $comment;
         }
 
@@ -345 +378 @@
      */
     public function get_item( $request ) {
-        $id = (int) $request['id'];
-
-        $comment = get_comment( $id );
-        if ( empty( $comment ) ) {
-            return new WP_Error( 'rest_comment_invalid_id', __( 'Invalid comment ID.' ), array( 'status' => 404 ) );
-        }
-
-        if ( ! empty( $comment->comment_post_ID ) ) {
-            $post = get_post( $comment->comment_post_ID );
-            if ( empty( $post ) ) {
-                return new WP_Error( 'rest_post_invalid_id', __( 'Invalid post ID.' ), array( 'status' => 404 ) );
-            }
+        $comment = $this->get_comment( $request['id'] );
+        if ( is_wp_error( $comment ) ) {
+            return $comment;
         }
 
@@ -631 +655 @@
      */
     public function update_item_permissions_check( $request ) {
-
-        $id = (int) $request['id'];
-
-        $comment = get_comment( $id );
-
-        if ( $comment && ! $this->check_edit_permission( $comment ) ) {
+        $comment = $this->get_comment( $request['id'] );
+        if ( is_wp_error( $comment ) ) {
+            return $comment;
+        }
+
+        if ( ! $this->check_edit_permission( $comment ) ) {
             return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this comment.' ), array( 'status' => rest_authorization_required_code() ) );
         }
@@ -653 +677 @@
      */
     public function update_item( $request ) {
-        $id = (int) $request['id'];
-
-        $comment = get_comment( $id );
-
-        if ( empty( $comment ) ) {
-            return new WP_Error( 'rest_comment_invalid_id', __( 'Invalid comment ID.' ), array( 'status' => 404 ) );
-        }
+        $comment = $this->get_comment( $request['id'] );
+        if ( is_wp_error( $comment ) ) {
+            return $comment;
+        }
+
+        $id = $comment->comment_ID;
 
         if ( isset( $request['type'] ) && get_comment_type( $id ) !== $request['type'] ) {
@@ -751 +774 @@
      */
     public function delete_item_permissions_check( $request ) {
-        $id      = (int) $request['id'];
-        $comment = get_comment( $id );
-
-        if ( ! $comment ) {
-            return new WP_Error( 'rest_comment_invalid_id', __( 'Invalid comment ID.' ), array( 'status' => 404 ) );
+        $comment = $this->get_comment( $request['id'] );
+        if ( is_wp_error( $comment ) ) {
+            return $comment;
         }
 
@@ -774 +795 @@
      */
     public function delete_item( $request ) {
-        $id    = (int) $request['id'];
+        $comment = $this->get_comment( $request['id'] );
+        if ( is_wp_error( $comment ) ) {
+            return $comment;
+        }
+
         $force = isset( $request['force'] ) ? (bool) $request['force'] : false;
-
-        $comment = get_comment( $id );
-
-        if ( empty( $comment ) ) {
-            return new WP_Error( 'rest_comment_invalid_id', __( 'Invalid comment ID.' ), array( 'status' => 404 ) );
-        }
 
         /**