Changeset 45505

Timestamp:

06/08/2019 06:41:08 PM (5 years ago)

Author:

johnbillion

Message:

I18N: Allow the length of automatically generated excerpts to be localized.

This introduces three new strings that can be used to control the maximum length of automatically generated excerpts for posts, comments, and draft post previews in the dashboard. Optionally combined with the existing word count type control this allows languages which include many multibyte characters to specify more appropriate maximum excerpt lengths.

Props miyauchi, birgire, johnbillion

Fixes #44541

Location:

trunk

Files:

• src/wp-admin/includes/dashboard.php (modified) (2 diffs)
• src/wp-includes/comment-template.php (modified) (3 diffs)
• src/wp-includes/formatting.php (modified) (3 diffs)
• tests/phpunit/data/languages/ja_JP.mo (modified) (previous)
• tests/phpunit/data/languages/ja_JP.po (modified) (1 diff)
• tests/phpunit/tests/formatting/WPTrimWords.php (modified) (2 diffs)
• tests/phpunit/tests/l10n.php (modified) (2 diffs)

trunk/src/wp-admin/includes/dashboard.php

@@ -585 +585 @@
     echo '<h2 class="hide-if-no-js">' . __( 'Your Recent Drafts' ) . "</h2>\n<ul>";
 
+
+
+
     $drafts = array_slice( $drafts, 0, 3 );
     foreach ( $drafts as $draft ) {
@@ -593 +596 @@
         echo '<div class="draft-title"><a href="' . esc_url( $url ) . '" aria-label="' . esc_attr( sprintf( __( 'Edit &#8220;%s&#8221;' ), $title ) ) . '">' . esc_html( $title ) . '</a>';
         echo '<time datetime="' . get_the_time( 'c', $draft ) . '">' . get_the_time( __( 'F j, Y' ), $draft ) . '</time></div>';
-        if ( $the_content = wp_trim_words( $draft->post_content, 10 ) ) {
+        if ( $the_content = wp_trim_words( $draft->post_content,  ) ) {
             echo '<p>' . $the_content . '</p>';
         }

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

@@ -578 +578 @@
 
 /**
- * Retrieve the excerpt of the current comment.
- *
- * 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.
+ * Retrieves the excerpt of the given comment.
+ *
+ * Returns a maximum of 20 words with an ellipsis appended if necessary.
  *
  * @since 1.5.0
@@ -589 +587 @@
  * @param int|WP_Comment $comment_ID  WP_Comment or ID of the comment for which to get the excerpt.
  *                                    Default current comment.
- * @return string The maybe truncated comment with 20 words or less.
+ * @return string The .
  */
 function get_comment_excerpt( $comment_ID = 0 ) {
     $comment      = get_comment( $comment_ID );
     $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) );
-    $words        = explode( ' ', $comment_text );
-
-    /**
-     * Filters the amount of words used in the comment excerpt.
+
+    /* translators: Maximum number of words used in a comment excerpt. */
+    $comment_excerpt_length = intval( _x( '20', 'comment_excerpt_length' ) );
+
+    /**
+     * Filters the maximum number of words used in the comment excerpt.
      *
      * @since 4.4.0
@@ -603 +603 @@
      * @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 .= '…';
-    }
+    $comment_excerpt_length = apply_filters( 'comment_excerpt_length', $comment_excerpt_length );
+
+    $excerpt = wp_trim_words( $comment_text, $comment_excerpt_length, '…' );
+
     /**
      * Filters the retrieved comment excerpt.

trunk/src/wp-includes/formatting.php

@@ -3681 +3681 @@
  * Generates an excerpt from the content, if needed.
  *
- * The excerpt word amount will be 55 words and if the amount is greater than
- * that, then the string ' […]' will be appended to the excerpt. If the string
- * is less than 55 words, then the content will be returned as is.
+ * Returns a maximum of 55 words with an ellipsis appended if necessary.
  *
  * The 55 word limit can be modified by plugins/themes using the {@see 'excerpt_length'} filter
@@ -3708 +3706 @@
         $text = str_replace( ']]>', ']]>', $text );
 
+
+
+
         /**
-         * Filters the number of words in an excerpt.
+         * Filters the  excerpt.
          *
          * @since 2.7.0
          *
-         * @param int $number The number of words. Default 55.
+         * @param int $number The number of words. Default 55.
          */
-        $excerpt_length = apply_filters( 'excerpt_length', 55 );
+        $excerpt_length = apply_filters( 'excerpt_length', $excerpt_length );
+
         /**
          * Filters the string in the "more" link displayed after a trimmed excerpt.
@@ -3726 +3728 @@
         $text         = wp_trim_words( $text, $excerpt_length, $excerpt_more );
     }
+
     /**
      * Filters the trimmed excerpt string.

trunk/tests/phpunit/data/languages/ja_JP.po

@@ -41 +41 @@
 msgid "Update %s now"
 msgstr "今すぐ %s を更新"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

trunk/tests/phpunit/tests/formatting/WPTrimWords.php

@@ -5 +5 @@
  */
 class Tests_Formatting_WPTrimWords extends WP_UnitTestCase {
+
+
+
+
+
+
+
+
     private $long_text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce varius lacinia vehicula. Etiam sapien risus, ultricies ac posuere eu, convallis sit amet augue. Pellentesque urna massa, lacinia vel iaculis eget, bibendum in mauris. Aenean eleifend pulvinar ligula, a convallis eros gravida non. Suspendisse potenti. Pellentesque et odio tortor. In vulputate pellentesque libero, sed dapibus velit mollis viverra. Pellentesque id urna euismod dolor cursus sagittis.';
 
@@ -43 +51 @@
         $this->assertEquals( $text, wp_trim_words( $text ) );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

trunk/tests/phpunit/tests/l10n.php

@@ -6 +6 @@
  */
 class Tests_L10n extends WP_UnitTestCase {
+
+
+
+
+
+
+
+
+
 
     /**
@@ -261 +270 @@
         $this->assertNotEmpty( $array['X-Generator'] );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }