function hook_tokens

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Utility/token.api.php \hook_tokens()
  2. 8.9.x core/lib/Drupal/Core/Utility/token.api.php \hook_tokens()
  3. 10 core/lib/Drupal/Core/Utility/token.api.php \hook_tokens()
  4. 11.x core/lib/Drupal/Core/Utility/token.api.php \hook_tokens()

Provide replacement values for placeholder tokens.

This hook is invoked when someone calls token_replace(). That function first scans the text for [type:token] patterns, and splits the needed tokens into groups by type. Then hook_tokens() is invoked on each token-type group, allowing your module to respond by providing replacement text for any of the tokens in the group that your module knows how to process.

A module implementing this hook should also implement hook_token_info() in order to list its available tokens on editing screens.


$type: The machine-readable name of the type (group) of token being replaced, such as 'node', 'user', or another type defined by a hook_token_info() implementation.

$tokens: An array of tokens to be replaced. The keys are the machine-readable token names, and the values are the raw [type:token] strings that appeared in the original text.

$data: (optional) An associative array of data objects to be used when generating replacement values, as supplied in the $data parameter to token_replace().

$options: (optional) An associative array of options for token replacement; see token_replace() for possible values.

Return value

An associative array of replacement values, keyed by the raw [type:token] strings from the original text.

See also



Related topics

8 functions implement hook_tokens()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

comment_tokens in modules/comment/
Implements hook_tokens().
node_tokens in modules/node/
Implements hook_tokens().
poll_tokens in modules/poll/
Implements hook_tokens().
statistics_tokens in modules/statistics/
Implements hook_tokens().
system_tokens in modules/system/
Implements hook_tokens().

... See full list

1 invocation of hook_tokens()
token_generate in includes/
Generates replacement values for a list of tokens.


modules/system/system.api.php, line 4425


function hook_tokens($type, $tokens, array $data = array(), array $options = array()) {
    $url_options = array(
        'absolute' => TRUE,
    if (isset($options['language'])) {
        $url_options['language'] = $options['language'];
        $language_code = $options['language']->language;
    else {
        $language_code = NULL;
    $sanitize = !empty($options['sanitize']);
    $replacements = array();
    if ($type == 'node' && !empty($data['node'])) {
        $node = $data['node'];
        foreach ($tokens as $name => $original) {
            switch ($name) {
                // Simple key values on the node.
                case 'nid':
                    $replacements[$original] = $node->nid;
                case 'title':
                    $replacements[$original] = $sanitize ? check_plain($node->title) : $node->title;
                case 'edit-url':
                    $replacements[$original] = url('node/' . $node->nid . '/edit', $url_options);
                // Default values for the chained tokens handled below.
                case 'author':
                    $name = $node->uid == 0 ? variable_get('anonymous', t('Anonymous')) : $node->name;
                    $replacements[$original] = $sanitize ? filter_xss($name) : $name;
                case 'created':
                    $replacements[$original] = format_date($node->created, 'medium', '', NULL, $language_code);
        if ($author_tokens = token_find_with_prefix($tokens, 'author')) {
            $author = user_load($node->uid);
            $replacements += token_generate('user', $author_tokens, array(
                'user' => $author,
            ), $options);
        if ($created_tokens = token_find_with_prefix($tokens, 'created')) {
            $replacements += token_generate('date', $created_tokens, array(
                'date' => $node->created,
            ), $options);
    return $replacements;

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