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

Timestamp:

01/17/2017 05:17:15 AM (8 years ago)

Author:

rmccue

Message:

REST API: Allow shortcircuiting rest_pre_insert_comment

rest_pre_insert_{post_type} allows returning a WP_Error from the filter to shortcircuit actually creating the object, so it makes sense to do so for comments too.

Props dspilka.
Fixes #39578.

File:

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

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

@@ -553 +553 @@
          *
          * Allows modification of the comment right before it is inserted via wp_insert_comment().
+         * Returning a WP_Error value from the filter will shortcircuit insertion and allow
+         * skipping further processing.
          *
          * @since 4.7.0
-         *
-         * @param array           $prepared_comment The prepared comment data for wp_insert_comment().
+         * @since 4.8.0 $prepared_comment can now be a WP_Error to shortcircuit insertion.
+         *
+         * @param array|WP_Error  $prepared_comment The prepared comment data for wp_insert_comment().
          * @param WP_REST_Request $request          Request used to insert the comment.
          */
         $prepared_comment = apply_filters( 'rest_pre_insert_comment', $prepared_comment, $request );
+        if ( is_wp_error( $prepared_comment ) ) {
+            return $prepared_comment;
+        }
 
         $comment_id = wp_insert_comment( wp_filter_comment( wp_slash( (array) $prepared_comment ) ) );