| [ XREF Home ] [ Index ] |
PHP Cross Reference of WordPress TrunkProvided by Yoast |
[Source view] [Print] [Project Stats]
WordPress Translation API
| File Size: | 535 lines (17 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| get_locale() X-Ref |
| 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 |
| Retrieves the translation of $text. If there is no translation, or the domain isn't loaded the original text is 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_gettext_context( $text, $context, $domain = 'default' ) X-Ref |
| No description |
| __( $text, $domain = 'default' ) X-Ref |
| Retrieves the translation of $text. If there is no translation, or the domain isn't loaded the original text is returned. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text return: string Translated text |
| esc_attr__( $text, $domain = 'default' ) X-Ref |
| 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. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text return: string Translated text |
| esc_html__( $text, $domain = 'default' ) X-Ref |
| 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. 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 |
| esc_attr_e( $text, $domain = 'default' ) X-Ref |
| Displays translated text that has been escaped for safe use in an attribute. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text |
| esc_html_e( $text, $domain = 'default' ) X-Ref |
| Displays translated text that has been escaped for safe use in HTML output. param: string $text Text to translate param: string $domain Optional. Domain to retrieve the translated text |
| _x( $text, $context, $domain = 'default' ) X-Ref |
| 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 string differently. param: string $text Text to translate param: string $context Context information for the translators param: string $domain Optional. Domain to retrieve the translated text return: string Translated context string without pipe |
| _ex( $text, $context, $domain = 'default' ) X-Ref |
| Displays translated string with gettext context param: string $text Text to translate param: string $context Context information for the translators param: string $domain Optional. Domain to retrieve the translated text return: string Translated context string without pipe |
| esc_attr_x( $single, $context, $domain = 'default' ) X-Ref |
| No description |
| esc_html_x( $single, $context, $domain = 'default' ) X-Ref |
| No description |
| _n( $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 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. 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 |
| _nx($single, $plural, $number, $context, $domain = 'default') X-Ref |
| A hybrid of _n() and _x(). It supports contexts and plurals. |
| _n_noop( $singular, $plural ) 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' => _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 ); param: string $singular Single form to be i18ned param: string $plural Plural form to be i18ned return: array array($singular, $plural) |
| _nx_noop( $singular, $plural, $context ) X-Ref |
| Register plural strings with context in POT file, but don't translate them. |
| translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) X-Ref |
| Translate the result of _n_noop() or _nx_noop() param: array $nooped_plural array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop() param: int $count number of objects param: string $domain Optional. The domain identifier the text should be retrieved in |
| load_textdomain( $domain, $mofile ) X-Ref |
| 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. param: string $domain Unique identifier for retrieving translated strings param: string $mofile Path to the .mo file return: bool true on success, false on failure |
| unload_textdomain( $domain ) X-Ref |
| Unloads translations for a domain param: string $domain Textdomain to be unloaded return: bool Whether textdomain was unloaded |
| 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, 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_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) X-Ref |
| Load the translated strings for a plugin residing in the mu-plugins dir. param: string $domain Unique identifier for retrieving translated strings param: strings $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which |
| 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 |
| load_child_theme_textdomain( $domain, $path = false ) X-Ref |
| 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. param: string $domain Unique identifier for retrieving translated strings |
| get_translations_for_domain( $domain ) X-Ref |
| Returns the Translations instance for a domain. If there isn't one, returns empty Translations instance. param: string $domain return: object A Translation instance |
| is_textdomain_loaded( $domain ) X-Ref |
| Whether there are translations for the domain param: string $domain return: bool Whether there are translations |
| translate_user_role( $name ) X-Ref |
| 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. |
| get_available_languages( $dir = null ) X-Ref |
| Get all available languages based on the presence of *.mo files in a given directory. The default directory is WP_LANG_DIR. param: string $dir A directory in which to search for language files. The default directory is WP_LANG_DIR. return: array 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. |
| Generated: Wed Jun 1 08:30:02 2011 |
Cross-referenced by PHPXref 0.7 Provided by Yoast and awesome WordPress Hosting |