<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34923] trunk/src: Reset Password: Move the code for creating password reset key into a new function, `get_password_reset_key()`, and use it in `retrieve_password()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34923">34923</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34923","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-10-08 00:10:41 +0000 (Thu, 08 Oct 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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: <a href="https://core.trac.wordpress.org/changeset/25231">[25231]</a>.
Props DH-Shredder.
Fixes <a href="https://core.trac.wordpress.org/ticket/34180">#34180</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesuserfunctionsphp">trunk/src/wp-includes/user-functions.php</a></li>
<li><a href="#trunksrcwploginphp">trunk/src/wp-login.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesuserfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/user-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user-functions.php 2015-10-08 00:01:26 UTC (rev 34922)
+++ trunk/src/wp-includes/user-functions.php 2015-10-08 00:10:41 UTC (rev 34923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1870,6 +1870,83 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Retrieves a user row based on password reset key and login
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * A key is considered 'expired' if it exactly matches the value of the
</span></span></pre></div>
<a id="trunksrcwploginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-login.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-login.php 2015-10-08 00:01:26 UTC (rev 34922)
+++ trunk/src/wp-login.php 2015-10-08 00:10:41 UTC (rev 34923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -313,63 +313,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Redefining user_login ensures we return the right case in the email.
</span><span class="cx" style="display: block; padding: 0 10px"> $user_login = $user_data->user_login;
</span><span class="cx" style="display: block; padding: 0 10px"> $user_email = $user_data->user_email;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $key = get_password_reset_key( $user_data );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * 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_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_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_data->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;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $key ) ) {
+ return $key;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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_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 );
- $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user_login ) );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $message = __('Someone requested that the password be reset for the following account:') . "\r\n\r\n";
</span><span class="cx" style="display: block; padding: 0 10px"> $message .= network_home_url( '/' ) . "\r\n\r\n";
</span><span class="cx" style="display: block; padding: 0 10px"> $message .= sprintf(__('Username: %s'), $user_login) . "\r\n\r\n";
</span></span></pre>
</div>
</div>
</body>
</html>