You are here

function user_token_info in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/user/user.tokens.inc \user_token_info()

Implements hook_token_info().

File

core/modules/user/user.tokens.inc, line 15
Builds placeholder replacement tokens for user-related data.

Code

function user_token_info() {
  $types['user'] = array(
    'name' => t('Users'),
    'description' => t('Tokens related to individual user accounts.'),
    'needs-data' => 'user',
  );
  $types['current-user'] = array(
    'name' => t('Current user'),
    'description' => t('Tokens related to the currently logged in user.'),
    'type' => 'user',
  );
  $user['uid'] = array(
    'name' => t('User ID'),
    'description' => t("The unique ID of the user account."),
  );
  $user['name'] = array(
    'name' => t("Deprecated: User Name"),
    'description' => t("Deprecated: Use account-name or display-name instead."),
  );
  $user['account-name'] = array(
    'name' => t("Account Name"),
    'description' => t("The login name of the user account."),
  );
  $user['display-name'] = array(
    'name' => t("Display Name"),
    'description' => t("The display name of the user account."),
  );
  $user['mail'] = array(
    'name' => t("Email"),
    'description' => t("The email address of the user account."),
  );
  $user['url'] = array(
    'name' => t("URL"),
    'description' => t("The URL of the account profile page."),
  );
  $user['edit-url'] = array(
    'name' => t("Edit URL"),
    'description' => t("The URL of the account edit page."),
  );
  $user['last-login'] = array(
    'name' => t("Last login"),
    'description' => t("The date the user last logged in to the site."),
    'type' => 'date',
  );
  $user['created'] = array(
    'name' => t("Created"),
    'description' => t("The date the user account was created."),
    'type' => 'date',
  );
  return array(
    'types' => $types,
    'tokens' => array(
      'user' => $user,
    ),
  );
}