Changeset 26367

Timestamp:

11/25/2013 01:46:49 AM (11 years ago)

Author:

markjaquith

Message:

Fix comment_notification_recipients filter behavior so that it is still respected even on comments left by the post author

The code was bailing on this-is-a-comment-on-your-own-post detection, ignoring additional recipients. Now:

• Logic check is done within wp_notify_postauthor()
• Logic check is overridable via comment_notification_notify_author filter (default still false)
• The code doesn't bail on comment-on-own-post detection, but just removes the author from the array
• The code instead now bails if the recipients list is empty, so comment_notification_recipients works properly

props ethitter.
fixes #25699

Location:

trunk/src/wp-includes

Files:

• comment.php (modified) (3 diffs)
• pluggable.php (modified) (5 diffs)

trunk/src/wp-includes/comment.php

@@ -1378 +1378 @@
  *
  * @since 1.5.0
- * @uses apply_filters() Calls 'preprocess_comment' hook on $commentdata parameter array before processing
- * @uses do_action() Calls 'comment_post' hook on $comment_ID returned from adding the comment and if the comment was approved.
- * @uses wp_filter_comment() Used to filter comment before adding comment.
- * @uses wp_allow_comment() checks to see if comment is approved.
- * @uses wp_insert_comment() Does the actual comment insertion to the database.
- *
  * @param array $commentdata Contains information on the comment.
+ * @uses apply_filters()
+ * @uses wp_get_comment_status()
+ * @uses wp_filter_comment()
+ * @uses wp_allow_comment()
+ * @uses wp_insert_comment()
+ * @uses do_action()
+ * @uses wp_notify_moderator()
+ * @uses get_option()
+ * @uses wp_notify_postauthor()
  * @return int The ID of the comment after adding.
  */
@@ -1419 +1422 @@
         }
 
-        if ( get_option('comments_notify') && $commentdata['comment_approved'] ) {
-            $post = get_post( $commentdata['comment_post_ID'] );
-            // Don't notify if it's your own comment
-            if ( ! isset( $commentdata['user_id'] ) || $post->post_author != $commentdata['user_id'] ) {
-                wp_notify_postauthor( $comment_ID );
-            }
+        // wp_notify_postauthor() checks if notifying the author of their own comment.
+        // By default, it won't, but filters can override this.
+        if ( get_option( 'comments_notify' ) && $commentdata['comment_approved'] ) {
+            wp_notify_postauthor( $comment_ID );
         }
     }
@@ -1458 +1459 @@
             $status = '1';
             if ( get_option('comments_notify') ) {
-                wp_notify_postauthor( $comment_id ); 
+                wp_notify_postauthor( $comment_id );
             }
             break;

trunk/src/wp-includes/pluggable.php

@@ -1001 +1001 @@
 if ( ! function_exists('wp_notify_postauthor') ) :
 /**
- * Notify an author of a comment/trackback/pingback to one of their posts.
+ * Notify an author (and/or others) of a comment/trackback/pingback on a post.
  *
  * @since 1.0.0
@@ -1007 +1007 @@
  * @param int $comment_id Comment ID
  * @param string $deprecated Not used
- * @return bool False if user email does not exist. True on completion.
+ * @uses get_comment()
+ * @uses get_post()
+ * @uses get_userdata()
+ * @uses apply_filters()
+ * @uses wp_specialchars_decode()
+ * @uses get_option()
+ * @uses __()
+ * @uses get_permalink()
+ * @uses admin_url()
+ * @uses wp_mail()
+ * @return bool True on completion. False if no email addresses were specified.
  */
 function wp_notify_postauthor( $comment_id, $deprecated = null ) {
@@ -1021 +1031 @@
     $author  = get_userdata( $post->post_author );
 
+    // Who to notify? By default, just the post author, but others can be added.
+    $emails = array( $author->user_email );
+    $emails = apply_filters( 'comment_notification_recipients', $emails, $comment_id );
+    $emails = array_filter( $emails );
+
+    // If there are no addresses to send the comment to, bail.
+    if ( ! count( $emails ) ) {
+        return false;
+    }
+
+    // Facilitate unsetting below without knowing the keys.
+    $emails = array_flip( $emails );
+
+    // Post author may want to receive notifications for their own comments
+    $notify_author = apply_filters( 'comment_notification_notify_author', false, $comment_id );
+
     // The comment was left by the author
-    if ( $comment->user_id == $post->post_author )
+    if ( ! $notify_author && $comment->user_id == $post->post_author ) {
+        unset( $emails[ $author->user_email ] );
+    }
+
+    // The author moderated a comment on their own post
+    if ( ! $notify_author && $post->post_author == get_current_user_id() ) {
+        unset( $emails[ $author->user_email ] );
+    }
+
+    // The post author is no longer a member of the blog
+    if ( ! $notify_author && ! user_can( $post->post_author, 'read_post', $post->ID ) ) {
+        unset( $emails[ $author->user_email ] );
+    }
+
+    // If there's no email to send the comment to, bail, otherwise flip array back around for use below
+    if ( ! count( $emails ) ) {
         return false;
-
-    // The author moderated a comment on his own post
-    if ( $post->post_author == get_current_user_id() )
-        return false;
-
-    // The post author is no longer a member of the blog
-    if ( ! user_can( $post->post_author, 'read_post', $post->ID ) )
-        return false;
-
-    // If there's no email to send the comment to
-    if ( '' == $author->user_email )
-        return false;
+    } else {
+        $emails = array_flip( $emails );
+    }
 
     $comment_author_domain = @gethostbyaddr($comment->comment_author_IP);
@@ -1043 +1075 @@
     $blogname = wp_specialchars_decode(get_option('blogname'), ENT_QUOTES);
 
-    $comment_type = $comment->comment_type ? $comment->comment_type : 'comment'; 
-
-    switch ( $comment_type ) {
+    switch ( $comment->comment_type ) {
         case 'trackback':
             $notify_message  = sprintf( __( 'New trackback on your post "%s"' ), $post->post_title ) . "\r\n";
@@ -1108 +1138 @@
         $message_headers .= $reply_to . "\n";
 
-    $emails = array( $author->user_email );
-
-    $emails          = apply_filters( 'comment_notification_recipients', $emails,          $comment_id );
     $notify_message  = apply_filters( 'comment_notification_text',       $notify_message,  $comment_id );
     $subject         = apply_filters( 'comment_notification_subject',    $subject,         $comment_id );