comment_email │ filter-hook │ WP 1.2.0

Filters the comment author's email for display.

Care should be taken to protect the email address and assure that email harvesters do not capture your commenter's email address.

Usage

add_filter( 'comment_email', 'wp_kama_comment_email_filter', 10, 2 );

/**
 * Function for `comment_email` filter-hook.
 * 
 * @param string     $comment_author_email The comment author's email address.
 * @param WP_Comment $comment              The comment object.
 *
 * @return string
 */
function wp_kama_comment_email_filter( $comment_author_email, $comment ){

	// filter...
	return $comment_author_email;
}

$comment_author_email(string)

The comment author's email address.

$comment(WP_Comment)

The comment object.

Changelog

Where the hook is called

$comment_author_email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );

$email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );

Where the hook is used in WordPress

add_filter( 'comment_email', 'antispambot' );