summaryrefslogtreecommitdiff
path: root/modules/user
diff options
context:
space:
mode:
Diffstat (limited to 'modules/user')
-rw-r--r--modules/user/user.info1
-rw-r--r--modules/user/user.tokens.inc129
2 files changed, 130 insertions, 0 deletions
diff --git a/modules/user/user.info b/modules/user/user.info
index d4c24fa77..cd916a873 100644
--- a/modules/user/user.info
+++ b/modules/user/user.info
@@ -9,4 +9,5 @@ files[] = user.admin.inc
files[] = user.pages.inc
files[] = user.install
files[] = user.test
+files[] = user.tokens.inc
required = TRUE
diff --git a/modules/user/user.tokens.inc b/modules/user/user.tokens.inc
new file mode 100644
index 000000000..11048e72c
--- /dev/null
+++ b/modules/user/user.tokens.inc
@@ -0,0 +1,129 @@
+<?php
+// $Id$
+
+/**
+ * @file
+ * Builds placeholder replacement tokens for user-related data.
+ */
+
+/**
+ * Implement hook_token_info().
+ */
+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("Name"),
+ 'description' => t("The login 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' => array('user' => $types),
+ 'tokens' => array('user' => $user),
+ );
+}
+
+/**
+ * Implement hook_tokens().
+ */
+function user_tokens($type, $tokens, array $data = array(), array $options = array()) {
+ global $user;
+ $url_options = array('absolute' => TRUE);
+ if (isset($options['language'])) {
+ $url_options['language'] = $language;
+ $language_code = $language->language;
+ }
+ else {
+ $language_code = NULL;
+ }
+ $sanitize = !empty($options['sanitize']);
+
+ $replacements = array();
+
+ if ($type == 'user' && !empty($data['user'])) {
+ $account = $data['user'];
+ foreach ($tokens as $name => $original) {
+ switch ($name) {
+ // Basic user account information.
+ case 'uid':
+ $replacements[$original] = $account->uid;
+ break;
+
+ case 'name':
+ $name = ($account->uid == 0) ? variable_get('anonymous', t('Anonymous')) : $account->name;
+ $replacements[$original] = $sanitize ? filter_xss($name) : $name;
+ break;
+
+ case 'mail':
+ $replacements[$original] = $sanitize ? check_plain($account->mail) : $account->mail;
+ break;
+
+ case 'url':
+ $replacements[$original] = url("user/$account->uid", $url_options);
+ break;
+
+ case 'edit-url':
+ $replacements[$original] = url("user/$account->uid/edit", $url_options);
+ break;
+
+ // These tokens are default variations on the chained tokens handled below.
+ case 'last-login':
+ $replacements[$original] = format_date($account->login, 'medium', '', NULL, $language_code);
+ break;
+
+ case 'created':
+ $replacements[$original] = format_date($account->created, 'medium', '', NULL, $language_code);
+ break;
+ }
+ }
+
+ if ($login_tokens = token_find_with_prefix($tokens, 'last-login')) {
+ $replacements += token_generate('date', $login_tokens, array('date' => $account->login), $options);
+ }
+
+ if ($registered_tokens = token_find_with_prefix($tokens, 'created')) {
+ $replacements += token_generate('date', $registered_tokens, array('date' => $account->created), $options);
+ }
+ }
+ if ($type == 'current-user') {
+ global $user;
+ $replacements += token_generate('user', $tokens, array('user' => $user), $options);
+ }
+
+ return $replacements;
+}