diff --git a/wp-login.php b/wp-login.php index 111eddc1cf..39526f822d 100644 --- a/wp-login.php +++ b/wp-login.php @@ -23,19 +23,11 @@ if ( force_ssl_admin() && ! is_ssl() ) { } /** - * Outputs the header for the login page. + * Output the login page header. * - * @uses do_action() Calls the 'login_head' for outputting HTML in the Log In - * header. - * @uses apply_filters() Calls 'login_headerurl' for the top login link. - * @uses apply_filters() Calls 'login_headertitle' for the top login title. - * @uses apply_filters() Calls 'login_message' on the message to display in the - * header. - * @uses $error The error global, which is checked for displaying errors. - * - * @param string $title Optional. WordPress Log In Page title to display in - * element. - * @param string $message Optional. Message to display in header. + * @param string $title Optional. WordPress Log In Page title to display in <title/> element. Default 'Log In'. + * @param string $message Optional. Message to display in header. Default empty. + * @param string $wp_error Optional. The error to pass. Default empty. * @param WP_Error $wp_error Optional. WordPress Error Object */ function login_header($title = 'Log In', $message = '', $wp_error = '') { @@ -52,6 +44,13 @@ function login_header($title = 'Log In', $message = '', $wp_error = '') { // Shake it! $shake_error_codes = array( 'empty_password', 'empty_email', 'invalid_email', 'invalidcombo', 'empty_username', 'invalid_username', 'incorrect_password' ); + /** + * Filter the error codes array for shaking the login form. + * + * @since 3.0.0 + * + * @param array $shake_error_codes Error codes that shake the login form. + */ $shake_error_codes = apply_filters( 'shake_error_codes', $shake_error_codes ); if ( $shake_error_codes && $wp_error->get_error_code() && in_array( $wp_error->get_error_code(), $shake_error_codes ) ) @@ -76,7 +75,17 @@ function login_header($title = 'Log In', $message = '', $wp_error = '') { <?php } + /** + * Enqueue scripts and styles for the login page. + * + * @since 3.1.0 + */ do_action( 'login_enqueue_scripts' ); + /** + * Fires in the login page header after scripts are enqueued. + * + * @since 2.1.0 + */ do_action( 'login_head' ); if ( is_multisite() ) { @@ -87,7 +96,21 @@ function login_header($title = 'Log In', $message = '', $wp_error = '') { $login_header_title = __( 'Powered by WordPress' ); } - $login_header_url = apply_filters( 'login_headerurl', $login_header_url ); + /** + * Filter link URL of the header logo above login form. + * + * @since 2.1.0 + * + * @param string $login_header_url Login header logo URL. + */ + $login_header_url = apply_filters( 'login_headerurl', $login_header_url ); + /** + * Filter the title attribute of the header logo above login form. + * + * @since 2.1.0 + * + * @param string $login_header_title Login header logo title attribute. + */ $login_header_title = apply_filters( 'login_headertitle', $login_header_title ); $classes = array( 'login-action-' . $action, 'wp-core-ui' ); @@ -105,6 +128,14 @@ function login_header($title = 'Log In', $message = '', $wp_error = '') { $classes[] = 'interim-login-success'; } + /** + * Filter the login page body classes. + * + * @since 3.5.0 + * + * @param array $classes An array of body classes. + * @param string $action The action that brought the visitor to the login page. + */ $classes = apply_filters( 'login_body_class', $classes, $action ); ?> @@ -116,7 +147,14 @@ function login_header($title = 'Log In', $message = '', $wp_error = '') { unset( $login_header_url, $login_header_title ); - $message = apply_filters('login_message', $message); + /** + * Filter the message to display above the login form. + * + * @since 2.1.0 + * + * @param string $message Login message text. + */ + $message = apply_filters( 'login_message', $message ); if ( !empty( $message ) ) echo $message . "\n"; @@ -138,10 +176,26 @@ function login_header($title = 'Log In', $message = '', $wp_error = '') { $errors .= ' ' . $error . "<br />\n"; } } - if ( !empty($errors) ) - echo '<div id="login_error">' . apply_filters('login_errors', $errors) . "</div>\n"; - if ( !empty($messages) ) - echo '<p class="message">' . apply_filters('login_messages', $messages) . "</p>\n"; + if ( ! empty( $errors ) ) { + /** + * Filter the error messages displayed above the login form. + * + * @since 2.1.0 + * + * @param string $errors Login error message. + */ + echo '<div id="login_error">' . apply_filters( 'login_errors', $errors ) . "</div>\n"; + } + if ( ! empty( $messages ) ) { + /** + * Filter instructional messages displayed above the login form. + * + * @since 2.5.0 + * + * @param string $messages Login messages. + */ + echo '<p class="message">' . apply_filters( 'login_messages', $messages ) . "</p>\n"; + } } } // End of login_header() @@ -167,7 +221,13 @@ function login_footer($input_id = '') { </script> <?php endif; ?> - <?php do_action('login_footer'); ?> + <?php + /** + * Fires in the login page footer. + * + * @since 3.1.0 + */ + do_action( 'login_footer' ); ?> <div class="clear"></div> </body> </html> @@ -217,7 +277,12 @@ function retrieve_password() { $user_data = get_user_by('login', $login); } - do_action('lostpassword_post'); + /** + * Fires before errors are returned from a password reset request. + * + * @since 2.1.0 + */ + do_action( 'lostpassword_post' ); if ( $errors->get_error_code() ) return $errors; @@ -231,10 +296,33 @@ function retrieve_password() { $user_login = $user_data->user_login; $user_email = $user_data->user_email; - do_action('retreive_password', $user_login); // Misspelled and deprecated - do_action('retrieve_password', $user_login); + /** + * Fires before a new password is retrieved. + * + * @since 1.5.2 + * @deprecated 1.5.2 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.2 + * + * @param string $user_login The user login name. + */ + do_action( 'retrieve_password', $user_login ); - $allow = apply_filters('allow_password_reset', true, $user_data->ID); + /** + * 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')); @@ -278,8 +366,23 @@ function retrieve_password() { $title = sprintf( __('[%s] Password Reset'), $blogname ); - $title = apply_filters('retrieve_password_title', $title); - $message = apply_filters('retrieve_password_message', $message, $key); + /** + * Filter the subject of the password reset email. + * + * @since 2.8.0 + * + * @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 + * + * @param string $message Default mail message. + * @param string $key The activation key. + */ + $message = apply_filters( 'retrieve_password_message', $message, $key ); if ( $message && !wp_mail($user_email, $title, $message) ) wp_die( __('The e-mail could not be sent.') . "<br />\n" . __('Possible reason: your host may have disabled the mail() function.') ); @@ -319,8 +422,21 @@ setcookie(TEST_COOKIE, 'WP Cookie check', 0, COOKIEPATH, COOKIE_DOMAIN); if ( SITECOOKIEPATH != COOKIEPATH ) setcookie(TEST_COOKIE, 'WP Cookie check', 0, SITECOOKIEPATH, COOKIE_DOMAIN); -// allow plugins to override the default actions, and to add extra actions if they want +/** + * Fires when the login form is initialized. + * + * @since 3.2.0 + */ do_action( 'login_init' ); +/** + * Fires before a specified login form 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. + * + * @since 2.8.0 + */ do_action( 'login_form_' . $action ); $http_post = ('POST' == $_SERVER['REQUEST_METHOD']); @@ -333,12 +449,13 @@ case 'postpass' : $hasher = new PasswordHash( 8, true ); /** - * Filter the life of the post password cookie. + * Filter the life span of the post password cookie. * - * By default, the cookie expires 10 days from now. - * To turn this into a session cookie, return 0. + * By default, the cookie expires 10 days from creation. To turn this + * into a session cookie, return 0. * * @since 3.7.0 + * * @param int $expires The expiry time, as passed to setcookie(). */ $expire = apply_filters( 'post_password_expires', time() + 10 * DAY_IN_SECONDS ); @@ -378,9 +495,23 @@ case 'retrievepassword' : $errors->add( 'expiredkey', __( 'Sorry, that key has expired. Please try again.' ) ); } - $redirect_to = apply_filters( 'lostpassword_redirect', !empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '' ); + $lostpassword_redirect = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : ''; + /** + * Filter the URL redirected to after submitting the lostpassword/retrievepassword form. + * + * @since 3.0.0 + * + * @param string $lostpassword_redirect The redirect destination URL. + */ + $redirect_to = apply_filters( 'lostpassword_redirect', $lostpassword_redirect ); + + /** + * Fires before the lost password form. + * + * @since 1.5.2 + */ + do_action( 'lost_password' ); - do_action('lost_password'); login_header(__('Lost Password'), '<p class="message">' . __('Please enter your username or email address. You will receive a link to create a new password via email.') . '</p>', $errors); $user_login = isset($_POST['user_login']) ? wp_unslash($_POST['user_login']) : ''; @@ -392,16 +523,32 @@ case 'retrievepassword' : <label for="user_login" ><?php _e('Username or E-mail:') ?><br /> <input type="text" name="user_login" id="user_login" class="input" value="<?php echo esc_attr($user_login); ?>" size="20" /></label> </p> -<?php do_action('lostpassword_form'); ?> + <?php + /** + * Fires inside the lostpassword <form> tags, before the hidden fields. + * + * @since 2.1.0 + */ + do_action( 'lostpassword_form' ); ?> <input type="hidden" name="redirect_to" value="<?php echo esc_attr( $redirect_to ); ?>" /> <p class="submit"><input type="submit" name="wp-submit" id="wp-submit" class="button button-primary button-large" value="<?php esc_attr_e('Get New Password'); ?>" /></p> </form> <p id="nav"> <a href="<?php echo esc_url( wp_login_url() ); ?>"><?php _e('Log in') ?></a> -<?php if ( get_option( 'users_can_register' ) ) : ?> - | <?php echo apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) ); ?> -<?php endif; ?> +<?php +if ( get_option( 'users_can_register' ) ) : + $registration_url = sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ); + /** + * Filter the registration URL below the login form. + * + * @since 1.5.2 + * + * @param string $registration_url Registration URL. + */ + echo ' | ' . apply_filters( 'register', $registration_url ); +endif; +?> </p> <?php @@ -425,6 +572,14 @@ case 'rp' : if ( isset($_POST['pass1']) && $_POST['pass1'] != $_POST['pass2'] ) $errors->add( 'password_reset_mismatch', __( 'The passwords do not match.' ) ); + /** + * Fires before the password reset procedure is validated. + * + * @since 3.5.0 + * + * @param object $errors WP Error object. + * @param WP_User|WP_Error $user WP_User object if the login and reset key match. WP_Error object otherwise. + */ do_action( 'validate_password_reset', $errors, $user ); if ( ( ! $errors->get_error_code() ) && isset( $_POST['pass1'] ) && !empty( $_POST['pass1'] ) ) { @@ -461,9 +616,13 @@ case 'rp' : <p id="nav"> <a href="<?php echo esc_url( wp_login_url() ); ?>"><?php _e( 'Log in' ); ?></a> -<?php if ( get_option( 'users_can_register' ) ) : ?> - | <?php echo apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) ); ?> -<?php endif; ?> +<?php +if ( get_option( 'users_can_register' ) ) : + $registration_url = sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ); + //duplicate_hook + echo ' | ' . apply_filters( 'register', $registration_url ); +endif; +?> </p> <?php @@ -472,8 +631,15 @@ break; case 'register' : if ( is_multisite() ) { - // Multisite uses wp-signup.php - wp_redirect( apply_filters( 'wp_signup_location', network_site_url('wp-signup.php') ) ); + $sign_up_url = network_site_url( 'wp-signup.php' ); + /** + * Filter the Multisite sign up URL. + * + * @since 3.0.0 + * + * @param string $sign_up_url The sign up URL. + */ + wp_redirect( apply_filters( 'wp_signup_location', $sign_up_url ) ); exit; } @@ -495,7 +661,15 @@ case 'register' : } } - $redirect_to = apply_filters( 'registration_redirect', !empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '' ); + $registration_redirect = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : ''; + /** + * Filter the registration redirect URL. + * + * @since 3.0.0 + * + * @param string $registration_redirect The redirect destination URL. + */ + $redirect_to = apply_filters( 'registration_redirect', $registration_redirect ); login_header(__('Registration Form'), '<p class="message register">' . __('Register For This Site') . '</p>', $errors); ?> @@ -508,7 +682,14 @@ case 'register' : <label for="user_email"><?php _e('E-mail') ?><br /> <input type="text" name="user_email" id="user_email" class="input" value="<?php echo esc_attr(wp_unslash($user_email)); ?>" size="25" /></label> </p> -<?php do_action('register_form'); ?> + <?php + /** + * Fires following the 'E-mail' field in the user registration form. + * + * @since 2.1.0 + */ + do_action( 'register_form' ); + ?> <p id="reg_passmail"><?php _e('A password will be e-mailed to you.') ?></p> <br class="clear" /> <input type="hidden" name="redirect_to" value="<?php echo esc_attr( $redirect_to ); ?>" /> @@ -565,7 +746,17 @@ default: else $user = wp_signon('', $secure_cookie); - $redirect_to = apply_filters('login_redirect', $redirect_to, isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '', $user); + $requested_redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : ''; + /** + * Filter the login redirect URL. + * + * @since 3.0.0 + * + * @param string $redirect_to The redirect destination URL. + * @param string $requested_redirect_to The requested redirect destination URL passed as a parameter. + * @param WP_User|WP_Error $user WP_User object if login was successful, WP_Error object otherwise. + */ + $redirect_to = apply_filters( 'login_redirect', $redirect_to, $requested_redirect_to, $user ); if ( !is_wp_error($user) && !$reauth ) { if ( $interim_login ) { @@ -573,7 +764,9 @@ default: $interim_login = 'success'; login_header( '', $message ); ?> </div> - <?php do_action( 'login_footer' ); ?> + <?php + //duplicate_hook + do_action( 'login_footer' ); ?> <?php if ( $customize_login ) : ?> <script type="text/javascript">setTimeout( function(){ new wp.customize.Messenger({ url: '<?php echo wp_customize_url(); ?>', channel: 'login' }).send('login') }, 1000 );</script> <?php endif; ?> @@ -618,6 +811,14 @@ default: $errors->add('updated', __( '<strong>You have successfully updated WordPress!</strong> Please log back in to experience the awesomeness.' ), 'message' ); } + /** + * Filter the login page errors. + * + * @since 3.6.0 + * + * @param object $errors WP Error object. + * @param string $redirect_to Redirect destination URL. + */ $errors = apply_filters( 'wp_login_errors', $errors, $redirect_to ); // Clear any stale cookies. @@ -640,7 +841,14 @@ default: <label for="user_pass"><?php _e('Password') ?><br /> <input type="password" name="pwd" id="user_pass" class="input" value="" size="20" /></label> </p> -<?php do_action('login_form'); ?> + <?php + /** + * Fires following the 'Password' field in the login form. + * + * @since 2.1.0 + */ + do_action( 'login_form' ); + ?> <p class="forgetmenot"><label for="rememberme"><input name="rememberme" type="checkbox" id="rememberme" value="forever" <?php checked( $rememberme ); ?> /> <?php esc_attr_e('Remember Me'); ?></label></p> <p class="submit"> <input type="submit" name="wp-submit" id="wp-submit" class="button button-primary button-large" value="<?php esc_attr_e('Log In'); ?>" /> @@ -658,10 +866,13 @@ default: <?php if ( ! $interim_login ) { ?> <p id="nav"> -<?php if ( ! isset( $_GET['checkemail'] ) || ! in_array( $_GET['checkemail'], array( 'confirm', 'newpass' ) ) ) : ?> - <?php if ( get_option( 'users_can_register' ) ) : ?> - <?php echo apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) ); ?> | - <?php endif; ?> +<?php if ( ! isset( $_GET['checkemail'] ) || ! in_array( $_GET['checkemail'], array( 'confirm', 'newpass' ) ) ) : + if ( get_option( 'users_can_register' ) ) : + $registration_url = sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ); + //duplicate_hook + echo apply_filters( 'register', $registration_url ) . ' | '; + endif; + ?> <a href="<?php echo esc_url( wp_lostpassword_url() ); ?>" title="<?php esc_attr_e( 'Password Lost and Found' ); ?>"><?php _e( 'Lost your password?' ); ?></a> <?php endif; ?> </p>