<!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>[50140] trunk/src/wp-includes: Users: Move `retrieve_password()` to `wp-includes/user.php`, for consistency with other user functions.</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 { white-space: pre-line; 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/50140">50140</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/50140","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>2021-02-02 12:35:35 +0000 (Tue, 02 Feb 2021)</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'>Users: Move `retrieve_password()` to `wp-includes/user.php`, for consistency with other user functions.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/25231">[25231]</a>, <a href="https://core.trac.wordpress.org/changeset/50129">[50129]</a>.
Props jfarthing84, dimadin.
See <a href="https://core.trac.wordpress.org/ticket/34281">#34281</a>, <a href="https://core.trac.wordpress.org/ticket/31039">#31039</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2021-02-02 12:15:22 UTC (rev 50139)
+++ trunk/src/wp-includes/functions.php 2021-02-02 12:35:35 UTC (rev 50140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7866,172 +7866,3 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_fuzzy_number_match( $expected, $actual, $precision = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return abs( (float) $expected - (float) $actual ) <= $precision;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-/**
- * Handles sending a password retrieval email to a user.
- *
- * @since 2.5.0
- * @since 5.7.0 Added `$user_login` parameter.
- *
- * Note: prior to 5.7.0 this function was in wp_login.php.
- *
- * @global wpdb $wpdb WordPress database abstraction object.
- * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
- *
- * @param string $user_login Optional user_login, default null. Uses
- * `$_POST['user_login']` if `$user_login` not set.
- * @return true|WP_Error True when finished, WP_Error object on error.
- */
-function retrieve_password( $user_login = null ) {
- $errors = new WP_Error();
- $user_data = false;
-
- // Use the passed $user_login if available, otherwise use $_POST['user_login'].
- if ( ! $user_login && ! empty( $_POST['user_login'] ) ) {
- $user_login = $_POST['user_login'];
- }
-
- if ( empty( $user_login ) ) {
- $errors->add( 'empty_username', __( '<strong>Error</strong>: Please enter a username or email address.' ) );
- } elseif ( strpos( $user_login, '@' ) ) {
- $user_data = get_user_by( 'email', trim( wp_unslash( $user_login ) ) );
- if ( empty( $user_data ) ) {
- $errors->add( 'invalid_email', __( '<strong>Error</strong>: There is no account with that username or email address.' ) );
- }
- } else {
- $user_data = get_user_by( 'login', trim( wp_unslash( $user_login ) ) );
- }
-
- /**
- * Filters the user data during a password reset request.
- *
- * Allows, for example, custom validation using data other than username or email address.
- *
- * @since 5.7.0
- *
- * @param WP_User|false $user_data WP_User object if found, false if the user does not exist.
- * @param WP_Error $errors A WP_Error object containing any errors generated
- * by using invalid credentials.
- */
- $user_data = apply_filters( 'lostpassword_user_data', $user_data, $errors );
-
- /**
- * Fires before errors are returned from a password reset request.
- *
- * @since 2.1.0
- * @since 4.4.0 Added the `$errors` parameter.
- * @since 5.4.0 Added the `$user_data` parameter.
- *
- * @param WP_Error $errors A WP_Error object containing any errors generated
- * by using invalid credentials.
- * @param WP_User|false $user_data WP_User object if found, false if the user does not exist.
- */
- do_action( 'lostpassword_post', $errors, $user_data );
-
- /**
- * Filters the errors encountered on a password reset request.
- *
- * The filtered WP_Error object may, for example, contain errors for an invalid
- * username or email address. A WP_Error object should always be returned,
- * but may or may not contain errors.
- *
- * If any errors are present in $errors, this will abort the password reset request.
- *
- * @since 5.5.0
- *
- * @param WP_Error $errors A WP_Error object containing any errors generated
- * by using invalid credentials.
- * @param WP_User|false $user_data WP_User object if found, false if the user does not exist.
- */
- $errors = apply_filters( 'lostpassword_errors', $errors, $user_data );
-
- if ( $errors->has_errors() ) {
- return $errors;
- }
-
- if ( ! $user_data ) {
- $errors->add( 'invalidcombo', __( '<strong>Error</strong>: There is no account with that username or email address.' ) );
- return $errors;
- }
-
- // Redefining user_login ensures we return the right case in the email.
- $user_login = $user_data->user_login;
- $user_email = $user_data->user_email;
- $key = get_password_reset_key( $user_data );
-
- if ( is_wp_error( $key ) ) {
- return $key;
- }
-
- if ( is_multisite() ) {
- $site_name = get_network()->site_name;
- } else {
- /*
- * The blogname option is escaped with esc_html on the way into the database
- * in sanitize_option. We want to reverse this for the plain text arena of emails.
- */
- $site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
- }
-
- $message = __( 'Someone has requested a password reset for the following account:' ) . "\r\n\r\n";
- /* translators: %s: Site name. */
- $message .= sprintf( __( 'Site Name: %s' ), $site_name ) . "\r\n\r\n";
- /* translators: %s: User login. */
- $message .= sprintf( __( 'Username: %s' ), $user_login ) . "\r\n\r\n";
- $message .= __( 'If this was a mistake, ignore this email and nothing will happen.' ) . "\r\n\r\n";
- $message .= __( 'To reset your password, visit the following address:' ) . "\r\n\r\n";
- $message .= network_site_url( "wp-login.php?action=rp&key=$key&login=" . rawurlencode( $user_login ), 'login' ) . "\r\n\r\n";
-
- $requester_ip = $_SERVER['REMOTE_ADDR'];
- if ( $requester_ip ) {
- $message .= sprintf(
- /* translators: %s: IP address of password reset requester. */
- __( 'This password reset request originated from the IP address %s.' ),
- $requester_ip
- ) . "\r\n";
- }
-
- /* translators: Password reset notification email subject. %s: Site title. */
- $title = sprintf( __( '[%s] Password Reset' ), $site_name );
-
- /**
- * Filters the subject of the password reset email.
- *
- * @since 2.8.0
- * @since 4.4.0 Added the `$user_login` and `$user_data` parameters.
- *
- * @param string $title Email subject.
- * @param string $user_login The username for the user.
- * @param WP_User $user_data WP_User object.
- */
- $title = apply_filters( 'retrieve_password_title', $title, $user_login, $user_data );
-
- /**
- * Filters the message body of the password reset mail.
- *
- * If the filtered message is empty, the password reset email will not be sent.
- *
- * @since 2.8.0
- * @since 4.1.0 Added `$user_login` and `$user_data` parameters.
- *
- * @param string $message Email message.
- * @param string $key The activation key.
- * @param string $user_login The username for the user.
- * @param WP_User $user_data WP_User object.
- */
- $message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data );
-
- if ( $message && ! wp_mail( $user_email, wp_specialchars_decode( $title ), $message ) ) {
- $errors->add(
- 'retrieve_password_email_failure',
- sprintf(
- /* translators: %s: Documentation URL. */
- __( '<strong>Error</strong>: The email could not be sent. Your site may not be correctly configured to send emails. <a href="%s">Get support for resetting your password</a>.' ),
- esc_url( __( 'https://wordpress.org/support/article/resetting-your-password/' ) )
- )
- );
- return $errors;
- }
-
- return true;
-}
</del></span></pre></div>
<a id="trunksrcwpincludesuserphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2021-02-02 12:15:22 UTC (rev 50139)
+++ trunk/src/wp-includes/user.php 2021-02-02 12:35:35 UTC (rev 50140)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2656,6 +2656,173 @@
</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">+ * Handles sending a password retrieval email to a user.
+ *
+ * @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.
+ *
+ * @param string $user_login Optional user_login, default null. Uses
+ * `$_POST['user_login']` if `$user_login` not set.
+ * @return true|WP_Error True when finished, WP_Error object on error.
+ */
+function retrieve_password( $user_login = null ) {
+ $errors = new WP_Error();
+ $user_data = false;
+
+ // Use the passed $user_login if available, otherwise use $_POST['user_login'].
+ if ( ! $user_login && ! empty( $_POST['user_login'] ) ) {
+ $user_login = $_POST['user_login'];
+ }
+
+ if ( empty( $user_login ) ) {
+ $errors->add( 'empty_username', __( '<strong>Error</strong>: Please enter a username or email address.' ) );
+ } elseif ( strpos( $user_login, '@' ) ) {
+ $user_data = get_user_by( 'email', trim( wp_unslash( $user_login ) ) );
+ if ( empty( $user_data ) ) {
+ $errors->add( 'invalid_email', __( '<strong>Error</strong>: There is no account with that username or email address.' ) );
+ }
+ } else {
+ $user_data = get_user_by( 'login', trim( wp_unslash( $user_login ) ) );
+ }
+
+ /**
+ * Filters the user data during a password reset request.
+ *
+ * Allows, for example, custom validation using data other than username or email address.
+ *
+ * @since 5.7.0
+ *
+ * @param WP_User|false $user_data WP_User object if found, false if the user does not exist.
+ * @param WP_Error $errors A WP_Error object containing any errors generated
+ * by using invalid credentials.
+ */
+ $user_data = apply_filters( 'lostpassword_user_data', $user_data, $errors );
+
+ /**
+ * Fires before errors are returned from a password reset request.
+ *
+ * @since 2.1.0
+ * @since 4.4.0 Added the `$errors` parameter.
+ * @since 5.4.0 Added the `$user_data` parameter.
+ *
+ * @param WP_Error $errors A WP_Error object containing any errors generated
+ * by using invalid credentials.
+ * @param WP_User|false $user_data WP_User object if found, false if the user does not exist.
+ */
+ do_action( 'lostpassword_post', $errors, $user_data );
+
+ /**
+ * Filters the errors encountered on a password reset request.
+ *
+ * The filtered WP_Error object may, for example, contain errors for an invalid
+ * username or email address. A WP_Error object should always be returned,
+ * but may or may not contain errors.
+ *
+ * If any errors are present in $errors, this will abort the password reset request.
+ *
+ * @since 5.5.0
+ *
+ * @param WP_Error $errors A WP_Error object containing any errors generated
+ * by using invalid credentials.
+ * @param WP_User|false $user_data WP_User object if found, false if the user does not exist.
+ */
+ $errors = apply_filters( 'lostpassword_errors', $errors, $user_data );
+
+ if ( $errors->has_errors() ) {
+ return $errors;
+ }
+
+ if ( ! $user_data ) {
+ $errors->add( 'invalidcombo', __( '<strong>Error</strong>: There is no account with that username or email address.' ) );
+ return $errors;
+ }
+
+ // Redefining user_login ensures we return the right case in the email.
+ $user_login = $user_data->user_login;
+ $user_email = $user_data->user_email;
+ $key = get_password_reset_key( $user_data );
+
+ if ( is_wp_error( $key ) ) {
+ return $key;
+ }
+
+ if ( is_multisite() ) {
+ $site_name = get_network()->site_name;
+ } else {
+ /*
+ * The blogname option is escaped with esc_html on the way into the database
+ * in sanitize_option. We want to reverse this for the plain text arena of emails.
+ */
+ $site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
+ }
+
+ $message = __( 'Someone has requested a password reset for the following account:' ) . "\r\n\r\n";
+ /* translators: %s: Site name. */
+ $message .= sprintf( __( 'Site Name: %s' ), $site_name ) . "\r\n\r\n";
+ /* translators: %s: User login. */
+ $message .= sprintf( __( 'Username: %s' ), $user_login ) . "\r\n\r\n";
+ $message .= __( 'If this was a mistake, ignore this email and nothing will happen.' ) . "\r\n\r\n";
+ $message .= __( 'To reset your password, visit the following address:' ) . "\r\n\r\n";
+ $message .= network_site_url( "wp-login.php?action=rp&key=$key&login=" . rawurlencode( $user_login ), 'login' ) . "\r\n\r\n";
+
+ $requester_ip = $_SERVER['REMOTE_ADDR'];
+ if ( $requester_ip ) {
+ $message .= sprintf(
+ /* translators: %s: IP address of password reset requester. */
+ __( 'This password reset request originated from the IP address %s.' ),
+ $requester_ip
+ ) . "\r\n";
+ }
+
+ /* translators: Password reset notification email subject. %s: Site title. */
+ $title = sprintf( __( '[%s] Password Reset' ), $site_name );
+
+ /**
+ * Filters the subject of the password reset email.
+ *
+ * @since 2.8.0
+ * @since 4.4.0 Added the `$user_login` and `$user_data` parameters.
+ *
+ * @param string $title Email subject.
+ * @param string $user_login The username for the user.
+ * @param WP_User $user_data WP_User object.
+ */
+ $title = apply_filters( 'retrieve_password_title', $title, $user_login, $user_data );
+
+ /**
+ * Filters the message body of the password reset mail.
+ *
+ * If the filtered message is empty, the password reset email will not be sent.
+ *
+ * @since 2.8.0
+ * @since 4.1.0 Added `$user_login` and `$user_data` parameters.
+ *
+ * @param string $message Email message.
+ * @param string $key The activation key.
+ * @param string $user_login The username for the user.
+ * @param WP_User $user_data WP_User object.
+ */
+ $message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data );
+
+ if ( $message && ! wp_mail( $user_email, wp_specialchars_decode( $title ), $message ) ) {
+ $errors->add(
+ 'retrieve_password_email_failure',
+ sprintf(
+ /* translators: %s: Documentation URL. */
+ __( '<strong>Error</strong>: The email could not be sent. Your site may not be correctly configured to send emails. <a href="%s">Get support for resetting your password</a>.' ),
+ esc_url( __( 'https://wordpress.org/support/article/resetting-your-password/' ) )
+ )
+ );
+ return $errors;
+ }
+
+ return true;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Handles resetting the user's password.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span></span></pre>
</div>
</div>
</body>
</html>