WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.
Built from https://develop.svn.wordpress.org/trunk@57226


git-svn-id: http://core.svn.wordpress.org/trunk@56732 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2023-12-24 13:05:21 +00:00
parent 9b09f2c239
commit 356dd51612
4 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
wp-includes/class-wp-recovery-mode-key-service.php
View File

@ -38,7 +38,7 @@ final class WP_Recovery_Mode_Key_Service {
* *
* @since 5.2.0 * @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()}. * @param string $token A token generated by {@see generate_recovery_mode_token()}.
* @return string Recovery mode key. * @return string Recovery mode key.
@ -85,7 +85,7 @@ final class WP_Recovery_Mode_Key_Service {
* *
* @since 5.2.0 * @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 $token The token used when generating the given key.
* @param string $key The unhashed key. * @param string $key The unhashed key.

2
wp-includes/pluggable.php
View File

@ -2528,7 +2528,7 @@ if ( ! function_exists( 'wp_hash_password' ) ) :
* *
* @since 2.5.0 * @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. * @param string $password Plain text user password to hash.
* @return string The hash string of the password. * @return string The hash string of the password.

10
wp-includes/user.php
View File

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

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.5-alpha-57225'; $wp_version = '6.5-alpha-57226';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.