get_comment_author_email
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
Since 1.5.0 | Introduced. |
Since 4.1.0 | The $comment_id and $comment parameters were added. |
Where the hook is called
get_comment_author_email
wp-includes/comment-template.php 108
return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment );