diff options
Diffstat (limited to 'modules/user/user.module')
| -rw-r--r-- | modules/user/user.module | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/modules/user/user.module b/modules/user/user.module index 4492c6028..1920789bf 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -2266,7 +2266,18 @@ function user_pass_reset_url($account) { } /** - * Generate a URL to confirm an account cancellation request. + * Generates a URL to confirm an account cancellation request. + * + * @param object $account + * The user account object, which must contain at least the following + * properties: + * - uid: The user uid number. + * - pass: The hashed user password string. + * - login: The user login name. + * + * @return + * A unique URL that may be used to confirm the cancellation of the user + * account. * * @see user_mail_tokens() * @see user_cancel_confirm() |