From fe119088ec3835c6c7ea9a4dd3adca3c91035ea2 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Wed, 8 Feb 2023 10:15:33 +0000 Subject: [PATCH] Docs: Document possible return values for `wp_get_word_count_type()`. Follow-up to [55279]. See #56698. git-svn-id: https://develop.svn.wordpress.org/trunk@55295 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-locale.php | 5 ++--- src/wp-includes/l10n.php | 3 ++- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/class-wp-locale.php b/src/wp-includes/class-wp-locale.php index 82a79c3750..38b1860b89 100644 --- a/src/wp-includes/class-wp-locale.php +++ b/src/wp-includes/class-wp-locale.php @@ -413,11 +413,10 @@ class WP_Locale { /** * 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() { diff --git a/src/wp-includes/l10n.php b/src/wp-includes/l10n.php index 3a620ee3ca..52a51d5147 100644 --- a/src/wp-includes/l10n.php +++ b/src/wp-includes/l10n.php @@ -1817,7 +1817,8 @@ function wp_get_list_item_separator() { * * @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() { global $wp_locale;