X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/2329f698283944696a7076258cf816545970bb47..caeaf8dc94b5e3f75dc98ec92dc7b76049cdddb6:/wp-login.php
diff --git a/wp-login.php b/wp-login.php
index 5ab6fc67..3dabec4a 100644
--- a/wp-login.php
+++ b/wp-login.php
@@ -25,7 +25,8 @@ if ( force_ssl_admin() && ! is_ssl() ) {
/**
* Output the login page header.
*
- * @param string $title Optional. WordPress Log In Page title to display in
element. Default 'Log In'.
+ * @param string $title Optional. WordPress login Page title to display in the `` element.
+ * Default 'Log In'.
* @param string $message Optional. Message to display in header. Default empty.
* @param WP_Error $wp_error Optional. The error to pass. Default empty.
*/
@@ -263,7 +264,8 @@ function wp_login_viewport_meta() {
/**
* Handles sending password retrieval email to user.
*
- * @uses $wpdb WordPress Database object
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
*
* @return bool|WP_Error True: when finish. WP_Error on error
*/
@@ -383,15 +385,19 @@ function retrieve_password() {
* @param string $title Default email title.
*/
$title = apply_filters( 'retrieve_password_title', $title );
+
/**
* Filter the message body of the password reset mail.
*
* @since 2.8.0
+ * @since 4.1.0 Added `$user_login` and `$user_data` parameters.
*
- * @param string $message Default mail message.
- * @param string $key The activation key.
+ * @param string $message Default mail 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 );
+ $message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data );
if ( $message && !wp_mail( $user_email, wp_specialchars_decode( $title ), $message ) )
wp_die( __('The e-mail could not be sent.') . "
\n" . __('Possible reason: your host may have disabled the mail() function.') );
@@ -441,7 +447,7 @@ do_action( 'login_init' );
/**
* Fires before a specified login form action.
*
- * The dynamic portion of the hook name, $action, refers to the action
+ * The dynamic portion of the hook name, `$action`, refers to the action
* that brought the visitor to the login form. Actions include 'postpass',
* 'logout', 'lostpassword', etc.
*
@@ -532,7 +538,7 @@ case 'retrievepassword' :
tags, before the hidden fields.
+ * Fires inside the lostpassword form tags, before the hidden fields.
*
* @since 2.1.0
*/
@@ -629,8 +635,7 @@ case 'rp' :
-
-
+