Changeset 34520

Timestamp:

09/24/2015 09:04:16 PM (9 years ago)

Author:

wonderboymusic

Message:

Comments: add a 'comment_excerpt_length' filter to get_comment_excerpt().

Create the first ever unit tests for get_comment_excerpt().

Props dannydehaan, wonderboymusic.
Fixes #27526.

Location:

trunk

Files:

• src/wp-includes/comment-template.php (modified) (1 diff)
• tests/phpunit/tests/comment/getCommentExcerpt.php (added)

trunk/src/wp-includes/comment-template.php

@@ -566 +566 @@
 function get_comment_excerpt( $comment_ID = 0 ) {
     $comment = get_comment( $comment_ID );
-    $comment_text = strip_tags($comment->comment_content);
-    $blah = explode(' ', $comment_text);
-
-    if (count($blah) > 20) {
-        $k = 20;
-        $use_dotdotdot = 1;
-    } else {
-        $k = count($blah);
-        $use_dotdotdot = 0;
-    }
-
-    $excerpt = '';
-    for ($i=0; $i<$k; $i++) {
-        $excerpt .= $blah[$i] . ' ';
-    }
-    $excerpt .= ($use_dotdotdot) ? '&hellip;' : '';
-
+    $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) );
+    $words = explode( ' ', $comment_text );
+
+    /**
+     * Filter the amount of words used in the comment excerpt.
+     *
+     * @since 4.4.0
+     *
+     * @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt.
+     */
+    $comment_excerpt_length = apply_filters( 'comment_excerpt_length', 20 );
+
+    $use_ellipsis = count( $words ) > $comment_excerpt_length;
+    if ( $use_ellipsis ) {
+        $words = array_slice( $words, 0, $comment_excerpt_length );
+    }
+
+    $excerpt = trim( join( ' ', $words ) );
+    if ( $use_ellipsis ) {
+        $excerpt .= '&hellip;';
+    }
     /**
      * Filter the retrieved comment excerpt.