Perform a translation in the given $textdomain for $text to the current language
Usage
// basic usage
$string = $languageTranslator->getTranslation($textdomain, string $text);
// usage with all arguments
$string = $languageTranslator->getTranslation($textdomain, string $text, string $context = '', array $options = []);
Arguments
Name | Type(s) | Description |
---|---|---|
textdomain | string, object | Textdomain string, filename, or object. |
text | string | Text in default language (EN) that needs to be converted to current language. |
context (optional) | string | Optional context label for the text, to differentiate from others that may be the same in English, but not other languages. |
options (optional) | array | 3.0.237+ only
|
Return value
string
array
false
Translation if available, or original EN version if translation not available.
- Returns array if options[getInfo] is true.
- Returns false if translation not found and options[getFalse] is true.
LanguageTranslator methods and properties
API reference based on ProcessWire core version 3.0.244