[ Index ]

PHP Cross Reference of WordPress (latest release)

title

Body

[close]

/ -> wp-login.php (source)

   1  <?php
   2  /**
   3   * WordPress User Page
   4   *
   5   * Handles authentication, registering, resetting passwords, forgot password,
   6   * and other user handling.
   7   *
   8   * @package WordPress
   9   */
  10  
  11  /** Make sure that the WordPress bootstrap has ran before continuing. */
  12  require( dirname(__FILE__) . '/wp-load.php' );
  13  
  14  // Redirect to https login if forced to use SSL
  15  if ( force_ssl_admin() && !is_ssl() ) {
  16      if ( 0 === strpos($_SERVER['REQUEST_URI'], 'http') ) {
  17          wp_redirect(preg_replace('|^http://|', 'https://', $_SERVER['REQUEST_URI']));
  18          exit();
  19      } else {
  20          wp_redirect('https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']);
  21          exit();
  22      }
  23  }
  24  
  25  /**
  26   * Outputs the header for the login page.
  27   *
  28   * @uses do_action() Calls the 'login_head' for outputting HTML in the Log In
  29   *        header.
  30   * @uses apply_filters() Calls 'login_headerurl' for the top login link.
  31   * @uses apply_filters() Calls 'login_headertitle' for the top login title.
  32   * @uses apply_filters() Calls 'login_message' on the message to display in the
  33   *        header.
  34   * @uses $error The error global, which is checked for displaying errors.
  35   *
  36   * @param string $title Optional. WordPress Log In Page title to display in
  37   *        <title/> element.
  38   * @param string $message Optional. Message to display in header.
  39   * @param WP_Error $wp_error Optional. WordPress Error Object
  40   */
  41  function login_header($title = 'Log In', $message = '', $wp_error = '') {
  42      global $error;
  43  
  44      if ( empty($wp_error) )
  45          $wp_error = new WP_Error();
  46      ?>
  47  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  48  <html xmlns="http://www.w3.org/1999/xhtml" <?php language_attributes(); ?>>
  49  <head>
  50      <title><?php bloginfo('name'); ?> &rsaquo; <?php echo $title; ?></title>
  51      <meta http-equiv="Content-Type" content="<?php bloginfo('html_type'); ?>; charset=<?php bloginfo('charset'); ?>" />
  52      <?php
  53      wp_admin_css( 'login', true );
  54      wp_admin_css( 'colors-fresh', true );
  55      do_action('login_head'); ?>
  56  </head>
  57  <body class="login">
  58  
  59  <div id="login"><h1><a href="<?php echo apply_filters('login_headerurl', 'http://wordpress.org/'); ?>" title="<?php echo apply_filters('login_headertitle', __('Powered by WordPress')); ?>"><?php bloginfo('name'); ?></a></h1>
  60  <?php
  61      if ( !empty( $message ) ) echo apply_filters('login_message', $message) . "\n";
  62  
  63      // Incase a plugin uses $error rather than the $errors object
  64      if ( !empty( $error ) ) {
  65          $wp_error->add('error', $error);
  66          unset($error);
  67      }
  68  
  69      if ( $wp_error->get_error_code() ) {
  70          $errors = '';
  71          $messages = '';
  72          foreach ( $wp_error->get_error_codes() as $code ) {
  73              $severity = $wp_error->get_error_data($code);
  74              foreach ( $wp_error->get_error_messages($code) as $error ) {
  75                  if ( 'message' == $severity )
  76                      $messages .= '    ' . $error . "<br />\n";
  77                  else
  78                      $errors .= '    ' . $error . "<br />\n";
  79              }
  80          }
  81          if ( !empty($errors) )
  82              echo '<div id="login_error">' . apply_filters('login_errors', $errors) . "</div>\n";
  83          if ( !empty($messages) )
  84              echo '<p class="message">' . apply_filters('login_messages', $messages) . "</p>\n";
  85      }
  86  } // End of login_header()
  87  
  88  /**
  89   * Handles sending password retrieval email to user.
  90   *
  91   * @uses $wpdb WordPress Database object
  92   *
  93   * @return bool|WP_Error True: when finish. WP_Error on error
  94   */
  95  function retrieve_password() {
  96      global $wpdb;
  97  
  98      $errors = new WP_Error();
  99  
 100      if ( empty( $_POST['user_login'] ) && empty( $_POST['user_email'] ) )
 101          $errors->add('empty_username', __('<strong>ERROR</strong>: Enter a username or e-mail address.'));
 102  
 103      if ( strpos($_POST['user_login'], '@') ) {
 104          $user_data = get_user_by_email(trim($_POST['user_login']));
 105          if ( empty($user_data) )
 106              $errors->add('invalid_email', __('<strong>ERROR</strong>: There is no user registered with that email address.'));
 107      } else {
 108          $login = trim($_POST['user_login']);
 109          $user_data = get_userdatabylogin($login);
 110      }
 111  
 112      do_action('lostpassword_post');
 113  
 114      if ( $errors->get_error_code() )
 115          return $errors;
 116  
 117      if ( !$user_data ) {
 118          $errors->add('invalidcombo', __('<strong>ERROR</strong>: Invalid username or e-mail.'));
 119          return $errors;
 120      }
 121  
 122      // redefining user_login ensures we return the right case in the email
 123      $user_login = $user_data->user_login;
 124      $user_email = $user_data->user_email;
 125  
 126      do_action('retreive_password', $user_login);  // Misspelled and deprecated
 127      do_action('retrieve_password', $user_login);
 128  
 129      $allow = apply_filters('allow_password_reset', true, $user_data->ID);
 130  
 131      if ( ! $allow )
 132          return new WP_Error('no_password_reset', __('Password reset is not allowed for this user'));
 133      else if ( is_wp_error($allow) )
 134          return $allow;
 135  
 136      $key = $wpdb->get_var($wpdb->prepare("SELECT user_activation_key FROM $wpdb->users WHERE user_login = %s", $user_login));
 137      if ( empty($key) ) {
 138          // Generate something random for a key...
 139          $key = wp_generate_password(20, false);
 140          do_action('retrieve_password_key', $user_login, $key);
 141          // Now insert the new md5 key into the db
 142          $wpdb->query($wpdb->prepare("UPDATE $wpdb->users SET user_activation_key = %s WHERE user_login = %s", $key, $user_login));
 143      }
 144      $message = __('Someone has asked to reset the password for the following site and username.') . "\r\n\r\n";
 145      $message .= get_option('siteurl') . "\r\n\r\n";
 146      $message .= sprintf(__('Username: %s'), $user_login) . "\r\n\r\n";
 147      $message .= __('To reset your password visit the following address, otherwise just ignore this email and nothing will happen.') . "\r\n\r\n";
 148      $message .= site_url("wp-login.php?action=rp&key=$key", 'login') . "\r\n";
 149  
 150      if ( !wp_mail($user_email, sprintf(__('[%s] Password Reset'), get_option('blogname')), $message) )
 151          die('<p>' . __('The e-mail could not be sent.') . "<br />\n" . __('Possible reason: your host may have disabled the mail() function...') . '</p>');
 152  
 153      return true;
 154  }
 155  
 156  /**
 157   * Handles resetting the user's password.
 158   *
 159   * @uses $wpdb WordPress Database object
 160   *
 161   * @param string $key Hash to validate sending user's password
 162   * @return bool|WP_Error
 163   */
 164  function reset_password($key) {
 165      global $wpdb;
 166  
 167      $key = preg_replace('/[^a-z0-9]/i', '', $key);
 168  
 169      if ( empty( $key ) )
 170          return new WP_Error('invalid_key', __('Invalid key'));
 171  
 172      $user = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->users WHERE user_activation_key = %s", $key));
 173      if ( empty( $user ) )
 174          return new WP_Error('invalid_key', __('Invalid key'));
 175  
 176      do_action('password_reset', $user);
 177  
 178      // Generate something random for a password...
 179      $new_pass = wp_generate_password();
 180      wp_set_password($new_pass, $user->ID);
 181      $message  = sprintf(__('Username: %s'), $user->user_login) . "\r\n";
 182      $message .= sprintf(__('Password: %s'), $new_pass) . "\r\n";
 183      $message .= site_url('wp-login.php', 'login') . "\r\n";
 184  
 185      if (  !wp_mail($user->user_email, sprintf(__('[%s] Your new password'), get_option('blogname')), $message) )
 186          die('<p>' . __('The e-mail could not be sent.') . "<br />\n" . __('Possible reason: your host may have disabled the mail() function...') . '</p>');
 187  
 188      wp_password_change_notification($user);
 189  
 190      return true;
 191  }
 192  
 193  /**
 194   * Handles registering a new user.
 195   *
 196   * @param string $user_login User's username for logging in
 197   * @param string $user_email User's email address to send password and add
 198   * @return int|WP_Error Either user's ID or error on failure.
 199   */
 200  function register_new_user($user_login, $user_email) {
 201      $errors = new WP_Error();
 202  
 203      $user_login = sanitize_user( $user_login );
 204      $user_email = apply_filters( 'user_registration_email', $user_email );
 205  
 206      // Check the username
 207      if ( $user_login == '' )
 208          $errors->add('empty_username', __('<strong>ERROR</strong>: Please enter a username.'));
 209      elseif ( !validate_username( $user_login ) ) {
 210          $errors->add('invalid_username', __('<strong>ERROR</strong>: This username is invalid.  Please enter a valid username.'));
 211          $user_login = '';
 212      } elseif ( username_exists( $user_login ) )
 213          $errors->add('username_exists', __('<strong>ERROR</strong>: This username is already registered, please choose another one.'));
 214  
 215      // Check the e-mail address
 216      if ($user_email == '') {
 217          $errors->add('empty_email', __('<strong>ERROR</strong>: Please type your e-mail address.'));
 218      } elseif ( !is_email( $user_email ) ) {
 219          $errors->add('invalid_email', __('<strong>ERROR</strong>: The email address isn&#8217;t correct.'));
 220          $user_email = '';
 221      } elseif ( email_exists( $user_email ) )
 222          $errors->add('email_exists', __('<strong>ERROR</strong>: This email is already registered, please choose another one.'));
 223  
 224      do_action('register_post', $user_login, $user_email, $errors);
 225  
 226      $errors = apply_filters( 'registration_errors', $errors );
 227  
 228      if ( $errors->get_error_code() )
 229          return $errors;
 230  
 231      $user_pass = wp_generate_password();
 232      $user_id = wp_create_user( $user_login, $user_pass, $user_email );
 233      if ( !$user_id ) {
 234          $errors->add('registerfail', sprintf(__('<strong>ERROR</strong>: Couldn&#8217;t register you... please contact the <a href="mailto:%s">webmaster</a> !'), get_option('admin_email')));
 235          return $errors;
 236      }
 237  
 238      wp_new_user_notification($user_id, $user_pass);
 239  
 240      return $user_id;
 241  }
 242  
 243  //
 244  // Main
 245  //
 246  
 247  $action = isset($_REQUEST['action']) ? $_REQUEST['action'] : '';
 248  $errors = new WP_Error();
 249  
 250  if ( isset($_GET['key']) )
 251      $action = 'resetpass';
 252  
 253  nocache_headers();
 254  
 255  header('Content-Type: '.get_bloginfo('html_type').'; charset='.get_bloginfo('charset'));
 256  
 257  if ( defined('RELOCATE') ) { // Move flag is set
 258      if ( isset( $_SERVER['PATH_INFO'] ) && ($_SERVER['PATH_INFO'] != $_SERVER['PHP_SELF']) )
 259          $_SERVER['PHP_SELF'] = str_replace( $_SERVER['PATH_INFO'], '', $_SERVER['PHP_SELF'] );
 260  
 261      $schema = ( isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on' ) ? 'https://' : 'http://';
 262      if ( dirname($schema . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF']) != get_option('siteurl') )
 263          update_option('siteurl', dirname($schema . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF']) );
 264  }
 265  
 266  //Set a cookie now to see if they are supported by the browser.
 267  setcookie(TEST_COOKIE, 'WP Cookie check', 0, COOKIEPATH, COOKIE_DOMAIN);
 268  if ( SITECOOKIEPATH != COOKIEPATH )
 269      setcookie(TEST_COOKIE, 'WP Cookie check', 0, SITECOOKIEPATH, COOKIE_DOMAIN);
 270  
 271  $http_post = ('POST' == $_SERVER['REQUEST_METHOD']);
 272  switch ($action) {
 273  
 274  case 'logout' :
 275      check_admin_referer('log-out');
 276      wp_logout();
 277  
 278      $redirect_to = 'wp-login.php?loggedout=true';
 279      if ( isset( $_REQUEST['redirect_to'] ) )
 280          $redirect_to = $_REQUEST['redirect_to'];
 281  
 282      wp_safe_redirect($redirect_to);
 283      exit();
 284  
 285  break;
 286  
 287  case 'lostpassword' :
 288  case 'retrievepassword' :
 289      if ( $http_post ) {
 290          $errors = retrieve_password();
 291          if ( !is_wp_error($errors) ) {
 292              wp_redirect('wp-login.php?checkemail=confirm');
 293              exit();
 294          }
 295      }
 296  
 297      if ( isset($_GET['error']) && 'invalidkey' == $_GET['error'] ) $errors->add('invalidkey', __('Sorry, that key does not appear to be valid.'));
 298  
 299      do_action('lost_password');
 300      login_header(__('Lost Password'), '<p class="message">' . __('Please enter your username or e-mail address. You will receive a new password via e-mail.') . '</p>', $errors);
 301  
 302      $user_login = isset($_POST['user_login']) ? stripslashes($_POST['user_login']) : '';
 303  
 304  ?>
 305  
 306  <form name="lostpasswordform" id="lostpasswordform" action="<?php echo site_url('wp-login.php?action=lostpassword', 'login_post') ?>" method="post">
 307      <p>
 308          <label><?php _e('Username or E-mail:') ?><br />
 309          <input type="text" name="user_login" id="user_login" class="input" value="<?php echo attribute_escape($user_login); ?>" size="20" tabindex="10" /></label>
 310      </p>
 311  <?php do_action('lostpassword_form'); ?>
 312      <p class="submit"><input type="submit" name="wp-submit" id="wp-submit" value="<?php _e('Get New Password'); ?>" tabindex="100" /></p>
 313  </form>
 314  
 315  <p id="nav">
 316  <?php if (get_option('users_can_register')) : ?>
 317  <a href="<?php echo site_url('wp-login.php', 'login') ?>"><?php _e('Log in') ?></a> |
 318  <a href="<?php echo site_url('wp-login.php?action=register', 'login') ?>"><?php _e('Register') ?></a>
 319  <?php else : ?>
 320  <a href="<?php echo site_url('wp-login.php', 'login') ?>"><?php _e('Log in') ?></a>
 321  <?php endif; ?>
 322  </p>
 323  
 324  </div>
 325  
 326  <p id="backtoblog"><a href="<?php bloginfo('url'); ?>/" title="<?php _e('Are you lost?') ?>"><?php printf(__('&larr; Back to %s'), get_bloginfo('title', 'display' )); ?></a></p>
 327  
 328  <script type="text/javascript">
 329  try{document.getElementById('user_login').focus();}catch(e){}
 330  </script>
 331  </body>
 332  </html>
 333  <?php
 334  break;
 335  
 336  case 'resetpass' :
 337  case 'rp' :
 338      $errors = reset_password($_GET['key']);
 339  
 340      if ( ! is_wp_error($errors) ) {
 341          wp_redirect('wp-login.php?checkemail=newpass');
 342          exit();
 343      }
 344  
 345      wp_redirect('wp-login.php?action=lostpassword&error=invalidkey');
 346      exit();
 347  
 348  break;
 349  
 350  case 'register' :
 351      if ( !get_option('users_can_register') ) {
 352          wp_redirect('wp-login.php?registration=disabled');
 353          exit();
 354      }
 355  
 356      $user_login = '';
 357      $user_email = '';
 358      if ( $http_post ) {
 359          require_once ( ABSPATH . WPINC . '/registration.php');
 360  
 361          $user_login = $_POST['user_login'];
 362          $user_email = $_POST['user_email'];
 363          $errors = register_new_user($user_login, $user_email);
 364          if ( !is_wp_error($errors) ) {
 365              wp_redirect('wp-login.php?checkemail=registered');
 366              exit();
 367          }
 368      }
 369  
 370      login_header(__('Registration Form'), '<p class="message register">' . __('Register For This Site') . '</p>', $errors);
 371  ?>
 372  
 373  <form name="registerform" id="registerform" action="<?php echo site_url('wp-login.php?action=register', 'login_post') ?>" method="post">
 374      <p>
 375          <label><?php _e('Username') ?><br />
 376          <input type="text" name="user_login" id="user_login" class="input" value="<?php echo attribute_escape(stripslashes($user_login)); ?>" size="20" tabindex="10" /></label>
 377      </p>
 378      <p>
 379          <label><?php _e('E-mail') ?><br />
 380          <input type="text" name="user_email" id="user_email" class="input" value="<?php echo attribute_escape(stripslashes($user_email)); ?>" size="25" tabindex="20" /></label>
 381      </p>
 382  <?php do_action('register_form'); ?>
 383      <p id="reg_passmail"><?php _e('A password will be e-mailed to you.') ?></p>
 384      <p class="submit"><input type="submit" name="wp-submit" id="wp-submit" value="<?php _e('Register'); ?>" tabindex="100" /></p>
 385  </form>
 386  
 387  <p id="nav">
 388  <a href="<?php echo site_url('wp-login.php', 'login') ?>"><?php _e('Log in') ?></a> |
 389  <a href="<?php echo site_url('wp-login.php?action=lostpassword', 'login') ?>" title="<?php _e('Password Lost and Found') ?>"><?php _e('Lost your password?') ?></a>
 390  </p>
 391  
 392  </div>
 393  
 394  <p id="backtoblog"><a href="<?php bloginfo('url'); ?>/" title="<?php _e('Are you lost?') ?>"><?php printf(__('&larr; Back to %s'), get_bloginfo('title', 'display' )); ?></a></p>
 395  
 396  <script type="text/javascript">
 397  try{document.getElementById('user_login').focus();}catch(e){}
 398  </script>
 399  </body>
 400  </html>
 401  <?php
 402  break;
 403  
 404  case 'login' :
 405  default:
 406      $secure_cookie = '';
 407  
 408      // If the user wants ssl but the session is not ssl, force a secure cookie.
 409      if ( !empty($_POST['log']) && !force_ssl_admin() ) {
 410          $user_name = sanitize_user($_POST['log']);
 411          if ( $user = get_userdatabylogin($user_name) ) {
 412              if ( get_user_option('use_ssl', $user->ID) ) {
 413                  $secure_cookie = true;
 414                  force_ssl_admin(true);
 415              }
 416          }
 417      }
 418  
 419      if ( isset( $_REQUEST['redirect_to'] ) ) {
 420          $redirect_to = $_REQUEST['redirect_to'];
 421          // Redirect to https if user wants ssl
 422          if ( $secure_cookie && false !== strpos($redirect_to, 'wp-admin') )
 423              $redirect_to = preg_replace('|^http://|', 'https://', $redirect_to);
 424      } else {
 425          $redirect_to = admin_url();
 426      }
 427  
 428      if ( !$secure_cookie && is_ssl() && force_ssl_login() && !force_ssl_admin() && ( 0 !== strpos($redirect_to, 'https') ) && ( 0 === strpos($redirect_to, 'http') ) )
 429          $secure_cookie = false;
 430  
 431      $user = wp_signon('', $secure_cookie);
 432  
 433      $redirect_to = apply_filters('login_redirect', $redirect_to, isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '', $user);
 434  
 435      if ( !is_wp_error($user) ) {
 436          // If the user can't edit posts, send them to their profile.
 437          if ( !$user->has_cap('edit_posts') && ( empty( $redirect_to ) || $redirect_to == 'wp-admin/' ) )
 438              $redirect_to = admin_url('profile.php');
 439          wp_safe_redirect($redirect_to);
 440          exit();
 441      }
 442  
 443      $errors = $user;
 444      // Clear errors if loggedout is set.
 445      if ( !empty($_GET['loggedout']) )
 446          $errors = new WP_Error();
 447  
 448      // If cookies are disabled we can't log in even with a valid user+pass
 449      if ( isset($_POST['testcookie']) && empty($_COOKIE[TEST_COOKIE]) )
 450          $errors->add('test_cookie', __("<strong>ERROR</strong>: Cookies are blocked or not supported by your browser. You must <a href='http://www.google.com/cookies.html'>enable cookies</a> to use WordPress."));
 451  
 452      // Some parts of this script use the main login form to display a message
 453      if        ( isset($_GET['loggedout']) && TRUE == $_GET['loggedout'] )            $errors->add('loggedout', __('You are now logged out.'), 'message');
 454      elseif    ( isset($_GET['registration']) && 'disabled' == $_GET['registration'] )    $errors->add('registerdisabled', __('User registration is currently not allowed.'));
 455      elseif    ( isset($_GET['checkemail']) && 'confirm' == $_GET['checkemail'] )    $errors->add('confirm', __('Check your e-mail for the confirmation link.'), 'message');
 456      elseif    ( isset($_GET['checkemail']) && 'newpass' == $_GET['checkemail'] )    $errors->add('newpass', __('Check your e-mail for your new password.'), 'message');
 457      elseif    ( isset($_GET['checkemail']) && 'registered' == $_GET['checkemail'] )    $errors->add('registered', __('Registration complete. Please check your e-mail.'), 'message');
 458  
 459      login_header(__('Log In'), '', $errors);
 460  
 461      if ( isset($_POST['log']) )
 462          $user_login = ( 'incorrect_password' == $errors->get_error_code() || 'empty_password' == $errors->get_error_code() ) ? attribute_escape(stripslashes($_POST['log'])) : '';
 463  ?>
 464  
 465  <?php if ( !isset($_GET['checkemail']) || !in_array( $_GET['checkemail'], array('confirm', 'newpass') ) ) : ?>
 466  <form name="loginform" id="loginform" action="<?php echo site_url('wp-login.php', 'login_post') ?>" method="post">
 467      <p>
 468          <label><?php _e('Username') ?><br />
 469          <input type="text" name="log" id="user_login" class="input" value="<?php echo $user_login; ?>" size="20" tabindex="10" /></label>
 470      </p>
 471      <p>
 472          <label><?php _e('Password') ?><br />
 473          <input type="password" name="pwd" id="user_pass" class="input" value="" size="20" tabindex="20" /></label>
 474      </p>
 475  <?php do_action('login_form'); ?>
 476      <p class="forgetmenot"><label><input name="rememberme" type="checkbox" id="rememberme" value="forever" tabindex="90" /> <?php _e('Remember Me'); ?></label></p>
 477      <p class="submit">
 478          <input type="submit" name="wp-submit" id="wp-submit" value="<?php _e('Log In'); ?>" tabindex="100" />
 479          <input type="hidden" name="redirect_to" value="<?php echo attribute_escape($redirect_to); ?>" />
 480          <input type="hidden" name="testcookie" value="1" />
 481      </p>
 482  </form>
 483  <?php endif; ?>
 484  
 485  <p id="nav">
 486  <?php if ( isset($_GET['checkemail']) && in_array( $_GET['checkemail'], array('confirm', 'newpass') ) ) : ?>
 487  <?php elseif (get_option('users_can_register')) : ?>
 488  <a href="<?php echo site_url('wp-login.php?action=register', 'login') ?>"><?php _e('Register') ?></a> |
 489  <a href="<?php echo site_url('wp-login.php?action=lostpassword', 'login') ?>" title="<?php _e('Password Lost and Found') ?>"><?php _e('Lost your password?') ?></a>
 490  <?php else : ?>
 491  <a href="<?php echo site_url('wp-login.php?action=lostpassword', 'login') ?>" title="<?php _e('Password Lost and Found') ?>"><?php _e('Lost your password?') ?></a>
 492  <?php endif; ?>
 493  </p>
 494  
 495  </div>
 496  
 497  <p id="backtoblog"><a href="<?php bloginfo('url'); ?>/" title="<?php _e('Are you lost?') ?>"><?php printf(__('&larr; Back to %s'),