get_comment_author
Retrieve the author of the current comment.
Description
(string) get_comment_author( (int) $comment_ID = 0 );
If the comment has an empty comment_author field, then Anonymous person is assumed.
Returns (string)
The comment author
Parameters (1)
- 0. $comment_id — Optional. (int)
-
WP_Comment
or the ID of the comment for which to retrieve the author.
Usage
if ( !function_exists( 'get_comment_author' ) ) { require_once ABSPATH . WPINC . '/comment-template.php'; } // Optional. WP_Comment or the ID of the comment for which to retrieve the author. // Default current comment. $comment_id = -1; // NOTICE! Understand what this does before running. $result = get_comment_author($comment_id);
Defined (1)
The function is defined in the following location(s).
- /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 1.5.0
- * @since 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 );
- }