Changeset 34923 for trunk/src/wp-includes/user-functions.php

Timestamp:

10/08/2015 12:10:41 AM (11 years ago)

Author:

SergeyBiryukov

Message:

Reset Password: Move the code for creating password reset key into a new function, get_password_reset_key(), and use it in retrieve_password().

Previously: [25231].

Props DH-Shredder.
Fixes #34180.

File:

• trunk/src/wp-includes/user-functions.php (modified) (1 diff)

trunk/src/wp-includes/user-functions.php

@@ -1871 +1871 @@
 
 /**
+ * Creates, stores, then returns a password reset key for user.
+ *
+ * @since 4.4.0
+ *
+ * @global wpdb         $wpdb      WordPress database abstraction object.
+ * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
+ *
+ * @param WP_User $user User to retrieve password reset key for.
+ *
+ * @return string|WP_Error Password reset key on success. WP_Error on error.
+ */
+function get_password_reset_key( $user ) {
+        global $wpdb, $wp_hasher;
+
+        /**
+         * Fires before a new password is retrieved.
+         *
+         * @since 1.5.0
+         * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
+         *
+         * @param string $user_login The user login name.
+         */
+        do_action( 'retreive_password', $user->user_login );
+
+        /**
+         * Fires before a new password is retrieved.
+         *
+         * @since 1.5.1
+         *
+         * @param string $user_login The user login name.
+         */
+        do_action( 'retrieve_password', $user->user_login );
+
+        /**
+         * Filter whether to allow a password to be reset.
+         *
+         * @since 2.7.0
+         *
+         * @param bool true           Whether to allow the password to be reset. Default true.
+         * @param int  $user_data->ID The ID of the user attempting to reset a password.
+         */
+        $allow = apply_filters( 'allow_password_reset', true, $user->ID );
+
+        if ( ! $allow ) {
+                return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );
+        } elseif ( is_wp_error( $allow ) ) {
+                return $allow;
+        }
+
+        // Generate something random for a password reset key.
+        $key = wp_generate_password( 20, false );
+
+        /**
+         * Fires when a password reset key is generated.
+         *
+         * @since 2.5.0
+         *
+         * @param string $user_login The username for the user.
+         * @param string $key        The generated password reset key.
+         */
+        do_action( 'retrieve_password_key', $user->user_login, $key );
+
+        // Now insert the key, hashed, into the DB.
+        if ( empty( $wp_hasher ) ) {
+                require_once ABSPATH . WPINC . '/class-phpass.php';
+                $wp_hasher = new PasswordHash( 8, true );
+        }
+        $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
+        $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
+        if ( false === $key_saved ) {
+                return WP_Error( 'no_password_key_update', __( 'Could not save password reset key to database.' ) );
+        }
+
+        return $key;
+}
+
+/**
  * Retrieves a user row based on password reset key and login
  *