PHPXRef 0.7 : Wordpress 2.7.1 : Detail view of l10n.php

Functions that are not part of a class:

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: string The locale of the blog or from the 'locale' hook.

translate($text, $domain = 'default') X-Ref

Retrieve the translated text.

If the domain is set in the $l10n global, then the text is run through the
domain's translate method. After it is passed to the 'gettext' filter hook,
along with the untranslated text as the second parameter.

If the domain is not set, the $text is just returned.

param: string $text Text to translate.
param: string $domain Domain to retrieve the translated text.
return: string Translated text

before_last_bar( $string ) X-Ref

No description

translate_with_context( $text, $domain = 'default' ) X-Ref

Retrieve the translated text and strip context.

If the domain is set in the $l10n global, then the text is run through the
domain's translate method. After it is passed to the 'gettext' filter hook,
along with the untranslated text as the second parameter.

If the domain is not set, the $text is just returned.

param: string $text Text to translate
param: string $domain Domain to retrieve the translated text
return: string Translated text

__($text, $domain = 'default') X-Ref

Retrieves the translated string from the translate().

param: string $text Text to translate
param: string $domain Optional. Domain to retrieve the translated text
return: string Translated text

_e($text, $domain = 'default') X-Ref

Displays the returned translated text from translate().

param: string $text Text to translate
param: string $domain Optional. Domain to retrieve the translated text

_c($text, $domain = 'default') X-Ref

Retrieve context translated string.

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

In order to use the separate contexts, the _c() function is used and the
translatable string uses a pipe ('|') which has the context the string is in.

When the translated string is returned, it is everything before the pipe, not
including the pipe character. If there is no pipe in the translated text then
everything is returned.

param: string $text Text to translate
param: string $domain Optional. Domain to retrieve the translated text
return: string Translated context string without pipe

__ngettext($single, $plural, $number, $domain = 'default') X-Ref

Retrieve the plural or single form based on the amount.

If the domain is not set in the $l10n list, then a comparsion 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.

param: string $single The text that will be used if $number is 1
param: string $plural The text that will be used if $number is not 1
param: int $number The number to compare against to use either $single or $plural
param: string $domain Optional. The domain identifier the text should be retrieved in
return: string Either $single or $plural translated text

_n() X-Ref

_nc( $single, $plural, $number, $domain = 'default' ) X-Ref

__ngettext_noop($single, $plural, $number=1, $domain = 'default') X-Ref

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

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

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

param: $single Single form to be i18ned
param: $plural Plural form to be i18ned
param: $number Not used, here for compatibility with __ngettext, optional
param: $domain Not used, here for compatibility with __ngettext, optional
return: array array($single, $plural)

_n_noop() X-Ref

load_textdomain($domain, $mofile) X-Ref

Loads MO file into the list of domains.

If the domain already exists, the inclusion will fail. If the MO file is not
readable, the inclusion will fail.

On success, the mofile will be placed in the $l10n global by $domain and will
be an gettext_reader object.

param: string $domain Unique identifier for retrieving translated strings
param: string $mofile Path to the .mo file
return: null On failure returns null and also on success returns nothing.

load_default_textdomain() X-Ref

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 off of the locale.

load_plugin_textdomain($domain, $abs_rel_path = false, $plugin_rel_path = false) X-Ref

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 followed by a
dash, and then the locale exactly.

param: string $domain Unique identifier for retrieving translated strings
param: string $abs_rel_path Optional. Relative path to ABSPATH of a folder,
param: string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precendence over $abs_rel_path

load_theme_textdomain($domain, $path = false) X-Ref

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.

param: string $domain Unique identifier for retrieving translated strings

File Size:	343 lines (10 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Wordpress 2.7.1

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

Defines 16 functions