Ticket #44541: 44541.diff

src/wp-admin/includes/dashboard.php

@@ -584 +584 @@
         }
         echo '<h2 class="hide-if-no-js">' . __( 'Your Recent Drafts' ) . "</h2>\n<ul>";
 
+        /* translators: Maximum number of words used in a preview of a draft on the dashboard. */
+        $draft_length = intval( _x( '10', 'draft_length' ) );
+
         $drafts = array_slice( $drafts, 0, 3 );
         foreach ( $drafts as $draft ) {
                 $url   = get_edit_post_link( $draft->ID );
@@ -592 +595 @@
                 /* translators: %s: post title */
                 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, $draft_length ) ) {
                         echo '<p>' . $the_content . '</p>';
                 }
                 echo "</li>\n";

src/wp-includes/comment-template.php

@@ -577 +577 @@
 }
 
 /**
- * Retrieve the excerpt of the current comment.
+ * Retrieves the excerpt of the given 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.
+ * Returns a maximum of 20 words with an ellipsis appended if necessary.
  *
  * @since 1.5.0
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
  * @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 possibly truncated comment excerpt.
  */
 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 );
+
+        /* translators: Maximum number of words used in a comment excerpt. */
+        $comment_excerpt_length = intval( _x( '20', 'comment_excerpt_length' ) );
 
         /**
-         * Filters the amount of words used in the comment excerpt.
+         * Filters the maximum number 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 );
+        $comment_excerpt_length = apply_filters( 'comment_excerpt_length', $comment_excerpt_length );
 
-        $use_ellipsis = count( $words ) > $comment_excerpt_length;
-        if ( $use_ellipsis ) {
-                $words = array_slice( $words, 0, $comment_excerpt_length );
-        }
+        $excerpt = wp_trim_words( $comment_text, $comment_excerpt_length, '…' );
 
-        $excerpt = trim( join( ' ', $words ) );
-        if ( $use_ellipsis ) {
-                $excerpt .= '…';
-        }
         /**
          * Filters the retrieved comment excerpt.
          *

src/wp-includes/formatting.php

@@ -3680 +3680 @@
 /**
  * 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
  * The ' […]' string can be modified by plugins/themes using the {@see 'excerpt_more'} filter
@@ -3707 +3705 @@
                 $text = apply_filters( 'the_content', $text );
                 $text = str_replace( ']]>', ']]>', $text );
 
+                /* translators: Maximum number of words used in a post excerpt. */
+                $excerpt_length = intval( _x( '55', 'excerpt_length' ) );
+
                 /**
-                 * Filters the number of words in an excerpt.
+                 * Filters the maximum number of words in a post excerpt.
                  *
                  * @since 2.7.0
                  *
-                 * @param int $number The number of words. Default 55.
+                 * @param int $number The maximum 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.
                  *
@@ -3725 +3727 @@
                 $excerpt_more = apply_filters( 'excerpt_more', ' ' . '[…]' );
                 $text         = wp_trim_words( $text, $excerpt_length, $excerpt_more );
         }
+
         /**
          * Filters the trimmed excerpt string.
          *

tests/phpunit/data/languages/ja_JP.po

@@ -40 +40 @@
 #: wp-includes/script-loader.php:620
 msgid "Update %s now"
 msgstr "今すぐ %s を更新"
+
+#. translators: If your word count is based on single characters (e.g. East
+#. Asian characters), enter 'characters_excluding_spaces' or
+#. 'characters_including_spaces'. Otherwise, enter 'words'. Do not translate
+#. into your own language.
+#: wp-includes/formatting.php:3372 wp-includes/script-loader.php:1100
+msgctxt "Word count type. Do not translate!"
+msgid "words"
+msgstr "characters_including_spaces"
+
+#. translators: Maximum number of words used in a post excerpt.
+#: wp-includes/formatting.php:3640
+msgctxt "excerpt_length"
+msgid "55"
+msgstr "110"
+
+#. translators: Maximum number of words used in a comment excerpt.
+#: wp-includes/comment-template.ph:599
+msgctxt "comment_excerpt_length"
+msgid "20"
+msgstr "40"
+
+#. translators: Maximum number of words used in a preview of a draft on the dashboard.
+#: wp-admin/includes/dashboard.php:591
+msgctxt "draft_length"
+msgid "10"
+msgstr "40"

tests/phpunit/tests/formatting/WPTrimWords.php

@@ -4 +4 @@
  * @group formatting
  */
 class Tests_Formatting_WPTrimWords extends WP_UnitTestCase {
+
+        /**
+         * Long Dummy Text.
+         *
+         * @since 5.0.0
+         *
+         * @var string $long_text
+         */
         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.';
 
         function test_trims_to_55_by_default() {
@@ -42 +50 @@
                 $text = 'This is some short text.';
                 $this->assertEquals( $text, wp_trim_words( $text ) );
         }
+
+        /**
+         * @ticket 44541
+         */
+        function test_trims_to_20_counted_by_chars() {
+                switch_to_locale( 'ja_JP' );
+                $expected = substr( $this->long_text, 0, 20 ) . '…';
+                $actual   = wp_trim_words( $this->long_text, 20 );
+                restore_previous_locale();
+                $this->assertEquals( $expected, $actual );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_trims_to_20_counted_by_chars_with_double_width_chars() {
+                switch_to_locale( 'ja_JP' );
+                $text     = str_repeat( 'あ', 100 );
+                $expected = str_repeat( 'あ', 19 ) . '…';
+                $actual   = wp_trim_words( $text, 19 );
+                restore_previous_locale();
+                $this->assertEquals( $expected, $actual );
+        }
 }

tests/phpunit/tests/l10n.php

@@ -6 +6 @@
  */
 class Tests_L10n extends WP_UnitTestCase {
 
+        /**
+         * Long Dummy Text.
+         *
+         * @since 5.0.0
+         *
+         * @var string $long_text
+         */
+        private $long_text = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.';
+
         /**
          * @ticket 35961
          */
@@ -260 +269 @@
                 $this->assertNotEmpty( $array['Project-Id-Version'] );
                 $this->assertNotEmpty( $array['X-Generator'] );
         }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_excerpt_should_be_counted_by_words() {
+                global $post;
+
+                switch_to_locale( 'en_US' );
+
+                $args = array(
+                        'post_content' => $this->long_text,
+                        'post_excerpt' => '',
+                );
+
+                $post = $this->factory()->post->create_and_get( $args );
+                setup_postdata( $post );
+
+                $expect = "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat [&hellip;]</p>\n";
+                the_excerpt();
+
+                restore_previous_locale();
+
+                $this->expectOutputString( $expect );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_excerpt_should_be_counted_by_chars() {
+                global $post;
+
+                switch_to_locale( 'ja_JP' );
+
+                $args = array(
+                        'post_content' => $this->long_text,
+                        'post_excerpt' => '',
+                );
+
+                $post = $this->factory()->post->create_and_get( $args );
+                setup_postdata( $post );
+
+                $expect = "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore  [&hellip;]</p>\n";
+                the_excerpt();
+
+                restore_previous_locale();
+
+                $this->expectOutputString( $expect );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_excerpt_should_be_counted_by_chars_in_japanese() {
+                global $post;
+
+                switch_to_locale( 'ja_JP' );
+
+                $args = array(
+                        'post_content' => str_repeat( 'あ', 200 ),
+                        'post_excerpt' => '',
+                );
+
+                $post = $this->factory()->post->create_and_get( $args );
+                setup_postdata( $post );
+
+                $expect = '<p>' . str_repeat( 'あ', 110 ) . " [&hellip;]</p>\n";
+                the_excerpt();
+
+                restore_previous_locale();
+
+                $this->expectOutputString( $expect );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_excerpt_rss_should_be_counted_by_words() {
+                global $post;
+
+                switch_to_locale( 'en_US' );
+
+                $args = array(
+                        'post_content' => $this->long_text,
+                        'post_excerpt' => '',
+                );
+
+                $post = $this->factory()->post->create_and_get( $args );
+                setup_postdata( $post );
+
+                $expect = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat [&#8230;]';
+                the_excerpt_rss();
+
+                restore_previous_locale();
+
+                $this->expectOutputString( $expect );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_excerpt_rss_should_be_counted_by_chars() {
+                global $post;
+
+                switch_to_locale( 'ja_JP' );
+
+                $args = array(
+                        'post_content' => $this->long_text,
+                        'post_excerpt' => '',
+                );
+
+                $post = $this->factory()->post->create_and_get( $args );
+                setup_postdata( $post );
+
+                $expect = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore  [&#8230;]';
+
+                the_excerpt_rss();
+
+                restore_previous_locale();
+
+                $this->expectOutputString( $expect );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_draft_should_be_counted_by_words() {
+                require_once ABSPATH . 'wp-admin/includes/dashboard.php';
+
+                switch_to_locale( 'en_US' );
+
+                $args = array(
+                        'post_content' => $this->long_text,
+                        'post_excerpt' => '',
+                        'post_status'  => 'draft',
+                );
+
+                $this->factory()->post->create( $args );
+
+                $expect = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do&hellip;';
+                wp_dashboard_recent_drafts();
+
+                restore_previous_locale();
+
+                $this->expectOutputRegex( '/' . $expect . '/' );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_draft_should_be_counted_by_chars() {
+                require_once ABSPATH . 'wp-admin/includes/dashboard.php';
+
+                switch_to_locale( 'ja_JP' );
+
+                $args = array(
+                        'post_content' => $this->long_text,
+                        'post_excerpt' => '',
+                        'post_status'  => 'draft',
+                );
+
+                $post = $this->factory()->post->create( $args );
+
+                $expect = 'Lorem ipsum dolor sit amet, consectetur &hellip;';
+                wp_dashboard_recent_drafts();
+
+                restore_previous_locale();
+
+                $this->expectOutputRegex( '/' . $expect . '/' );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_draft_should_be_counted_by_chars_in_japanese() {
+                require_once ABSPATH . 'wp-admin/includes/dashboard.php';
+
+                switch_to_locale( 'ja_JP' );
+
+                $args = array(
+                        'post_content' => str_repeat( 'あ', 200 ),
+                        'post_excerpt' => '',
+                        'post_status'  => 'draft',
+                );
+
+                $this->factory()->post->create( $args );
+
+                $expect = str_repeat( 'あ', 40 ) . '&hellip;';
+                wp_dashboard_recent_drafts();
+
+                restore_previous_locale();
+
+                $this->expectOutputRegex( '/' . $expect . '/' );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_comment_excerpt_should_be_counted_by_words() {
+                switch_to_locale( 'en_US' );
+
+                $args            = array(
+                        'comment_content' => $this->long_text,
+                );
+                $comment_id      = $this->factory()->comment->create( $args );
+                $expect          = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut&hellip;';
+                $comment_excerpt = get_comment_excerpt( $comment_id );
+
+                restore_previous_locale();
+
+                $this->assertSame( $expect, $comment_excerpt );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_comment_excerpt_should_be_counted_by_chars() {
+                switch_to_locale( 'ja_JP' );
+
+                $args            = array(
+                        'comment_content' => $this->long_text,
+                );
+                $comment_id      = $this->factory()->comment->create( $args );
+                $expect          = 'Lorem ipsum dolor sit amet, consectetur &hellip;';
+                $comment_excerpt = get_comment_excerpt( $comment_id );
+
+                restore_previous_locale();
+
+                $this->assertSame( $expect, $comment_excerpt );
+        }
+
+        /**
+         * @ticket 44541
+         */
+        function test_length_of_comment_excerpt_should_be_counted_by_chars_in_Japanese() {
+                switch_to_locale( 'ja_JP' );
+
+                $args            = array(
+                        'comment_content' => str_repeat( 'あ', 200 ),
+                );
+                $comment_id      = $this->factory()->comment->create( $args );
+                $expect          = str_repeat( 'あ', 40 ) . '&hellip;';
+                $comment_excerpt = get_comment_excerpt( $comment_id );
+
+                restore_previous_locale();
+
+                $this->assertSame( $expect, $comment_excerpt );
+        }
 }