Docs: Document the $wp_hasher global in `wp_generate_user_request_k…

…ey()`.

Includes adding a description for the global in a few other functions.

Follow-up to [42791], [42964], [43008].

Props viralsampat.
See #60021.

git-svn-id: https://develop.svn.wordpress.org/trunk@57226 602fd350-edb4-49c9-b593-d223f7449a82

src/wp-includes/class-wp-recovery-mode-key-service.php

@@ -38,7 +38,7 @@ public function generate_recovery_mode_token() {
 	 *
 	 * @since 5.2.0
 	 *
-	 * @global PasswordHash $wp_hasher
+	 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
 	 *
 	 * @param string $token A token generated by {@see generate_recovery_mode_token()}.
 	 * @return string Recovery mode key.
@@ -85,7 +85,7 @@ public function generate_and_store_recovery_mode_key( $token ) {
 	 *
 	 * @since 5.2.0
 	 *
-	 * @global PasswordHash $wp_hasher
+	 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
 	 *
 	 * @param string $token The token used when generating the given key.
 	 * @param string $key   The unhashed key.

src/wp-includes/pluggable.php

@@ -2528,7 +2528,7 @@ function wp_hash( $data, $scheme = 'auth' ) {
 	 *
 	 * @since 2.5.0
 	 *
-	 * @global PasswordHash $wp_hasher PHPass object
+	 * @global PasswordHash $wp_hasher PHPass object.
 	 *
 	 * @param string $password Plain text user password to hash.
 	 * @return string The hash string of the password.

src/wp-includes/user.php

@@ -2875,7 +2875,7 @@ function wp_get_password_hint() {
  *
  * @since 4.4.0
  *
- * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
+ * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
  *
  * @param WP_User $user User to retrieve password reset key for.
  * @return string|WP_Error Password reset key on success. WP_Error on error.
@@ -3047,8 +3047,8 @@ function check_password_reset_key( $key, $login ) {
  * @since 2.5.0
  * @since 5.7.0 Added `$user_login` parameter.
  *
- * @global wpdb         $wpdb       WordPress database abstraction object.
- * @global PasswordHash $wp_hasher  Portable PHP password hashing framework.
+ * @global wpdb         $wpdb      WordPress database abstraction object.
+ * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
  *
  * @param string $user_login Optional. Username to send a password retrieval email for.
  *                           Defaults to `$_POST['user_login']` if not set.
@@ -4817,6 +4817,8 @@ function wp_send_user_request( $request_id ) {
  *
  * @since 4.9.6
  *
+ * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
+ *
  * @param int $request_id Request ID.
  * @return string Confirmation key.
  */
@@ -4848,6 +4850,8 @@ function wp_generate_user_request_key( $request_id ) {
  *
  * @since 4.9.6
  *
+ * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
+ *
  * @param string $request_id ID of the request being confirmed.
  * @param string $key        Provided key to validate.
  * @return true|WP_Error True on success, WP_Error on failure.