author_email │ filter-hook │ WP 1.2.0

Filters the comment author's email for display.

Usage

add_filter( 'author_email', 'wp_kama_author_email_filter', 10, 2 );

/**
 * Function for `author_email` filter-hook.
 * 
 * @param string $comment_author_email The comment author's email address.
 * @param string $comment_id           The comment ID as a numeric string.
 *
 * @return string
 */
function wp_kama_author_email_filter( $comment_author_email, $comment_id ){

	// filter...
	return $comment_author_email;
}

$comment_author_email(string)

The comment author's email address.

$comment_id(string)

The comment ID as a numeric string.

Changelog

Where the hook is called

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

Where the hook is used in WordPress