get_comment_excerpt

Retrieve the excerpt of the current comment.

Description

(string) get_comment_excerpt( (int) $comment_ID = 0 ); 

Will cut each word and only output the first 20 words with … at the end. If the word count is less than 20, then no truncating is done and no … will appear.

Returns (string)

The maybe truncated comment with 20 words or less.

Parameters (1)

0. $comment_id (int)
WP_Comment or ID of the comment for which to get the excerpt. Default current comment.

Usage

  1. if ( !function_exists( 'get_comment_excerpt' ) ) { 
  2.     require_once ABSPATH . WPINC . '/comment-template.php'; 
  3. } 
  4.   
  5. // WP_Comment or ID of the comment for which to get the excerpt. 
  6. // Default current comment. 
  7. $comment_id = -1; 
  8.   
  9. // NOTICE! Understand what this does before running. 
  10. $result = get_comment_excerpt($comment_id); 
  11.     

Defined (1)

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

/wp-includes/comment-template.php  
  1. function get_comment_excerpt( $comment_ID = 0 ) { 
  2.     $comment = get_comment( $comment_ID ); 
  3.     $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) ); 
  4.     $words = explode( ' ', $comment_text ); 
  5.  
  6.     /** 
  7.      * Filters the amount of words used in the comment excerpt. 
  8.      * 
  9.      * @since 4.4.0 
  10.      * 
  11.      * @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt. 
  12.      */ 
  13.     $comment_excerpt_length = apply_filters( 'comment_excerpt_length', 20 ); 
  14.  
  15.     $use_ellipsis = count( $words ) > $comment_excerpt_length; 
  16.     if ( $use_ellipsis ) { 
  17.         $words = array_slice( $words, 0, $comment_excerpt_length ); 
  18.     } 
  19.  
  20.     $excerpt = trim( join( ' ', $words ) ); 
  21.     if ( $use_ellipsis ) { 
  22.         $excerpt .= '…'; 
  23.     } 
  24.     /** 
  25.      * Filters the retrieved comment excerpt. 
  26.      * 
  27.      * @since 1.5.0 
  28.      * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added. 
  29.      * 
  30.      * @param string     $excerpt    The comment excerpt text. 
  31.      * @param int        $comment_ID The comment ID. 
  32.      * @param WP_Comment $comment    The comment object. 
  33.      */ 
  34.     return apply_filters( 'get_comment_excerpt', $excerpt, $comment->comment_ID, $comment ); 
  35. }