Commit 6a82b741 authored by jhodgdon's avatar jhodgdon

Issue #1665446 by kostajh, markpavlitski: Correct errors in user_pass_rehash docs

parent 2de13706
...@@ -1468,7 +1468,10 @@ function user_user_logout($account) { ...@@ -1468,7 +1468,10 @@ function user_user_logout($account) {
* Generates a unique URL for a user to login and reset their password. * Generates a unique URL for a user to login and reset their password.
* *
* @param object $account * @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 * @param array $options
* (optional) A keyed array of settings. Supported options are: * (optional) A keyed array of settings. Supported options are:
* - langcode: A language code to be used when generating locale-sensitive * - langcode: A language code to be used when generating locale-sensitive
...@@ -1491,9 +1494,9 @@ function user_pass_reset_url($account, $options = array()) { ...@@ -1491,9 +1494,9 @@ function user_pass_reset_url($account, $options = array()) {
* @param object $account * @param object $account
* The user account object, which must contain at least the following * The user account object, which must contain at least the following
* properties: * properties:
* - uid: The user uid number. * - uid: The user ID number.
* - pass: The hashed user password string. * - pass: The hashed user password string.
* - login: The user login name. * - login: The UNIX timestamp of the user's last login.
* @param array $options * @param array $options
* (optional) A keyed array of settings. Supported options are: * (optional) A keyed array of settings. Supported options are:
* - langcode: A language code to be used when generating locale-sensitive * - langcode: A language code to be used when generating locale-sensitive
...@@ -1521,15 +1524,15 @@ function user_cancel_url($account, $options = array()) { ...@@ -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 * 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 * 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 * 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 * timestamp and hashed password are retrieved from the database as necessary.
* usage example, see user_cancel_url() and user_cancel_confirm(). * For a usage example, see user_cancel_url() and user_cancel_confirm().
* *
* @param $password * @param string $password
* The hashed user account password value. * The hashed user account password value.
* @param $timestamp * @param int $timestamp
* A unix timestamp. * A UNIX timestamp, typically REQUEST_TIME.
* @param $login * @param int $login
* The user account login name. * The UNIX timestamp of the user's last login.
* *
* @return * @return
* A string that is safe for use in URLs and SQL statements. * A string that is safe for use in URLs and SQL statements.
...@@ -1782,7 +1785,7 @@ function user_mail($key, &$message, $params) { ...@@ -1782,7 +1785,7 @@ function user_mail($key, &$message, $params) {
* An associative array of token replacement values. If the 'user' element * An associative array of token replacement values. If the 'user' element
* exists, it must contain a user account object with the following * exists, it must contain a user account object with the following
* properties: * properties:
* - login: The account login name. * - login: The UNIX timestamp of the user's last login.
* - pass: The hashed account login password. * - pass: The hashed account login password.
* @param $options * @param $options
* Unused parameter required by \Drupal\Core\Utility\Token::replace(). * Unused parameter required by \Drupal\Core\Utility\Token::replace().
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment