WordPress.org
Get WordPress

Make WordPress Core

Ticket #25393: wp-login-2.diff

File wp-login-2.diff, 14.9 KB (added by ShinichiN, 13 years ago)

  • wp-login.php

     
    4949
    5050        // Shake it!
    5151        $shake_error_codes = array( 'empty_password', 'empty_email', 'invalid_email', 'invalidcombo', 'empty_username', 'invalid_username', 'incorrect_password' );
     52        /**
     53         * Filter the error codes array that are to shake the login form.
     54         *
     55         * @since 3.0.0
     56         *
     57         * @param array $shake_error_codes Error codes that will shake the login form.
     58         */
    5259        $shake_error_codes = apply_filters( 'shake_error_codes', $shake_error_codes );
    5360
    5461        if ( $shake_error_codes && $wp_error->get_error_code() && in_array( $wp_error->get_error_code(), $shake_error_codes ) )
    … …  
    7784                <?php
    7885        }
    7986
     87        /**
     88         * Fires at the timig of enqueing scripts and styles on the login page.
     89         *
     90         * The proper hook to use when enqueuing scripts and styles that are meant to appear on the login page.
     91         *
     92         * @since 3.1.0
     93         */
    8094        do_action( 'login_enqueue_scripts' );
     95        /**
     96         * Fires before </head> on the login page.
     97         *
     98         * @since 2.1.0
     99         */     
    81100        do_action( 'login_head' );
    82101
    83102        if ( is_multisite() ) {
    … …  
    88107                $login_header_title = __( 'Powered by WordPress' );
    89108        }
    90109
    91         $login_header_url   = apply_filters( 'login_headerurl',   $login_header_url   );
     110        /**
     111         * Filter the link url of the header logo above login form.
     112         *
     113         * @since 2.1.0
     114         *
     115         * @param string $login_header_url Default url.
     116         */
     117        $login_header_url   = apply_filters( 'login_headerurl',   $login_header_url );
     118        /**
     119         * Filter the title of the header logo above login form.
     120         *
     121         * @since 2.1.0
     122         *
     123         * @param string $login_header_title Default title.
     124         */
    92125        $login_header_title = apply_filters( 'login_headertitle', $login_header_title );
    93126
    94127        $classes = array( 'login-action-' . $action, 'wp-core-ui' );
    … …  
    106139                        $classes[] = 'interim-login-success';
    107140        }
    108141
     142        /**
     143         * Filter the classes of login page <body>.
     144         *
     145         * @since 3.5.0
     146         *
     147         * @param array $classes        Classes to be added to the <body>.
     148         * @param string $action        The action user took before coming to the login page.
     149         */
    109150        $classes = apply_filters( 'login_body_class', $classes, $action );
    110151
    111152        ?>
    … …  
    117158
    118159        unset( $login_header_url, $login_header_title );
    119160
    120         $message = apply_filters('login_message', $message);
     161        /**
     162         * Filter the message to display in header above the login form.
     163         *
     164         * @since 2.1.0
     165         *
     166         * @param string $message Default message text.
     167         */
     168        $message = apply_filters( 'login_message', $message );
    121169        if ( !empty( $message ) )
    122170                echo $message . "\n";
    123171
    … …  
    140188                        }
    141189                }
    142190                if ( !empty($errors) )
    143                         echo '<div id="login_error">' . apply_filters('login_errors', $errors) . "</div>\n";
     191                        /**
     192                         * Filter the error message above the login form.
     193                         *
     194                         * @since 2.1.0
     195                         *
     196                         * @param string $errors Error message.
     197                         */
     198                        echo '<div id="login_error">' . apply_filters( 'login_errors', $errors ) . "</div>\n";
    144199                if ( !empty($messages) )
    145                         echo '<p class="message">' . apply_filters('login_messages', $messages) . "</p>\n";
     200                        /**
     201                         * Filter the message above the login form.
     202                         *
     203                         * @since 2.5.0
     204                         *
     205                         * @param string $messages Login message.
     206                         */
     207                        echo '<p class="message">' . apply_filters( 'login_messages', $messages ) . "</p>\n";
    146208        }
    147209} // End of login_header()
    148210
    … …  
    168230        </script>
    169231        <?php endif; ?>
    170232
    171         <?php do_action('login_footer'); ?>
     233        <?php
     234        /**
     235         * Fires at the end of the html on the login page.
     236         *
     237         * @since 3.1.0
     238         */     
     239        do_action( 'login_footer' ); ?>
    172240        <div class="clear"></div>
    173241        </body>
    174242        </html>
    … …  
    212280                $user_data = get_user_by('login', $login);
    213281        }
    214282
    215         do_action('lostpassword_post');
     283        /**
     284         * Fires before returning WP Error in password retrieving process.
     285         *
     286         * @since 2.1.0
     287         */     
     288        do_action( 'lostpassword_post' );
    216289
    217290        if ( $errors->get_error_code() )
    218291                return $errors;
    … …  
    226299        $user_login = $user_data->user_login;
    227300        $user_email = $user_data->user_email;
    228301
    229         do_action('retreive_password', $user_login);  // Misspelled and deprecated
    230         do_action('retrieve_password', $user_login);
     302        // Misspelled and deprecated
     303        do_action( 'retreive_password', $user_login );
     304        /**
     305         * Fires within the password retrieving process.
     306         *
     307         * @since 1.5.2
     308         *
     309         * @param string $user_login User name to login.
     310         */             
     311        do_action( 'retrieve_password', $user_login );
    231312
    232         $allow = apply_filters('allow_password_reset', true, $user_data->ID);
     313        /**
     314         * Filter password reset restriction boolean.
     315         *
     316         * @since 2.7.0
     317         *
     318         * @param boolean                               True as default.
     319         * @param int $user_data->ID    The ID of the user who is retrieving new password.
     320         */
     321        $allow = apply_filters( 'allow_password_reset', true, $user_data->ID );
    233322
    234323        if ( ! $allow )
    235324                return new WP_Error('no_password_reset', __('Password reset is not allowed for this user'));
    … …  
    240329        if ( empty($key) ) {
    241330                // Generate something random for a key...
    242331                $key = wp_generate_password(20, false);
    243                 do_action('retrieve_password_key', $user_login, $key);
     332                /**
     333                 * Fires before inserting the new md5 key into database.
     334                 *
     335                 * @since 2.5.0
     336                 *
     337                 * @param string $user_login    User name to login.
     338                 * @param string $key                   Activation key.
     339                 */
     340                do_action( 'retrieve_password_key', $user_login, $key );
    244341                // Now insert the new md5 key into the db
    245342                $wpdb->update($wpdb->users, array('user_activation_key' => $key), array('user_login' => $user_login));
    246343        }
    … …  
    260357
    261358        $title = sprintf( __('[%s] Password Reset'), $blogname );
    262359
    263         $title = apply_filters('retrieve_password_title', $title);
    264         $message = apply_filters('retrieve_password_message', $message, $key);
     360        /**
     361         * Filter the title of the password reset email.
     362         *
     363         * @since 2.8.0
     364         *
     365         * @param string $title Default email title.
     366         */
     367        $title = apply_filters( 'retrieve_password_title', $title );
     368        /**
     369         * Filter the body message of the password reset mail.
     370         *
     371         * @since 2.8.0
     372         *
     373         * @param string $message       Default mail message.
     374         * @param string $key           The activation key.
     375         */
     376        $message = apply_filters( 'retrieve_password_message', $message, $key );
    265377
    266378        if ( $message && !wp_mail($user_email, $title, $message) )
    267379                wp_die( __('The e-mail could not be sent.') . "<br />\n" . __('Possible reason: your host may have disabled the mail() function.') );
    … …  
    301413if ( SITECOOKIEPATH != COOKIEPATH )
    302414        setcookie(TEST_COOKIE, 'WP Cookie check', 0, SITECOOKIEPATH, COOKIE_DOMAIN);
    303415
    304 // allow plugins to override the default actions, and to add extra actions if they want
     416/**
     417 * Fires before running the main action of wp-login.php.
     418 *
     419 * Allow plugins to override the default actions, and to add extra actions if they want.
     420 *
     421 * @since 3.2.0
     422 *
     423 */             
    305424do_action( 'login_init' );
     425/**
     426 * Fires before running the main action of wp-login.php depending on the $action.
     427 *
     428 * @since Unknown
     429 *
     430 */             
    306431do_action( 'login_form_' . $action );
    307432
    308433$http_post = ('POST' == $_SERVER['REQUEST_METHOD']);
    … …  
    354479        }
    355480
    356481        if ( isset($_GET['error']) && 'invalidkey' == $_GET['error'] ) $errors->add('invalidkey', __('Sorry, that key does not appear to be valid.'));
     482        /**
     483         * Filtering the redirect url after submitting the lostpassword/retrievepassword form.
     484         *
     485         * @since 3.0.0
     486         *
     487         * @param string The redirect destination url.
     488         */
    357489        $redirect_to = apply_filters( 'lostpassword_redirect', !empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '' );
    358490
    359         do_action('lost_password');
     491        /**
     492         * Fires before the lost password and retrieving password form.
     493         *
     494         * @since 1.5.2
     495         */     
     496        do_action( 'lost_password' );
    360497        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);
    361498
    362499        $user_login = isset($_POST['user_login']) ? wp_unslash($_POST['user_login']) : '';
    … …  
    368505                <label for="user_login" ><?php _e('Username or E-mail:') ?><br />
    369506                <input type="text" name="user_login" id="user_login" class="input" value="<?php echo esc_attr($user_login); ?>" size="20" /></label>
    370507        </p>
    371 <?php do_action('lostpassword_form'); ?>
     508<?php
     509/**
     510 * Fires in the lostpassword form to add extra hidden input.
     511 *
     512 * @since 2.1.0
     513 */             
     514do_action( 'lostpassword_form' ); ?>
    372515        <input type="hidden" name="redirect_to" value="<?php echo esc_attr( $redirect_to ); ?>" />
    373516        <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>
    374517</form>
    … …  
    375518
    376519<p id="nav">
    377520<a href="<?php echo esc_url( wp_login_url() ); ?>"><?php _e('Log in') ?></a>
    378 <?php if ( get_option( 'users_can_register' ) ) : ?>
    379  | <?php echo apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) ); ?>
    380 <?php endif; ?>
     521<?php if ( get_option( 'users_can_register' ) ) :
     522        /**
     523         * Filter the Register link text below the login form.
     524         *
     525         * @since 1.5.2
     526         *
     527         * @param string Register link text.
     528         */
     529        echo ' | ' . apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) );
     530endif; ?>
    381531</p>
    382532
    383533<?php
    … …  
    398548        if ( isset($_POST['pass1']) && $_POST['pass1'] != $_POST['pass2'] )
    399549                $errors->add( 'password_reset_mismatch', __( 'The passwords do not match.' ) );
    400550
     551        /**
     552         * Fires before the validation in the password reset precedure.
     553         *
     554         * @since 3.5.0
     555         *
     556         * @param object $errors        WP Error object.
     557         * @param string $user          User data.
     558         */     
    401559        do_action( 'validate_password_reset', $errors, $user );
    402560
    403561        if ( ( ! $errors->get_error_code() ) && isset( $_POST['pass1'] ) && !empty( $_POST['pass1'] ) ) {
    … …  
    434592
    435593<p id="nav">
    436594<a href="<?php echo esc_url( wp_login_url() ); ?>"><?php _e( 'Log in' ); ?></a>
    437 <?php if ( get_option( 'users_can_register' ) ) : ?>
    438  | <?php echo apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) ); ?>
    439 <?php endif; ?>
     595<?php if ( get_option( 'users_can_register' ) ) :
     596        //duplicate_hook
     597        echo ' | ' . apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) );
     598endif; ?>
    440599</p>
    441600
    442601<?php
    … …  
    445604
    446605case 'register' :
    447606        if ( is_multisite() ) {
    448                 // Multisite uses wp-signup.php
     607                /**
     608                 * Filter the redirect destination url for the Multi Site installation.
     609                 *
     610                 * @since 3.0.0
     611                 *
     612                 * @param string Signup url of the multisite.
     613                 */
    449614                wp_redirect( apply_filters( 'wp_signup_location', network_site_url('wp-signup.php') ) );
    450615                exit;
    451616        }
    … …  
    468633                }
    469634        }
    470635
     636        /**
     637         * Filter the redirect destination url after user registration.
     638         *
     639         * @since 3.0.0
     640         *
     641         * @param string The redirect destination url.
     642         */
    471643        $redirect_to = apply_filters( 'registration_redirect', !empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '' );
    472644        login_header(__('Registration Form'), '<p class="message register">' . __('Register For This Site') . '</p>', $errors);
    473645?>
    … …  
    481653                <label for="user_email"><?php _e('E-mail') ?><br />
    482654                <input type="text" name="user_email" id="user_email" class="input" value="<?php echo esc_attr(wp_unslash($user_email)); ?>" size="25" /></label>
    483655        </p>
    484 <?php do_action('register_form'); ?>
     656<?php
     657/**
     658 * Fires in the registration form to add extra input.
     659 *
     660 * @since 2.1.0
     661 */     
     662do_action( 'register_form' ); ?>
    485663        <p id="reg_passmail"><?php _e('A password will be e-mailed to you.') ?></p>
    486664        <br class="clear" />
    487665        <input type="hidden" name="redirect_to" value="<?php echo esc_attr( $redirect_to ); ?>" />
    … …  
    538716        else
    539717                $user = wp_signon('', $secure_cookie);
    540718
    541         $redirect_to = apply_filters('login_redirect', $redirect_to, isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '', $user);
     719        /**
     720         * Filtering the redirect url after login.
     721         *
     722         * @since 3.0.0
     723         *
     724         * @param string $redirect_to   The redirect destination url.
     725         * @param string                                The redirect destination url which was passed as a parameter.
     726         * @param object $user                  User data object.
     727         */
     728        $redirect_to = apply_filters( 'login_redirect', $redirect_to, isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '', $user );
    542729
    543730        if ( !is_wp_error($user) && !$reauth ) {
    544731                if ( $interim_login ) {
    … …  
    546733                        $interim_login = 'success';
    547734                        login_header( '', $message ); ?>
    548735                        </div>
    549                         <?php do_action( 'login_footer' ); ?>
     736                        <?php
     737                        /**
     738                         * Fires at the end of the html on the login page.
     739                         *
     740                         * @since 3.1.0
     741                         */     
     742                        do_action( 'login_footer' ); ?>
    550743                        <?php if ( $customize_login ) : ?>
    551744                                <script type="text/javascript">setTimeout( function(){ new wp.customize.Messenger({ url: '<?php echo wp_customize_url(); ?>', channel: 'login' }).send('login') }, 1000 );</script>
    552745                        <?php endif; ?>
    … …  
    591784                        $errors->add('updated', __( '<strong>You have successfully updated WordPress!</strong> Please log back in to experience the awesomeness.' ), 'message' );
    592785        }
    593786
     787        /**
     788         * Filter the WP Error object of the login page.
     789         *
     790         * @since 3.6.0
     791         *
     792         * @param object $errors                WP Error object.
     793         * @param string $redirect_to   Redirect destination url.
     794         */
    594795        $errors = apply_filters( 'wp_login_errors', $errors, $redirect_to );
    595796
    596797        // Clear any stale cookies.
    … …  
    613814                <label for="user_pass"><?php _e('Password') ?><br />
    614815                <input type="password" name="pwd" id="user_pass" class="input" value="" size="20" /></label>
    615816        </p>
    616 <?php do_action('login_form'); ?>
     817<?php
     818/**
     819 * Fires in the login form to add extra input.
     820 *
     821 * @since 2.1.0
     822 */     
     823do_action( 'login_form' ); ?>
    617824        <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>
    618825        <p class="submit">
    619826                <input type="submit" name="wp-submit" id="wp-submit" class="button button-primary button-large" value="<?php esc_attr_e('Log In'); ?>" />
    … …  
    631838
    632839<?php if ( ! $interim_login ) { ?>
    633840<p id="nav">
    634 <?php if ( ! isset( $_GET['checkemail'] ) || ! in_array( $_GET['checkemail'], array( 'confirm', 'newpass' ) ) ) : ?>
    635         <?php if ( get_option( 'users_can_register' ) ) : ?>
    636                 <?php echo apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) ); ?> |
    637         <?php endif; ?>
     841<?php if ( ! isset( $_GET['checkemail'] ) || ! in_array( $_GET['checkemail'], array( 'confirm', 'newpass' ) ) ) :
     842        if ( get_option( 'users_can_register' ) ) :
     843                //duplicate_hook
     844                echo apply_filters( 'register', sprintf( '<a href="%s">%s</a>', esc_url( wp_registration_url() ), __( 'Register' ) ) ) . ' | ';
     845        endif;
     846?>
    638847        <a href="<?php echo esc_url( wp_lostpassword_url() ); ?>" title="<?php esc_attr_e( 'Password Lost and Found' ); ?>"><?php _e( 'Lost your password?' ); ?></a>
    639848<?php endif; ?>
    640849</p>