function StringTranslationTrait::t

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php \Drupal\Core\StringTranslation\StringTranslationTrait::t()
  2. 8.9.x core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php \Drupal\Core\StringTranslation\StringTranslationTrait::t()
  3. 11.x core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php \Drupal\Core\StringTranslation\StringTranslationTrait::t()

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

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

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.

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\TranslatableMarkup::__construct()

139 calls to StringTranslationTrait::t()
AddModerationDeriver::getDerivativeDefinitions in core/modules/content_moderation/src/Plugin/ConfigAction/AddModerationDeriver.php
Gets the definition of all derivatives of a base plugin.
AlreadyInstalledException::__construct in core/lib/Drupal/Core/Installer/Exception/AlreadyInstalledException.php
Constructs a new "already installed" exception.
AnnounceRenderer::render in core/modules/announcements_feed/src/AnnounceRenderer.php
Generates the announcements feed render array.
AssetsStream::getDescription in core/lib/Drupal/Core/StreamWrapper/AssetsStream.php
Returns the description of the stream wrapper for use in the UI.
AssetsStream::getName in core/lib/Drupal/Core/StreamWrapper/AssetsStream.php
Returns the name of the stream wrapper for use in the UI.

... See full list

File

core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php, line 70

Class

StringTranslationTrait
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Namespace

Drupal\Core\StringTranslation

Code

protected function t($string, array $args = [], array $options = []) {
  return new TranslatableMarkup($string, $args, $options, $this->getStringTranslation());
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.