Changeset 55295

Timestamp:

02/08/2023 10:15:33 AM (20 months ago)

Author:

SergeyBiryukov

Message:

Docs: Document possible return values for wp_get_word_count_type().

Follow-up to [55279].

See #56698.

Location:

trunk/src/wp-includes

Files:

• class-wp-locale.php (modified) (1 diff)
• l10n.php (modified) (1 diff)

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

@@ -414 +414 @@
      * 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.
+     * @return string Localized word count type. Possible values are `characters_excluding_spaces`,
+     *                `characters_including_spaces`, or `words`. Defaults to `words`.
      */
     public function get_word_count_type() {

trunk/src/wp-includes/l10n.php

@@ -1818 +1818 @@
  * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
- * @return string Locale-specific word count type.
+ * @return string Locale-specific word count type. Possible values are `characters_excluding_spaces`,
+ *                `characters_including_spaces`, or `words`. Defaults to `words`.
  */
 function wp_get_word_count_type() {