[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-wp-locale.php (summary)

Locale API: WP_Locale class

File Size: 369 lines (14 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_Locale:: (11 methods):
  __construct()
  init()
  get_weekday()
  get_weekday_initial()
  get_weekday_abbrev()
  get_month()
  get_month_abbrev()
  get_meridiem()
  register_globals()
  is_rtl()
  _strings_for_pot()


Class: WP_Locale  - X-Ref

Core class used to store translated data for a locale.

__construct()   X-Ref
Constructor which calls helper methods to set up object variables.

since: 2.1.0

init()   X-Ref
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

get_weekday( $weekday_number )   X-Ref
Retrieve 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).

param: int $weekday_number 0 for Sunday through 6 Saturday.
since: 2.1.0
return: string Full translated weekday.

get_weekday_initial( $weekday_name )   X-Ref
Retrieve 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.

param: string $weekday_name Full translated weekday word.
since: 2.1.0
return: string Translated weekday initial.

get_weekday_abbrev( $weekday_name )   X-Ref
Retrieve the translated weekday abbreviation.

The weekday abbreviation is retrieved by the translated
full weekday word.

param: string $weekday_name Full translated weekday word.
since: 2.1.0
return: string Translated weekday abbreviation.

get_month( $month_number )   X-Ref
Retrieve 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.

param: string|int $month_number '01' through '12'.
since: 2.1.0
return: string Translated full month name.

get_month_abbrev( $month_name )   X-Ref
Retrieve translated version of month abbreviation string.

The $month_name parameter is expected to be the translated or
translatable version of the month.

param: string $month_name Translated month to get abbreviated version.
since: 2.1.0
return: string Translated abbreviated month.

get_meridiem( $meridiem )   X-Ref
Retrieve translated version of meridiem string.

The $meridiem parameter is expected to not be translated.

param: string $meridiem Either 'am', 'pm', 'AM', or 'PM'. Not translated version.
since: 2.1.0
return: string Translated version

register_globals()   X-Ref
Global variables are deprecated.

For backward compatibility only.

since: 2.1.0

is_rtl()   X-Ref
Checks if current locale is RTL.

since: 3.0.0
return: bool Whether locale is RTL.

_strings_for_pot()   X-Ref
Register 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



Generated: Mon Sep 23 01:00:03 2019 Cross-referenced by PHPXref 0.7.1