WordPress Cross Reference

Date and Time Locale object

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

Defines 1 class

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

Class: WP_Locale - X-Ref

Class that loads the calendar locale.

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.

rtl_src_admin_notice() X-Ref

No description

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
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
return: string

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
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'
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
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.
return: string Translated version

register_globals() X-Ref

Global variables are deprecated. For backwards compatibility only.

__construct() X-Ref

Constructor which calls helper methods to set up object variables

return: WP_Locale

is_rtl() X-Ref

Checks if current locale is RTL.

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.

is_rtl() X-Ref

Checks if current locale is RTL.

return: bool Whether locale is RTL.

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

Defines 1 class