comment_email

This filter is documented in wp-includes/comment-template.php.

Description

apply_filters( 'comment_email', (string) $comment_comment_author_email, (WP_Comment) $comment ); 

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

Parameters (2)

0. $comment_comment_author_email (string)
The comment author's email address.
1. $comment (WP_Comment)
The comment object.

Usage

To run the hook, copy the example below.
  1. $comment_comment_author_email = apply_filters( 'comment_email', $comment_comment_author_email, $comment ); 
  2.  
  3. if ( !empty( $comment_comment_author_email ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the comment_email callback 
  2. function filter_comment_email( $comment_comment_author_email, $comment ) { 
  3. // make filter magic happen here... 
  4. return $comment_comment_author_email
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'comment_email', 'filter_comment_email', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'comment_email', 'filter_comment_email', 10, 2 ); 

Defined (2)

The filter is defined in the following location(s).

/wp-includes/comment-template.php  
  1. $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment ); 
/wp-admin/includes/class-wp-comments-list-table.php  
  1. $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );