On this page
get_comment_author( int|WP_Comment $comment_ID ): string
Retrieves the author of the current comment.
Description
If the comment has an empty comment_author field, then ‘Anonymous’ person is assumed.
Parameters
$comment_IDint|WP_Comment Optional-
WP_Comment or the ID of the comment for which to retrieve the author.
Default current comment.
Return
string The comment author
Source
File: wp-includes/comment-template.php. View all references
function get_comment_author( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID );
$comment_ID = ! empty( $comment->comment_ID ) ? $comment->comment_ID : $comment_ID;
if ( empty( $comment->comment_author ) ) {
$user = ! empty( $comment->user_id ) ? get_userdata( $comment->user_id ) : false;
if ( $user ) {
$author = $user->display_name;
} else {
$author = __( 'Anonymous' );
}
} else {
$author = $comment->comment_author;
}
/**
* Filters the returned comment author name.
*
* @since 1.5.0
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $author The comment author's username.
* @param string $comment_ID The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_author', $author, $comment_ID, $comment );
}
Hooks
- apply_filters( 'get_comment_author',
string $author ,string $comment_ID ,WP_Comment $comment ) -
Filters the returned comment author name.
Related
Uses
| Uses | Description |
|---|---|
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| get_userdata() wp-includes/pluggable.php | Retrieves user info by user ID. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
| get_comment() wp-includes/comment.php | Retrieves comment data given a comment ID or comment object. |
Used By
| Used By | Description |
|---|---|
| WP_Comments_List_Table::column_comment() wp-admin/includes/class-wp-comments-list-table.php | |
| get_comment_author_rss() wp-includes/feed.php | Retrieves the current comment author for use in the feeds. |
| Walker_Comment::comment() wp-includes/class-walker-comment.php | Outputs a single comment. |
| Walker_Comment::html5_comment() wp-includes/class-walker-comment.php | Outputs a comment in the HTML5 format. |
| comment_form_title() wp-includes/comment-template.php | Displays text based on comment reply status. |
| get_comment_reply_link() wp-includes/comment-template.php | Retrieves HTML content for reply to comment link. |
| get_comment_text() wp-includes/comment-template.php | Retrieves the text of the current comment. |
| comment_author() wp-includes/comment-template.php | Displays the author of the current comment. |
| get_comment_author_link() wp-includes/comment-template.php | Retrieves the HTML link to the URL of the author of the current comment. |
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Added the ability for $comment_ID to also accept a WP_Comment object. |
| 1.5.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_comment_author