LanguageTranslator::findTranslation()

Find a translation for given text

Scans all textdomains to find first translation.

Available since version 3.0.237.

Usage

// basic usage
$string = $languageTranslator->findTranslation(string $text);

// usage with all arguments
$string = $languageTranslator->findTranslation(string $text, $context = '', array $options = []);

Arguments

NameType(s)Description
$textstring
$context (optional)string array
  • Optional context label for the text, to differentiate from others that may be the same in English, but not other languages.
    • If context is not needed you may optionally specify the $options array here.
$options (optional)array
  • getInfo (bool): Return verbose array of information about found translation? Default:false

Return value

string array
  • Returns string with translated text if found, or blank string if not found.
    • Returns array of info if getInfo option requested. This array is empty if translation was not found.

LanguageTranslator methods and properties

API reference based on ProcessWire core version 3.0.251