Changeset 57226

Timestamp:

12/24/2023 01:03:12 PM (15 months ago)

Author:

SergeyBiryukov

Message:

Docs: Document the $wp_hasher global in wp_generate_user_request_key().

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

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

Props viralsampat.
See #60021.

Location:

trunk/src/wp-includes

Files:

• class-wp-recovery-mode-key-service.php (modified) (2 diffs)
• pluggable.php (modified) (1 diff)
• user.php (modified) (4 diffs)

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

@@ -39 +39 @@
      * @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()}.
@@ -86 +86 @@
      * @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.

trunk/src/wp-includes/pluggable.php

@@ -2529 +2529 @@
      * @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.

trunk/src/wp-includes/user.php

@@ -2876 +2876 @@
  * @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.
@@ -3048 +3048 @@
  * @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.
@@ -4818 +4818 @@
  * @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 +4850 @@
  *
  * @since 4.9.6
+ *
+ * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
  *
  * @param string $request_id ID of the request being confirmed.