comment_author │ filter-hook │ WP 1.2.0

Filters the comment author's name for display.

Usage

add_filter( 'comment_author', 'wp_kama_comment_author_filter', 10, 2 );

/**
 * Function for `comment_author` filter-hook.
 * 
 * @param string $comment_author The comment author's username.
 * @param string $comment_id     The comment ID as a numeric string.
 *
 * @return string
 */
function wp_kama_comment_author_filter( $comment_author, $comment_id ){

	// filter...
	return $comment_author;
}

$comment_author(string)

The comment author's username.

$comment_id(string)

The comment ID as a numeric string.

Changelog

Where the hook is called

echo apply_filters( 'comment_author', $comment_author, $comment->comment_ID );

Where the hook is used in WordPress

add_filter( 'comment_author', array( $this, 'floated_admin_avatar' ), 10, 2 );

add_filter( $filter, 'wptexturize' );

add_filter( $filter, 'convert_chars' );

add_filter( $filter, 'esc_html' );