diff options
Diffstat (limited to 'modules/user')
| -rw-r--r-- | modules/user/user.module | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/modules/user/user.module b/modules/user/user.module index 1920789bf..84430b2f7 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -2709,8 +2709,21 @@ Your account on [site:name] has been canceled. /** * Token callback to add unsafe tokens for user mails. * - * @see _user_mail_text() - * @see user_mail() + * This function is used by the token_replace() call at the end of + * _user_mail_text() to set up some additional tokens that can be + * used in email messages generated by user_mail(). + * + * @param $replacements + * An associative array variable containing mappings from token names to + * values (for use with strtr()). + * @param $data + * An associative array of token replacement values. If the 'user' element + * exists, it must contain a user account object with the following + * properties: + * - login: The account login name. + * - pass: The hashed account login password. + * @param $options + * Unused parameter required by the token_replace() function. */ function user_mail_tokens(&$replacements, $data, $options) { if (isset($data['user'])) { |