From 18a2dfda00f63430b00c109793b2256ece5e956e Mon Sep 17 00:00:00 2001 From: Angie Byron Date: Wed, 17 Feb 2010 03:49:02 +0000 Subject: #712598 by add1sun: Added documentation for user_pass_reset_url(). --- modules/user/user.module | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'modules/user/user.module') 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)); -- cgit v1.2.3