function t

t($string, array $args = array(), array $options = array())

Translates a string to the current language or to a given language.

In order for strings to be localized, make them available in one of the ways supported by the Localization API. When possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise create a new \Drupal\Core\StringTranslation\TranslatableMarkup object directly.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

Parameters

string $string: A string containing the English text to translate.

array $args: (optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.

array $options: (optional) An associative array of additional options, with the following elements:

• 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
• 'context' (defaults to the empty context): The context the source string belongs to. See the Internationalization topic for more information about string contexts.

Return value

\Drupal\Core\StringTranslation\TranslatableMarkup An object that, when cast to a string, returns the translated string.

See also

\Drupal\Component\Render\FormattableMarkup::placeholderFormat()

\Drupal\Core\StringTranslation\StringTranslationTrait::t()

\Drupal\Core\StringTranslation\TranslatableMarkup::__construct()

Related topics

Sanitization functions

Functions to sanitize values.

File

core/includes/bootstrap.inc, line 298

Functions that need to be loaded on every Drupal request.

Code

function t($string, array $args = array(), array $options = array()) {
  return new TranslatableMarkup($string, $args, $options);
}