diff --git a/core/modules/user/user.module b/core/modules/user/user.module index 322311f100e855a0d5df28de83c5a7d63c02f6c0..42a79dbc5dda68d6c7c04de6e7c59cb047abff3b 100644 --- a/core/modules/user/user.module +++ b/core/modules/user/user.module @@ -1468,7 +1468,10 @@ function user_user_logout($account) { * Generates a unique URL for a user to login and reset their password. * * @param object $account - * An object containing the user account. + * An object containing the user account, which must contain at least the + * following properties: + * - uid: The user ID number. + * - login: The UNIX timestamp of the user's last login. * @param array $options * (optional) A keyed array of settings. Supported options are: * - langcode: A language code to be used when generating locale-sensitive @@ -1491,9 +1494,9 @@ function user_pass_reset_url($account, $options = array()) { * @param object $account * The user account object, which must contain at least the following * properties: - * - uid: The user uid number. + * - uid: The user ID number. * - pass: The hashed user password string. - * - login: The user login name. + * - login: The UNIX timestamp of the user's last login. * @param array $options * (optional) A keyed array of settings. Supported options are: * - langcode: A language code to be used when generating locale-sensitive @@ -1521,15 +1524,15 @@ function user_cancel_url($account, $options = array()) { * order to validate the URL, the same hash can be generated again, from the * same information, and compared to the hash value from the URL. The URL * normally contains both the time stamp and the numeric user ID. The login - * name and hashed password are retrieved from the database as necessary. For a - * usage example, see user_cancel_url() and user_cancel_confirm(). + * timestamp and hashed password are retrieved from the database as necessary. + * For a usage example, see user_cancel_url() and user_cancel_confirm(). * - * @param $password + * @param string $password * The hashed user account password value. - * @param $timestamp - * A unix timestamp. - * @param $login - * The user account login name. + * @param int $timestamp + * A UNIX timestamp, typically REQUEST_TIME. + * @param int $login + * The UNIX timestamp of the user's last login. * * @return * A string that is safe for use in URLs and SQL statements. @@ -1782,7 +1785,7 @@ function user_mail($key, &$message, $params) { * 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. + * - login: The UNIX timestamp of the user's last login. * - pass: The hashed account login password. * @param $options * Unused parameter required by \Drupal\Core\Utility\Token::replace().