get_comment_excerpt

Filters the retrieved comment excerpt.

Description

apply_filters( 'get_comment_excerpt', (string) $excerpt, (int) $comment_comment_id, (WP_Comment) $comment ); 

Parameters (3)

0. $excerpt (string)
The comment excerpt text.
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. $excerpt = apply_filters( 'get_comment_excerpt', $excerpt, $comment_comment_id, $comment ); 
  2.  
  3. if ( !empty( $excerpt ) ) { 
  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_excerpt callback 
  2. function filter_get_comment_excerpt( $excerpt, $comment_comment_id, $comment ) { 
  3. // make filter magic happen here... 
  4. return $excerpt
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'get_comment_excerpt', 'filter_get_comment_excerpt', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'get_comment_excerpt', 'filter_get_comment_excerpt', 10, 3 ); 

Defined (1)

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

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