function t

8.x bootstrap.inc t($string, array $args = array(), array $options = array())

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

The t() function serves two purposes. First, at run-time it translates user-visible text into the appropriate language. Second, various mechanisms that figure out what text needs to be translated work off t() -- the text inside t() calls is added to the database of strings to be translated. These strings are expected to be in English, so the first argument should always be in English. To enable a fully-translatable site, it is important that all human-readable text that will be displayed on the site or sent to a user is passed through the t() function, or a related function. See the Localization API pages for more information, including recommendations on how to break up or not break up strings for translation.

Translating Variables

You should never use t() to translate variables, such as calling

t($text); 

, unless the text that the variable holds has been passed through t() elsewhere (e.g., $text is one of several translated literal strings in an array). It is especially important never to call

t($user_text); 

, where $user_text is some text that a user entered - doing that can lead to cross-site scripting and other security problems. However, you can use variable substitution in your string, to put variable text such as user names or link URLs into translated text. Variable substitution looks like this:

$text = t("@name's blog", array('@name' => user_format_name($account)));

Basically, you can put variables like @name into your string, and t() will substitute their sanitized values at translation time. (See the Localization API pages referenced above and the documentation of format_string() for details about how to define variables in your string.) Translators can then rearrange the string as necessary for the language (e.g., in Spanish, it might be "blog de @name").

Use During Installation Phase

During the Drupal installation phase, some resources used by t() wil not be available to code that needs localization. See st() and get_t() for alternatives.

Parameters

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

$args: 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 format_string() for details.

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

  • 'langcode' (defaults to the current language): The 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.

Return value

The translated string.

See also

st()

get_t()

format_string()

Related topics

703 calls to t()
action_help in drupal/core/modules/action/action.module
Implements hook_help().
action_permission in drupal/core/modules/action/action.module
Implements hook_permission().
aggregator_help in drupal/core/modules/aggregator/aggregator.module
Implements hook_help().
aggregator_permission in drupal/core/modules/aggregator/aggregator.module
Implements hook_permission().
aggregator_queue_info in drupal/core/modules/aggregator/aggregator.module
Implements hook_queue_info().

... See full list

40 string references to 't'
database_test_even_pager_query in drupal/core/modules/system/tests/modules/database_test/database_test.module
Runs a pager query and returns the results.
database_test_odd_pager_query in drupal/core/modules/system/tests/modules/database_test/database_test.module
Runs a pager query and returns the results.
database_test_tablesort in drupal/core/modules/system/tests/modules/database_test/database_test.module
Runs a tablesort query and returns the results.
database_test_tablesort_first in drupal/core/modules/system/tests/modules/database_test/database_test.module
Runs a tablesort query with a second order_by after and returns the results.
get_t in drupal/core/includes/bootstrap.inc
Returns the name of the proper localization function.

... See full list

File

drupal/core/includes/bootstrap.inc, line 1390
Functions that need to be loaded on every Drupal request.

Code

function t($string, array $args = array(), array $options = array()) {
  return Drupal::translation()->translate($string, $args, $options);
}