Changeset 48207

Timestamp:

06/28/2020 09:40:54 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct description for the $avoid_die parameter of wp_check_comment_flood().

The function always return a boolean value, never a WP_Error object.

See #49572, #39732.

File:

• trunk/src/wp-includes/comment.php (modified) (6 diffs)

trunk/src/wp-includes/comment.php

@@ -871 +871 @@
  * @param string $date      MySQL time string.
  * @param bool   $avoid_die When true, a disallowed comment will result in the function
- *                          returning a WP_Error object, rather than executing wp_die().
- *                          Default false.
+ *                          returning without executing wp_die() or die(). Default false.
  * @return bool Whether comment flooding is occurring.
  */
@@ -888 +887 @@
         return false;
     }
+
     $hour_ago = gmdate( 'Y-m-d H:i:s', time() - HOUR_IN_SECONDS );
 
@@ -898 +898 @@
     }
 
-    $sql      = $wpdb->prepare(
+    $sql = $wpdb->prepare(
         "SELECT `comment_date_gmt` FROM `$wpdb->comments` WHERE `comment_date_gmt` >= %s AND ( $check_column = %s OR `comment_author_email` = %s ) ORDER BY `comment_date_gmt` DESC LIMIT 1",
         $hour_ago,
@@ -904 +904 @@
         $email
     );
+
     $lasttime = $wpdb->get_var( $sql );
+
     if ( $lasttime ) {
         $time_lastcomment = mysql2date( 'U', $lasttime, false );
         $time_newcomment  = mysql2date( 'U', $date, false );
+
         /**
          * Filters the comment flood status.
@@ -918 +921 @@
          */
         $flood_die = apply_filters( 'comment_flood_filter', false, $time_lastcomment, $time_newcomment );
+
         if ( $flood_die ) {
             /**
@@ -929 +933 @@
             do_action( 'comment_flood_trigger', $time_lastcomment, $time_newcomment );
 
-            if ( true === $avoid_die ) {
+            if ( $avoid_die ) {
                 return true;
             } else {