comment_author( int|WP_Comment $comment_id )
Displays the author of the current comment.
Contents
Parameters
-
$comment_id
int|WP_Comment Optional -
WP_Comment or the ID of the comment for which to print the author.
Default current comment.
More Information
If no name is provided (and “User must fill out name and email” is not enabled under Discussion Options), WordPress will assign “Anonymous” as comment author.
Source
File: wp-includes/comment-template.php
.
View all references
function comment_author( $comment_id = 0 ) {
$comment = get_comment( $comment_id );
$comment_author = get_comment_author( $comment );
/**
* Filters the comment author's name for display.
*
* @since 1.2.0
* @since 4.1.0 The `$comment_id` parameter was added.
*
* @param string $comment_author The comment author's username.
* @param string $comment_id The comment ID as a numeric string.
*/
echo apply_filters( 'comment_author', $comment_author, $comment->comment_ID );
}
Hooks
-
apply_filters( 'comment_author',
string $comment_author ,string $comment_id ) -
Filters the comment author’s name for display.
Changelog
Version | Description |
---|---|
4.4.0 | Added the ability for $comment_id to also accept a WP_Comment object. |
0.71 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Basic Example