Changeset 34250

Timestamp:

09/16/2015 09:59:16 PM (11 years ago)

Author:

boonebgorges

Message:

Don't notify post authors about spam comments.

[34106] moved post author notification to a hook, and in the process, missed
the 'spam' check. This changeset restores that check.

To make unit testing easier, the notification callbacks have been refactored
to return values: false when various conditions aren't met (eg, approved
comments should not trigger moderation emails), and the return value of the
wp_notify_*() function otherwise.

Props cfinke, kraftbj.
See #33587.

Location:

trunk

Files:

• src/wp-includes/comment-functions.php (modified) (3 diffs)
• tests/phpunit/tests/comment.php (modified) (1 diff)

trunk/src/wp-includes/comment-functions.php

@@ -1649 +1649 @@
  * @param int $comment_ID       ID of the comment.
  * @param int $comment_approved Whether the comment is approved.
+ * @return bool True on success, false on failure.
  */
 function wp_new_comment_notify_moderator( $comment_ID, $comment_approved ) {
-        if ( '0' == $comment_approved ) {
-                wp_notify_moderator( $comment_ID );
-        }
+        // Only send notifications for pending comments.
+        if ( '0' != $comment_approved ) {
+                return false;
+        }
+
+        return wp_notify_moderator( $comment_ID );
 }
 
@@ -1662 +1666 @@
  *
  * @param int $comment_ID ID of the comment.
+ * @return bool True on success, false on failure.
  */
 function wp_new_comment_notify_postauthor( $comment_ID ) {
@@ -1670 +1675 @@
          * By default, it won't, but filters can override this.
          */
-        if ( get_option( 'comments_notify' ) && $comment->comment_approved ) {
-                wp_notify_postauthor( $comment_ID );
-        }
+        if ( ! get_option( 'comments_notify' ) ) {
+                return false;
+        }
+
+        // Only send notifications for approved comments.
+        if ( 'spam' === $comment->comment_approved || ! $comment->comment_approved ) {
+                return false;
+        }
+
+        return wp_notify_postauthor( $comment_ID );
 }
 

trunk/tests/phpunit/tests/comment.php

@@ -260 +260 @@
                 $this->assertTrue( wp_notify_moderator( $c ) );
         }
+
+        /**
+         * @ticket 33587
+         */
+        public function test_wp_new_comment_notify_postauthor_should_not_send_email_when_comment_has_been_marked_as_spam() {
+                $p = $this->factory->post->create();
+                $c = $this->factory->comment->create( array(
+                        'comment_post_ID' => $p,
+                        'comment_approved' => 'spam',
+                ) );
+
+                $sent = wp_new_comment_notify_postauthor( $c );
+                $this->assertFalse( $sent );
+        }
 }