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

Timestamp:

11/23/2016 03:32:25 PM (9 years ago)

Author:

rachelbaker

Message:

REST API: Always fire the rest_insert_* actions after the related object is updated or inserted.

Brings consistency to the rest_insert_* actions. Also includes some shuffling and clean-up as well including:

• Ensure we are passing the most current $post and $user objects to the update_additional_fields_for_object() callbacks.
• Changes the function signature of handle_status_param() in the Comments controller to accept just the comment_id as the 2nd parameter, instead of a full WP_Comment object. Only the comment_id is needed in the method, this avoids having to include another get_comment() call.
• Renames a variable in the create_item() method of the Posts controller from $post -> $prepared_post to be more explicit.
• Minor fixes/clarifications to the rest_insert_* hook docs

Props rachelbaker, joehoyle
Fixes #38905.

File:

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

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

@@ -568 +568 @@
 
         if ( isset( $request['status'] ) ) {
-            $comment = get_comment( $comment_id );
-
-            $this->handle_status_param( $request['status'], $comment );
-        }
+            $this->handle_status_param( $request['status'], $comment_id );
+        }
+
+        $comment = get_comment( $comment_id );
+
+        /**
+         * Fires after a comment is created or updated via the REST API.
+         *
+         * @since 4.7.0
+         *
+         * @param WP_Comment      $comment  Inserted or updated comment object.
+         * @param WP_REST_Request $request  Request object.
+         * @param bool            $creating True when creating a comment, false
+         *                                  when updating.
+         */
+        do_action( 'rest_insert_comment', $comment, $request, true );
 
         $schema = $this->get_item_schema();
@@ -583 +595 @@
         }
 
-        $comment = get_comment( $comment_id );
-
         $fields_update = $this->update_additional_fields_for_object( $comment, $request );
 
@@ -601 +611 @@
         $response->header( 'Location', rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $comment_id ) ) );
 
-        /**
-         * Fires after a comment is created or updated via the REST API.
-         *
-         * @since 4.7.0
-         *
-         * @param array           $comment  Comment as it exists in the database.
-         * @param WP_REST_Request $request  The request sent to the API.
-         * @param bool            $creating True when creating a comment, false when updating.
-         */
-        do_action( 'rest_insert_comment', $comment, $request, true );
 
         return $response;
@@ -667 +667 @@
         if ( empty( $prepared_args ) && isset( $request['status'] ) ) {
             // Only the comment status is being changed.
-            $change = $this->handle_status_param( $request['status'], $comment );
+            $change = $this->handle_status_param( $request['status'], $id );
 
             if ( ! $change ) {
@@ -696 +696 @@
 
             if ( isset( $request['status'] ) ) {
-                $this->handle_status_param( $request['status'], $comment );
-            }
-        }
+                $this->handle_status_param( $request['status'], $id );
+            }
+        }
+
+        $comment = get_comment( $id );
+
+        /* This action is documented in lib/endpoints/class-wp-rest-comments-controller.php */
+        do_action( 'rest_insert_comment', $comment, $request, false );
 
         $schema = $this->get_item_schema();
@@ -710 +715 @@
         }
 
-        $comment = get_comment( $id );
-
         $fields_update = $this->update_additional_fields_for_object( $comment, $request );
 
@@ -721 +724 @@
 
         $response = $this->prepare_item_for_response( $comment, $request );
-
-        /* This action is documented in lib/endpoints/class-wp-rest-comments-controller.php */
-        do_action( 'rest_insert_comment', $comment, $request, false );
 
         return rest_ensure_response( $response );
@@ -1434 +1434 @@
      *
      * @param string|int $new_status New comment status.
-     * @param WP_Comment $comment    Comment data.
+     * @param int        $comment_id Comment ID.
      * @return bool Whether the status was changed.
      */
-    protected function handle_status_param( $new_status, $comment ) {
-        $old_status = wp_get_comment_status( $comment->comment_ID );
+    protected function handle_status_param( $new_status, $comment_id ) {
+        $old_status = wp_get_comment_status( $comment_id );
 
         if ( $new_status === $old_status ) {
@@ -1448 +1448 @@
             case 'approve':
             case '1':
-                $changed = wp_set_comment_status( $comment->comment_ID, 'approve' );
+                $changed = wp_set_comment_status( $comment_id, 'approve' );
                 break;
             case 'hold':
             case '0':
-                $changed = wp_set_comment_status( $comment->comment_ID, 'hold' );
+                $changed = wp_set_comment_status( $comment_id, 'hold' );
                 break;
             case 'spam' :
-                $changed = wp_spam_comment( $comment->comment_ID );
+                $changed = wp_spam_comment( $comment_id );
                 break;
             case 'unspam' :
-                $changed = wp_unspam_comment( $comment->comment_ID );
+                $changed = wp_unspam_comment( $comment_id );
                 break;
             case 'trash' :
-                $changed = wp_trash_comment( $comment->comment_ID );
+                $changed = wp_trash_comment( $comment_id );
                 break;
             case 'untrash' :
-                $changed = wp_untrash_comment( $comment->comment_ID );
+                $changed = wp_untrash_comment( $comment_id );
                 break;
             default :