get_comment_author

Filters the returned comment author name.

Description

apply_filters( 'get_comment_author', (string) $author, (int) $comment_comment_id, (WP_Comment) $comment ); 

Parameters (3)

0. $author (string)
The comment author's username.
1. $comment_comment_id (int)
The comment comment id.
2. $comment (WP_Comment)
The comment object.

Usage

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

Defined (1)

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

/wp-includes/comment-template.php  
  1. return apply_filters( 'get_comment_author', $author, $comment->comment_ID, $comment );