#712598 by joachim, add1sun, jhodgdon: documentation for user_pass_reset_url()
authorGábor Hojtsy
Fri, 28 May 2010 13:39:07 +0000 (13:39 +0000)
committerGábor Hojtsy
Fri, 28 May 2010 13:39:07 +0000 (13:39 +0000)
modules/user/user.module

index 3b572a3..ecc7274 100644 (file)
@@ -1452,6 +1452,16 @@ function user_external_login_register($name, $module) {
   }
 }
 
+/**
+ * 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 = time();
   return url("user/reset/$account->uid/$timestamp/". user_pass_rehash($account->pass, $timestamp, $account->login), array('absolute' => TRUE));