summaryrefslogtreecommitdiffstats
path: root/wp-includes/class-wp-locale.php
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
commita415c29efee45520ae252d2aa28f1083a521cd7b (patch)
treef4ade4b6668ecc0765de7e1424f7c1427ad433ff /wp-includes/class-wp-locale.php
parentInitial commit. (diff)
downloadwordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.tar.xz
wordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.zip
Adding upstream version 6.4.3+dfsg1.upstream/6.4.3+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'wp-includes/class-wp-locale.php')
-rw-r--r--wp-includes/class-wp-locale.php440
1 files changed, 440 insertions, 0 deletions
diff --git a/wp-includes/class-wp-locale.php b/wp-includes/class-wp-locale.php
new file mode 100644
index 0000000..36be8ee
--- /dev/null
+++ b/wp-includes/class-wp-locale.php
@@ -0,0 +1,440 @@
+<?php
+/**
+ * Locale API: WP_Locale class
+ *
+ * @package WordPress
+ * @subpackage i18n
+ * @since 4.6.0
+ */
+
+/**
+ * Core class used to store translated data for a locale.
+ *
+ * @since 2.1.0
+ * @since 4.6.0 Moved to its own file from wp-includes/locale.php.
+ */
+#[AllowDynamicProperties]
+class WP_Locale {
+ /**
+ * Stores the translated strings for the full weekday names.
+ *
+ * @since 2.1.0
+ * @since 6.2.0 Initialized to an empty array.
+ * @var string[]
+ */
+ public $weekday = array();
+
+ /**
+ * Stores the translated strings for the one character weekday names.
+ *
+ * There is a hack to make sure that Tuesday and Thursday, as well
+ * as Sunday and Saturday, don't conflict. See init() method for more.
+ *
+ * @see WP_Locale::init() for how to handle the hack.
+ *
+ * @since 2.1.0
+ * @since 6.2.0 Initialized to an empty array.
+ * @var string[]
+ */
+ public $weekday_initial = array();
+
+ /**
+ * Stores the translated strings for the abbreviated weekday names.
+ *
+ * @since 2.1.0
+ * @since 6.2.0 Initialized to an empty array.
+ * @var string[]
+ */
+ public $weekday_abbrev = array();
+
+ /**
+ * Stores the translated strings for the full month names.
+ *
+ * @since 2.1.0
+ * @since 6.2.0 Initialized to an empty array.
+ * @var string[]
+ */
+ public $month = array();
+
+ /**
+ * Stores the translated strings for the month names in genitive case, if the locale specifies.
+ *
+ * @since 4.4.0
+ * @since 6.2.0 Initialized to an empty array.
+ * @var string[]
+ */
+ public $month_genitive = array();
+
+ /**
+ * Stores the translated strings for the abbreviated month names.
+ *
+ * @since 2.1.0
+ * @since 6.2.0 Initialized to an empty array.
+ * @var string[]
+ */
+ public $month_abbrev = array();
+
+ /**
+ * Stores the translated strings for 'am' and 'pm'.
+ *
+ * Also the capitalized versions.
+ *
+ * @since 2.1.0
+ * @since 6.2.0 Initialized to an empty array.
+ * @var string[]
+ */
+ public $meridiem = array();
+
+ /**
+ * The text direction of the locale language.
+ *
+ * Default is left to right 'ltr'.
+ *
+ * @since 2.1.0
+ * @var string
+ */
+ public $text_direction = 'ltr';
+
+ /**
+ * The thousands separator and decimal point values used for localizing numbers.
+ *
+ * @since 2.3.0
+ * @since 6.2.0 Initialized to an empty array.
+ * @var array
+ */
+ public $number_format = array();
+
+ /**
+ * The separator string used for localizing list item separator.
+ *
+ * @since 6.0.0
+ * @var string
+ */
+ 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;
+
+ /**
+ * Constructor which calls helper methods to set up object variables.
+ *
+ * @since 2.1.0
+ */
+ public function __construct() {
+ $this->init();
+ $this->register_globals();
+ }
+
+ /**
+ * Sets up the translated strings and object properties.
+ *
+ * The method creates the translatable strings for various
+ * calendar elements. Which allows for specifying locale
+ * specific calendar names and text direction.
+ *
+ * @since 2.1.0
+ *
+ * @global string $text_direction
+ */
+ public function init() {
+ // The weekdays.
+ $this->weekday[0] = /* translators: Weekday. */ __( 'Sunday' );
+ $this->weekday[1] = /* translators: Weekday. */ __( 'Monday' );
+ $this->weekday[2] = /* translators: Weekday. */ __( 'Tuesday' );
+ $this->weekday[3] = /* translators: Weekday. */ __( 'Wednesday' );
+ $this->weekday[4] = /* translators: Weekday. */ __( 'Thursday' );
+ $this->weekday[5] = /* translators: Weekday. */ __( 'Friday' );
+ $this->weekday[6] = /* translators: Weekday. */ __( 'Saturday' );
+
+ // The first letter of each day.
+ $this->weekday_initial[ $this->weekday[0] ] = /* translators: One-letter abbreviation of the weekday. */ _x( 'S', 'Sunday initial' );
+ $this->weekday_initial[ $this->weekday[1] ] = /* translators: One-letter abbreviation of the weekday. */ _x( 'M', 'Monday initial' );
+ $this->weekday_initial[ $this->weekday[2] ] = /* translators: One-letter abbreviation of the weekday. */ _x( 'T', 'Tuesday initial' );
+ $this->weekday_initial[ $this->weekday[3] ] = /* translators: One-letter abbreviation of the weekday. */ _x( 'W', 'Wednesday initial' );
+ $this->weekday_initial[ $this->weekday[4] ] = /* translators: One-letter abbreviation of the weekday. */ _x( 'T', 'Thursday initial' );
+ $this->weekday_initial[ $this->weekday[5] ] = /* translators: One-letter abbreviation of the weekday. */ _x( 'F', 'Friday initial' );
+ $this->weekday_initial[ $this->weekday[6] ] = /* translators: One-letter abbreviation of the weekday. */ _x( 'S', 'Saturday initial' );
+
+ // Abbreviations for each day.
+ $this->weekday_abbrev[ $this->weekday[0] ] = /* translators: Three-letter abbreviation of the weekday. */ __( 'Sun' );
+ $this->weekday_abbrev[ $this->weekday[1] ] = /* translators: Three-letter abbreviation of the weekday. */ __( 'Mon' );
+ $this->weekday_abbrev[ $this->weekday[2] ] = /* translators: Three-letter abbreviation of the weekday. */ __( 'Tue' );
+ $this->weekday_abbrev[ $this->weekday[3] ] = /* translators: Three-letter abbreviation of the weekday. */ __( 'Wed' );
+ $this->weekday_abbrev[ $this->weekday[4] ] = /* translators: Three-letter abbreviation of the weekday. */ __( 'Thu' );
+ $this->weekday_abbrev[ $this->weekday[5] ] = /* translators: Three-letter abbreviation of the weekday. */ __( 'Fri' );
+ $this->weekday_abbrev[ $this->weekday[6] ] = /* translators: Three-letter abbreviation of the weekday. */ __( 'Sat' );
+
+ // The months.
+ $this->month['01'] = /* translators: Month name. */ __( 'January' );
+ $this->month['02'] = /* translators: Month name. */ __( 'February' );
+ $this->month['03'] = /* translators: Month name. */ __( 'March' );
+ $this->month['04'] = /* translators: Month name. */ __( 'April' );
+ $this->month['05'] = /* translators: Month name. */ __( 'May' );
+ $this->month['06'] = /* translators: Month name. */ __( 'June' );
+ $this->month['07'] = /* translators: Month name. */ __( 'July' );
+ $this->month['08'] = /* translators: Month name. */ __( 'August' );
+ $this->month['09'] = /* translators: Month name. */ __( 'September' );
+ $this->month['10'] = /* translators: Month name. */ __( 'October' );
+ $this->month['11'] = /* translators: Month name. */ __( 'November' );
+ $this->month['12'] = /* translators: Month name. */ __( 'December' );
+
+ // The months, genitive.
+ $this->month_genitive['01'] = /* translators: Month name, genitive. */ _x( 'January', 'genitive' );
+ $this->month_genitive['02'] = /* translators: Month name, genitive. */ _x( 'February', 'genitive' );
+ $this->month_genitive['03'] = /* translators: Month name, genitive. */ _x( 'March', 'genitive' );
+ $this->month_genitive['04'] = /* translators: Month name, genitive. */ _x( 'April', 'genitive' );
+ $this->month_genitive['05'] = /* translators: Month name, genitive. */ _x( 'May', 'genitive' );
+ $this->month_genitive['06'] = /* translators: Month name, genitive. */ _x( 'June', 'genitive' );
+ $this->month_genitive['07'] = /* translators: Month name, genitive. */ _x( 'July', 'genitive' );
+ $this->month_genitive['08'] = /* translators: Month name, genitive. */ _x( 'August', 'genitive' );
+ $this->month_genitive['09'] = /* translators: Month name, genitive. */ _x( 'September', 'genitive' );
+ $this->month_genitive['10'] = /* translators: Month name, genitive. */ _x( 'October', 'genitive' );
+ $this->month_genitive['11'] = /* translators: Month name, genitive. */ _x( 'November', 'genitive' );
+ $this->month_genitive['12'] = /* translators: Month name, genitive. */ _x( 'December', 'genitive' );
+
+ // Abbreviations for each month.
+ $this->month_abbrev[ $this->month['01'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Jan', 'January abbreviation' );
+ $this->month_abbrev[ $this->month['02'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Feb', 'February abbreviation' );
+ $this->month_abbrev[ $this->month['03'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Mar', 'March abbreviation' );
+ $this->month_abbrev[ $this->month['04'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Apr', 'April abbreviation' );
+ $this->month_abbrev[ $this->month['05'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'May', 'May abbreviation' );
+ $this->month_abbrev[ $this->month['06'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Jun', 'June abbreviation' );
+ $this->month_abbrev[ $this->month['07'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Jul', 'July abbreviation' );
+ $this->month_abbrev[ $this->month['08'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Aug', 'August abbreviation' );
+ $this->month_abbrev[ $this->month['09'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Sep', 'September abbreviation' );
+ $this->month_abbrev[ $this->month['10'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Oct', 'October abbreviation' );
+ $this->month_abbrev[ $this->month['11'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Nov', 'November abbreviation' );
+ $this->month_abbrev[ $this->month['12'] ] = /* translators: Three-letter abbreviation of the month. */ _x( 'Dec', 'December abbreviation' );
+
+ // The meridiems.
+ $this->meridiem['am'] = __( 'am' );
+ $this->meridiem['pm'] = __( 'pm' );
+ $this->meridiem['AM'] = __( 'AM' );
+ $this->meridiem['PM'] = __( 'PM' );
+
+ /*
+ * Numbers formatting.
+ * See https://www.php.net/number_format
+ */
+
+ /* translators: $thousands_sep argument for https://www.php.net/number_format, default is ',' */
+ $thousands_sep = __( 'number_format_thousands_sep' );
+
+ // Replace space with a non-breaking space to avoid wrapping.
+ $thousands_sep = str_replace( ' ', '&nbsp;', $thousands_sep );
+
+ $this->number_format['thousands_sep'] = ( 'number_format_thousands_sep' === $thousands_sep ) ? ',' : $thousands_sep;
+
+ /* translators: $dec_point argument for https://www.php.net/number_format, default is '.' */
+ $decimal_point = __( 'number_format_decimal_point' );
+
+ $this->number_format['decimal_point'] = ( 'number_format_decimal_point' === $decimal_point ) ? '.' : $decimal_point;
+
+ /* translators: Used between list items, there is a space after the comma. */
+ $this->list_item_separator = __( ', ' );
+
+ // Set text direction.
+ if ( isset( $GLOBALS['text_direction'] ) ) {
+ $this->text_direction = $GLOBALS['text_direction'];
+
+ /* translators: 'rtl' or 'ltr'. This sets the text direction for WordPress. */
+ } elseif ( 'rtl' === _x( 'ltr', 'text direction' ) ) {
+ $this->text_direction = 'rtl';
+ }
+
+ // Set the word count type.
+ $this->word_count_type = $this->get_word_count_type();
+ }
+
+ /**
+ * Retrieves the full translated weekday word.
+ *
+ * Week starts on translated Sunday and can be fetched
+ * by using 0 (zero). So the week starts with 0 (zero)
+ * and ends on Saturday with is fetched by using 6 (six).
+ *
+ * @since 2.1.0
+ *
+ * @param int $weekday_number 0 for Sunday through 6 Saturday.
+ * @return string Full translated weekday.
+ */
+ public function get_weekday( $weekday_number ) {
+ return $this->weekday[ $weekday_number ];
+ }
+
+ /**
+ * Retrieves the translated weekday initial.
+ *
+ * The weekday initial is retrieved by the translated
+ * full weekday word. When translating the weekday initial
+ * pay attention to make sure that the starting letter does
+ * not conflict.
+ *
+ * @since 2.1.0
+ *
+ * @param string $weekday_name Full translated weekday word.
+ * @return string Translated weekday initial.
+ */
+ public function get_weekday_initial( $weekday_name ) {
+ return $this->weekday_initial[ $weekday_name ];
+ }
+
+ /**
+ * Retrieves the translated weekday abbreviation.
+ *
+ * The weekday abbreviation is retrieved by the translated
+ * full weekday word.
+ *
+ * @since 2.1.0
+ *
+ * @param string $weekday_name Full translated weekday word.
+ * @return string Translated weekday abbreviation.
+ */
+ public function get_weekday_abbrev( $weekday_name ) {
+ return $this->weekday_abbrev[ $weekday_name ];
+ }
+
+ /**
+ * Retrieves the full translated month by month number.
+ *
+ * The $month_number parameter has to be a string
+ * because it must have the '0' in front of any number
+ * that is less than 10. Starts from '01' and ends at
+ * '12'.
+ *
+ * You can use an integer instead and it will add the
+ * '0' before the numbers less than 10 for you.
+ *
+ * @since 2.1.0
+ *
+ * @param string|int $month_number '01' through '12'.
+ * @return string Translated full month name.
+ */
+ public function get_month( $month_number ) {
+ return $this->month[ zeroise( $month_number, 2 ) ];
+ }
+
+ /**
+ * Retrieves translated version of month abbreviation string.
+ *
+ * The $month_name parameter is expected to be the translated or
+ * translatable version of the month.
+ *
+ * @since 2.1.0
+ *
+ * @param string $month_name Translated month to get abbreviated version.
+ * @return string Translated abbreviated month.
+ */
+ public function get_month_abbrev( $month_name ) {
+ return $this->month_abbrev[ $month_name ];
+ }
+
+ /**
+ * Retrieves translated version of meridiem string.
+ *
+ * The $meridiem parameter is expected to not be translated.
+ *
+ * @since 2.1.0
+ *
+ * @param string $meridiem Either 'am', 'pm', 'AM', or 'PM'. Not translated version.
+ * @return string Translated version
+ */
+ public function get_meridiem( $meridiem ) {
+ return $this->meridiem[ $meridiem ];
+ }
+
+ /**
+ * Global variables are deprecated.
+ *
+ * For backward compatibility only.
+ *
+ * @deprecated For backward compatibility only.
+ *
+ * @global array $weekday
+ * @global array $weekday_initial
+ * @global array $weekday_abbrev
+ * @global array $month
+ * @global array $month_abbrev
+ *
+ * @since 2.1.0
+ */
+ public function register_globals() {
+ $GLOBALS['weekday'] = $this->weekday;
+ $GLOBALS['weekday_initial'] = $this->weekday_initial;
+ $GLOBALS['weekday_abbrev'] = $this->weekday_abbrev;
+ $GLOBALS['month'] = $this->month;
+ $GLOBALS['month_abbrev'] = $this->month_abbrev;
+ }
+
+ /**
+ * Checks if current locale is RTL.
+ *
+ * @since 3.0.0
+ * @return bool Whether locale is RTL.
+ */
+ public function is_rtl() {
+ return 'rtl' === $this->text_direction;
+ }
+
+ /**
+ * Registers date/time format strings for general POT.
+ *
+ * Private, unused method to add some date/time formats translated
+ * on wp-admin/options-general.php to the general POT that would
+ * otherwise be added to the admin POT.
+ *
+ * @since 3.6.0
+ */
+ public function _strings_for_pot() {
+ /* translators: Localized date format, see https://www.php.net/manual/datetime.format.php */
+ __( 'F j, Y' );
+ /* translators: Localized time format, see https://www.php.net/manual/datetime.format.php */
+ __( 'g:i a' );
+ /* translators: Localized date and time format, see https://www.php.net/manual/datetime.format.php */
+ __( 'F j, Y g:i a' );
+ }
+
+ /**
+ * Retrieves the localized list item separator.
+ *
+ * @since 6.0.0
+ *
+ * @return string Localized list item separator.
+ */
+ public function get_list_item_separator() {
+ return $this->list_item_separator;
+ }
+
+ /**
+ * Retrieves the localized word count type.
+ *
+ * @since 6.2.0
+ *
+ * @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() {
+
+ /*
+ * 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;
+ }
+}