1 system.api.php hook_tokens_alter(array &$replacements, array $context)

Alter replacement values for placeholder tokens.


$replacements: An associative array of replacements returned by hook_tokens().

$context: The context in which hook_tokens() was called. An associative array with the following keys, which have the same meaning as the corresponding parameters of hook_tokens():

  • 'type'
  • 'tokens'
  • 'data'
  • 'options'

See also


Related topics


core/modules/system/system.api.php, line 3727
Hooks provided by Backdrop core and the System module.


function hook_tokens_alter(array &$replacements, array $context) {
  $options = $context['options'];

  if (isset($options['language'])) {
    $url_options['language'] = $options['language'];
    $language_code = $options['language']->langcode;
  else {
    $language_code = NULL;
  $sanitize = !empty($options['sanitize']);

  if ($context['type'] == 'node' && !empty($context['data']['node'])) {
    $node = $context['data']['node'];

    // Alter the [node:title] token, and replace it with the rendered content
    // of a field (field_title).
    if (isset($context['tokens']['title'])) {
      $title = field_view_field('node', $node, 'field_title', 'default', $language_code);
      $replacements[$context['tokens']['title']] = backdrop_render($title);