wp-includes/user.php

   1 <?php
   2 /**
   3  * Core User API
   4  *
   5  * @package WordPress
   6  * @subpackage Users
   7  */
   8
   9 /**
  10  * Authenticates and logs a user in with 'remember' capability.
  11  *
  12  * The credentials is an array that has 'user_login', 'user_password', and
  13  * 'remember' indices. If the credentials is not given, then the log in form
  14  * will be assumed and used if set.
  15  *
  16  * The various authentication cookies will be set by this function and will be
  17  * set for a longer period depending on if the 'remember' credential is set to
  18  * true.
  19  *
  20  * @since 2.5.0
  21  *
  22  * @global string $auth_secure_cookie
  23  *
  24  * @param array       $credentials   Optional. User info in order to sign on.
  25  * @param string|bool $secure_cookie Optional. Whether to use secure cookie.
  26  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
  27  */
  28 function wp_signon( $credentials = array(), $secure_cookie = '' ) {
  29         if ( empty($credentials) ) {
  30                 $credentials = array(); // Back-compat for plugins passing an empty string.
  31
  32                 if ( ! empty($_POST['log']) )
  33                         $credentials['user_login'] = $_POST['log'];
  34                 if ( ! empty($_POST['pwd']) )
  35                         $credentials['user_password'] = $_POST['pwd'];
  36                 if ( ! empty($_POST['rememberme']) )
  37                         $credentials['remember'] = $_POST['rememberme'];
  38         }
  39
  40         if ( !empty($credentials['remember']) )
  41                 $credentials['remember'] = true;
  42         else
  43                 $credentials['remember'] = false;
  44
  45         /**
  46          * Fires before the user is authenticated.
  47          *
  48          * The variables passed to the callbacks are passed by reference,
  49          * and can be modified by callback functions.
  50          *
  51          * @since 1.5.1
  52          *
  53          * @todo Decide whether to deprecate the wp_authenticate action.
  54          *
  55          * @param string $user_login    Username, passed by reference.
  56          * @param string $user_password User password, passed by reference.
  57          */
  58         do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
  59
  60         if ( '' === $secure_cookie )
  61                 $secure_cookie = is_ssl();
  62
  63         /**
  64          * Filters whether to use a secure sign-on cookie.
  65          *
  66          * @since 3.1.0
  67          *
  68          * @param bool  $secure_cookie Whether to use a secure sign-on cookie.
  69          * @param array $credentials {
  70          *     Array of entered sign-on data.
  71          *
  72          *     @type string $user_login    Username.
  73          *     @type string $user_password Password entered.
  74          *     @type bool   $remember      Whether to 'remember' the user. Increases the time
  75          *                                 that the cookie will be kept. Default false.
  76          * }
  77          */
  78         $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );
  79
  80         global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
  81         $auth_secure_cookie = $secure_cookie;
  82
  83         add_filter('authenticate', 'wp_authenticate_cookie', 30, 3);
  84
  85         $user = wp_authenticate($credentials['user_login'], $credentials['user_password']);
  86
  87         if ( is_wp_error($user) ) {
  88                 if ( $user->get_error_codes() == array('empty_username', 'empty_password') ) {
  89                         $user = new WP_Error('', '');
  90                 }
  91
  92                 return $user;
  93         }
  94
  95         wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie);
  96         /**
  97          * Fires after the user has successfully logged in.
  98          *
  99          * @since 1.5.0
 100          *
 101          * @param string  $user_login Username.
 102          * @param WP_User $user       WP_User object of the logged-in user.
 103          */
 104         do_action( 'wp_login', $user->user_login, $user );
 105         return $user;
 106 }
 107
 108 /**
 109  * Authenticate a user, confirming the username and password are valid.
 110  *
 111  * @since 2.8.0
 112  *
 113  * @param WP_User|WP_Error|null $user     WP_User or WP_Error object from a previous callback. Default null.
 114  * @param string                $username Username for authentication.
 115  * @param string                $password Password for authentication.
 116  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 117  */
 118 function wp_authenticate_username_password($user, $username, $password) {
 119         if ( $user instanceof WP_User ) {
 120                 return $user;
 121         }
 122
 123         if ( empty($username) || empty($password) ) {
 124                 if ( is_wp_error( $user ) )
 125                         return $user;
 126
 127                 $error = new WP_Error();
 128
 129                 if ( empty($username) )
 130                         $error->add('empty_username', __('<strong>ERROR</strong>: The username field is empty.'));
 131
 132                 if ( empty($password) )
 133                         $error->add('empty_password', __('<strong>ERROR</strong>: The password field is empty.'));
 134
 135                 return $error;
 136         }
 137
 138         $user = get_user_by('login', $username);
 139
 140         if ( !$user ) {
 141                 return new WP_Error( 'invalid_username',
 142                         __( '<strong>ERROR</strong>: Invalid username.' ) .
 143                         ' <a href="' . wp_lostpassword_url() . '">' .
 144                         __( 'Lost your password?' ) .
 145                         '</a>'
 146                 );
 147         }
 148
 149         /**
 150          * Filters whether the given user can be authenticated with the provided $password.
 151          *
 152          * @since 2.5.0
 153          *
 154          * @param WP_User|WP_Error $user     WP_User or WP_Error object if a previous
 155          *                                   callback failed authentication.
 156          * @param string           $password Password to check against the user.
 157          */
 158         $user = apply_filters( 'wp_authenticate_user', $user, $password );
 159         if ( is_wp_error($user) )
 160                 return $user;
 161
 162         if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
 163                 return new WP_Error( 'incorrect_password',
 164                         sprintf(
 165                                 /* translators: %s: user name */
 166                                 __( '<strong>ERROR</strong>: The password you entered for the username %s is incorrect.' ),
 167                                 '<strong>' . $username . '</strong>'
 168                         ) .
 169                         ' <a href="' . wp_lostpassword_url() . '">' .
 170                         __( 'Lost your password?' ) .
 171                         '</a>'
 172                 );
 173         }
 174
 175         return $user;
 176 }
 177
 178 /**
 179  * Authenticates a user using the email and password.
 180  *
 181  * @since 4.5.0
 182  *
 183  * @param WP_User|WP_Error|null $user     WP_User or WP_Error object if a previous
 184  *                                        callback failed authentication.
 185  * @param string                $email    Email address for authentication.
 186  * @param string                $password Password for authentication.
 187  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 188  */
 189 function wp_authenticate_email_password( $user, $email, $password ) {
 190         if ( $user instanceof WP_User ) {
 191                 return $user;
 192         }
 193
 194         if ( empty( $email ) || empty( $password ) ) {
 195                 if ( is_wp_error( $user ) ) {
 196                         return $user;
 197                 }
 198
 199                 $error = new WP_Error();
 200
 201                 if ( empty( $email ) ) {
 202                         $error->add( 'empty_username', __( '<strong>ERROR</strong>: The email field is empty.' ) ); // Uses 'empty_username' for back-compat with wp_signon()
 203                 }
 204
 205                 if ( empty( $password ) ) {
 206                         $error->add( 'empty_password', __( '<strong>ERROR</strong>: The password field is empty.' ) );
 207                 }
 208
 209                 return $error;
 210         }
 211
 212         if ( ! is_email( $email ) ) {
 213                 return $user;
 214         }
 215
 216         $user = get_user_by( 'email', $email );
 217
 218         if ( ! $user ) {
 219                 return new WP_Error( 'invalid_email',
 220                         __( '<strong>ERROR</strong>: Invalid email address.' ) .
 221                         ' <a href="' . wp_lostpassword_url() . '">' .
 222                         __( 'Lost your password?' ) .
 223                         '</a>'
 224                 );
 225         }
 226
 227         /** This filter is documented in wp-includes/user.php */
 228         $user = apply_filters( 'wp_authenticate_user', $user, $password );
 229
 230         if ( is_wp_error( $user ) ) {
 231                 return $user;
 232         }
 233
 234         if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
 235                 return new WP_Error( 'incorrect_password',
 236                         sprintf(
 237                                 /* translators: %s: email address */
 238                                 __( '<strong>ERROR</strong>: The password you entered for the email address %s is incorrect.' ),
 239                                 '<strong>' . $email . '</strong>'
 240                         ) .
 241                         ' <a href="' . wp_lostpassword_url() . '">' .
 242                         __( 'Lost your password?' ) .
 243                         '</a>'
 244                 );
 245         }
 246
 247         return $user;
 248 }
 249
 250 /**
 251  * Authenticate the user using the WordPress auth cookie.
 252  *
 253  * @since 2.8.0
 254  *
 255  * @global string $auth_secure_cookie
 256  *
 257  * @param WP_User|WP_Error|null $user     WP_User or WP_Error object from a previous callback. Default null.
 258  * @param string                $username Username. If not empty, cancels the cookie authentication.
 259  * @param string                $password Password. If not empty, cancels the cookie authentication.
 260  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 261  */
 262 function wp_authenticate_cookie($user, $username, $password) {
 263         if ( $user instanceof WP_User ) {
 264                 return $user;
 265         }
 266
 267         if ( empty($username) && empty($password) ) {
 268                 $user_id = wp_validate_auth_cookie();
 269                 if ( $user_id )
 270                         return new WP_User($user_id);
 271
 272                 global $auth_secure_cookie;
 273
 274                 if ( $auth_secure_cookie )
 275                         $auth_cookie = SECURE_AUTH_COOKIE;
 276                 else
 277                         $auth_cookie = AUTH_COOKIE;
 278
 279                 if ( !empty($_COOKIE[$auth_cookie]) )
 280                         return new WP_Error('expired_session', __('Please log in again.'));
 281
 282                 // If the cookie is not set, be silent.
 283         }
 284
 285         return $user;
 286 }
 287
 288 /**
 289  * For Multisite blogs, check if the authenticated user has been marked as a
 290  * spammer, or if the user's primary blog has been marked as spam.
 291  *
 292  * @since 3.7.0
 293  *
 294  * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
 295  * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer.
 296  */
 297 function wp_authenticate_spam_check( $user ) {
 298         if ( $user instanceof WP_User && is_multisite() ) {
 299                 /**
 300                  * Filters whether the user has been marked as a spammer.
 301                  *
 302                  * @since 3.7.0
 303                  *
 304                  * @param bool    $spammed Whether the user is considered a spammer.
 305                  * @param WP_User $user    User to check against.
 306                  */
 307                 $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy( $user ), $user );
 308
 309                 if ( $spammed )
 310                         return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) );
 311         }
 312         return $user;
 313 }
 314
 315 /**
 316  * Validates the logged-in cookie.
 317  *
 318  * Checks the logged-in cookie if the previous auth cookie could not be
 319  * validated and parsed.
 320  *
 321  * This is a callback for the {@see 'determine_current_user'} filter, rather than API.
 322  *
 323  * @since 3.9.0
 324  *
 325  * @param int|bool $user_id The user ID (or false) as received from the
 326  *                       determine_current_user filter.
 327  * @return int|false User ID if validated, false otherwise. If a user ID from
 328  *                   an earlier filter callback is received, that value is returned.
 329  */
 330 function wp_validate_logged_in_cookie( $user_id ) {
 331         if ( $user_id ) {
 332                 return $user_id;
 333         }
 334
 335         if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) ) {
 336                 return false;
 337         }
 338
 339         return wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' );
 340 }
 341
 342 /**
 343  * Number of posts user has written.
 344  *
 345  * @since 3.0.0
 346  * @since 4.1.0 Added `$post_type` argument.
 347  * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array
 348  *              of post types to `$post_type`.
 349  *
 350  * @global wpdb $wpdb WordPress database abstraction object.
 351  *
 352  * @param int          $userid      User ID.
 353  * @param array|string $post_type   Optional. Single post type or array of post types to count the number of posts for. Default 'post'.
 354  * @param bool         $public_only Optional. Whether to only return counts for public posts. Default false.
 355  * @return string Number of posts the user has written in this post type.
 356  */
 357 function count_user_posts( $userid, $post_type = 'post', $public_only = false ) {
 358         global $wpdb;
 359
 360         $where = get_posts_by_author_sql( $post_type, true, $userid, $public_only );
 361
 362         $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
 363
 364         /**
 365          * Filters the number of posts a user has written.
 366          *
 367          * @since 2.7.0
 368          * @since 4.1.0 Added `$post_type` argument.
 369          * @since 4.3.1 Added `$public_only` argument.
 370          *
 371          * @param int          $count       The user's post count.
 372          * @param int          $userid      User ID.
 373          * @param string|array $post_type   Single post type or array of post types to count the number of posts for.
 374          * @param bool         $public_only Whether to limit counted posts to public posts.
 375          */
 376         return apply_filters( 'get_usernumposts', $count, $userid, $post_type, $public_only );
 377 }
 378
 379 /**
 380  * Number of posts written by a list of users.
 381  *
 382  * @since 3.0.0
 383  *
 384  * @global wpdb $wpdb WordPress database abstraction object.
 385  *
 386  * @param array        $users       Array of user IDs.
 387  * @param string|array $post_type   Optional. Single post type or array of post types to check. Defaults to 'post'.
 388  * @param bool         $public_only Optional. Only return counts for public posts.  Defaults to false.
 389  * @return array Amount of posts each user has written.
 390  */
 391 function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) {
 392         global $wpdb;
 393
 394         $count = array();
 395         if ( empty( $users ) || ! is_array( $users ) )
 396                 return $count;
 397
 398         $userlist = implode( ',', array_map( 'absint', $users ) );
 399         $where = get_posts_by_author_sql( $post_type, true, null, $public_only );
 400
 401         $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N );
 402         foreach ( $result as $row ) {
 403                 $count[ $row[0] ] = $row[1];
 404         }
 405
 406         foreach ( $users as $id ) {
 407                 if ( ! isset( $count[ $id ] ) )
 408                         $count[ $id ] = 0;
 409         }
 410
 411         return $count;
 412 }
 413
 414 //
 415 // User option functions
 416 //
 417
 418 /**
 419  * Get the current user's ID
 420  *
 421  * @since MU
 422  *
 423  * @return int The current user's ID
 424  */
 425 function get_current_user_id() {
 426         if ( ! function_exists( 'wp_get_current_user' ) )
 427                 return 0;
 428         $user = wp_get_current_user();
 429         return ( isset( $user->ID ) ? (int) $user->ID : 0 );
 430 }
 431
 432 /**
 433  * Retrieve user option that can be either per Site or per Network.
 434  *
 435  * If the user ID is not given, then the current user will be used instead. If
 436  * the user ID is given, then the user data will be retrieved. The filter for
 437  * the result, will also pass the original option name and finally the user data
 438  * object as the third parameter.
 439  *
 440  * The option will first check for the per site name and then the per Network name.
 441  *
 442  * @since 2.0.0
 443  *
 444  * @global wpdb $wpdb WordPress database abstraction object.
 445  *
 446  * @param string $option     User option name.
 447  * @param int    $user       Optional. User ID.
 448  * @param string $deprecated Use get_option() to check for an option in the options table.
 449  * @return mixed User option value on success, false on failure.
 450  */
 451 function get_user_option( $option, $user = 0, $deprecated = '' ) {
 452         global $wpdb;
 453
 454         if ( !empty( $deprecated ) )
 455                 _deprecated_argument( __FUNCTION__, '3.0.0' );
 456
 457         if ( empty( $user ) )
 458                 $user = get_current_user_id();
 459
 460         if ( ! $user = get_userdata( $user ) )
 461                 return false;
 462
 463         $prefix = $wpdb->get_blog_prefix();
 464         if ( $user->has_prop( $prefix . $option ) ) // Blog specific
 465                 $result = $user->get( $prefix . $option );
 466         elseif ( $user->has_prop( $option ) ) // User specific and cross-blog
 467                 $result = $user->get( $option );
 468         else
 469                 $result = false;
 470
 471         /**
 472          * Filters a specific user option value.
 473          *
 474          * The dynamic portion of the hook name, `$option`, refers to the user option name.
 475          *
 476          * @since 2.5.0
 477          *
 478          * @param mixed   $result Value for the user's option.
 479          * @param string  $option Name of the option being retrieved.
 480          * @param WP_User $user   WP_User object of the user whose option is being retrieved.
 481          */
 482         return apply_filters( "get_user_option_{$option}", $result, $option, $user );
 483 }
 484
 485 /**
 486  * Update user option with global blog capability.
 487  *
 488  * User options are just like user metadata except that they have support for
 489  * global blog options. If the 'global' parameter is false, which it is by default
 490  * it will prepend the WordPress table prefix to the option name.
 491  *
 492  * Deletes the user option if $newvalue is empty.
 493  *
 494  * @since 2.0.0
 495  *
 496  * @global wpdb $wpdb WordPress database abstraction object.
 497  *
 498  * @param int    $user_id     User ID.
 499  * @param string $option_name User option name.
 500  * @param mixed  $newvalue    User option value.
 501  * @param bool   $global      Optional. Whether option name is global or blog specific.
 502  *                            Default false (blog specific).
 503  * @return int|bool User meta ID if the option didn't exist, true on successful update,
 504  *                  false on failure.
 505  */
 506 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
 507         global $wpdb;
 508
 509         if ( !$global )
 510                 $option_name = $wpdb->get_blog_prefix() . $option_name;
 511
 512         return update_user_meta( $user_id, $option_name, $newvalue );
 513 }
 514
 515 /**
 516  * Delete user option with global blog capability.
 517  *
 518  * User options are just like user metadata except that they have support for
 519  * global blog options. If the 'global' parameter is false, which it is by default
 520  * it will prepend the WordPress table prefix to the option name.
 521  *
 522  * @since 3.0.0
 523  *
 524  * @global wpdb $wpdb WordPress database abstraction object.
 525  *
 526  * @param int    $user_id     User ID
 527  * @param string $option_name User option name.
 528  * @param bool   $global      Optional. Whether option name is global or blog specific.
 529  *                            Default false (blog specific).
 530  * @return bool True on success, false on failure.
 531  */
 532 function delete_user_option( $user_id, $option_name, $global = false ) {
 533         global $wpdb;
 534
 535         if ( !$global )
 536                 $option_name = $wpdb->get_blog_prefix() . $option_name;
 537         return delete_user_meta( $user_id, $option_name );
 538 }
 539
 540 /**
 541  * Retrieve list of users matching criteria.
 542  *
 543  * @since 3.1.0
 544  *
 545  * @see WP_User_Query
 546  *
 547  * @param array $args Optional. Arguments to retrieve users. See WP_User_Query::prepare_query().
 548  *                    for more information on accepted arguments.
 549  * @return array List of users.
 550  */
 551 function get_users( $args = array() ) {
 552
 553         $args = wp_parse_args( $args );
 554         $args['count_total'] = false;
 555
 556         $user_search = new WP_User_Query($args);
 557
 558         return (array) $user_search->get_results();
 559 }
 560
 561 /**
 562  * Get the sites a user belongs to.
 563  *
 564  * @since 3.0.0
 565  * @since 4.7.0 Converted to use get_sites().
 566  *
 567  * @global wpdb $wpdb WordPress database abstraction object.
 568  *
 569  * @param int  $user_id User ID
 570  * @param bool $all     Whether to retrieve all sites, or only sites that are not
 571  *                      marked as deleted, archived, or spam.
 572  * @return array A list of the user's sites. An empty array if the user doesn't exist
 573  *               or belongs to no sites.
 574  */
 575 function get_blogs_of_user( $user_id, $all = false ) {
 576         global $wpdb;
 577
 578         $user_id = (int) $user_id;
 579
 580         // Logged out users can't have sites
 581         if ( empty( $user_id ) )
 582                 return array();
 583
 584         /**
 585          * Filters the list of a user's sites before it is populated.
 586          *
 587          * Passing a non-null value to the filter will effectively short circuit
 588          * get_blogs_of_user(), returning that value instead.
 589          *
 590          * @since 4.6.0
 591          *
 592          * @param null|array $sites   An array of site objects of which the user is a member.
 593          * @param int        $user_id User ID.
 594          * @param bool       $all     Whether the returned array should contain all sites, including
 595          *                            those marked 'deleted', 'archived', or 'spam'. Default false.
 596          */
 597         $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
 598
 599         if ( null !== $sites ) {
 600                 return $sites;
 601         }
 602
 603         $keys = get_user_meta( $user_id );
 604         if ( empty( $keys ) )
 605                 return array();
 606
 607         if ( ! is_multisite() ) {
 608                 $site_id = get_current_blog_id();
 609                 $sites = array( $site_id => new stdClass );
 610                 $sites[ $site_id ]->userblog_id = $site_id;
 611                 $sites[ $site_id ]->blogname = get_option('blogname');
 612                 $sites[ $site_id ]->domain = '';
 613                 $sites[ $site_id ]->path = '';
 614                 $sites[ $site_id ]->site_id = 1;
 615                 $sites[ $site_id ]->siteurl = get_option('siteurl');
 616                 $sites[ $site_id ]->archived = 0;
 617                 $sites[ $site_id ]->spam = 0;
 618                 $sites[ $site_id ]->deleted = 0;
 619                 return $sites;
 620         }
 621
 622         $site_ids = array();
 623
 624         if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
 625                 $site_ids[] = 1;
 626                 unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
 627         }
 628
 629         $keys = array_keys( $keys );
 630
 631         foreach ( $keys as $key ) {
 632                 if ( 'capabilities' !== substr( $key, -12 ) )
 633                         continue;
 634                 if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) )
 635                         continue;
 636                 $site_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
 637                 if ( ! is_numeric( $site_id ) )
 638                         continue;
 639
 640                 $site_ids[] = (int) $site_id;
 641         }
 642
 643         $sites = array();
 644
 645         if ( ! empty( $site_ids ) ) {
 646                 $args = array(
 647                         'number'   => '',
 648                         'site__in' => $site_ids,
 649                 );
 650                 if ( ! $all ) {
 651                         $args['archived'] = 0;
 652                         $args['spam']     = 0;
 653                         $args['deleted']  = 0;
 654                 }
 655
 656                 $_sites = get_sites( $args );
 657
 658                 foreach ( $_sites as $site ) {
 659                         $sites[ $site->id ] = (object) array(
 660                                 'userblog_id' => $site->id,
 661                                 'blogname'    => $site->blogname,
 662                                 'domain'      => $site->domain,
 663                                 'path'        => $site->path,
 664                                 'site_id'     => $site->network_id,
 665                                 'siteurl'     => $site->siteurl,
 666                                 'archived'    => $site->archived,
 667                                 'mature'      => $site->mature,
 668                                 'spam'        => $site->spam,
 669                                 'deleted'     => $site->deleted,
 670                         );
 671                 }
 672         }
 673
 674         /**
 675          * Filters the list of sites a user belongs to.
 676          *
 677          * @since MU
 678          *
 679          * @param array $sites   An array of site objects belonging to the user.
 680          * @param int   $user_id User ID.
 681          * @param bool  $all     Whether the returned sites array should contain all sites, including
 682          *                       those marked 'deleted', 'archived', or 'spam'. Default false.
 683          */
 684         return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all );
 685 }
 686
 687 /**
 688  * Find out whether a user is a member of a given blog.
 689  *
 690  * @since MU 1.1
 691  *
 692  * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
 693  * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
 694  * @return bool
 695  */
 696 function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
 697         global $wpdb;
 698
 699         $user_id = (int) $user_id;
 700         $blog_id = (int) $blog_id;
 701
 702         if ( empty( $user_id ) ) {
 703                 $user_id = get_current_user_id();
 704         }
 705
 706         // Technically not needed, but does save calls to get_site and get_user_meta
 707         // in the event that the function is called when a user isn't logged in
 708         if ( empty( $user_id ) ) {
 709                 return false;
 710         } else {
 711                 $user = get_userdata( $user_id );
 712                 if ( ! $user instanceof WP_User ) {
 713                         return false;
 714                 }
 715         }
 716
 717         if ( ! is_multisite() ) {
 718                 return true;
 719         }
 720
 721         if ( empty( $blog_id ) ) {
 722                 $blog_id = get_current_blog_id();
 723         }
 724
 725         $blog = get_site( $blog_id );
 726
 727         if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) {
 728                 return false;
 729         }
 730
 731         $keys = get_user_meta( $user_id );
 732         if ( empty( $keys ) ) {
 733                 return false;
 734         }
 735
 736         // no underscore before capabilities in $base_capabilities_key
 737         $base_capabilities_key = $wpdb->base_prefix . 'capabilities';
 738         $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
 739
 740         if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) {
 741                 return true;
 742         }
 743
 744         if ( isset( $keys[ $site_capabilities_key ] ) ) {
 745                 return true;
 746         }
 747
 748         return false;
 749 }
 750
 751 /**
 752  * Add meta data field to a user.
 753  *
 754  * Post meta data is called "Custom Fields" on the Administration Screens.
 755  *
 756  * @since 3.0.0
 757  * @link https://codex.wordpress.org/Function_Reference/add_user_meta
 758  *
 759  * @param int    $user_id    User ID.
 760  * @param string $meta_key   Metadata name.
 761  * @param mixed  $meta_value Metadata value.
 762  * @param bool   $unique     Optional, default is false. Whether the same key should not be added.
 763  * @return int|false Meta ID on success, false on failure.
 764  */
 765 function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
 766         return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
 767 }
 768
 769 /**
 770  * Remove metadata matching criteria from a user.
 771  *
 772  * You can match based on the key, or key and value. Removing based on key and
 773  * value, will keep from removing duplicate metadata with the same key. It also
 774  * allows removing all metadata matching key, if needed.
 775  *
 776  * @since 3.0.0
 777  * @link https://codex.wordpress.org/Function_Reference/delete_user_meta
 778  *
 779  * @param int    $user_id    User ID
 780  * @param string $meta_key   Metadata name.
 781  * @param mixed  $meta_value Optional. Metadata value.
 782  * @return bool True on success, false on failure.
 783  */
 784 function delete_user_meta($user_id, $meta_key, $meta_value = '') {
 785         return delete_metadata('user', $user_id, $meta_key, $meta_value);
 786 }
 787
 788 /**
 789  * Retrieve user meta field for a user.
 790  *
 791  * @since 3.0.0
 792  * @link https://codex.wordpress.org/Function_Reference/get_user_meta
 793  *
 794  * @param int    $user_id User ID.
 795  * @param string $key     Optional. The meta key to retrieve. By default, returns data for all keys.
 796  * @param bool   $single  Whether to return a single value.
 797  * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
 798  */
 799 function get_user_meta($user_id, $key = '', $single = false) {
 800         return get_metadata('user', $user_id, $key, $single);
 801 }
 802
 803 /**
 804  * Update user meta field based on user ID.
 805  *
 806  * Use the $prev_value parameter to differentiate between meta fields with the
 807  * same key and user ID.
 808  *
 809  * If the meta field for the user does not exist, it will be added.
 810  *
 811  * @since 3.0.0
 812  * @link https://codex.wordpress.org/Function_Reference/update_user_meta
 813  *
 814  * @param int    $user_id    User ID.
 815  * @param string $meta_key   Metadata key.
 816  * @param mixed  $meta_value Metadata value.
 817  * @param mixed  $prev_value Optional. Previous value to check before removing.
 818  * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
 819  */
 820 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
 821         return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
 822 }
 823
 824 /**
 825  * Count number of users who have each of the user roles.
 826  *
 827  * Assumes there are neither duplicated nor orphaned capabilities meta_values.
 828  * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query()
 829  * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
 830  * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
 831  *
 832  * @since 3.0.0
 833  * @since 4.4.0 The number of users with no role is now included in the `none` element.
 834  *
 835  * @global wpdb $wpdb WordPress database abstraction object.
 836  *
 837  * @param string $strategy 'time' or 'memory'
 838  * @return array Includes a grand total and an array of counts indexed by role strings.
 839  */
 840 function count_users($strategy = 'time') {
 841         global $wpdb;
 842
 843         // Initialize
 844         $id = get_current_blog_id();
 845         $blog_prefix = $wpdb->get_blog_prefix($id);
 846         $result = array();
 847
 848         if ( 'time' == $strategy ) {
 849                 $avail_roles = wp_roles()->get_names();
 850
 851                 // Build a CPU-intensive query that will return concise information.
 852                 $select_count = array();
 853                 foreach ( $avail_roles as $this_role => $name ) {
 854                         $select_count[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%');
 855                 }
 856                 $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))";
 857                 $select_count = implode(', ', $select_count);
 858
 859                 // Add the meta_value index to the selection list, then run the query.
 860                 $row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
 861
 862                 // Run the previous loop again to associate results with role names.
 863                 $col = 0;
 864                 $role_counts = array();
 865                 foreach ( $avail_roles as $this_role => $name ) {
 866                         $count = (int) $row[$col++];
 867                         if ($count > 0) {
 868                                 $role_counts[$this_role] = $count;
 869                         }
 870                 }
 871
 872                 $role_counts['none'] = (int) $row[$col++];
 873
 874                 // Get the meta_value index from the end of the result set.
 875                 $total_users = (int) $row[$col];
 876
 877                 $result['total_users'] = $total_users;
 878                 $result['avail_roles'] =& $role_counts;
 879         } else {
 880                 $avail_roles = array(
 881                         'none' => 0,
 882                 );
 883
 884                 $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" );
 885
 886                 foreach ( $users_of_blog as $caps_meta ) {
 887                         $b_roles = maybe_unserialize($caps_meta);
 888                         if ( ! is_array( $b_roles ) )
 889                                 continue;
 890                         if ( empty( $b_roles ) ) {
 891                                 $avail_roles['none']++;
 892                         }
 893                         foreach ( $b_roles as $b_role => $val ) {
 894                                 if ( isset($avail_roles[$b_role]) ) {
 895                                         $avail_roles[$b_role]++;
 896                                 } else {
 897                                         $avail_roles[$b_role] = 1;
 898                                 }
 899                         }
 900                 }
 901
 902                 $result['total_users'] = count( $users_of_blog );
 903                 $result['avail_roles'] =& $avail_roles;
 904         }
 905
 906         if ( is_multisite() ) {
 907                 $result['avail_roles']['none'] = 0;
 908         }
 909
 910         return $result;
 911 }
 912
 913 //
 914 // Private helper functions
 915 //
 916
 917 /**
 918  * Set up global user vars.
 919  *
 920  * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
 921  *
 922  * @since 2.0.4
 923  *
 924  * @global string $user_login    The user username for logging in
 925  * @global object $userdata      User data.
 926  * @global int    $user_level    The level of the user
 927  * @global int    $user_ID       The ID of the user
 928  * @global string $user_email    The email address of the user
 929  * @global string $user_url      The url in the user's profile
 930  * @global string $user_identity The display name of the user
 931  *
 932  * @param int $for_user_id Optional. User ID to set up global data.
 933  */
 934 function setup_userdata($for_user_id = '') {
 935         global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity;
 936
 937         if ( '' == $for_user_id )
 938                 $for_user_id = get_current_user_id();
 939         $user = get_userdata( $for_user_id );
 940
 941         if ( ! $user ) {
 942                 $user_ID = 0;
 943                 $user_level = 0;
 944                 $userdata = null;
 945                 $user_login = $user_email = $user_url = $user_identity = '';
 946                 return;
 947         }
 948
 949         $user_ID    = (int) $user->ID;
 950         $user_level = (int) $user->user_level;
 951         $userdata   = $user;
 952         $user_login = $user->user_login;
 953         $user_email = $user->user_email;
 954         $user_url   = $user->user_url;
 955         $user_identity = $user->display_name;
 956 }
 957
 958 /**
 959  * Create dropdown HTML content of users.
 960  *
 961  * The content can either be displayed, which it is by default or retrieved by
 962  * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
 963  * need to be used; all users will be displayed in that case. Only one can be
 964  * used, either 'include' or 'exclude', but not both.
 965  *
 966  * The available arguments are as follows:
 967  *
 968  * @since 2.3.0
 969  * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
 970  * @since 4.7.0 Added the `$role`, `$role__in`, and `$role__not_in` parameters.
 971  *
 972  * @param array|string $args {
 973  *     Optional. Array or string of arguments to generate a drop-down of users.
 974  *     See WP_User_Query::prepare_query() for additional available arguments.
 975  *
 976  *     @type string       $show_option_all         Text to show as the drop-down default (all).
 977  *                                                 Default empty.
 978  *     @type string       $show_option_none        Text to show as the drop-down default when no
 979  *                                                 users were found. Default empty.
 980  *     @type int|string   $option_none_value       Value to use for $show_option_non when no users
 981  *                                                 were found. Default -1.
 982  *     @type string       $hide_if_only_one_author Whether to skip generating the drop-down
 983  *                                                 if only one user was found. Default empty.
 984  *     @type string       $orderby                 Field to order found users by. Accepts user fields.
 985  *                                                 Default 'display_name'.
 986  *     @type string       $order                   Whether to order users in ascending or descending
 987  *                                                 order. Accepts 'ASC' (ascending) or 'DESC' (descending).
 988  *                                                 Default 'ASC'.
 989  *     @type array|string $include                 Array or comma-separated list of user IDs to include.
 990  *                                                 Default empty.
 991  *     @type array|string $exclude                 Array or comma-separated list of user IDs to exclude.
 992  *                                                 Default empty.
 993  *     @type bool|int     $multi                   Whether to skip the ID attribute on the 'select' element.
 994  *                                                 Accepts 1|true or 0|false. Default 0|false.
 995  *     @type string       $show                    User data to display. If the selected item is empty
 996  *                                                 then the 'user_login' will be displayed in parentheses.
 997  *                                                 Accepts any user field, or 'display_name_with_login' to show
 998  *                                                 the display name with user_login in parentheses.
 999  *                                                 Default 'display_name'.
1000  *     @type int|bool     $echo                    Whether to echo or return the drop-down. Accepts 1|true (echo)
1001  *                                                 or 0|false (return). Default 1|true.
1002  *     @type int          $selected                Which user ID should be selected. Default 0.
1003  *     @type bool         $include_selected        Whether to always include the selected user ID in the drop-
1004  *                                                 down. Default false.
1005  *     @type string       $name                    Name attribute of select element. Default 'user'.
1006  *     @type string       $id                      ID attribute of the select element. Default is the value of $name.
1007  *     @type string       $class                   Class attribute of the select element. Default empty.
1008  *     @type int          $blog_id                 ID of blog (Multisite only). Default is ID of the current blog.
1009  *     @type string       $who                     Which type of users to query. Accepts only an empty string or
1010  *                                                 'authors'. Default empty.
1011  *     @type string|array $role                    An array or a comma-separated list of role names that users must
1012  *                                                 match to be included in results. Note that this is an inclusive
1013  *                                                 list: users must match *each* role. Default empty.
1014  *     @type array        $role__in                An array of role names. Matched users must have at least one of
1015  *                                                 these roles. Default empty array.
1016  *     @type array        $role__not_in            An array of role names to exclude. Users matching one or more of
1017  *                                                 these roles will not be included in results. Default empty array.
1018  * }
1019  * @return string String of HTML content.
1020  */
1021 function wp_dropdown_users( $args = '' ) {
1022         $defaults = array(
1023                 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
1024                 'orderby' => 'display_name', 'order' => 'ASC',
1025                 'include' => '', 'exclude' => '', 'multi' => 0,
1026                 'show' => 'display_name', 'echo' => 1,
1027                 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
1028                 'blog_id' => get_current_blog_id(), 'who' => '', 'include_selected' => false,
1029                 'option_none_value' => -1,
1030                 'role' => '',
1031                 'role__in' => array(),
1032                 'role__not_in' => array(),
1033         );
1034
1035         $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
1036
1037         $r = wp_parse_args( $args, $defaults );
1038
1039         $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who', 'role', 'role__in', 'role__not_in' ) );
1040
1041         $fields = array( 'ID', 'user_login' );
1042
1043         $show = ! empty( $r['show'] ) ? $r['show'] : 'display_name';
1044         if ( 'display_name_with_login' === $show ) {
1045                 $fields[] = 'display_name';
1046         } else {
1047                 $fields[] = $show;
1048         }
1049
1050         $query_args['fields'] = $fields;
1051
1052         $show_option_all = $r['show_option_all'];
1053         $show_option_none = $r['show_option_none'];
1054         $option_none_value = $r['option_none_value'];
1055
1056         /**
1057          * Filters the query arguments for the list of users in the dropdown.
1058          *
1059          * @since 4.4.0
1060          *
1061          * @param array $query_args The query arguments for get_users().
1062          * @param array $r          The arguments passed to wp_dropdown_users() combined with the defaults.
1063          */
1064         $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $r );
1065
1066         $users = get_users( $query_args );
1067
1068         $output = '';
1069         if ( ! empty( $users ) && ( empty( $r['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
1070                 $name = esc_attr( $r['name'] );
1071                 if ( $r['multi'] && ! $r['id'] ) {
1072                         $id = '';
1073                 } else {
1074                         $id = $r['id'] ? " id='" . esc_attr( $r['id'] ) . "'" : " id='$name'";
1075                 }
1076                 $output = "<select name='{$name}'{$id} class='" . $r['class'] . "'>\n";
1077
1078                 if ( $show_option_all ) {
1079                         $output .= "\t<option value='0'>$show_option_all</option>\n";
1080                 }
1081
1082                 if ( $show_option_none ) {
1083                         $_selected = selected( $option_none_value, $r['selected'], false );
1084                         $output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n";
1085                 }
1086
1087                 if ( $r['include_selected'] && ( $r['selected'] > 0 ) ) {
1088                         $found_selected = false;
1089                         $r['selected'] = (int) $r['selected'];
1090                         foreach ( (array) $users as $user ) {
1091                                 $user->ID = (int) $user->ID;
1092                                 if ( $user->ID === $r['selected'] ) {
1093                                         $found_selected = true;
1094                                 }
1095                         }
1096
1097                         if ( ! $found_selected ) {
1098                                 $users[] = get_userdata( $r['selected'] );
1099                         }
1100                 }
1101
1102                 foreach ( (array) $users as $user ) {
1103                         if ( 'display_name_with_login' === $show ) {
1104                                 /* translators: 1: display name, 2: user_login */
1105                                 $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login );
1106                         } elseif ( ! empty( $user->$show ) ) {
1107                                 $display = $user->$show;
1108                         } else {
1109                                 $display = '(' . $user->user_login . ')';
1110                         }
1111
1112                         $_selected = selected( $user->ID, $r['selected'], false );
1113                         $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
1114                 }
1115
1116                 $output .= "</select>";
1117         }
1118
1119         /**
1120          * Filters the wp_dropdown_users() HTML output.
1121          *
1122          * @since 2.3.0
1123          *
1124          * @param string $output HTML output generated by wp_dropdown_users().
1125          */
1126         $html = apply_filters( 'wp_dropdown_users', $output );
1127
1128         if ( $r['echo'] ) {
1129                 echo $html;
1130         }
1131         return $html;
1132 }
1133
1134 /**
1135  * Sanitize user field based on context.
1136  *
1137  * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1138  * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1139  * when calling filters.
1140  *
1141  * @since 2.3.0
1142  *
1143  * @param string $field   The user Object field name.
1144  * @param mixed  $value   The user Object value.
1145  * @param int    $user_id User ID.
1146  * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
1147  *                        'attribute' and 'js'.
1148  * @return mixed Sanitized value.
1149  */
1150 function sanitize_user_field($field, $value, $user_id, $context) {
1151         $int_fields = array('ID');
1152         if ( in_array($field, $int_fields) )
1153                 $value = (int) $value;
1154
1155         if ( 'raw' == $context )
1156                 return $value;
1157
1158         if ( !is_string($value) && !is_numeric($value) )
1159                 return $value;
1160
1161         $prefixed = false !== strpos( $field, 'user_' );
1162
1163         if ( 'edit' == $context ) {
1164                 if ( $prefixed ) {
1165
1166                         /** This filter is documented in wp-includes/post.php */
1167                         $value = apply_filters( "edit_{$field}", $value, $user_id );
1168                 } else {
1169
1170                         /**
1171                          * Filters a user field value in the 'edit' context.
1172                          *
1173                          * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1174                          * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1175                          *
1176                          * @since 2.9.0
1177                          *
1178                          * @param mixed $value   Value of the prefixed user field.
1179                          * @param int   $user_id User ID.
1180                          */
1181                         $value = apply_filters( "edit_user_{$field}", $value, $user_id );
1182                 }
1183
1184                 if ( 'description' == $field )
1185                         $value = esc_html( $value ); // textarea_escaped?
1186                 else
1187                         $value = esc_attr($value);
1188         } elseif ( 'db' == $context ) {
1189                 if ( $prefixed ) {
1190                         /** This filter is documented in wp-includes/post.php */
1191                         $value = apply_filters( "pre_{$field}", $value );
1192                 } else {
1193
1194                         /**
1195                          * Filters the value of a user field in the 'db' context.
1196                          *
1197                          * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1198                          * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1199                          *
1200                          * @since 2.9.0
1201                          *
1202                          * @param mixed $value Value of the prefixed user field.
1203                          */
1204                         $value = apply_filters( "pre_user_{$field}", $value );
1205                 }
1206         } else {
1207                 // Use display filters by default.
1208                 if ( $prefixed ) {
1209
1210                         /** This filter is documented in wp-includes/post.php */
1211                         $value = apply_filters( $field, $value, $user_id, $context );
1212                 } else {
1213
1214                         /**
1215                          * Filters the value of a user field in a standard context.
1216                          *
1217                          * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1218                          * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1219                          *
1220                          * @since 2.9.0
1221                          *
1222                          * @param mixed  $value   The user object value to sanitize.
1223                          * @param int    $user_id User ID.
1224                          * @param string $context The context to filter within.
1225                          */
1226                         $value = apply_filters( "user_{$field}", $value, $user_id, $context );
1227                 }
1228         }
1229
1230         if ( 'user_url' == $field )
1231                 $value = esc_url($value);
1232
1233         if ( 'attribute' == $context ) {
1234                 $value = esc_attr( $value );
1235         } elseif ( 'js' == $context ) {
1236                 $value = esc_js( $value );
1237         }
1238         return $value;
1239 }
1240
1241 /**
1242  * Update all user caches
1243  *
1244  * @since 3.0.0
1245  *
1246  * @param object|WP_User $user User object to be cached
1247  * @return bool|null Returns false on failure.
1248  */
1249 function update_user_caches( $user ) {
1250         if ( $user instanceof WP_User ) {
1251                 if ( ! $user->exists() ) {
1252                         return false;
1253                 }
1254
1255                 $user = $user->data;
1256         }
1257
1258         wp_cache_add($user->ID, $user, 'users');
1259         wp_cache_add($user->user_login, $user->ID, 'userlogins');
1260         wp_cache_add($user->user_email, $user->ID, 'useremail');
1261         wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
1262 }
1263
1264 /**
1265  * Clean all user caches
1266  *
1267  * @since 3.0.0
1268  * @since 4.4.0 'clean_user_cache' action was added.
1269  *
1270  * @param WP_User|int $user User object or ID to be cleaned from the cache
1271  */
1272 function clean_user_cache( $user ) {
1273         if ( is_numeric( $user ) )
1274                 $user = new WP_User( $user );
1275
1276         if ( ! $user->exists() )
1277                 return;
1278
1279         wp_cache_delete( $user->ID, 'users' );
1280         wp_cache_delete( $user->user_login, 'userlogins' );
1281         wp_cache_delete( $user->user_email, 'useremail' );
1282         wp_cache_delete( $user->user_nicename, 'userslugs' );
1283
1284         /**
1285          * Fires immediately after the given user's cache is cleaned.
1286          *
1287          * @since 4.4.0
1288          *
1289          * @param int     $user_id User ID.
1290          * @param WP_User $user    User object.
1291          */
1292         do_action( 'clean_user_cache', $user->ID, $user );
1293 }
1294
1295 /**
1296  * Checks whether the given username exists.
1297  *
1298  * @since 2.0.0
1299  *
1300  * @param string $username Username.
1301  * @return int|false The user's ID on success, and false on failure.
1302  */
1303 function username_exists( $username ) {
1304         if ( $user = get_user_by( 'login', $username ) ) {
1305                 return $user->ID;
1306         }
1307         return false;
1308 }
1309
1310 /**
1311  * Checks whether the given email exists.
1312  *
1313  * @since 2.1.0
1314  *
1315  * @param string $email Email.
1316  * @return int|false The user's ID on success, and false on failure.
1317  */
1318 function email_exists( $email ) {
1319         if ( $user = get_user_by( 'email', $email) ) {
1320                 return $user->ID;
1321         }
1322         return false;
1323 }
1324
1325 /**
1326  * Checks whether a username is valid.
1327  *
1328  * @since 2.0.1
1329  * @since 4.4.0 Empty sanitized usernames are now considered invalid
1330  *
1331  * @param string $username Username.
1332  * @return bool Whether username given is valid
1333  */
1334 function validate_username( $username ) {
1335         $sanitized = sanitize_user( $username, true );
1336         $valid = ( $sanitized == $username && ! empty( $sanitized ) );
1337
1338         /**
1339          * Filters whether the provided username is valid or not.
1340          *
1341          * @since 2.0.1
1342          *
1343          * @param bool   $valid    Whether given username is valid.
1344          * @param string $username Username to check.
1345          */
1346         return apply_filters( 'validate_username', $valid, $username );
1347 }
1348
1349 /**
1350  * Insert a user into the database.
1351  *
1352  * Most of the `$userdata` array fields have filters associated with the values. Exceptions are
1353  * 'ID', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl',
1354  * 'user_registered', and 'role'. The filters have the prefix 'pre_user_' followed by the field
1355  * name. An example using 'description' would have the filter called, 'pre_user_description' that
1356  * can be hooked into.
1357  *
1358  * @since 2.0.0
1359  * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact
1360  *              methods for new installs. See wp_get_user_contact_methods().
1361  * @since 4.7.0 The user's locale can be passed to `$userdata`.
1362  *
1363  * @global wpdb $wpdb WordPress database abstraction object.
1364  *
1365  * @param array|object|WP_User $userdata {
1366  *     An array, object, or WP_User object of user data arguments.
1367  *
1368  *     @type int         $ID                   User ID. If supplied, the user will be updated.
1369  *     @type string      $user_pass            The plain-text user password.
1370  *     @type string      $user_login           The user's login username.
1371  *     @type string      $user_nicename        The URL-friendly user name.
1372  *     @type string      $user_url             The user URL.
1373  *     @type string      $user_email           The user email address.
1374  *     @type string      $display_name         The user's display name.
1375  *                                             Default is the user's username.
1376  *     @type string      $nickname             The user's nickname.
1377  *                                             Default is the user's username.
1378  *     @type string      $first_name           The user's first name. For new users, will be used
1379  *                                             to build the first part of the user's display name
1380  *                                             if `$display_name` is not specified.
1381  *     @type string      $last_name            The user's last name. For new users, will be used
1382  *                                             to build the second part of the user's display name
1383  *                                             if `$display_name` is not specified.
1384  *     @type string      $description          The user's biographical description.
1385  *     @type string|bool $rich_editing         Whether to enable the rich-editor for the user.
1386  *                                             False if not empty.
1387  *     @type string|bool $comment_shortcuts    Whether to enable comment moderation keyboard
1388  *                                             shortcuts for the user. Default false.
1389  *     @type string      $admin_color          Admin color scheme for the user. Default 'fresh'.
1390  *     @type bool        $use_ssl              Whether the user should always access the admin over
1391  *                                             https. Default false.
1392  *     @type string      $user_registered      Date the user registered. Format is 'Y-m-d H:i:s'.
1393  *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
1394  *                                             site's front end. Default true.
1395  *     @type string      $role                 User's role.
1396  *     @type string      $locale               User's locale. Default empty.
1397  * }
1398  * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1399  *                      be created.
1400  */
1401 function wp_insert_user( $userdata ) {
1402         global $wpdb;
1403
1404         if ( $userdata instanceof stdClass ) {
1405                 $userdata = get_object_vars( $userdata );
1406         } elseif ( $userdata instanceof WP_User ) {
1407                 $userdata = $userdata->to_array();
1408         }
1409
1410         // Are we updating or creating?
1411         if ( ! empty( $userdata['ID'] ) ) {
1412                 $ID = (int) $userdata['ID'];
1413                 $update = true;
1414                 $old_user_data = get_userdata( $ID );
1415
1416                 if ( ! $old_user_data ) {
1417                         return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1418                 }
1419
1420                 // hashed in wp_update_user(), plaintext if called directly
1421                 $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass;
1422         } else {
1423                 $update = false;
1424                 // Hash the password
1425                 $user_pass = wp_hash_password( $userdata['user_pass'] );
1426         }
1427
1428         $sanitized_user_login = sanitize_user( $userdata['user_login'], true );
1429
1430         /**
1431          * Filters a username after it has been sanitized.
1432          *
1433          * This filter is called before the user is created or updated.
1434          *
1435          * @since 2.0.3
1436          *
1437          * @param string $sanitized_user_login Username after it has been sanitized.
1438          */
1439         $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login );
1440
1441         //Remove any non-printable chars from the login string to see if we have ended up with an empty username
1442         $user_login = trim( $pre_user_login );
1443
1444         // user_login must be between 0 and 60 characters.
1445         if ( empty( $user_login ) ) {
1446                 return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
1447         } elseif ( mb_strlen( $user_login ) > 60 ) {
1448                 return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) );
1449         }
1450
1451         if ( ! $update && username_exists( $user_login ) ) {
1452                 return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
1453         }
1454
1455         /**
1456          * Filters the list of blacklisted usernames.
1457          *
1458          * @since 4.4.0
1459          *
1460          * @param array $usernames Array of blacklisted usernames.
1461          */
1462         $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
1463
1464         if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ) ) ) {
1465                 return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) );
1466         }
1467
1468         /*
1469          * If a nicename is provided, remove unsafe user characters before using it.
1470          * Otherwise build a nicename from the user_login.
1471          */
1472         if ( ! empty( $userdata['user_nicename'] ) ) {
1473                 $user_nicename = sanitize_user( $userdata['user_nicename'], true );
1474                 if ( mb_strlen( $user_nicename ) > 50 ) {
1475                         return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) );
1476                 }
1477         } else {
1478                 $user_nicename = mb_substr( $user_login, 0, 50 );
1479         }
1480
1481         $user_nicename = sanitize_title( $user_nicename );
1482
1483         // Store values to save in user meta.
1484         $meta = array();
1485
1486         /**
1487          * Filters a user's nicename before the user is created or updated.
1488          *
1489          * @since 2.0.3
1490          *
1491          * @param string $user_nicename The user's nicename.
1492          */
1493         $user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
1494
1495         $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url'];
1496
1497         /**
1498          * Filters a user's URL before the user is created or updated.
1499          *
1500          * @since 2.0.3
1501          *
1502          * @param string $raw_user_url The user's URL.
1503          */
1504         $user_url = apply_filters( 'pre_user_url', $raw_user_url );
1505
1506         $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email'];
1507
1508         /**
1509          * Filters a user's email before the user is created or updated.
1510          *
1511          * @since 2.0.3
1512          *
1513          * @param string $raw_user_email The user's email.
1514          */
1515         $user_email = apply_filters( 'pre_user_email', $raw_user_email );
1516
1517         /*
1518          * If there is no update, just check for `email_exists`. If there is an update,
1519          * check if current email and new email are the same, or not, and check `email_exists`
1520          * accordingly.
1521          */
1522         if ( ( ! $update || ( ! empty( $old_user_data ) && 0 !== strcasecmp( $user_email, $old_user_data->user_email ) ) )
1523                 && ! defined( 'WP_IMPORTING' )
1524                 && email_exists( $user_email )
1525         ) {
1526                 return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
1527         }
1528         $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname'];
1529
1530         /**
1531          * Filters a user's nickname before the user is created or updated.
1532          *
1533          * @since 2.0.3
1534          *
1535          * @param string $nickname The user's nickname.
1536          */
1537         $meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname );
1538
1539         $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name'];
1540
1541         /**
1542          * Filters a user's first name before the user is created or updated.
1543          *
1544          * @since 2.0.3
1545          *
1546          * @param string $first_name The user's first name.
1547          */
1548         $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name );
1549
1550         $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name'];
1551
1552         /**
1553          * Filters a user's last name before the user is created or updated.
1554          *
1555          * @since 2.0.3
1556          *
1557          * @param string $last_name The user's last name.
1558          */
1559         $meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name );
1560
1561         if ( empty( $userdata['display_name'] ) ) {
1562                 if ( $update ) {
1563                         $display_name = $user_login;
1564                 } elseif ( $meta['first_name'] && $meta['last_name'] ) {
1565                         /* translators: 1: first name, 2: last name */
1566                         $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $meta['first_name'], $meta['last_name'] );
1567                 } elseif ( $meta['first_name'] ) {
1568                         $display_name = $meta['first_name'];
1569                 } elseif ( $meta['last_name'] ) {
1570                         $display_name = $meta['last_name'];
1571                 } else {
1572                         $display_name = $user_login;
1573                 }
1574         } else {
1575                 $display_name = $userdata['display_name'];
1576         }
1577
1578         /**
1579          * Filters a user's display name before the user is created or updated.
1580          *
1581          * @since 2.0.3
1582          *
1583          * @param string $display_name The user's display name.
1584          */
1585         $display_name = apply_filters( 'pre_user_display_name', $display_name );
1586
1587         $description = empty( $userdata['description'] ) ? '' : $userdata['description'];
1588
1589         /**
1590          * Filters a user's description before the user is created or updated.
1591          *
1592          * @since 2.0.3
1593          *
1594          * @param string $description The user's description.
1595          */
1596         $meta['description'] = apply_filters( 'pre_user_description', $description );
1597
1598         $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing'];
1599
1600         $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true';
1601
1602         $admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color'];
1603         $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color );
1604
1605         $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : $userdata['use_ssl'];
1606
1607         $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered'];
1608
1609         $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front'];
1610
1611         $meta['locale'] = isset( $userdata['locale'] ) ? $userdata['locale'] : '';
1612
1613         $user_nicename_check = $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->users WHERE user_nicename = %s AND user_login != %s LIMIT 1" , $user_nicename, $user_login));
1614
1615         if ( $user_nicename_check ) {
1616                 $suffix = 2;
1617                 while ($user_nicename_check) {
1618                         // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix.
1619                         $base_length = 49 - mb_strlen( $suffix );
1620                         $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix";
1621                         $user_nicename_check = $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->users WHERE user_nicename = %s AND user_login != %s LIMIT 1" , $alt_user_nicename, $user_login));
1622                         $suffix++;
1623                 }
1624                 $user_nicename = $alt_user_nicename;
1625         }
1626
1627         $compacted = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
1628         $data = wp_unslash( $compacted );
1629
1630         if ( $update ) {
1631                 if ( $user_email !== $old_user_data->user_email ) {
1632                         $data['user_activation_key'] = '';
1633                 }
1634                 $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
1635                 $user_id = (int) $ID;
1636         } else {
1637                 $wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) );
1638                 $user_id = (int) $wpdb->insert_id;
1639         }
1640
1641         $user = new WP_User( $user_id );
1642
1643         /**
1644          * Filters a user's meta values and keys before the user is created or updated.
1645          *
1646          * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`.
1647          *
1648          * @since 4.4.0
1649          *
1650          * @param array $meta {
1651          *     Default meta values and keys for the user.
1652          *
1653          *     @type string   $nickname             The user's nickname. Default is the user's username.
1654          *     @type string   $first_name           The user's first name.
1655          *     @type string   $last_name            The user's last name.
1656          *     @type string   $description          The user's description.
1657          *     @type bool     $rich_editing         Whether to enable the rich-editor for the user. False if not empty.
1658          *     @type bool     $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default false.
1659          *     @type string   $admin_color          The color scheme for a user's admin screen. Default 'fresh'.
1660          *     @type int|bool $use_ssl              Whether to force SSL on the user's admin area. 0|false if SSL is
1661          *                                          not forced.
1662          *     @type bool     $show_admin_bar_front Whether to show the admin bar on the front end for the user.
1663          *                                          Default true.
1664          * }
1665          * @param WP_User $user   User object.
1666          * @param bool    $update Whether the user is being updated rather than created.
1667          */
1668         $meta = apply_filters( 'insert_user_meta', $meta, $user, $update );
1669
1670         // Update user meta.
1671         foreach ( $meta as $key => $value ) {
1672                 update_user_meta( $user_id, $key, $value );
1673         }
1674
1675         foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) {
1676                 if ( isset( $userdata[ $key ] ) ) {
1677                         update_user_meta( $user_id, $key, $userdata[ $key ] );
1678                 }
1679         }
1680
1681         if ( isset( $userdata['role'] ) ) {
1682                 $user->set_role( $userdata['role'] );
1683         } elseif ( ! $update ) {
1684                 $user->set_role(get_option('default_role'));
1685         }
1686         wp_cache_delete( $user_id, 'users' );
1687         wp_cache_delete( $user_login, 'userlogins' );
1688
1689         if ( $update ) {
1690                 /**
1691                  * Fires immediately after an existing user is updated.
1692                  *
1693                  * @since 2.0.0
1694                  *
1695                  * @param int    $user_id       User ID.
1696                  * @param object $old_user_data Object containing user's data prior to update.
1697                  */
1698                 do_action( 'profile_update', $user_id, $old_user_data );
1699         } else {
1700                 /**
1701                  * Fires immediately after a new user is registered.
1702                  *
1703                  * @since 1.5.0
1704                  *
1705                  * @param int $user_id User ID.
1706                  */
1707                 do_action( 'user_register', $user_id );
1708         }
1709
1710         return $user_id;
1711 }
1712
1713 /**
1714  * Update a user in the database.
1715  *
1716  * It is possible to update a user's password by specifying the 'user_pass'
1717  * value in the $userdata parameter array.
1718  *
1719  * If current user's password is being updated, then the cookies will be
1720  * cleared.
1721  *
1722  * @since 2.0.0
1723  *
1724  * @see wp_insert_user() For what fields can be set in $userdata.
1725  *
1726  * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
1727  * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
1728  */
1729 function wp_update_user($userdata) {
1730         if ( $userdata instanceof stdClass ) {
1731                 $userdata = get_object_vars( $userdata );
1732         } elseif ( $userdata instanceof WP_User ) {
1733                 $userdata = $userdata->to_array();
1734         }
1735
1736         $ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
1737         if ( ! $ID ) {
1738                 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1739         }
1740
1741         // First, get all of the original fields
1742         $user_obj = get_userdata( $ID );
1743         if ( ! $user_obj ) {
1744                 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1745         }
1746
1747         $user = $user_obj->to_array();
1748
1749         // Add additional custom fields
1750         foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
1751                 $user[ $key ] = get_user_meta( $ID, $key, true );
1752         }
1753
1754         // Escape data pulled from DB.
1755         $user = add_magic_quotes( $user );
1756
1757         if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) {
1758                 // If password is changing, hash it now
1759                 $plaintext_pass = $userdata['user_pass'];
1760                 $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] );
1761
1762                 /**
1763                  * Filters whether to send the password change email.
1764                  *
1765                  * @since 4.3.0
1766                  *
1767                  * @see wp_insert_user() For `$user` and `$userdata` fields.
1768                  *
1769                  * @param bool  $send     Whether to send the email.
1770                  * @param array $user     The original user array.
1771                  * @param array $userdata The updated user array.
1772                  *
1773                  */
1774                 $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata );
1775         }
1776
1777         if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) {
1778                 /**
1779                  * Filters whether to send the email change email.
1780                  *
1781                  * @since 4.3.0
1782                  *
1783                  * @see wp_insert_user() For `$user` and `$userdata` fields.
1784                  *
1785                  * @param bool  $send     Whether to send the email.
1786                  * @param array $user     The original user array.
1787                  * @param array $userdata The updated user array.
1788                  *
1789                  */
1790                 $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata );
1791         }
1792
1793         wp_cache_delete( $user['user_email'], 'useremail' );
1794         wp_cache_delete( $user['user_nicename'], 'userslugs' );
1795
1796         // Merge old and new fields with new fields overwriting old ones.
1797         $userdata = array_merge( $user, $userdata );
1798         $user_id = wp_insert_user( $userdata );
1799
1800         if ( ! is_wp_error( $user_id ) ) {
1801
1802                 $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
1803
1804                 $switched_locale = false;
1805                 if ( ! empty( $send_password_change_email ) || ! empty( $send_email_change_email ) ) {
1806                         $switched_locale = switch_to_locale( get_user_locale( $user_id ) );
1807                 }
1808
1809                 if ( ! empty( $send_password_change_email ) ) {
1810                         /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1811                         $pass_change_text = __( 'Hi ###USERNAME###,
1812
1813 This notice confirms that your password was changed on ###SITENAME###.
1814
1815 If you did not change your password, please contact the Site Administrator at
1816 ###ADMIN_EMAIL###
1817
1818 This email has been sent to ###EMAIL###
1819
1820 Regards,
1821 All at ###SITENAME###
1822 ###SITEURL###' );
1823
1824                         $pass_change_email = array(
1825                                 'to'      => $user['user_email'],
1826                                 /* translators: User password change notification email subject. 1: Site name */
1827                                 'subject' => __( '[%s] Notice of Password Change' ),
1828                                 'message' => $pass_change_text,
1829                                 'headers' => '',
1830                         );
1831
1832                         /**
1833                          * Filters the contents of the email sent when the user's password is changed.
1834                          *
1835                          * @since 4.3.0
1836                          *
1837                          * @param array $pass_change_email {
1838                          *            Used to build wp_mail().
1839                          *            @type string $to      The intended recipients. Add emails in a comma separated string.
1840                          *            @type string $subject The subject of the email.
1841                          *            @type string $message The content of the email.
1842                          *                The following strings have a special meaning and will get replaced dynamically:
1843                          *                - ###USERNAME###    The current user's username.
1844                          *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1845                          *                - ###EMAIL###       The old email.
1846                          *                - ###SITENAME###    The name of the site.
1847                          *                - ###SITEURL###     The URL to the site.
1848                          *            @type string $headers Headers. Add headers in a newline (\r\n) separated string.
1849                          *        }
1850                          * @param array $user     The original user array.
1851                          * @param array $userdata The updated user array.
1852                          *
1853                          */
1854                         $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata );
1855
1856                         $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] );
1857                         $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] );
1858                         $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] );
1859                         $pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] );
1860                         $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] );
1861
1862                         wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] );
1863                 }
1864
1865                 if ( ! empty( $send_email_change_email ) ) {
1866                         /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1867                         $email_change_text = __( 'Hi ###USERNAME###,
1868
1869 This notice confirms that your email was changed on ###SITENAME###.
1870
1871 If you did not change your email, please contact the Site Administrator at
1872 ###ADMIN_EMAIL###
1873
1874 This email has been sent to ###EMAIL###
1875
1876 Regards,
1877 All at ###SITENAME###
1878 ###SITEURL###' );
1879
1880                         $email_change_email = array(
1881                                 'to'      => $user['user_email'],
1882                                 /* translators: User email change notification email subject. 1: Site name */
1883                                 'subject' => __( '[%s] Notice of Email Change' ),
1884                                 'message' => $email_change_text,
1885                                 'headers' => '',
1886                         );
1887
1888                         /**
1889                          * Filters the contents of the email sent when the user's email is changed.
1890                          *
1891                          * @since 4.3.0
1892                          *
1893                          * @param array $email_change_email {
1894                          *            Used to build wp_mail().
1895                          *            @type string $to      The intended recipients.
1896                          *            @type string $subject The subject of the email.
1897                          *            @type string $message The content of the email.
1898                          *                The following strings have a special meaning and will get replaced dynamically:
1899                          *                - ###USERNAME###    The current user's username.
1900                          *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1901                          *                - ###EMAIL###       The old email.
1902                          *                - ###SITENAME###    The name of the site.
1903                          *                - ###SITEURL###     The URL to the site.
1904                          *            @type string $headers Headers.
1905                          *        }
1906                          * @param array $user The original user array.
1907                          * @param array $userdata The updated user array.
1908                          */
1909                         $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata );
1910
1911                         $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] );
1912                         $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] );
1913                         $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] );
1914                         $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] );
1915                         $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );
1916
1917                         wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] );
1918                 }
1919
1920                 if ( $switched_locale ) {
1921                         restore_previous_locale();
1922                 }
1923         }
1924
1925         // Update the cookies if the password changed.
1926         $current_user = wp_get_current_user();
1927         if ( $current_user->ID == $ID ) {
1928                 if ( isset($plaintext_pass) ) {
1929                         wp_clear_auth_cookie();
1930
1931                         // Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
1932                         // If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
1933                         $logged_in_cookie    = wp_parse_auth_cookie( '', 'logged_in' );
1934                         /** This filter is documented in wp-includes/pluggable.php */
1935                         $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false );
1936                         $remember            = ( ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life );
1937
1938                         wp_set_auth_cookie( $ID, $remember );
1939                 }
1940         }
1941
1942         return $user_id;
1943 }
1944
1945 /**
1946  * A simpler way of inserting a user into the database.
1947  *
1948  * Creates a new user with just the username, password, and email. For more
1949  * complex user creation use wp_insert_user() to specify more information.
1950  *
1951  * @since 2.0.0
1952  * @see wp_insert_user() More complete way to create a new user
1953  *
1954  * @param string $username The user's username.
1955  * @param string $password The user's password.
1956  * @param string $email    Optional. The user's email. Default empty.
1957  * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1958  *                      be created.
1959  */
1960 function wp_create_user($username, $password, $email = '') {
1961         $user_login = wp_slash( $username );
1962         $user_email = wp_slash( $email    );
1963         $user_pass = $password;
1964
1965         $userdata = compact('user_login', 'user_email', 'user_pass');
1966         return wp_insert_user($userdata);
1967 }
1968
1969 /**
1970  * Returns a list of meta keys to be (maybe) populated in wp_update_user().
1971  *
1972  * The list of keys returned via this function are dependent on the presence
1973  * of those keys in the user meta data to be set.
1974  *
1975  * @since 3.3.0
1976  * @access private
1977  *
1978  * @param WP_User $user WP_User instance.
1979  * @return array List of user keys to be populated in wp_update_user().
1980  */
1981 function _get_additional_user_keys( $user ) {
1982         $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front', 'locale' );
1983         return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
1984 }
1985
1986 /**
1987  * Set up the user contact methods.
1988  *
1989  * Default contact methods were removed in 3.6. A filter dictates contact methods.
1990  *
1991  * @since 3.7.0
1992  *
1993  * @param WP_User $user Optional. WP_User object.
1994  * @return array Array of contact methods and their labels.
1995  */
1996 function wp_get_user_contact_methods( $user = null ) {
1997         $methods = array();
1998         if ( get_site_option( 'initial_db_version' ) < 23588 ) {
1999                 $methods = array(
2000                         'aim'    => __( 'AIM' ),
2001                         'yim'    => __( 'Yahoo IM' ),
2002                         'jabber' => __( 'Jabber / Google Talk' )
2003                 );
2004         }
2005
2006         /**
2007          * Filters the user contact methods.
2008          *
2009          * @since 2.9.0
2010          *
2011          * @param array   $methods Array of contact methods and their labels.
2012          * @param WP_User $user    WP_User object.
2013          */
2014         return apply_filters( 'user_contactmethods', $methods, $user );
2015 }
2016
2017 /**
2018  * The old private function for setting up user contact methods.
2019  *
2020  * Use wp_get_user_contact_methods() instead.
2021  *
2022  * @since 2.9.0
2023  * @access private
2024  *
2025  * @param WP_User $user Optional. WP_User object. Default null.
2026  * @return array Array of contact methods and their labels.
2027  */
2028 function _wp_get_user_contactmethods( $user = null ) {
2029         return wp_get_user_contact_methods( $user );
2030 }
2031
2032 /**
2033  * Gets the text suggesting how to create strong passwords.
2034  *
2035  * @since 4.1.0
2036  *
2037  * @return string The password hint text.
2038  */
2039 function wp_get_password_hint() {
2040         $hint = __( 'Hint: The password should be at least twelve characters long. To make it stronger, use upper and lower case letters, numbers, and symbols like ! " ? $ % ^ &amp; ).' );
2041
2042         /**
2043          * Filters the text describing the site's password complexity policy.
2044          *
2045          * @since 4.1.0
2046          *
2047          * @param string $hint The password hint text.
2048          */
2049         return apply_filters( 'password_hint', $hint );
2050 }
2051
2052 /**
2053  * Creates, stores, then returns a password reset key for user.
2054  *
2055  * @since 4.4.0
2056  *
2057  * @global wpdb         $wpdb      WordPress database abstraction object.
2058  * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
2059  *
2060  * @param WP_User $user User to retrieve password reset key for.
2061  *
2062  * @return string|WP_Error Password reset key on success. WP_Error on error.
2063  */
2064 function get_password_reset_key( $user ) {
2065         global $wpdb, $wp_hasher;
2066
2067         /**
2068          * Fires before a new password is retrieved.
2069          *
2070          * Use the {@see 'retrieve_password'} hook instead.
2071          *
2072          * @since 1.5.0
2073          * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
2074          *
2075          * @param string $user_login The user login name.
2076          */
2077         do_action( 'retreive_password', $user->user_login );
2078
2079         /**
2080          * Fires before a new password is retrieved.
2081          *
2082          * @since 1.5.1
2083          *
2084          * @param string $user_login The user login name.
2085          */
2086         do_action( 'retrieve_password', $user->user_login );
2087
2088         $allow = true;
2089         if ( is_multisite() && is_user_spammy( $user ) ) {
2090                 $allow = false;
2091         }
2092
2093         /**
2094          * Filters whether to allow a password to be reset.
2095          *
2096          * @since 2.7.0
2097          *
2098          * @param bool $allow         Whether to allow the password to be reset. Default true.
2099          * @param int  $user_data->ID The ID of the user attempting to reset a password.
2100          */
2101         $allow = apply_filters( 'allow_password_reset', $allow, $user->ID );
2102
2103         if ( ! $allow ) {
2104                 return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );
2105         } elseif ( is_wp_error( $allow ) ) {
2106                 return $allow;
2107         }
2108
2109         // Generate something random for a password reset key.
2110         $key = wp_generate_password( 20, false );
2111
2112         /**
2113          * Fires when a password reset key is generated.
2114          *
2115          * @since 2.5.0
2116          *
2117          * @param string $user_login The username for the user.
2118          * @param string $key        The generated password reset key.
2119          */
2120         do_action( 'retrieve_password_key', $user->user_login, $key );
2121
2122         // Now insert the key, hashed, into the DB.
2123         if ( empty( $wp_hasher ) ) {
2124                 $wp_hasher = new PasswordHash( 8, true );
2125         }
2126         $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
2127         $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
2128         if ( false === $key_saved ) {
2129                 return new WP_Error( 'no_password_key_update', __( 'Could not save password reset key to database.' ) );
2130         }
2131
2132         return $key;
2133 }
2134
2135 /**
2136  * Retrieves a user row based on password reset key and login
2137  *
2138  * A key is considered 'expired' if it exactly matches the value of the
2139  * user_activation_key field, rather than being matched after going through the
2140  * hashing process. This field is now hashed; old values are no longer accepted
2141  * but have a different WP_Error code so good user feedback can be provided.
2142  *
2143  * @since 3.1.0
2144  *
2145  * @global wpdb         $wpdb      WordPress database object for queries.
2146  * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
2147  *
2148  * @param string $key       Hash to validate sending user's password.
2149  * @param string $login     The user login.
2150  * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
2151  */
2152 function check_password_reset_key($key, $login) {
2153         global $wpdb, $wp_hasher;
2154
2155         $key = preg_replace('/[^a-z0-9]/i', '', $key);
2156
2157         if ( empty( $key ) || !is_string( $key ) )
2158                 return new WP_Error('invalid_key', __('Invalid key'));
2159
2160         if ( empty($login) || !is_string($login) )
2161                 return new WP_Error('invalid_key', __('Invalid key'));
2162
2163         $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
2164         if ( ! $row )
2165                 return new WP_Error('invalid_key', __('Invalid key'));
2166
2167         if ( empty( $wp_hasher ) ) {
2168                 $wp_hasher = new PasswordHash( 8, true );
2169         }
2170
2171         /**
2172          * Filters the expiration time of password reset keys.
2173          *
2174          * @since 4.3.0
2175          *
2176          * @param int $expiration The expiration time in seconds.
2177          */
2178         $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS );
2179
2180         if ( false !== strpos( $row->user_activation_key, ':' ) ) {
2181                 list( $pass_request_time, $pass_key ) = explode( ':', $row->user_activation_key, 2 );
2182                 $expiration_time = $pass_request_time + $expiration_duration;
2183         } else {
2184                 $pass_key = $row->user_activation_key;
2185                 $expiration_time = false;
2186         }
2187
2188         if ( ! $pass_key ) {
2189                 return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2190         }
2191
2192         $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key );
2193
2194         if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) {
2195                 return get_userdata( $row->ID );
2196         } elseif ( $hash_is_correct && $expiration_time ) {
2197                 // Key has an expiration time that's passed
2198                 return new WP_Error( 'expired_key', __( 'Invalid key' ) );
2199         }
2200
2201         if ( hash_equals( $row->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) {
2202                 $return = new WP_Error( 'expired_key', __( 'Invalid key' ) );
2203                 $user_id = $row->ID;
2204
2205                 /**
2206                  * Filters the return value of check_password_reset_key() when an
2207                  * old-style key is used.
2208                  *
2209                  * @since 3.7.0 Previously plain-text keys were stored in the database.
2210                  * @since 4.3.0 Previously key hashes were stored without an expiration time.
2211                  *
2212                  * @param WP_Error $return  A WP_Error object denoting an expired key.
2213                  *                          Return a WP_User object to validate the key.
2214                  * @param int      $user_id The matched user ID.
2215                  */
2216                 return apply_filters( 'password_reset_key_expired', $return, $user_id );
2217         }
2218
2219         return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2220 }
2221
2222 /**
2223  * Handles resetting the user's password.
2224  *
2225  * @since 2.5.0
2226  *
2227  * @param object $user     The user
2228  * @param string $new_pass New password for the user in plaintext
2229  */
2230 function reset_password( $user, $new_pass ) {
2231         /**
2232          * Fires before the user's password is reset.
2233          *
2234          * @since 1.5.0
2235          *
2236          * @param object $user     The user.
2237          * @param string $new_pass New user password.
2238          */
2239         do_action( 'password_reset', $user, $new_pass );
2240
2241         wp_set_password( $new_pass, $user->ID );
2242         update_user_option( $user->ID, 'default_password_nag', false, true );
2243
2244         /**
2245          * Fires after the user's password is reset.
2246          *
2247          * @since 4.4.0
2248          *
2249          * @param object $user     The user.
2250          * @param string $new_pass New user password.
2251          */
2252         do_action( 'after_password_reset', $user, $new_pass );
2253 }
2254
2255 /**
2256  * Handles registering a new user.
2257  *
2258  * @since 2.5.0
2259  *
2260  * @param string $user_login User's username for logging in
2261  * @param string $user_email User's email address to send password and add
2262  * @return int|WP_Error Either user's ID or error on failure.
2263  */
2264 function register_new_user( $user_login, $user_email ) {
2265         $errors = new WP_Error();
2266
2267         $sanitized_user_login = sanitize_user( $user_login );
2268         /**
2269          * Filters the email address of a user being registered.
2270          *
2271          * @since 2.1.0
2272          *
2273          * @param string $user_email The email address of the new user.
2274          */
2275         $user_email = apply_filters( 'user_registration_email', $user_email );
2276
2277         // Check the username
2278         if ( $sanitized_user_login == '' ) {
2279                 $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
2280         } elseif ( ! validate_username( $user_login ) ) {
2281                 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) );
2282                 $sanitized_user_login = '';
2283         } elseif ( username_exists( $sanitized_user_login ) ) {
2284                 $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) );
2285
2286         } else {
2287                 /** This filter is documented in wp-includes/user.php */
2288                 $illegal_user_logins = array_map( 'strtolower', (array) apply_filters( 'illegal_user_logins', array() ) );
2289                 if ( in_array( strtolower( $sanitized_user_login ), $illegal_user_logins ) ) {
2290                         $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
2291                 }
2292         }
2293
2294         // Check the email address
2295         if ( $user_email == '' ) {
2296                 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) );
2297         } elseif ( ! is_email( $user_email ) ) {
2298                 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn&#8217;t correct.' ) );
2299                 $user_email = '';
2300         } elseif ( email_exists( $user_email ) ) {
2301                 $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
2302         }
2303
2304         /**
2305          * Fires when submitting registration form data, before the user is created.
2306          *
2307          * @since 2.1.0
2308          *
2309          * @param string   $sanitized_user_login The submitted username after being sanitized.
2310          * @param string   $user_email           The submitted email.
2311          * @param WP_Error $errors               Contains any errors with submitted username and email,
2312          *                                       e.g., an empty field, an invalid username or email,
2313          *                                       or an existing username or email.
2314          */
2315         do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
2316
2317         /**
2318          * Filters the errors encountered when a new user is being registered.
2319          *
2320          * The filtered WP_Error object may, for example, contain errors for an invalid
2321          * or existing username or email address. A WP_Error object should always returned,
2322          * but may or may not contain errors.
2323          *
2324          * If any errors are present in $errors, this will abort the user's registration.
2325          *
2326          * @since 2.1.0
2327          *
2328          * @param WP_Error $errors               A WP_Error object containing any errors encountered
2329          *                                       during registration.
2330          * @param string   $sanitized_user_login User's username after it has been sanitized.
2331          * @param string   $user_email           User's email.
2332          */
2333         $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
2334
2335         if ( $errors->get_error_code() )
2336                 return $errors;
2337
2338         $user_pass = wp_generate_password( 12, false );
2339         $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email );
2340         if ( ! $user_id || is_wp_error( $user_id ) ) {
2341                 $errors->add( 'registerfail', sprintf( __( '<strong>ERROR</strong>: Couldn&#8217;t register you&hellip; please contact the <a href="mailto:%s">webmaster</a> !' ), get_option( 'admin_email' ) ) );
2342                 return $errors;
2343         }
2344
2345         update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
2346
2347         /**
2348          * Fires after a new user registration has been recorded.
2349          *
2350          * @since 4.4.0
2351          *
2352          * @param int $user_id ID of the newly registered user.
2353          */
2354         do_action( 'register_new_user', $user_id );
2355
2356         return $user_id;
2357 }
2358
2359 /**
2360  * Initiates email notifications related to the creation of new users.
2361  *
2362  * Notifications are sent both to the site admin and to the newly created user.
2363  *
2364  * @since 4.4.0
2365  * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending
2366  *              notifications only to the user created.
2367  *
2368  * @param int    $user_id ID of the newly created user.
2369  * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin'
2370  *                        or an empty string (admin only), 'user', or 'both' (admin and user).
2371  *                        Default 'both'.
2372  */
2373 function wp_send_new_user_notifications( $user_id, $notify = 'both' ) {
2374         wp_new_user_notification( $user_id, null, $notify );
2375 }
2376
2377 /**
2378  * Retrieve the current session token from the logged_in cookie.
2379  *
2380  * @since 4.0.0
2381  *
2382  * @return string Token.
2383  */
2384 function wp_get_session_token() {
2385         $cookie = wp_parse_auth_cookie( '', 'logged_in' );
2386         return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
2387 }
2388
2389 /**
2390  * Retrieve a list of sessions for the current user.
2391  *
2392  * @since 4.0.0
2393  * @return array Array of sessions.
2394  */
2395 function wp_get_all_sessions() {
2396         $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2397         return $manager->get_all();
2398 }
2399
2400 /**
2401  * Remove the current session token from the database.
2402  *
2403  * @since 4.0.0
2404  */
2405 function wp_destroy_current_session() {
2406         $token = wp_get_session_token();
2407         if ( $token ) {
2408                 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2409                 $manager->destroy( $token );
2410         }
2411 }
2412
2413 /**
2414  * Remove all but the current session token for the current user for the database.
2415  *
2416  * @since 4.0.0
2417  */
2418 function wp_destroy_other_sessions() {
2419         $token = wp_get_session_token();
2420         if ( $token ) {
2421                 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2422                 $manager->destroy_others( $token );
2423         }
2424 }
2425
2426 /**
2427  * Remove all session tokens for the current user from the database.
2428  *
2429  * @since 4.0.0
2430  */
2431 function wp_destroy_all_sessions() {
2432         $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2433         $manager->destroy_all();
2434 }
2435
2436 /**
2437  * Get the user IDs of all users with no role on this site.
2438  *
2439  * This function returns an empty array when used on Multisite.
2440  *
2441  * @since 4.4.0
2442  *
2443  * @return array Array of user IDs.
2444  */
2445 function wp_get_users_with_no_role() {
2446         global $wpdb;
2447
2448         if ( is_multisite() ) {
2449                 return array();
2450         }
2451
2452         $prefix = $wpdb->get_blog_prefix();
2453         $regex  = implode( '|', array_keys( wp_roles()->get_names() ) );
2454         $regex  = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex );
2455         $users  = $wpdb->get_col( $wpdb->prepare( "
2456                 SELECT user_id
2457                 FROM $wpdb->usermeta
2458                 WHERE meta_key = '{$prefix}capabilities'
2459                 AND meta_value NOT REGEXP %s
2460         ", $regex ) );
2461
2462         return $users;
2463 }
2464
2465 /**
2466  * Retrieves the current user object.
2467  *
2468  * Will set the current user, if the current user is not set. The current user
2469  * will be set to the logged-in person. If no user is logged-in, then it will
2470  * set the current user to 0, which is invalid and won't have any permissions.
2471  *
2472  * This function is used by the pluggable functions wp_get_current_user() and
2473  * get_currentuserinfo(), the latter of which is deprecated but used for backward
2474  * compatibility.
2475  *
2476  * @since 4.5.0
2477  * @access private
2478  *
2479  * @see wp_get_current_user()
2480  * @global WP_User $current_user Checks if the current user is set.
2481  *
2482  * @return WP_User Current WP_User instance.
2483  */
2484 function _wp_get_current_user() {
2485         global $current_user;
2486
2487         if ( ! empty( $current_user ) ) {
2488                 if ( $current_user instanceof WP_User ) {
2489                         return $current_user;
2490                 }
2491
2492                 // Upgrade stdClass to WP_User
2493                 if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
2494                         $cur_id = $current_user->ID;
2495                         $current_user = null;
2496                         wp_set_current_user( $cur_id );
2497                         return $current_user;
2498                 }
2499
2500                 // $current_user has a junk value. Force to WP_User with ID 0.
2501                 $current_user = null;
2502                 wp_set_current_user( 0 );
2503                 return $current_user;
2504         }
2505
2506         if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) {
2507                 wp_set_current_user( 0 );
2508                 return $current_user;
2509         }
2510
2511         /**
2512          * Filters the current user.
2513          *
2514          * The default filters use this to determine the current user from the
2515          * request's cookies, if available.
2516          *
2517          * Returning a value of false will effectively short-circuit setting
2518          * the current user.
2519          *
2520          * @since 3.9.0
2521          *
2522          * @param int|bool $user_id User ID if one has been determined, false otherwise.
2523          */
2524         $user_id = apply_filters( 'determine_current_user', false );
2525         if ( ! $user_id ) {
2526                 wp_set_current_user( 0 );
2527                 return $current_user;
2528         }
2529
2530         wp_set_current_user( $user_id );
2531
2532         return $current_user;
2533 }