translate() WordPress Function
The translate() function allows you to translate a string using the WordPress translation API. This function takes two parameters: the string to be translated and the target language. If the target language is not specified, WordPress will try to determine the language based on the current user's language settings.
translate( string $text, string $domain = 'default' ) #
Retrieve the translation of $text.
Description
If there is no translation, or the text domain isn’t loaded, the original text is returned.
_Note:_ Don’t use translate() directly, use __() or related functions.
Parameters
- $text
(string)(Required)Text to translate.
- $domain
(string)(Optional) Text domain. Unique identifier for retrieving translated strings.
Default value: 'default'
Return
(string) Translated text.
Source
File: wp-includes/l10n.php
function translate( $text, $domain = 'default' ) { $translations = get_translations_for_domain( $domain ); $translation = $translations->translate( $text ); /** * Filters text with its translation. * * @since 2.0.11 * * @param string $translation Translated text. * @param string $text Text to translate. * @param string $domain Text domain. Unique identifier for retrieving translated strings. */ $translation = apply_filters( 'gettext', $translation, $text, $domain ); /** * Filters text with its translation for a domain. * * The dynamic portion of the hook name, `$domain`, refers to the text domain. * * @since 5.5.0 * * @param string $translation Translated text. * @param string $text Text to translate. * @param string $domain Text domain. Unique identifier for retrieving translated strings. */ $translation = apply_filters( "gettext_{$domain}", $translation, $text, $domain ); return $translation; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.5.0 | Introduced gettext-{$domain} filter. |
2.2.0 | Introduced. |