/wp-includes/l10n.php

Description
Description | Functions

WordPress Translation API

Functions
Description | Functions
before_last_bar (line 72)
void before_last_bar ( $string)
  • $string
esc_attr_e (line 155)

Displays translated text that has been escaped for safe use in an attribute.

  • see: translate() Echoes returned translate() string
  • see: esc_attr()
  • since: 2.8.0
void esc_attr_e (string $text, [string $domain = 'default'])
  • string $text: Text to translate
  • string $domain: Optional. Domain to retrieve the translated text
esc_attr_x (line 208)
void esc_attr_x ( $single,  $context, [ $domain = 'default'])
  • $single
  • $context
  • $domain
esc_attr__ (line 112)

Retrieves the translation of $text and escapes it for safe use in an attribute.

If there is no translation, or the domain isn't loaded, the original text is returned.

  • return: Translated text
  • see: translate() An alias of translate()
  • see: esc_attr()
  • since: 2.8.0
string esc_attr__ (string $text, [string $domain = 'default'])
  • string $text: Text to translate
  • string $domain: Optional. Domain to retrieve the translated text
esc_html_e (line 169)

Displays translated text that has been escaped for safe use in HTML output.

  • see: translate() Echoes returned translate() string
  • see: esc_html()
  • since: 2.8.0
void esc_html_e (string $text, [string $domain = 'default'])
  • string $text: Text to translate
  • string $domain: Optional. Domain to retrieve the translated text
esc_html_x (line 212)
void esc_html_x ( $single,  $context, [ $domain = 'default'])
  • $single
  • $context
  • $domain
esc_html__ (line 128)

Retrieves the translation of $text and escapes it for safe use in HTML output.

If there is no translation, or the domain isn't loaded, the original text is returned.

  • return: Translated text
  • see: translate() An alias of translate()
  • see: esc_html()
  • since: 2.8.0
string esc_html__ (string $text, [string $domain = 'default'])
  • string $text: Text to translate
  • string $domain: Optional. Domain to retrieve the translated text
get_available_languages (line 542)

Get all available languages based on the presence of *.mo files in a given directory. The default directory is WP_LANG_DIR.

  • return: Array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names.
  • since: 3.0.0
array get_available_languages ([string $dir = null])
  • string $dir: A directory in which to search for language files. The default directory is WP_LANG_DIR.
get_locale (line 28)

Gets the current locale.

If the locale is set, then it will filter the locale in the 'locale' filter hook and return the value.

If the locale is not set already, then the WPLANG constant is used if it is defined. Then it is filtered through the 'locale' filter hook and the value for the locale global set and the locale is returned.

The process to get the locale should only be done once, but the locale will always be filtered using the 'locale' hook.

  • return: The locale of the blog or from the 'locale' hook.
  • since: 1.5.0
  • uses: apply_filters() - Calls 'locale' hook on locale value.
  • uses: $locale - Gets the locale stored in the global.
string get_locale ()
get_translations_for_domain (line 500)

Returns the Translations instance for a domain. If there isn't one, returns empty Translations instance.

  • return: Translation instance
object A get_translations_for_domain (string $domain)
  • string $domain
is_textdomain_loaded (line 515)

Whether there are translations for the domain

  • return: Whether there are translations
  • since: 3.0.0
bool is_textdomain_loaded (string $domain)
  • string $domain
load_child_theme_textdomain (line 487)

Loads the child themes translated strings.

If the current locale exists as a .mo file in the child themes root directory, it will be included in the translated strings by the $domain.

The .mo files must be named based on the locale exactly.

  • since: 2.9.0
void load_child_theme_textdomain (string $domain, [ $path = false])
  • string $domain: Unique identifier for retrieving translated strings
  • $path
load_default_textdomain (line 385)

Loads default translated strings based on locale.

Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The translated (.mo) file is named based on the locale.

  • since: 1.5.0
void load_default_textdomain ()
load_muplugin_textdomain (line 441)

Load the translated strings for a plugin residing in the mu-plugins dir.

  • since: 3.0.0
void load_muplugin_textdomain (string $domain, [string $mu_plugin_rel_path = ''])
  • string $domain: Unique identifier for retrieving translated strings
  • string $mu_plugin_rel_path: Relative to WPMU_PLUGIN_DIR directory in which the MO file resides. Defaults to empty string.
load_plugin_textdomain (line 416)

Loads the plugin's translated strings.

If the path is not given then it will be the root of the plugin directory. The .mo file should be named based on the domain with a dash, and then the locale exactly.

  • since: 1.5.0
void load_plugin_textdomain (string $domain, [string $abs_rel_path = false], [string $plugin_rel_path = false])
  • string $domain: Unique identifier for retrieving translated strings
  • string $abs_rel_path: Optional. Relative path to ABSPATH of a folder, where the .mo file resides. Deprecated, but still functional until 2.7
  • string $plugin_rel_path: Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precedence over $abs_rel_path
load_textdomain (line 326)

Loads a MO file into the domain $domain.

If the domain already exists, the translations will be merged. If both sets have the same string, the translation from the original value will be taken.

On success, the .mo file will be placed in the $l10n global by $domain and will be a MO object.

  • return: True on success, false on failure
  • since: 1.5.0
  • uses: $l10n - Gets list of domain translated string objects
bool load_textdomain (string $domain, string $mofile)
  • string $domain: Unique identifier for retrieving translated strings
  • string $mofile: Path to the .mo file
load_theme_textdomain (line 459)

Loads the theme's translated strings.

If the current locale exists as a .mo file in the theme's root directory, it will be included in the translated strings by the $domain.

The .mo files must be named based on the locale exactly.

void load_theme_textdomain (string $domain, [ $path = false])
  • string $domain: Unique identifier for retrieving translated strings
  • $path
translate (line 67)

Retrieves the translation of $text. If there is no translation, or the domain isn't loaded, the original text is returned.

  • return: Translated text
  • see: __() Don't use translate() directly, use __()
  • since: 2.2.0
  • usedby: translate_with_context()
  • uses: apply_filters() - Calls 'gettext' on domain translated text with the untranslated text as second parameter.
string translate (string $text, [string $domain = 'default'])
  • string $text: Text to translate.
  • string $domain: Domain to retrieve the translated text.
translate_nooped_plural (line 300)

Translate the result of _n_noop() or _nx_noop()

  • since: 3.1
void translate_nooped_plural (array $nooped_plural, int $count, [string $domain = 'default'])
  • array $nooped_plural: Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()
  • int $count: Number of objects
  • string $domain: Optional. The domain identifier the text should be retrieved in. If $nooped_plural contains a domain passed to _n_noop() or _nx_noop(), it will override this value.
translate_user_role (line 530)

Translates role name. Since the role names are in the database and not in the source there are dummy gettext calls to get them into the POT file and this function properly translates them back.

The before_last_bar() call is needed, because older installs keep the roles using the old context format: 'Role name|User role' and just skipping the content after the last bar is easier than fixing them in the DB. New installs won't suffer from that problem.

void translate_user_role ( $name)
  • $name
translate_with_gettext_context (line 80)
void translate_with_gettext_context ( $text,  $context, [ $domain = 'default'])
  • $text
  • $context
  • $domain
unload_textdomain (line 359)

Unloads translations for a domain

  • return: Whether textdomain was unloaded
  • since: 3.0.0
bool unload_textdomain (string $domain)
  • string $domain: Textdomain to be unloaded
_e (line 141)

Displays the returned translated text from translate().

  • see: translate() Echoes returned translate() string
  • since: 1.2.0
void _e (string $text, [string $domain = 'default'])
  • string $text: Text to translate
  • string $domain: Optional. Domain to retrieve the translated text
_ex (line 204)

Displays translated string with gettext context

  • return: Translated context string without pipe
  • see: _x()
  • since: 3.0.0
string _ex (string $text, string $context, [string $domain = 'default'])
  • string $text: Text to translate
  • string $context: Context information for the translators
  • string $domain: Optional. Domain to retrieve the translated text
_n (line 238)

Retrieve the plural or single form based on the amount.

If the domain is not set in the $l10n list, then a comparison will be made and either $plural or $single parameters returned.

If the domain does exist, then the parameters $single, $plural, and $number will first be passed to the domain's ngettext method. Then it will be passed to the 'ngettext' filter hook along with the same parameters. The expected type will be a string.

  • return: Either $single or $plural translated text
  • since: 2.8.0
  • uses: apply_filters() - Calls 'ngettext' hook on domains text returned, along with $single, $plural, and $number parameters. Expected to return string.
  • uses: $l10n - Gets list of domain translated string (gettext_reader) objects
string _n (string $single, string $plural, int $number, [string $domain = 'default'])
  • string $single: The text that will be used if $number is 1
  • string $plural: The text that will be used if $number is not 1
  • int $number: The number to compare against to use either $single or $plural
  • string $domain: Optional. The domain identifier the text should be retrieved in
_nx (line 251)

A hybrid of _n() and _x(). It supports contexts and plurals.

void _nx ( $single,  $plural,  $number,  $context, [ $domain = 'default'])
  • $single
  • $plural
  • $number
  • $context
  • $domain
_nx_noop (line 287)

Register plural strings with context in POT file, but don't translate them.

void _nx_noop ( $singular,  $plural,  $context, [ $domain = null])
  • $singular
  • $plural
  • $context
  • $domain
_n_noop (line 278)

Register plural strings in POT file, but don't translate them.

Used when you want to keep structures with translatable plural strings and use them later.

Example: $messages = array( 'post' => _n_noop('%s post', '%s posts'), 'page' => _n_noop('%s pages', '%s pages') ); ... $message = $messages[$type]; $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count );

  • return: array($singular, $plural)
  • since: 2.5
array _n_noop (string $singular, string $plural, [string $domain = null])
  • string $singular: Single form to be i18ned
  • string $plural: Plural form to be i18ned
  • string $domain: Optional. The domain identifier the text will be retrieved in
_x (line 189)

Retrieve translated string with gettext context

Quite a few times, there will be collisions with similar translatable text found in more than two places but with different translated context.

By including the context in the pot file translators can translate the two strings differently.

  • return: Translated context string without pipe
  • since: 2.8.0
string _x (string $text, string $context, [string $domain = 'default'])
  • string $text: Text to translate
  • string $context: Context information for the translators
  • string $domain: Optional. Domain to retrieve the translated text
__ (line 96)

Retrieves the translation of $text. If there is no translation, or the domain isn't loaded, the original text is returned.

  • return: Translated text
  • see: translate() An alias of translate()
  • since: 2.1.0
string __ (string $text, [string $domain = 'default'])
  • string $text: Text to translate
  • string $domain: Optional. Domain to retrieve the translated text

Documentation generated on Tue, 18 Jun 2013 23:18:52 +0000 by phpDocumentor 1.4.1