Ticket #10653: 10653.diff

src/wp-includes/comment-template.php

@@ -13 +13 @@
  *
  * If the comment has an empty comment_author field, then 'Anonymous' person is
  * assumed.
+ * If the commenter name has changed, both the new one and the old one are shown.
  *
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ * @since 5.0.0 Added `$before_alias` and `$after_alias` parameters to customize former commenter name.
  *
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
- *                                   Default current comment.
+ * @param int|WP_Comment $comment_ID   Optional. WP_Comment or the ID of the comment for which to retrieve the author.
+ *                                     Default current comment.
+ * @param string         $before_alias The custom text before the former author name.
+ * @param string         $after_alias  The custom text after the former author name.
  * @return string The comment author
  */
-function get_comment_author( $comment_ID = 0 ) {
+function get_comment_author( $comment_ID = 0, $before_alias = null, $after_alias = null ) {
         $comment = get_comment( $comment_ID );
 
-        if ( empty( $comment->comment_author ) ) {
-                if ( $comment->user_id && $user = get_userdata( $comment->user_id ) ) {
-                        $author = $user->display_name;
-                } else {
-                        $author = __( 'Anonymous' );
-                }
-        } else {
+        $author = __( 'Anonymous' );
+        $user = $comment->user_id ? get_userdata( $comment->user_id ) : null;
+
+        if ( $comment->comment_author ) {
                 $author = $comment->comment_author;
+
+                if ( $user && $author != $user->display_name ) {
+                        if ( is_null( $before_alias ) ) {
+                                $before_alias = __(' (Initially posted by ' );
+                        }
+
+                        if ( is_null( $after_alias ) ) {
+                                $after_alias = __(')');
+                        }
+
+                        $author = $user->display_name . $before_alias . $author . $after_alias;
+                }
+        } elseif ( $user ) {
+                $author = $user->display_name;
         }
 
         /**

tests/phpunit/tests/comment/getCommentAuthor.php

@@ +1 @@
+<?php
+
+/**
+* @group comment
+*/
+class Tests_Comment_GetCommentAuthor extends WP_UnitTestCase {
+
+        public function test_comment_author_with_name() {
+                $comment = self::factory()->comment->create_and_get(
+                        array(
+                                'comment_author' => 'Commenter Name',
+                        )
+                );
+
+                $this->assertEquals( 'Commenter Name', get_comment_author( $comment ) );
+        }
+
+        public function test_comment_author_with_user_id_and_no_author() {
+                $user_id = self::factory()->user->create(
+                        array(
+                                'display_name' => 'Commenter Name',
+                        )
+                );
+                $comment = self::factory()->comment->create_and_get(
+                        array(
+                                'user_id' => $user_id,
+                                'comment_author' => '',
+                        )
+                );
+
+                $this->assertEquals( 'Commenter Name', get_comment_author( $comment ) );
+        }
+
+        public function test_comment_author_with_no_user_id_and_no_author() {
+                $comment = self::factory()->comment->create_and_get(
+                        array(
+                                'user_id' => '',
+                                'comment_author' => '',
+                        )
+                );
+
+                $this->assertEquals( 'Anonymous', get_comment_author( $comment ) );
+        }
+
+        /**
+        * @ticket 10653
+        */
+        public function test_comment_author_with_name_different_from_user_name() {
+                $user_id = self::factory()->user->create(
+                        array(
+                                'display_name' => 'Commenter Name',
+                        )
+                );
+                $comment = self::factory()->comment->create_and_get(
+                        array(
+                                'user_id' => $user_id,
+                                'comment_author' => 'Old Commenter Name',
+                        )
+                );
+
+                $this->assertEquals( 'Commenter Name (Initially posted by Old Commenter Name)', get_comment_author( $comment ) );
+        }
+
+        public function test_comment_author_with_name_different_from_user_name_with_custom_before_after() {
+                $user_id = self::factory()->user->create(
+                        array(
+                                'display_name' => 'Commenter Name',
+                        )
+                );
+                $comment = self::factory()->comment->create_and_get(
+                        array(
+                                'user_id' => $user_id,
+                                'comment_author' => 'Old Commenter Name',
+                        )
+                );
+
+                $this->assertEquals( 'Commenter Name AKA Old Commenter Name', get_comment_author( $comment, ' AKA ', '' ) );
+        }
+
+}