function node_tokens

Implements hook_tokens().

File

drupal/core/modules/node/node.tokens.inc, line 92

Builds placeholder replacement tokens for node-related data.

Code

function node_tokens($type, $tokens, array $data = array(), array $options = array()) {
  $url_options = array(
    'absolute' => TRUE,
  );
  if (isset($options['langcode'])) {
    $url_options['language'] = language_load($options['langcode']);
    $langcode = $options['langcode'];
  }
  else {
    $langcode = 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;
          break;
        case 'vid':
          $replacements[$original] = $node->vid;
          break;
        case 'tnid':
          $replacements[$original] = $node->tnid;
          break;
        case 'type':
          $replacements[$original] = $sanitize ? check_plain($node->type) : $node->type;
          break;
        case 'type-name':
          $type_name = node_get_type_label($node);
          $replacements[$original] = $sanitize ? check_plain($type_name) : $type_name;
          break;
        case 'title':
          $replacements[$original] = $sanitize ? check_plain($node->title) : $node->title;
          break;
        case 'body':
        case 'summary':
          if ($items = field_get_items('node', $node, 'body', $langcode)) {
            $instance = field_info_instance('node', 'body', $node->type);
            $field_langcode = field_language('node', $node, 'body', $langcode);

            // If the summary was requested and is not empty, use it.
            if ($name == 'summary' && !empty($items[0]['summary'])) {
              $output = $sanitize ? _text_sanitize($instance, $field_langcode, $items[0], 'summary') : $items[0]['summary'];
            }
            else {
              $output = $sanitize ? _text_sanitize($instance, $field_langcode, $items[0], 'value') : $items[0]['value'];

              // A summary was requested.
              if ($name == 'summary') {

                // Generate an optionally trimmed summary of the body field.
                $output = text_summary($output, $instance['settings']['text_processing'] ? $items[0]['format'] : NULL, $instance['display']['teaser']['settings']['trim_length']);
              }
            }
            $replacements[$original] = $output;
          }
          break;
        case 'langcode':
          $replacements[$original] = $sanitize ? check_plain($node->langcode) : $node->langcode;
          break;
        case 'url':
          $replacements[$original] = url('node/' . $node->nid, $url_options);
          break;
        case 'edit-url':
          $replacements[$original] = url('node/' . $node->nid . '/edit', $url_options);
          break;

        // Default values for the chained tokens handled below.
        case 'author':
          $account = user_load($node->uid);
          $name = user_format_name($account);
          $replacements[$original] = $sanitize ? check_plain($name) : $name;
          break;
        case 'created':
          $replacements[$original] = format_date($node->created, 'medium', '', NULL, $langcode);
          break;
        case 'changed':
          $replacements[$original] = format_date($node->changed, 'medium', '', NULL, $langcode);
          break;
      }
    }
    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);
    }
    if ($changed_tokens = token_find_with_prefix($tokens, 'changed')) {
      $replacements += token_generate('date', $changed_tokens, array(
        'date' => $node->changed,
      ), $options);
    }
  }
  return $replacements;
}