From 393960b1829bebbcec7d7e52da0bdf5e2fdc3294 Mon Sep 17 00:00:00 2001
From: John Blackbourn <johnbillion@git.wordpress.org>
Date: Sat, 8 Jun 2019 18:41:08 +0000
Subject: [PATCH] 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


git-svn-id: https://develop.svn.wordpress.org/trunk@45505 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-admin/includes/dashboard.php           |   5 +-
 src/wp-includes/comment-template.php          |  25 +-
 src/wp-includes/formatting.php                |  15 +-
 tests/phpunit/data/languages/ja_JP.mo         | Bin 658 -> 816 bytes
 tests/phpunit/data/languages/ja_JP.po         |  27 ++
 .../phpunit/tests/formatting/WPTrimWords.php  |  31 +++
 tests/phpunit/tests/l10n.php                  | 256 ++++++++++++++++++
 7 files changed, 336 insertions(+), 23 deletions(-)

diff --git a/src/wp-admin/includes/dashboard.php b/src/wp-admin/includes/dashboard.php
index 9c7f93c430..a622f0e7cf 100644
--- a/src/wp-admin/includes/dashboard.php
+++ b/src/wp-admin/includes/dashboard.php
@@ -584,6 +584,9 @@ function wp_dashboard_recent_drafts( $drafts = false ) {
 	}
 	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,7 +595,7 @@ function wp_dashboard_recent_drafts( $drafts = false ) {
 		/* 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";
diff --git a/src/wp-includes/comment-template.php b/src/wp-includes/comment-template.php
index 5158a6f8a7..ca0a8de714 100644
--- a/src/wp-includes/comment-template.php
+++ b/src/wp-includes/comment-template.php
@@ -577,42 +577,35 @@ function comment_date( $d = '', $comment_ID = 0 ) {
 }
 
 /**
- * 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 '&hellip;' at the end.
- * If the word count is less than 20, then no truncating is done and no '&hellip;'
- * 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, '&hellip;' );
 
-	$excerpt = trim( join( ' ', $words ) );
-	if ( $use_ellipsis ) {
-		$excerpt .= '&hellip;';
-	}
 	/**
 	 * Filters the retrieved comment excerpt.
 	 *
diff --git a/src/wp-includes/formatting.php b/src/wp-includes/formatting.php
index 51a1388dfd..a76a4927b7 100644
--- a/src/wp-includes/formatting.php
+++ b/src/wp-includes/formatting.php
@@ -3680,9 +3680,7 @@ function human_time_diff( $from, $to = '' ) {
 /**
  * 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 ' [&hellip;]' 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 ' [&hellip;]' string can be modified by plugins/themes using the {@see 'excerpt_more'} filter
@@ -3707,14 +3705,18 @@ function wp_trim_excerpt( $text = '', $post = null ) {
 		$text = apply_filters( 'the_content', $text );
 		$text = str_replace( ']]>', ']]&gt;', $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,6 +3727,7 @@ function wp_trim_excerpt( $text = '', $post = null ) {
 		$excerpt_more = apply_filters( 'excerpt_more', ' ' . '[&hellip;]' );
 		$text         = wp_trim_words( $text, $excerpt_length, $excerpt_more );
 	}
+
 	/**
 	 * Filters the trimmed excerpt string.
 	 *
diff --git a/tests/phpunit/data/languages/ja_JP.mo b/tests/phpunit/data/languages/ja_JP.mo
index 1399898aa789525109f1238c3ef93ad18f47541d..da1681326c3031f13be8aa79a0ece0bed1c24427 100644
GIT binary patch
delta 419
zcmZ9Hy-EW?6h?1!jXxl21VI#B1wl~4t{Bix#3!(^a~WpGB(j-ZW+xaciKUf^Mi5_O
zg<zwdoxXvEO(cRK7_irGWU+9#XU_eY%Y|tUB-!JaoYf+n5ikn^FbeL0IiJAf9#{h3
zVA}K<qA_?2o`84YN!W*H;9BYnIES3TX4eBe1-JWt=l19c4T|1Uzr+2=A8GEvX5m-r
zaXgy$6<pXw!ypTWfceBAz$jUO8m$F?H&njO!>ZJ_K8i%%-VSXUA}A)~fN3#r9bzOV
z9#$$sYERU-P?7cmA&a_Xtvci@w*Qx1hyG0z3OBcNnXH>%&%4g~b7pyyUhhsj^{Y<(
x%wCM`&PlU--R@o{#7j&uu7!%dvgAS4FUz7AM~sV@)*MqV)*rCO<AxPzML#9&TfP7Q

delta 255
zcmdnMHi@<Vo)F7a1|VPqVi_Rz0b*_-t^r~YSOLVmK)e!&g@JfG5K9B`X(;_1NDBcm
zGb00oDiDi-FpzJ<#J~VV48cGGq&^Hv7XfKzAiobtLzOZxumA->0OSY|V48SWX>$sr
z93!ido`Ig(<PIin-vIv*UFV|I#FEVXJYAQ>l2j`NE}z8W65WuZ#Ju91#FG3Xut;8d
sX<~Y+Zb)ikE|AagWOvu&#+i>BCn%^ED?DzR^lbK)XVW%J{=nn_0D0CiWB>pF

diff --git a/tests/phpunit/data/languages/ja_JP.po b/tests/phpunit/data/languages/ja_JP.po
index f71a737714..bd9cd17a95 100644
--- a/tests/phpunit/data/languages/ja_JP.po
+++ b/tests/phpunit/data/languages/ja_JP.po
@@ -40,3 +40,30 @@ msgstr "number_format_thousands_sep"
 #: 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"
diff --git a/tests/phpunit/tests/formatting/WPTrimWords.php b/tests/phpunit/tests/formatting/WPTrimWords.php
index 7f2a27fc05..fab62372f7 100644
--- a/tests/phpunit/tests/formatting/WPTrimWords.php
+++ b/tests/phpunit/tests/formatting/WPTrimWords.php
@@ -4,6 +4,14 @@
  * @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,4 +50,27 @@ class Tests_Formatting_WPTrimWords extends WP_UnitTestCase {
 		$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 ) . '&hellip;';
+		$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 ) . '&hellip;';
+		$actual   = wp_trim_words( $text, 19 );
+		restore_previous_locale();
+		$this->assertEquals( $expected, $actual );
+	}
 }
diff --git a/tests/phpunit/tests/l10n.php b/tests/phpunit/tests/l10n.php
index 45a6008363..7b34d32b4e 100644
--- a/tests/phpunit/tests/l10n.php
+++ b/tests/phpunit/tests/l10n.php
@@ -6,6 +6,15 @@
  */
 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,4 +269,251 @@ class Tests_L10n extends WP_UnitTestCase {
 		$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 );
+	}
 }