comment_excerpt

Filters the comment excerpt for display.

Description

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

Parameters (2)

0. $comment_excerpt (string)
The comment excerpt text.
1. $comment_comment_id (int)
The comment comment id.

Usage

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

Defined (1)

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

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