get_comment_author( int|WP_Comment $comment_id )
Retrieves the author of the current comment.
Description
If the comment has an empty comment_author field, then ‘Anonymous’ person is assumed.
Parameters
- $comment_id
-
(Optional) WP_Comment or the ID of the comment for which to retrieve the author.<br> Default current comment.
Return
(string) The comment author
Source
File: wp-includes/comment-template.php
function get_comment_author( $comment_ID = 0 ) {
$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 = $comment->comment_author;
}
/**
* Filters the returned comment author name.
*
* @since WP-1.5.0
* @since WP-4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_author', $author, $comment->comment_ID, $comment );
}
Changelog
Version | Description |
---|---|
4.4.0 | Added the ability for $comment_id to also accept a WP_Comment object. |
1.5.0 | Introduced. |