diff options
| author | Angie Byron <webchick@24967.no-reply.drupal.org> | 2010-02-17 03:49:02 +0000 |
|---|---|---|
| committer | Angie Byron <webchick@24967.no-reply.drupal.org> | 2010-02-17 03:49:02 +0000 |
| commit | 18a2dfda00f63430b00c109793b2256ece5e956e (patch) | |
| tree | 822d339b39ddecf92ad98eae88b28a2732412458 | |
| parent | f177c12db77a1728273317f350c8e6723b53459c (diff) | |
| download | brdo-18a2dfda00f63430b00c109793b2256ece5e956e.tar.gz brdo-18a2dfda00f63430b00c109793b2256ece5e956e.tar.bz2 | |
#712598 by add1sun: Added documentation for user_pass_reset_url().
| -rw-r--r-- | modules/user/user.module | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/modules/user/user.module b/modules/user/user.module index 9417f57a8..6e242d997 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -2077,6 +2077,16 @@ function user_external_login_register($name, $module) { user_login_submit(array(), $form_state); } +/** + * Generates a unique URL for a user to login and reset their password. + * + * @param object $account + * An object containing the user account. + * + * @return + * A unique URL that provides a one-time log in for the user, from which + * they can change their password. + */ function user_pass_reset_url($account) { $timestamp = REQUEST_TIME; return url("user/reset/$account->uid/$timestamp/" . user_pass_rehash($account->pass, $timestamp, $account->login), array('absolute' => TRUE)); |