author_email

Filters the comment author's email for display.

Description

apply_filters( 'author_email', (string) $author_email, (int) $comment_comment_id ); 

Parameters (2)

0. $author_email (string)
The comment author's email address.
1. $comment_comment_id (int)
The comment comment id.

Usage

To run the hook, copy the example below.
  1. $author_email = apply_filters( 'author_email', $author_email, $comment_comment_id ); 
  2.  
  3. if ( !empty( $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 author_email callback 
  2. function filter_author_email( $author_email, $comment_comment_id ) { 
  3. // make filter magic happen here... 
  4. return $author_email
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'author_email', 'filter_author_email', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'author_email', 'filter_author_email', 10, 2 ); 

Defined (1)

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

/wp-includes/comment-template.php  
  1. echo apply_filters( 'author_email', $author_email, $comment->comment_ID );