get_comment_author() WordPress Function

The get_comment_author() function is a built-in function in WordPress that is used to return the author of the current comment.

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.


Top ↑

Parameters

$comment_ID

(int|WP_Comment)(Optional) WP_Comment or the ID of the comment for which to retrieve the author. Default current comment.


Top ↑

Return

(string) The comment author


Top ↑

Source

File: wp-includes/comment-template.php

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 );
}


Top ↑

Changelog

Changelog
VersionDescription
4.4.0Added the ability for $comment_ID to also accept a WP_Comment object.
1.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More