123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392 |
- <?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
- * @var string[]
- */
- public $weekday;
- /**
- * 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
- * @var string[]
- */
- public $weekday_initial;
- /**
- * Stores the translated strings for the abbreviated weekday names.
- *
- * @since 2.1.0
- * @var string[]
- */
- public $weekday_abbrev;
- /**
- * Stores the translated strings for the full month names.
- *
- * @since 2.1.0
- * @var string[]
- */
- public $month;
- /**
- * Stores the translated strings for the month names in genitive case, if the locale specifies.
- *
- * @since 4.4.0
- * @var string[]
- */
- public $month_genitive;
- /**
- * Stores the translated strings for the abbreviated month names.
- *
- * @since 2.1.0
- * @var string[]
- */
- public $month_abbrev;
- /**
- * Stores the translated strings for 'am' and 'pm'.
- *
- * Also the capitalized versions.
- *
- * @since 2.1.0
- * @var string[]
- */
- public $meridiem;
- /**
- * 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
- * @var array
- */
- public $number_format;
- /**
- * The separator string used for localizing list item separator.
- *
- * @since 6.0.0
- * @var string
- */
- public $list_item_separator;
- /**
- * 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
- * @global string $wp_version The WordPress version string.
- */
- 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( ' ', ' ', $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';
- }
- }
- /**
- * 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;
- }
- }
|