wp-includes/locale.php

   1 <?php
   2 /**
   3  * Date and Time Locale object
   4  *
   5  * @package WordPress
   6  * @subpackage i18n
   7  */
   8
   9 /**
  10  * Class that loads the calendar locale.
  11  *
  12  * @since 2.1.0
  13  */
  14 class WP_Locale {
  15         /**
  16          * Stores the translated strings for the full weekday names.
  17          *
  18          * @since 2.1.0
  19          * @var array
  20          */
  21         public $weekday;
  22
  23         /**
  24          * Stores the translated strings for the one character weekday names.
  25          *
  26          * There is a hack to make sure that Tuesday and Thursday, as well
  27          * as Sunday and Saturday, don't conflict. See init() method for more.
  28          *
  29          * @see WP_Locale::init() for how to handle the hack.
  30          *
  31          * @since 2.1.0
  32          * @var array
  33          */
  34         public $weekday_initial;
  35
  36         /**
  37          * Stores the translated strings for the abbreviated weekday names.
  38          *
  39          * @since 2.1.0
  40          * @var array
  41          */
  42         public $weekday_abbrev;
  43
  44         /**
  45          * Stores the translated strings for the full month names.
  46          *
  47          * @since 2.1.0
  48          * @var array
  49          */
  50         public $month;
  51
  52         /**
  53          * Stores the translated strings for the abbreviated month names.
  54          *
  55          * @since 2.1.0
  56          * @var array
  57          */
  58         public $month_abbrev;
  59
  60         /**
  61          * Stores the translated strings for 'am' and 'pm'.
  62          *
  63          * Also the capitalized versions.
  64          *
  65          * @since 2.1.0
  66          * @var array
  67          */
  68         public $meridiem;
  69
  70         /**
  71          * The text direction of the locale language.
  72          *
  73          * Default is left to right 'ltr'.
  74          *
  75          * @since 2.1.0
  76          * @var string
  77          */
  78         public $text_direction = 'ltr';
  79
  80         /**
  81          * @var array
  82          */
  83         public $number_format;
  84
  85         /**
  86          * Sets up the translated strings and object properties.
  87          *
  88          * The method creates the translatable strings for various
  89          * calendar elements. Which allows for specifying locale
  90          * specific calendar names and text direction.
  91          *
  92          * @since 2.1.0
  93          * @access private
  94          *
  95          * @global string $text_direction
  96          * @global string $wp_version
  97          */
  98         public function init() {
  99                 // The Weekdays
 100                 $this->weekday[0] = /* translators: weekday */ __('Sunday');
 101                 $this->weekday[1] = /* translators: weekday */ __('Monday');
 102                 $this->weekday[2] = /* translators: weekday */ __('Tuesday');
 103                 $this->weekday[3] = /* translators: weekday */ __('Wednesday');
 104                 $this->weekday[4] = /* translators: weekday */ __('Thursday');
 105                 $this->weekday[5] = /* translators: weekday */ __('Friday');
 106                 $this->weekday[6] = /* translators: weekday */ __('Saturday');
 107
 108                 // The first letter of each day. The _%day%_initial suffix is a hack to make
 109                 // sure the day initials are unique.
 110                 $this->weekday_initial[__('Sunday')]    = /* translators: one-letter abbreviation of the weekday */ __('S_Sunday_initial');
 111                 $this->weekday_initial[__('Monday')]    = /* translators: one-letter abbreviation of the weekday */ __('M_Monday_initial');
 112                 $this->weekday_initial[__('Tuesday')]   = /* translators: one-letter abbreviation of the weekday */ __('T_Tuesday_initial');
 113                 $this->weekday_initial[__('Wednesday')] = /* translators: one-letter abbreviation of the weekday */ __('W_Wednesday_initial');
 114                 $this->weekday_initial[__('Thursday')]  = /* translators: one-letter abbreviation of the weekday */ __('T_Thursday_initial');
 115                 $this->weekday_initial[__('Friday')]    = /* translators: one-letter abbreviation of the weekday */ __('F_Friday_initial');
 116                 $this->weekday_initial[__('Saturday')]  = /* translators: one-letter abbreviation of the weekday */ __('S_Saturday_initial');
 117
 118                 foreach ($this->weekday_initial as $weekday_ => $weekday_initial_) {
 119                         $this->weekday_initial[$weekday_] = preg_replace('/_.+_initial$/', '', $weekday_initial_);
 120                 }
 121
 122                 // Abbreviations for each day.
 123                 $this->weekday_abbrev[__('Sunday')]    = /* translators: three-letter abbreviation of the weekday */ __('Sun');
 124                 $this->weekday_abbrev[__('Monday')]    = /* translators: three-letter abbreviation of the weekday */ __('Mon');
 125                 $this->weekday_abbrev[__('Tuesday')]   = /* translators: three-letter abbreviation of the weekday */ __('Tue');
 126                 $this->weekday_abbrev[__('Wednesday')] = /* translators: three-letter abbreviation of the weekday */ __('Wed');
 127                 $this->weekday_abbrev[__('Thursday')]  = /* translators: three-letter abbreviation of the weekday */ __('Thu');
 128                 $this->weekday_abbrev[__('Friday')]    = /* translators: three-letter abbreviation of the weekday */ __('Fri');
 129                 $this->weekday_abbrev[__('Saturday')]  = /* translators: three-letter abbreviation of the weekday */ __('Sat');
 130
 131                 // The Months
 132                 $this->month['01'] = /* translators: month name */ __('January');
 133                 $this->month['02'] = /* translators: month name */ __('February');
 134                 $this->month['03'] = /* translators: month name */ __('March');
 135                 $this->month['04'] = /* translators: month name */ __('April');
 136                 $this->month['05'] = /* translators: month name */ __('May');
 137                 $this->month['06'] = /* translators: month name */ __('June');
 138                 $this->month['07'] = /* translators: month name */ __('July');
 139                 $this->month['08'] = /* translators: month name */ __('August');
 140                 $this->month['09'] = /* translators: month name */ __('September');
 141                 $this->month['10'] = /* translators: month name */ __('October');
 142                 $this->month['11'] = /* translators: month name */ __('November');
 143                 $this->month['12'] = /* translators: month name */ __('December');
 144
 145                 // Abbreviations for each month. Uses the same hack as above to get around the
 146                 // 'May' duplication.
 147                 $this->month_abbrev[__('January')] = /* translators: three-letter abbreviation of the month */ __('Jan_January_abbreviation');
 148                 $this->month_abbrev[__('February')] = /* translators: three-letter abbreviation of the month */ __('Feb_February_abbreviation');
 149                 $this->month_abbrev[__('March')] = /* translators: three-letter abbreviation of the month */ __('Mar_March_abbreviation');
 150                 $this->month_abbrev[__('April')] = /* translators: three-letter abbreviation of the month */ __('Apr_April_abbreviation');
 151                 $this->month_abbrev[__('May')] = /* translators: three-letter abbreviation of the month */ __('May_May_abbreviation');
 152                 $this->month_abbrev[__('June')] = /* translators: three-letter abbreviation of the month */ __('Jun_June_abbreviation');
 153                 $this->month_abbrev[__('July')] = /* translators: three-letter abbreviation of the month */ __('Jul_July_abbreviation');
 154                 $this->month_abbrev[__('August')] = /* translators: three-letter abbreviation of the month */ __('Aug_August_abbreviation');
 155                 $this->month_abbrev[__('September')] = /* translators: three-letter abbreviation of the month */ __('Sep_September_abbreviation');
 156                 $this->month_abbrev[__('October')] = /* translators: three-letter abbreviation of the month */ __('Oct_October_abbreviation');
 157                 $this->month_abbrev[__('November')] = /* translators: three-letter abbreviation of the month */ __('Nov_November_abbreviation');
 158                 $this->month_abbrev[__('December')] = /* translators: three-letter abbreviation of the month */ __('Dec_December_abbreviation');
 159
 160                 foreach ($this->month_abbrev as $month_ => $month_abbrev_) {
 161                         $this->month_abbrev[$month_] = preg_replace('/_.+_abbreviation$/', '', $month_abbrev_);
 162                 }
 163
 164                 // The Meridiems
 165                 $this->meridiem['am'] = __('am');
 166                 $this->meridiem['pm'] = __('pm');
 167                 $this->meridiem['AM'] = __('AM');
 168                 $this->meridiem['PM'] = __('PM');
 169
 170                 // Numbers formatting
 171                 // See http://php.net/number_format
 172
 173                 /* translators: $thousands_sep argument for http://php.net/number_format, default is , */
 174                 $trans = __('number_format_thousands_sep');
 175                 $this->number_format['thousands_sep'] = ('number_format_thousands_sep' == $trans) ? ',' : $trans;
 176
 177                 /* translators: $dec_point argument for http://php.net/number_format, default is . */
 178                 $trans = __('number_format_decimal_point');
 179                 $this->number_format['decimal_point'] = ('number_format_decimal_point' == $trans) ? '.' : $trans;
 180
 181                 // Set text direction.
 182                 if ( isset( $GLOBALS['text_direction'] ) )
 183                         $this->text_direction = $GLOBALS['text_direction'];
 184                 /* translators: 'rtl' or 'ltr'. This sets the text direction for WordPress. */
 185                 elseif ( 'rtl' == _x( 'ltr', 'text direction' ) )
 186                         $this->text_direction = 'rtl';
 187
 188                 if ( 'rtl' === $this->text_direction && strpos( $GLOBALS['wp_version'], '-src' ) ) {
 189                         $this->text_direction = 'ltr';
 190                         add_action( 'all_admin_notices', array( $this, 'rtl_src_admin_notice' ) );
 191                 }
 192         }
 193
 194         /**
 195          * @since 3.8.0
 196          */
 197         public function rtl_src_admin_notice() {
 198                 /* translators: %s: Name of the directory (build) */
 199                 echo '<div class="error"><p>' . sprintf( __( 'The %s directory of the develop repository must be used for RTL.' ), '<code>build</code>' ) . '</p></div>';
 200         }
 201
 202         /**
 203          * Retrieve the full translated weekday word.
 204          *
 205          * Week starts on translated Sunday and can be fetched
 206          * by using 0 (zero). So the week starts with 0 (zero)
 207          * and ends on Saturday with is fetched by using 6 (six).
 208          *
 209          * @since 2.1.0
 210          * @access public
 211          *
 212          * @param int $weekday_number 0 for Sunday through 6 Saturday
 213          * @return string Full translated weekday
 214          */
 215         public function get_weekday($weekday_number) {
 216                 return $this->weekday[$weekday_number];
 217         }
 218
 219         /**
 220          * Retrieve the translated weekday initial.
 221          *
 222          * The weekday initial is retrieved by the translated
 223          * full weekday word. When translating the weekday initial
 224          * pay attention to make sure that the starting letter does
 225          * not conflict.
 226          *
 227          * @since 2.1.0
 228          * @access public
 229          *
 230          * @param string $weekday_name
 231          * @return string
 232          */
 233         public function get_weekday_initial($weekday_name) {
 234                 return $this->weekday_initial[$weekday_name];
 235         }
 236
 237         /**
 238          * Retrieve the translated weekday abbreviation.
 239          *
 240          * The weekday abbreviation is retrieved by the translated
 241          * full weekday word.
 242          *
 243          * @since 2.1.0
 244          * @access public
 245          *
 246          * @param string $weekday_name Full translated weekday word
 247          * @return string Translated weekday abbreviation
 248          */
 249         public function get_weekday_abbrev($weekday_name) {
 250                 return $this->weekday_abbrev[$weekday_name];
 251         }
 252
 253         /**
 254          * Retrieve the full translated month by month number.
 255          *
 256          * The $month_number parameter has to be a string
 257          * because it must have the '0' in front of any number
 258          * that is less than 10. Starts from '01' and ends at
 259          * '12'.
 260          *
 261          * You can use an integer instead and it will add the
 262          * '0' before the numbers less than 10 for you.
 263          *
 264          * @since 2.1.0
 265          * @access public
 266          *
 267          * @param string|int $month_number '01' through '12'
 268          * @return string Translated full month name
 269          */
 270         public function get_month($month_number) {
 271                 return $this->month[zeroise($month_number, 2)];
 272         }
 273
 274         /**
 275          * Retrieve translated version of month abbreviation string.
 276          *
 277          * The $month_name parameter is expected to be the translated or
 278          * translatable version of the month.
 279          *
 280          * @since 2.1.0
 281          * @access public
 282          *
 283          * @param string $month_name Translated month to get abbreviated version
 284          * @return string Translated abbreviated month
 285          */
 286         public function get_month_abbrev($month_name) {
 287                 return $this->month_abbrev[$month_name];
 288         }
 289
 290         /**
 291          * Retrieve translated version of meridiem string.
 292          *
 293          * The $meridiem parameter is expected to not be translated.
 294          *
 295          * @since 2.1.0
 296          * @access public
 297          *
 298          * @param string $meridiem Either 'am', 'pm', 'AM', or 'PM'. Not translated version.
 299          * @return string Translated version
 300          */
 301         public function get_meridiem($meridiem) {
 302                 return $this->meridiem[$meridiem];
 303         }
 304
 305         /**
 306          * Global variables are deprecated. For backwards compatibility only.
 307          *
 308          * @deprecated For backwards compatibility only.
 309          * @access private
 310          *
 311          * @global array $weekday
 312          * @global array $weekday_initial
 313          * @global array $weekday_abbrev
 314          * @global array $month
 315          * @global array $month_abbrev
 316          *
 317          * @since 2.1.0
 318          */
 319         public function register_globals() {
 320                 $GLOBALS['weekday']         = $this->weekday;
 321                 $GLOBALS['weekday_initial'] = $this->weekday_initial;
 322                 $GLOBALS['weekday_abbrev']  = $this->weekday_abbrev;
 323                 $GLOBALS['month']           = $this->month;
 324                 $GLOBALS['month_abbrev']    = $this->month_abbrev;
 325         }
 326
 327         /**
 328          * Constructor which calls helper methods to set up object variables
 329          *
 330          * @since 2.1.0
 331          */
 332         public function __construct() {
 333                 $this->init();
 334                 $this->register_globals();
 335         }
 336
 337         /**
 338          * Checks if current locale is RTL.
 339          *
 340          * @since 3.0.0
 341          * @return bool Whether locale is RTL.
 342          */
 343         public function is_rtl() {
 344                 return 'rtl' == $this->text_direction;
 345         }
 346
 347         /**
 348          * Register date/time format strings for general POT.
 349          *
 350          * Private, unused method to add some date/time formats translated
 351          * on wp-admin/options-general.php to the general POT that would
 352          * otherwise be added to the admin POT.
 353          *
 354          * @since 3.6.0
 355          */
 356         public function _strings_for_pot() {
 357                 /* translators: localized date format, see http://php.net/date */
 358                 __( 'F j, Y' );
 359                 /* translators: localized time format, see http://php.net/date */
 360                 __( 'g:i a' );
 361                 /* translators: localized date and time format, see http://php.net/date */
 362                 __( 'F j, Y g:i a' );
 363         }
 364 }
 365
 366 /**
 367  * Checks if current locale is RTL.
 368  *
 369  * @since 3.0.0
 370  *
 371  * @global WP_Locale $wp_locale
 372  *
 373  * @return bool Whether locale is RTL.
 374  */
 375 function is_rtl() {
 376         global $wp_locale;
 377         return $wp_locale->is_rtl();
 378 }