<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[55279] trunk: I18N: Introduce `word_count_type` property to `WP_Locale`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/55279">55279</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/55279","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-02-07 17:26:14 +0000 (Tue, 07 Feb 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>I18N: Introduce `word_count_type` property to `WP_Locale`.
This changesets adds a `word_count_type` property, so that it does not need to be translated separately across multiple projects.
List of changes:
- New property: `WP_Locale::word_count_type`.
- New method: `WP_Locale::get_word_count_type()`.
- New function: `wp_get_word_count_type()` as a wrapper for `WP_Locale::get_word_count_type()`.
- All `_x( 'words', 'Word count type. Do not translate!' )` strings have been replaced with a call to `wp_get_word_count_type()`.
Props pedromendonca, desrosj, costdev, mukesh27, johnbillion.
Fixes <a href="https://core.trac.wordpress.org/ticket/56698">#56698</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswplocalephp">trunk/src/wp-includes/class-wp-locale.php</a></li>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
<li><a href="#trunktestsphpunittestslocalephp">trunk/tests/phpunit/tests/locale.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswplocalephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-locale.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-locale.php 2023-02-07 17:22:41 UTC (rev 55278)
+++ trunk/src/wp-includes/class-wp-locale.php 2023-02-07 17:26:14 UTC (rev 55279)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -113,6 +113,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $list_item_separator;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The word count type of the locale language.
+ *
+ * Default is 'words'.
+ *
+ * @since 6.2.0
+ * @var string
+ */
+ public $word_count_type;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Constructor which calls helper methods to set up object variables.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -236,6 +246,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'rtl' === _x( 'ltr', 'text direction' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->text_direction = 'rtl';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Set the word count type.
+ $this->word_count_type = $this->get_word_count_type();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -396,4 +409,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_list_item_separator() {
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->list_item_separator;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Retrieves the localized word count type.
+ *
+ * Options are 'characters_excluding_spaces', 'characters_including_spaces or 'words'. Defaults to 'words'.
+ *
+ * @since 6.2.0
+ *
+ * @return string Localized word count type.
+ */
+ public function get_word_count_type() {
+
+ /*
+ * 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.
+ */
+ $word_count_type = is_null( $this->word_count_type ) ? _x( 'words', 'Word count type. Do not translate!' ) : $this->word_count_type;
+
+ // Check for valid types.
+ if ( 'characters_excluding_spaces' !== $word_count_type && 'characters_including_spaces' !== $word_count_type ) {
+ // Defaults to 'words'.
+ $word_count_type = 'words';
+ }
+
+ return $word_count_type;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesformattingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2023-02-07 17:22:41 UTC (rev 55278)
+++ trunk/src/wp-includes/formatting.php 2023-02-07 17:26:14 UTC (rev 55279)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3945,12 +3945,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $text = wp_strip_all_tags( $text );
</span><span class="cx" style="display: block; padding: 0 10px"> $num_words = (int) $num_words;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * 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.
- */
- if ( strpos( _x( 'words', 'Word count type. Do not translate!' ), 'characters' ) === 0 && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( str_starts_with( wp_get_word_count_type(), 'characters' ) && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' );
</span><span class="cx" style="display: block; padding: 0 10px"> preg_match_all( '/./u', $text, $words_array );
</span><span class="cx" style="display: block; padding: 0 10px"> $words_array = array_slice( $words_array[0], 0, $num_words + 1 );
</span></span></pre></div>
<a id="trunksrcwpincludesl10nphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/l10n.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/l10n.php 2023-02-07 17:22:41 UTC (rev 55278)
+++ trunk/src/wp-includes/l10n.php 2023-02-07 17:26:14 UTC (rev 55279)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1809,3 +1809,18 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $wp_locale->get_list_item_separator();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Retrieves the word count type based on the locale.
+ *
+ * @since 6.2.0
+ *
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
+ *
+ * @return string Locale-specific word count type.
+ */
+function wp_get_word_count_type() {
+ global $wp_locale;
+
+ return $wp_locale->get_word_count_type();
+}
</ins></span></pre></div>
<a id="trunksrcwpincludesscriptloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2023-02-07 17:22:41 UTC (rev 55278)
+++ trunk/src/wp-includes/script-loader.php 2023-02-07 17:26:14 UTC (rev 55279)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1831,12 +1831,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'word-count',
</span><span class="cx" style="display: block; padding: 0 10px"> 'wordCountL10n',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * 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.
- */
- 'type' => _x( 'words', 'Word count type. Do not translate!' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => wp_get_word_count_type(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'shortcodes' => ! empty( $GLOBALS['shortcode_tags'] ) ? array_keys( $GLOBALS['shortcode_tags'] ) : array(),
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre></div>
<a id="trunktestsphpunittestslocalephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/locale.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/locale.php 2023-02-07 17:22:41 UTC (rev 55278)
+++ trunk/tests/phpunit/tests/locale.php 2023-02-07 17:26:14 UTC (rev 55279)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -173,6 +173,62 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->locale->text_direction = 'ltr';
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $this->locale->is_rtl() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that `WP_Locale::get_word_count_type()` returns
+ * the appropriate value.
+ *
+ * @ticket 56698
+ *
+ * @covers WP_Locale::get_word_count_type
+ *
+ * @dataProvider data_get_word_count_type
+ *
+ * @param string $word_count_type The word count type.
+ * @param string $expected The expected return value.
+ */
+ public function test_get_word_count_type( $word_count_type, $expected ) {
+ if ( is_string( $word_count_type ) ) {
+ $this->locale->word_count_type = $word_count_type;
+
+ }
+
+ $this->assertSame( $expected, $this->locale->get_word_count_type() );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_get_word_count_type() {
+ return array(
+ 'default' => array(
+ 'word_count_type' => null,
+ 'expected' => 'words',
+ ),
+ 'empty string' => array(
+ 'word_count_type' => '',
+ 'expected' => 'words',
+ ),
+ 'an invalid option - "foo"' => array(
+ 'word_count_type' => 'foo',
+ 'expected' => 'words',
+ ),
+ 'a valid option - "words"' => array(
+ 'word_count_type' => 'words',
+ 'expected' => 'words',
+ ),
+ 'a valid option - "characters_excluding_spaces"' => array(
+ 'word_count_type' => 'characters_excluding_spaces',
+ 'expected' => 'characters_excluding_spaces',
+ ),
+ 'a valid option - "characters_including_spaces"' => array(
+ 'word_count_type' => 'characters_including_spaces',
+ 'expected' => 'characters_including_spaces',
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> class Custom_WP_Locale extends WP_Locale {
</span></span></pre>
</div>
</div>
</body>
</html>