get_comment_author_email │ filter-hook │ WP 1.5.0

Filters the comment author's returned email address.

Usage

add_filter( 'get_comment_author_email', 'wp_kama_get_comment_author_email_filter', 10, 3 );

/**
 * Function for `get_comment_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.
 * @param WP_Comment $comment              The comment object.
 *
 * @return string
 */
function wp_kama_get_comment_author_email_filter( $comment_author_email, $comment_ID, $comment ){

	// 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.

$comment(WP_Comment)

The comment object.

Changelog

Where the hook is called

return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment );

Where the hook is used in WordPress