Changeset 55279 for trunk/src/wp-includes/class-wp-locale.php

Timestamp:

02/07/2023 05:26:14 PM (4 years ago)

Author:

audrasjb

Message:

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 #56698.

File:

• trunk/src/wp-includes/class-wp-locale.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-locale.php

@@ -112 +112 @@
          */
         public $list_item_separator;
+
+        /**
+         * The word count type of the locale language.
+         *
+         * Default is 'words'.
+         *
+         * @since 6.2.0
+         * @var string
+         */
+        public $word_count_type;
 
         /**
@@ -237 +247 @@
                         $this->text_direction = 'rtl';
                 }
+
+                // Set the word count type.
+                $this->word_count_type = $this->get_word_count_type();
         }
 
@@ -397 +410 @@
                 return $this->list_item_separator;
         }
+
+        /**
+         * 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;
+        }
 }