Changeset 41980 for trunk/src/wp-includes/comment.php

Timestamp:

10/23/2017 10:11:11 PM (8 years ago)

Author:

peterwilsoncc

Message:

Comments: Check if wp_new_comment() returns an error.

Adds checks throughout to allow for wp_new_comment() returning a WP_Error instance.

Updates the docs for the pre_comment_approved filter to include that it can be passed an error.

Props enrico.sorcinelli, ryotsun.
Fixes #39730.

File:

• trunk/src/wp-includes/comment.php (modified) (1 diff)

trunk/src/wp-includes/comment.php

@@ -770 +770 @@
      *
      * @since 2.1.0
-     *
-     * @param bool|string $approved    The approval status. Accepts 1, 0, or 'spam'.
-     * @param array       $commentdata Comment data.
+     * @since 4.9.0 Returning a WP_Error value from the filter will shortcircuit comment insertion and
+     *              allow skipping further processing.
+     *
+     * @param bool|string|WP_Error $approved    The approval status. Accepts 1, 0, 'spam' or WP_Error.
+     * @param array                $commentdata Comment data.
      */
     $approved = apply_filters( 'pre_comment_approved', $approved, $commentdata );