[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-includes/ -> user.php (source)

   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   * Note: wp_signon() doesn't handle setting the current user. This means that if the
  21   * function is called before the {@see 'init'} hook is fired, is_user_logged_in() will
  22   * evaluate as false until that point. If is_user_logged_in() is needed in conjunction
  23   * with wp_signon(), wp_set_current_user() should be called explicitly.
  24   *
  25   * @since 2.5.0
  26   *
  27   * @global string $auth_secure_cookie
  28   *
  29   * @param array       $credentials   Optional. User info in order to sign on.
  30   * @param string|bool $secure_cookie Optional. Whether to use secure cookie.
  31   * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
  32   */
  33  function wp_signon( $credentials = array(), $secure_cookie = '' ) {
  34      if ( empty( $credentials ) ) {
  35          $credentials = array(); // Back-compat for plugins passing an empty string.
  36  
  37          if ( ! empty( $_POST['log'] ) ) {
  38              $credentials['user_login'] = $_POST['log'];
  39          }
  40          if ( ! empty( $_POST['pwd'] ) ) {
  41              $credentials['user_password'] = $_POST['pwd'];
  42          }
  43          if ( ! empty( $_POST['rememberme'] ) ) {
  44              $credentials['remember'] = $_POST['rememberme'];
  45          }
  46      }
  47  
  48      if ( ! empty( $credentials['remember'] ) ) {
  49          $credentials['remember'] = true;
  50      } else {
  51          $credentials['remember'] = false;
  52      }
  53  
  54      /**
  55       * Fires before the user is authenticated.
  56       *
  57       * The variables passed to the callbacks are passed by reference,
  58       * and can be modified by callback functions.
  59       *
  60       * @since 1.5.1
  61       *
  62       * @todo Decide whether to deprecate the wp_authenticate action.
  63       *
  64       * @param string $user_login    Username (passed by reference).
  65       * @param string $user_password User password (passed by reference).
  66       */
  67      do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
  68  
  69      if ( '' === $secure_cookie ) {
  70          $secure_cookie = is_ssl();
  71      }
  72  
  73      /**
  74       * Filters whether to use a secure sign-on cookie.
  75       *
  76       * @since 3.1.0
  77       *
  78       * @param bool  $secure_cookie Whether to use a secure sign-on cookie.
  79       * @param array $credentials {
  80       *     Array of entered sign-on data.
  81       *
  82       *     @type string $user_login    Username.
  83       *     @type string $user_password Password entered.
  84       *     @type bool   $remember      Whether to 'remember' the user. Increases the time
  85       *                                 that the cookie will be kept. Default false.
  86       * }
  87       */
  88      $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );
  89  
  90      global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
  91      $auth_secure_cookie = $secure_cookie;
  92  
  93      add_filter( 'authenticate', 'wp_authenticate_cookie', 30, 3 );
  94  
  95      $user = wp_authenticate( $credentials['user_login'], $credentials['user_password'] );
  96  
  97      if ( is_wp_error( $user ) ) {
  98          return $user;
  99      }
 100  
 101      wp_set_auth_cookie( $user->ID, $credentials['remember'], $secure_cookie );
 102      /**
 103       * Fires after the user has successfully logged in.
 104       *
 105       * @since 1.5.0
 106       *
 107       * @param string  $user_login Username.
 108       * @param WP_User $user       WP_User object of the logged-in user.
 109       */
 110      do_action( 'wp_login', $user->user_login, $user );
 111      return $user;
 112  }
 113  
 114  /**
 115   * Authenticate a user, confirming the username and password are valid.
 116   *
 117   * @since 2.8.0
 118   *
 119   * @param WP_User|WP_Error|null $user     WP_User or WP_Error object from a previous callback. Default null.
 120   * @param string                $username Username for authentication.
 121   * @param string                $password Password for authentication.
 122   * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 123   */
 124  function wp_authenticate_username_password( $user, $username, $password ) {
 125      if ( $user instanceof WP_User ) {
 126          return $user;
 127      }
 128  
 129      if ( empty( $username ) || empty( $password ) ) {
 130          if ( is_wp_error( $user ) ) {
 131              return $user;
 132          }
 133  
 134          $error = new WP_Error();
 135  
 136          if ( empty( $username ) ) {
 137              $error->add( 'empty_username', __( '<strong>ERROR</strong>: The username field is empty.' ) );
 138          }
 139  
 140          if ( empty( $password ) ) {
 141              $error->add( 'empty_password', __( '<strong>ERROR</strong>: The password field is empty.' ) );
 142          }
 143  
 144          return $error;
 145      }
 146  
 147      $user = get_user_by( 'login', $username );
 148  
 149      if ( ! $user ) {
 150          return new WP_Error(
 151              'invalid_username',
 152              __( 'Unknown username. Check again or try your email address.' )
 153          );
 154      }
 155  
 156      /**
 157       * Filters whether the given user can be authenticated with the provided $password.
 158       *
 159       * @since 2.5.0
 160       *
 161       * @param WP_User|WP_Error $user     WP_User or WP_Error object if a previous
 162       *                                   callback failed authentication.
 163       * @param string           $password Password to check against the user.
 164       */
 165      $user = apply_filters( 'wp_authenticate_user', $user, $password );
 166      if ( is_wp_error( $user ) ) {
 167          return $user;
 168      }
 169  
 170      if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
 171          return new WP_Error(
 172              'incorrect_password',
 173              sprintf(
 174                  /* translators: %s: User name. */
 175                  __( '<strong>ERROR</strong>: The password you entered for the username %s is incorrect.' ),
 176                  '<strong>' . $username . '</strong>'
 177              ) .
 178              ' <a href="' . wp_lostpassword_url() . '">' .
 179              __( 'Lost your password?' ) .
 180              '</a>'
 181          );
 182      }
 183  
 184      return $user;
 185  }
 186  
 187  /**
 188   * Authenticates a user using the email and password.
 189   *
 190   * @since 4.5.0
 191   *
 192   * @param WP_User|WP_Error|null $user     WP_User or WP_Error object if a previous
 193   *                                        callback failed authentication.
 194   * @param string                $email    Email address for authentication.
 195   * @param string                $password Password for authentication.
 196   * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 197   */
 198  function wp_authenticate_email_password( $user, $email, $password ) {
 199      if ( $user instanceof WP_User ) {
 200          return $user;
 201      }
 202  
 203      if ( empty( $email ) || empty( $password ) ) {
 204          if ( is_wp_error( $user ) ) {
 205              return $user;
 206          }
 207  
 208          $error = new WP_Error();
 209  
 210          if ( empty( $email ) ) {
 211              $error->add( 'empty_username', __( '<strong>ERROR</strong>: The email field is empty.' ) ); // Uses 'empty_username' for back-compat with wp_signon()
 212          }
 213  
 214          if ( empty( $password ) ) {
 215              $error->add( 'empty_password', __( '<strong>ERROR</strong>: The password field is empty.' ) );
 216          }
 217  
 218          return $error;
 219      }
 220  
 221      if ( ! is_email( $email ) ) {
 222          return $user;
 223      }
 224  
 225      $user = get_user_by( 'email', $email );
 226  
 227      if ( ! $user ) {
 228          return new WP_Error(
 229              'invalid_email',
 230              __( 'Unknown email address. Check again or try your username.' )
 231          );
 232      }
 233  
 234      /** This filter is documented in wp-includes/user.php */
 235      $user = apply_filters( 'wp_authenticate_user', $user, $password );
 236  
 237      if ( is_wp_error( $user ) ) {
 238          return $user;
 239      }
 240  
 241      if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
 242          return new WP_Error(
 243              'incorrect_password',
 244              sprintf(
 245                  /* translators: %s: Email address. */
 246                  __( '<strong>ERROR</strong>: The password you entered for the email address %s is incorrect.' ),
 247                  '<strong>' . $email . '</strong>'
 248              ) .
 249              ' <a href="' . wp_lostpassword_url() . '">' .
 250              __( 'Lost your password?' ) .
 251              '</a>'
 252          );
 253      }
 254  
 255      return $user;
 256  }
 257  
 258  /**
 259   * Authenticate the user using the WordPress auth cookie.
 260   *
 261   * @since 2.8.0
 262   *
 263   * @global string $auth_secure_cookie
 264   *
 265   * @param WP_User|WP_Error|null $user     WP_User or WP_Error object from a previous callback. Default null.
 266   * @param string                $username Username. If not empty, cancels the cookie authentication.
 267   * @param string                $password Password. If not empty, cancels the cookie authentication.
 268   * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
 269   */
 270  function wp_authenticate_cookie( $user, $username, $password ) {
 271      if ( $user instanceof WP_User ) {
 272          return $user;
 273      }
 274  
 275      if ( empty( $username ) && empty( $password ) ) {
 276          $user_id = wp_validate_auth_cookie();
 277          if ( $user_id ) {
 278              return new WP_User( $user_id );
 279          }
 280  
 281          global $auth_secure_cookie;
 282  
 283          if ( $auth_secure_cookie ) {
 284              $auth_cookie = SECURE_AUTH_COOKIE;
 285          } else {
 286              $auth_cookie = AUTH_COOKIE;
 287          }
 288  
 289          if ( ! empty( $_COOKIE[ $auth_cookie ] ) ) {
 290              return new WP_Error( 'expired_session', __( 'Please log in again.' ) );
 291          }
 292  
 293          // If the cookie is not set, be silent.
 294      }
 295  
 296      return $user;
 297  }
 298  
 299  /**
 300   * For Multisite blogs, check if the authenticated user has been marked as a
 301   * spammer, or if the user's primary blog has been marked as spam.
 302   *
 303   * @since 3.7.0
 304   *
 305   * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
 306   * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer.
 307   */
 308  function wp_authenticate_spam_check( $user ) {
 309      if ( $user instanceof WP_User && is_multisite() ) {
 310          /**
 311           * Filters whether the user has been marked as a spammer.
 312           *
 313           * @since 3.7.0
 314           *
 315           * @param bool    $spammed Whether the user is considered a spammer.
 316           * @param WP_User $user    User to check against.
 317           */
 318          $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy( $user ), $user );
 319  
 320          if ( $spammed ) {
 321              return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) );
 322          }
 323      }
 324      return $user;
 325  }
 326  
 327  /**
 328   * Validates the logged-in cookie.
 329   *
 330   * Checks the logged-in cookie if the previous auth cookie could not be
 331   * validated and parsed.
 332   *
 333   * This is a callback for the {@see 'determine_current_user'} filter, rather than API.
 334   *
 335   * @since 3.9.0
 336   *
 337   * @param int|bool $user_id The user ID (or false) as received from the
 338   *                       determine_current_user filter.
 339   * @return int|false User ID if validated, false otherwise. If a user ID from
 340   *                   an earlier filter callback is received, that value is returned.
 341   */
 342  function wp_validate_logged_in_cookie( $user_id ) {
 343      if ( $user_id ) {
 344          return $user_id;
 345      }
 346  
 347      if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[ LOGGED_IN_COOKIE ] ) ) {
 348          return false;
 349      }
 350  
 351      return wp_validate_auth_cookie( $_COOKIE[ LOGGED_IN_COOKIE ], 'logged_in' );
 352  }
 353  
 354  /**
 355   * Number of posts user has written.
 356   *
 357   * @since 3.0.0
 358   * @since 4.1.0 Added `$post_type` argument.
 359   * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array
 360   *              of post types to `$post_type`.
 361   *
 362   * @global wpdb $wpdb WordPress database abstraction object.
 363   *
 364   * @param int          $userid      User ID.
 365   * @param array|string $post_type   Optional. Single post type or array of post types to count the number of posts for. Default 'post'.
 366   * @param bool         $public_only Optional. Whether to only return counts for public posts. Default false.
 367   * @return string Number of posts the user has written in this post type.
 368   */
 369  function count_user_posts( $userid, $post_type = 'post', $public_only = false ) {
 370      global $wpdb;
 371  
 372      $where = get_posts_by_author_sql( $post_type, true, $userid, $public_only );
 373  
 374      $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
 375  
 376      /**
 377       * Filters the number of posts a user has written.
 378       *
 379       * @since 2.7.0
 380       * @since 4.1.0 Added `$post_type` argument.
 381       * @since 4.3.1 Added `$public_only` argument.
 382       *
 383       * @param int          $count       The user's post count.
 384       * @param int          $userid      User ID.
 385       * @param string|array $post_type   Single post type or array of post types to count the number of posts for.
 386       * @param bool         $public_only Whether to limit counted posts to public posts.
 387       */
 388      return apply_filters( 'get_usernumposts', $count, $userid, $post_type, $public_only );
 389  }
 390  
 391  /**
 392   * Number of posts written by a list of users.
 393   *
 394   * @since 3.0.0
 395   *
 396   * @global wpdb $wpdb WordPress database abstraction object.
 397   *
 398   * @param array        $users       Array of user IDs.
 399   * @param string|array $post_type   Optional. Single post type or array of post types to check. Defaults to 'post'.
 400   * @param bool         $public_only Optional. Only return counts for public posts.  Defaults to false.
 401   * @return array Amount of posts each user has written.
 402   */
 403  function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) {
 404      global $wpdb;
 405  
 406      $count = array();
 407      if ( empty( $users ) || ! is_array( $users ) ) {
 408          return $count;
 409      }
 410  
 411      $userlist = implode( ',', array_map( 'absint', $users ) );
 412      $where    = get_posts_by_author_sql( $post_type, true, null, $public_only );
 413  
 414      $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N );
 415      foreach ( $result as $row ) {
 416          $count[ $row[0] ] = $row[1];
 417      }
 418  
 419      foreach ( $users as $id ) {
 420          if ( ! isset( $count[ $id ] ) ) {
 421              $count[ $id ] = 0;
 422          }
 423      }
 424  
 425      return $count;
 426  }
 427  
 428  //
 429  // User option functions
 430  //
 431  
 432  /**
 433   * Get the current user's ID
 434   *
 435   * @since MU (3.0.0)
 436   *
 437   * @return int The current user's ID, or 0 if no user is logged in.
 438   */
 439  function get_current_user_id() {
 440      if ( ! function_exists( 'wp_get_current_user' ) ) {
 441          return 0;
 442      }
 443      $user = wp_get_current_user();
 444      return ( isset( $user->ID ) ? (int) $user->ID : 0 );
 445  }
 446  
 447  /**
 448   * Retrieve user option that can be either per Site or per Network.
 449   *
 450   * If the user ID is not given, then the current user will be used instead. If
 451   * the user ID is given, then the user data will be retrieved. The filter for
 452   * the result, will also pass the original option name and finally the user data
 453   * object as the third parameter.
 454   *
 455   * The option will first check for the per site name and then the per Network name.
 456   *
 457   * @since 2.0.0
 458   *
 459   * @global wpdb $wpdb WordPress database abstraction object.
 460   *
 461   * @param string $option     User option name.
 462   * @param int    $user       Optional. User ID.
 463   * @param string $deprecated Use get_option() to check for an option in the options table.
 464   * @return mixed User option value on success, false on failure.
 465   */
 466  function get_user_option( $option, $user = 0, $deprecated = '' ) {
 467      global $wpdb;
 468  
 469      if ( ! empty( $deprecated ) ) {
 470          _deprecated_argument( __FUNCTION__, '3.0.0' );
 471      }
 472  
 473      if ( empty( $user ) ) {
 474          $user = get_current_user_id();
 475      }
 476  
 477      $user = get_userdata( $user );
 478      if ( ! $user ) {
 479          return false;
 480      }
 481  
 482      $prefix = $wpdb->get_blog_prefix();
 483      if ( $user->has_prop( $prefix . $option ) ) { // Blog specific
 484          $result = $user->get( $prefix . $option );
 485      } elseif ( $user->has_prop( $option ) ) { // User specific and cross-blog
 486          $result = $user->get( $option );
 487      } else {
 488          $result = false;
 489      }
 490  
 491      /**
 492       * Filters a specific user option value.
 493       *
 494       * The dynamic portion of the hook name, `$option`, refers to the user option name.
 495       *
 496       * @since 2.5.0
 497       *
 498       * @param mixed   $result Value for the user's option.
 499       * @param string  $option Name of the option being retrieved.
 500       * @param WP_User $user   WP_User object of the user whose option is being retrieved.
 501       */
 502      return apply_filters( "get_user_option_{$option}", $result, $option, $user );
 503  }
 504  
 505  /**
 506   * Update user option with global blog capability.
 507   *
 508   * User options are just like user metadata except that they have support for
 509   * global blog options. If the 'global' parameter is false, which it is by default
 510   * it will prepend the WordPress table prefix to the option name.
 511   *
 512   * Deletes the user option if $newvalue is empty.
 513   *
 514   * @since 2.0.0
 515   *
 516   * @global wpdb $wpdb WordPress database abstraction object.
 517   *
 518   * @param int    $user_id     User ID.
 519   * @param string $option_name User option name.
 520   * @param mixed  $newvalue    User option value.
 521   * @param bool   $global      Optional. Whether option name is global or blog specific.
 522   *                            Default false (blog specific).
 523   * @return int|bool User meta ID if the option didn't exist, true on successful update,
 524   *                  false on failure.
 525   */
 526  function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
 527      global $wpdb;
 528  
 529      if ( ! $global ) {
 530          $option_name = $wpdb->get_blog_prefix() . $option_name;
 531      }
 532  
 533      return update_user_meta( $user_id, $option_name, $newvalue );
 534  }
 535  
 536  /**
 537   * Delete user option with global blog capability.
 538   *
 539   * User options are just like user metadata except that they have support for
 540   * global blog options. If the 'global' parameter is false, which it is by default
 541   * it will prepend the WordPress table prefix to the option name.
 542   *
 543   * @since 3.0.0
 544   *
 545   * @global wpdb $wpdb WordPress database abstraction object.
 546   *
 547   * @param int    $user_id     User ID
 548   * @param string $option_name User option name.
 549   * @param bool   $global      Optional. Whether option name is global or blog specific.
 550   *                            Default false (blog specific).
 551   * @return bool True on success, false on failure.
 552   */
 553  function delete_user_option( $user_id, $option_name, $global = false ) {
 554      global $wpdb;
 555  
 556      if ( ! $global ) {
 557          $option_name = $wpdb->get_blog_prefix() . $option_name;
 558      }
 559      return delete_user_meta( $user_id, $option_name );
 560  }
 561  
 562  /**
 563   * Retrieve list of users matching criteria.
 564   *
 565   * @since 3.1.0
 566   *
 567   * @see WP_User_Query
 568   *
 569   * @param array $args Optional. Arguments to retrieve users. See WP_User_Query::prepare_query().
 570   *                    for more information on accepted arguments.
 571   * @return array List of users.
 572   */
 573  function get_users( $args = array() ) {
 574  
 575      $args                = wp_parse_args( $args );
 576      $args['count_total'] = false;
 577  
 578      $user_search = new WP_User_Query( $args );
 579  
 580      return (array) $user_search->get_results();
 581  }
 582  
 583  /**
 584   * Get the sites a user belongs to.
 585   *
 586   * @since 3.0.0
 587   * @since 4.7.0 Converted to use `get_sites()`.
 588   *
 589   * @global wpdb $wpdb WordPress database abstraction object.
 590   *
 591   * @param int  $user_id User ID
 592   * @param bool $all     Whether to retrieve all sites, or only sites that are not
 593   *                      marked as deleted, archived, or spam.
 594   * @return array A list of the user's sites. An empty array if the user doesn't exist
 595   *               or belongs to no sites.
 596   */
 597  function get_blogs_of_user( $user_id, $all = false ) {
 598      global $wpdb;
 599  
 600      $user_id = (int) $user_id;
 601  
 602      // Logged out users can't have sites
 603      if ( empty( $user_id ) ) {
 604          return array();
 605      }
 606  
 607      /**
 608       * Filters the list of a user's sites before it is populated.
 609       *
 610       * Passing a non-null value to the filter will effectively short circuit
 611       * get_blogs_of_user(), returning that value instead.
 612       *
 613       * @since 4.6.0
 614       *
 615       * @param null|array $sites   An array of site objects of which the user is a member.
 616       * @param int        $user_id User ID.
 617       * @param bool       $all     Whether the returned array should contain all sites, including
 618       *                            those marked 'deleted', 'archived', or 'spam'. Default false.
 619       */
 620      $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
 621  
 622      if ( null !== $sites ) {
 623          return $sites;
 624      }
 625  
 626      $keys = get_user_meta( $user_id );
 627      if ( empty( $keys ) ) {
 628          return array();
 629      }
 630  
 631      if ( ! is_multisite() ) {
 632          $site_id                        = get_current_blog_id();
 633          $sites                          = array( $site_id => new stdClass );
 634          $sites[ $site_id ]->userblog_id = $site_id;
 635          $sites[ $site_id ]->blogname    = get_option( 'blogname' );
 636          $sites[ $site_id ]->domain      = '';
 637          $sites[ $site_id ]->path        = '';
 638          $sites[ $site_id ]->site_id     = 1;
 639          $sites[ $site_id ]->siteurl     = get_option( 'siteurl' );
 640          $sites[ $site_id ]->archived    = 0;
 641          $sites[ $site_id ]->spam        = 0;
 642          $sites[ $site_id ]->deleted     = 0;
 643          return $sites;
 644      }
 645  
 646      $site_ids = array();
 647  
 648      if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
 649          $site_ids[] = 1;
 650          unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
 651      }
 652  
 653      $keys = array_keys( $keys );
 654  
 655      foreach ( $keys as $key ) {
 656          if ( 'capabilities' !== substr( $key, -12 ) ) {
 657              continue;
 658          }
 659          if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) ) {
 660              continue;
 661          }
 662          $site_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
 663          if ( ! is_numeric( $site_id ) ) {
 664              continue;
 665          }
 666  
 667          $site_ids[] = (int) $site_id;
 668      }
 669  
 670      $sites = array();
 671  
 672      if ( ! empty( $site_ids ) ) {
 673          $args = array(
 674              'number'                 => '',
 675              'site__in'               => $site_ids,
 676              'update_site_meta_cache' => false,
 677          );
 678          if ( ! $all ) {
 679              $args['archived'] = 0;
 680              $args['spam']     = 0;
 681              $args['deleted']  = 0;
 682          }
 683  
 684          $_sites = get_sites( $args );
 685  
 686          foreach ( $_sites as $site ) {
 687              $sites[ $site->id ] = (object) array(
 688                  'userblog_id' => $site->id,
 689                  'blogname'    => $site->blogname,
 690                  'domain'      => $site->domain,
 691                  'path'        => $site->path,
 692                  'site_id'     => $site->network_id,
 693                  'siteurl'     => $site->siteurl,
 694                  'archived'    => $site->archived,
 695                  'mature'      => $site->mature,
 696                  'spam'        => $site->spam,
 697                  'deleted'     => $site->deleted,
 698              );
 699          }
 700      }
 701  
 702      /**
 703       * Filters the list of sites a user belongs to.
 704       *
 705       * @since MU (3.0.0)
 706       *
 707       * @param array $sites   An array of site objects belonging to the user.
 708       * @param int   $user_id User ID.
 709       * @param bool  $all     Whether the returned sites array should contain all sites, including
 710       *                       those marked 'deleted', 'archived', or 'spam'. Default false.
 711       */
 712      return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all );
 713  }
 714  
 715  /**
 716   * Find out whether a user is a member of a given blog.
 717   *
 718   * @since MU (3.0.0)
 719   *
 720   * @global wpdb $wpdb WordPress database abstraction object.
 721   *
 722   * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
 723   * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
 724   * @return bool
 725   */
 726  function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
 727      global $wpdb;
 728  
 729      $user_id = (int) $user_id;
 730      $blog_id = (int) $blog_id;
 731  
 732      if ( empty( $user_id ) ) {
 733          $user_id = get_current_user_id();
 734      }
 735  
 736      // Technically not needed, but does save calls to get_site and get_user_meta
 737      // in the event that the function is called when a user isn't logged in
 738      if ( empty( $user_id ) ) {
 739          return false;
 740      } else {
 741          $user = get_userdata( $user_id );
 742          if ( ! $user instanceof WP_User ) {
 743              return false;
 744          }
 745      }
 746  
 747      if ( ! is_multisite() ) {
 748          return true;
 749      }
 750  
 751      if ( empty( $blog_id ) ) {
 752          $blog_id = get_current_blog_id();
 753      }
 754  
 755      $blog = get_site( $blog_id );
 756  
 757      if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) {
 758          return false;
 759      }
 760  
 761      $keys = get_user_meta( $user_id );
 762      if ( empty( $keys ) ) {
 763          return false;
 764      }
 765  
 766      // no underscore before capabilities in $base_capabilities_key
 767      $base_capabilities_key = $wpdb->base_prefix . 'capabilities';
 768      $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
 769  
 770      if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) {
 771          return true;
 772      }
 773  
 774      if ( isset( $keys[ $site_capabilities_key ] ) ) {
 775          return true;
 776      }
 777  
 778      return false;
 779  }
 780  
 781  /**
 782   * Adds meta data to a user.
 783   *
 784   * @since 3.0.0
 785   *
 786   * @param int    $user_id    User ID.
 787   * @param string $meta_key   Metadata name.
 788   * @param mixed  $meta_value Metadata value.
 789   * @param bool   $unique     Optional. Whether the same key should not be added. Default false.
 790   * @return int|false Meta ID on success, false on failure.
 791   */
 792  function add_user_meta( $user_id, $meta_key, $meta_value, $unique = false ) {
 793      return add_metadata( 'user', $user_id, $meta_key, $meta_value, $unique );
 794  }
 795  
 796  /**
 797   * Remove metadata matching criteria from a user.
 798   *
 799   * You can match based on the key, or key and value. Removing based on key and
 800   * value, will keep from removing duplicate metadata with the same key. It also
 801   * allows removing all metadata matching key, if needed.
 802   *
 803   * @since 3.0.0
 804   * @link https://developer.wordpress.org/reference/functions/delete_user_meta/
 805   *
 806   * @param int    $user_id    User ID
 807   * @param string $meta_key   Metadata name.
 808   * @param mixed  $meta_value Optional. Metadata value.
 809   * @return bool True on success, false on failure.
 810   */
 811  function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
 812      return delete_metadata( 'user', $user_id, $meta_key, $meta_value );
 813  }
 814  
 815  /**
 816   * Retrieve user meta field for a user.
 817   *
 818   * @since 3.0.0
 819   * @link https://developer.wordpress.org/reference/functions/get_user_meta/
 820   *
 821   * @param int    $user_id User ID.
 822   * @param string $key     Optional. The meta key to retrieve. By default, returns data for all keys.
 823   * @param bool   $single  Whether to return a single value.
 824   * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
 825   */
 826  function get_user_meta( $user_id, $key = '', $single = false ) {
 827      return get_metadata( 'user', $user_id, $key, $single );
 828  }
 829  
 830  /**
 831   * Update user meta field based on user ID.
 832   *
 833   * Use the $prev_value parameter to differentiate between meta fields with the
 834   * same key and user ID.
 835   *
 836   * If the meta field for the user does not exist, it will be added.
 837   *
 838   * @since 3.0.0
 839   * @link https://developer.wordpress.org/reference/functions/update_user_meta/
 840   *
 841   * @param int    $user_id    User ID.
 842   * @param string $meta_key   Metadata key.
 843   * @param mixed  $meta_value Metadata value.
 844   * @param mixed  $prev_value Optional. Previous value to check before removing.
 845   * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
 846   */
 847  function update_user_meta( $user_id, $meta_key, $meta_value, $prev_value = '' ) {
 848      return update_metadata( 'user', $user_id, $meta_key, $meta_value, $prev_value );
 849  }
 850  
 851  /**
 852   * Count number of users who have each of the user roles.
 853   *
 854   * Assumes there are neither duplicated nor orphaned capabilities meta_values.
 855   * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query()
 856   * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
 857   * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
 858   *
 859   * @since 3.0.0
 860   * @since 4.4.0 The number of users with no role is now included in the `none` element.
 861   * @since 4.9.0 The `$site_id` parameter was added to support multisite.
 862   *
 863   * @global wpdb $wpdb WordPress database abstraction object.
 864   *
 865   * @param string   $strategy Optional. The computational strategy to use when counting the users.
 866   *                           Accepts either 'time' or 'memory'. Default 'time'.
 867   * @param int|null $site_id  Optional. The site ID to count users for. Defaults to the current site.
 868   * @return array Includes a grand total and an array of counts indexed by role strings.
 869   */
 870  function count_users( $strategy = 'time', $site_id = null ) {
 871      global $wpdb;
 872  
 873      // Initialize
 874      if ( ! $site_id ) {
 875          $site_id = get_current_blog_id();
 876      }
 877  
 878      /**
 879       * Filter the user count before queries are run. Return a non-null value to cause count_users()
 880       * to return early.
 881       *
 882       * @since 5.1.0
 883       *
 884       * @param null|string $result   Default null.
 885       * @param string      $strategy Optional. The computational strategy to use when counting the users.
 886       *                              Accepts either 'time' or 'memory'. Default 'time'.
 887       * @param int|null    $site_id  Optional. The site ID to count users for. Defaults to the current site.
 888       */
 889      $pre = apply_filters( 'pre_count_users', null, $strategy, $site_id );
 890  
 891      if ( null !== $pre ) {
 892          return $pre;
 893      }
 894  
 895      $blog_prefix = $wpdb->get_blog_prefix( $site_id );
 896      $result      = array();
 897  
 898      if ( 'time' == $strategy ) {
 899          if ( is_multisite() && $site_id != get_current_blog_id() ) {
 900              switch_to_blog( $site_id );
 901              $avail_roles = wp_roles()->get_names();
 902              restore_current_blog();
 903          } else {
 904              $avail_roles = wp_roles()->get_names();
 905          }
 906  
 907          // Build a CPU-intensive query that will return concise information.
 908          $select_count = array();
 909          foreach ( $avail_roles as $this_role => $name ) {
 910              $select_count[] = $wpdb->prepare( 'COUNT(NULLIF(`meta_value` LIKE %s, false))', '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%' );
 911          }
 912          $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))";
 913          $select_count   = implode( ', ', $select_count );
 914  
 915          // Add the meta_value index to the selection list, then run the query.
 916          $row = $wpdb->get_row(
 917              "
 918              SELECT {$select_count}, COUNT(*)
 919              FROM {$wpdb->usermeta}
 920              INNER JOIN {$wpdb->users} ON user_id = ID
 921              WHERE meta_key = '{$blog_prefix}capabilities'
 922          ",
 923              ARRAY_N
 924          );
 925  
 926          // Run the previous loop again to associate results with role names.
 927          $col         = 0;
 928          $role_counts = array();
 929          foreach ( $avail_roles as $this_role => $name ) {
 930              $count = (int) $row[ $col++ ];
 931              if ( $count > 0 ) {
 932                  $role_counts[ $this_role ] = $count;
 933              }
 934          }
 935  
 936          $role_counts['none'] = (int) $row[ $col++ ];
 937  
 938          // Get the meta_value index from the end of the result set.
 939          $total_users = (int) $row[ $col ];
 940  
 941          $result['total_users'] = $total_users;
 942          $result['avail_roles'] =& $role_counts;
 943      } else {
 944          $avail_roles = array(
 945              'none' => 0,
 946          );
 947  
 948          $users_of_blog = $wpdb->get_col(
 949              "
 950              SELECT meta_value
 951              FROM {$wpdb->usermeta}
 952              INNER JOIN {$wpdb->users} ON user_id = ID
 953              WHERE meta_key = '{$blog_prefix}capabilities'
 954          "
 955          );
 956  
 957          foreach ( $users_of_blog as $caps_meta ) {
 958              $b_roles = maybe_unserialize( $caps_meta );
 959              if ( ! is_array( $b_roles ) ) {
 960                  continue;
 961              }
 962              if ( empty( $b_roles ) ) {
 963                  $avail_roles['none']++;
 964              }
 965              foreach ( $b_roles as $b_role => $val ) {
 966                  if ( isset( $avail_roles[ $b_role ] ) ) {
 967                      $avail_roles[ $b_role ]++;
 968                  } else {
 969                      $avail_roles[ $b_role ] = 1;
 970                  }
 971              }
 972          }
 973  
 974          $result['total_users'] = count( $users_of_blog );
 975          $result['avail_roles'] =& $avail_roles;
 976      }
 977  
 978      return $result;
 979  }
 980  
 981  //
 982  // Private helper functions
 983  //
 984  
 985  /**
 986   * Set up global user vars.
 987   *
 988   * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
 989   *
 990   * @since 2.0.4
 991   *
 992   * @global string  $user_login    The user username for logging in
 993   * @global WP_User $userdata      User data.
 994   * @global int     $user_level    The level of the user
 995   * @global int     $user_ID       The ID of the user
 996   * @global string  $user_email    The email address of the user
 997   * @global string  $user_url      The url in the user's profile
 998   * @global string  $user_identity The display name of the user
 999   *
1000   * @param int $for_user_id Optional. User ID to set up global data. Default 0.
1001   */
1002  function setup_userdata( $for_user_id = 0 ) {
1003      global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity;
1004  
1005      if ( ! $for_user_id ) {
1006          $for_user_id = get_current_user_id();
1007      }
1008      $user = get_userdata( $for_user_id );
1009  
1010      if ( ! $user ) {
1011          $user_ID       = 0;
1012          $user_level    = 0;
1013          $userdata      = null;
1014          $user_login    = '';
1015          $user_email    = '';
1016          $user_url      = '';
1017          $user_identity = '';
1018          return;
1019      }
1020  
1021      $user_ID       = (int) $user->ID;
1022      $user_level    = (int) $user->user_level;
1023      $userdata      = $user;
1024      $user_login    = $user->user_login;
1025      $user_email    = $user->user_email;
1026      $user_url      = $user->user_url;
1027      $user_identity = $user->display_name;
1028  }
1029  
1030  /**
1031   * Create dropdown HTML content of users.
1032   *
1033   * The content can either be displayed, which it is by default or retrieved by
1034   * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
1035   * need to be used; all users will be displayed in that case. Only one can be
1036   * used, either 'include' or 'exclude', but not both.
1037   *
1038   * The available arguments are as follows:
1039   *
1040   * @since 2.3.0
1041   * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
1042   * @since 4.7.0 Added the `$role`, `$role__in`, and `$role__not_in` parameters.
1043   *
1044   * @param array|string $args {
1045   *     Optional. Array or string of arguments to generate a drop-down of users.
1046   *     See WP_User_Query::prepare_query() for additional available arguments.
1047   *
1048   *     @type string       $show_option_all         Text to show as the drop-down default (all).
1049   *                                                 Default empty.
1050   *     @type string       $show_option_none        Text to show as the drop-down default when no
1051   *                                                 users were found. Default empty.
1052   *     @type int|string   $option_none_value       Value to use for $show_option_non when no users
1053   *                                                 were found. Default -1.
1054   *     @type string       $hide_if_only_one_author Whether to skip generating the drop-down
1055   *                                                 if only one user was found. Default empty.
1056   *     @type string       $orderby                 Field to order found users by. Accepts user fields.
1057   *                                                 Default 'display_name'.
1058   *     @type string       $order                   Whether to order users in ascending or descending
1059   *                                                 order. Accepts 'ASC' (ascending) or 'DESC' (descending).
1060   *                                                 Default 'ASC'.
1061   *     @type array|string $include                 Array or comma-separated list of user IDs to include.
1062   *                                                 Default empty.
1063   *     @type array|string $exclude                 Array or comma-separated list of user IDs to exclude.
1064   *                                                 Default empty.
1065   *     @type bool|int     $multi                   Whether to skip the ID attribute on the 'select' element.
1066   *                                                 Accepts 1|true or 0|false. Default 0|false.
1067   *     @type string       $show                    User data to display. If the selected item is empty
1068   *                                                 then the 'user_login' will be displayed in parentheses.
1069   *                                                 Accepts any user field, or 'display_name_with_login' to show
1070   *                                                 the display name with user_login in parentheses.
1071   *                                                 Default 'display_name'.
1072   *     @type int|bool     $echo                    Whether to echo or return the drop-down. Accepts 1|true (echo)
1073   *                                                 or 0|false (return). Default 1|true.
1074   *     @type int          $selected                Which user ID should be selected. Default 0.
1075   *     @type bool         $include_selected        Whether to always include the selected user ID in the drop-
1076   *                                                 down. Default false.
1077   *     @type string       $name                    Name attribute of select element. Default 'user'.
1078   *     @type string       $id                      ID attribute of the select element. Default is the value of $name.
1079   *     @type string       $class                   Class attribute of the select element. Default empty.
1080   *     @type int          $blog_id                 ID of blog (Multisite only). Default is ID of the current blog.
1081   *     @type string       $who                     Which type of users to query. Accepts only an empty string or
1082   *                                                 'authors'. Default empty.
1083   *     @type string|array $role                    An array or a comma-separated list of role names that users must
1084   *                                                 match to be included in results. Note that this is an inclusive
1085   *                                                 list: users must match *each* role. Default empty.
1086   *     @type array        $role__in                An array of role names. Matched users must have at least one of
1087   *                                                 these roles. Default empty array.
1088   *     @type array        $role__not_in            An array of role names to exclude. Users matching one or more of
1089   *                                                 these roles will not be included in results. Default empty array.
1090   * }
1091   * @return string String of HTML content.
1092   */
1093  function wp_dropdown_users( $args = '' ) {
1094      $defaults = array(
1095          'show_option_all'         => '',
1096          'show_option_none'        => '',
1097          'hide_if_only_one_author' => '',
1098          'orderby'                 => 'display_name',
1099          'order'                   => 'ASC',
1100          'include'                 => '',
1101          'exclude'                 => '',
1102          'multi'                   => 0,
1103          'show'                    => 'display_name',
1104          'echo'                    => 1,
1105          'selected'                => 0,
1106          'name'                    => 'user',
1107          'class'                   => '',
1108          'id'                      => '',
1109          'blog_id'                 => get_current_blog_id(),
1110          'who'                     => '',
1111          'include_selected'        => false,
1112          'option_none_value'       => -1,
1113          'role'                    => '',
1114          'role__in'                => array(),
1115          'role__not_in'            => array(),
1116      );
1117  
1118      $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
1119  
1120      $parsed_args = wp_parse_args( $args, $defaults );
1121  
1122      $query_args = wp_array_slice_assoc( $parsed_args, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who', 'role', 'role__in', 'role__not_in' ) );
1123  
1124      $fields = array( 'ID', 'user_login' );
1125  
1126      $show = ! empty( $parsed_args['show'] ) ? $parsed_args['show'] : 'display_name';
1127      if ( 'display_name_with_login' === $show ) {
1128          $fields[] = 'display_name';
1129      } else {
1130          $fields[] = $show;
1131      }
1132  
1133      $query_args['fields'] = $fields;
1134  
1135      $show_option_all   = $parsed_args['show_option_all'];
1136      $show_option_none  = $parsed_args['show_option_none'];
1137      $option_none_value = $parsed_args['option_none_value'];
1138  
1139      /**
1140       * Filters the query arguments for the list of users in the dropdown.
1141       *
1142       * @since 4.4.0
1143       *
1144       * @param array $query_args The query arguments for get_users().
1145       * @param array $parsed_args          The arguments passed to wp_dropdown_users() combined with the defaults.
1146       */
1147      $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $parsed_args );
1148  
1149      $users = get_users( $query_args );
1150  
1151      $output = '';
1152      if ( ! empty( $users ) && ( empty( $parsed_args['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
1153          $name = esc_attr( $parsed_args['name'] );
1154          if ( $parsed_args['multi'] && ! $parsed_args['id'] ) {
1155              $id = '';
1156          } else {
1157              $id = $parsed_args['id'] ? " id='" . esc_attr( $parsed_args['id'] ) . "'" : " id='$name'";
1158          }
1159          $output = "<select name='{$name}'{$id} class='" . $parsed_args['class'] . "'>\n";
1160  
1161          if ( $show_option_all ) {
1162              $output .= "\t<option value='0'>$show_option_all</option>\n";
1163          }
1164  
1165          if ( $show_option_none ) {
1166              $_selected = selected( $option_none_value, $parsed_args['selected'], false );
1167              $output   .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n";
1168          }
1169  
1170          if ( $parsed_args['include_selected'] && ( $parsed_args['selected'] > 0 ) ) {
1171              $found_selected          = false;
1172              $parsed_args['selected'] = (int) $parsed_args['selected'];
1173              foreach ( (array) $users as $user ) {
1174                  $user->ID = (int) $user->ID;
1175                  if ( $user->ID === $parsed_args['selected'] ) {
1176                      $found_selected = true;
1177                  }
1178              }
1179  
1180              if ( ! $found_selected ) {
1181                  $users[] = get_userdata( $parsed_args['selected'] );
1182              }
1183          }
1184  
1185          foreach ( (array) $users as $user ) {
1186              if ( 'display_name_with_login' === $show ) {
1187                  /* translators: 1: User's display name, 2: User login. */
1188                  $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login );
1189              } elseif ( ! empty( $user->$show ) ) {
1190                  $display = $user->$show;
1191              } else {
1192                  $display = '(' . $user->user_login . ')';
1193              }
1194  
1195              $_selected = selected( $user->ID, $parsed_args['selected'], false );
1196              $output   .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
1197          }
1198  
1199          $output .= '</select>';
1200      }
1201  
1202      /**
1203       * Filters the wp_dropdown_users() HTML output.
1204       *
1205       * @since 2.3.0
1206       *
1207       * @param string $output HTML output generated by wp_dropdown_users().
1208       */
1209      $html = apply_filters( 'wp_dropdown_users', $output );
1210  
1211      if ( $parsed_args['echo'] ) {
1212          echo $html;
1213      }
1214      return $html;
1215  }
1216  
1217  /**
1218   * Sanitize user field based on context.
1219   *
1220   * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1221   * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1222   * when calling filters.
1223   *
1224   * @since 2.3.0
1225   *
1226   * @param string $field   The user Object field name.
1227   * @param mixed  $value   The user Object value.
1228   * @param int    $user_id User ID.
1229   * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
1230   *                        'attribute' and 'js'.
1231   * @return mixed Sanitized value.
1232   */
1233  function sanitize_user_field( $field, $value, $user_id, $context ) {
1234      $int_fields = array( 'ID' );
1235      if ( in_array( $field, $int_fields ) ) {
1236          $value = (int) $value;
1237      }
1238  
1239      if ( 'raw' == $context ) {
1240          return $value;
1241      }
1242  
1243      if ( ! is_string( $value ) && ! is_numeric( $value ) ) {
1244          return $value;
1245      }
1246  
1247      $prefixed = false !== strpos( $field, 'user_' );
1248  
1249      if ( 'edit' == $context ) {
1250          if ( $prefixed ) {
1251  
1252              /** This filter is documented in wp-includes/post.php */
1253              $value = apply_filters( "edit_{$field}", $value, $user_id );
1254          } else {
1255  
1256              /**
1257               * Filters a user field value in the 'edit' context.
1258               *
1259               * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1260               * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1261               *
1262               * @since 2.9.0
1263               *
1264               * @param mixed $value   Value of the prefixed user field.
1265               * @param int   $user_id User ID.
1266               */
1267              $value = apply_filters( "edit_user_{$field}", $value, $user_id );
1268          }
1269  
1270          if ( 'description' == $field ) {
1271              $value = esc_html( $value ); // textarea_escaped?
1272          } else {
1273              $value = esc_attr( $value );
1274          }
1275      } elseif ( 'db' == $context ) {
1276          if ( $prefixed ) {
1277              /** This filter is documented in wp-includes/post.php */
1278              $value = apply_filters( "pre_{$field}", $value );
1279          } else {
1280  
1281              /**
1282               * Filters the value of a user field in the 'db' context.
1283               *
1284               * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1285               * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1286               *
1287               * @since 2.9.0
1288               *
1289               * @param mixed $value Value of the prefixed user field.
1290               */
1291              $value = apply_filters( "pre_user_{$field}", $value );
1292          }
1293      } else {
1294          // Use display filters by default.
1295          if ( $prefixed ) {
1296  
1297              /** This filter is documented in wp-includes/post.php */
1298              $value = apply_filters( "{$field}", $value, $user_id, $context );
1299          } else {
1300  
1301              /**
1302               * Filters the value of a user field in a standard context.
1303               *
1304               * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1305               * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1306               *
1307               * @since 2.9.0
1308               *
1309               * @param mixed  $value   The user object value to sanitize.
1310               * @param int    $user_id User ID.
1311               * @param string $context The context to filter within.
1312               */
1313              $value = apply_filters( "user_{$field}", $value, $user_id, $context );
1314          }
1315      }
1316  
1317      if ( 'user_url' == $field ) {
1318          $value = esc_url( $value );
1319      }
1320  
1321      if ( 'attribute' == $context ) {
1322          $value = esc_attr( $value );
1323      } elseif ( 'js' == $context ) {
1324          $value = esc_js( $value );
1325      }
1326      return $value;
1327  }
1328  
1329  /**
1330   * Update all user caches
1331   *
1332   * @since 3.0.0
1333   *
1334   * @param WP_User $user User object to be cached
1335   * @return bool|null Returns false on failure.
1336   */
1337  function update_user_caches( $user ) {
1338      if ( $user instanceof WP_User ) {
1339          if ( ! $user->exists() ) {
1340              return false;
1341          }
1342  
1343          $user = $user->data;
1344      }
1345  
1346      wp_cache_add( $user->ID, $user, 'users' );
1347      wp_cache_add( $user->user_login, $user->ID, 'userlogins' );
1348      wp_cache_add( $user->user_email, $user->ID, 'useremail' );
1349      wp_cache_add( $user->user_nicename, $user->ID, 'userslugs' );
1350  }
1351  
1352  /**
1353   * Clean all user caches
1354   *
1355   * @since 3.0.0
1356   * @since 4.4.0 'clean_user_cache' action was added.
1357   *
1358   * @param WP_User|int $user User object or ID to be cleaned from the cache
1359   */
1360  function clean_user_cache( $user ) {
1361      if ( is_numeric( $user ) ) {
1362          $user = new WP_User( $user );
1363      }
1364  
1365      if ( ! $user->exists() ) {
1366          return;
1367      }
1368  
1369      wp_cache_delete( $user->ID, 'users' );
1370      wp_cache_delete( $user->user_login, 'userlogins' );
1371      wp_cache_delete( $user->user_email, 'useremail' );
1372      wp_cache_delete( $user->user_nicename, 'userslugs' );
1373  
1374      /**
1375       * Fires immediately after the given user's cache is cleaned.
1376       *
1377       * @since 4.4.0
1378       *
1379       * @param int     $user_id User ID.
1380       * @param WP_User $user    User object.
1381       */
1382      do_action( 'clean_user_cache', $user->ID, $user );
1383  }
1384  
1385  /**
1386   * Determines whether the given username exists.
1387   *
1388   * For more information on this and similar theme functions, check out
1389   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
1390   * Conditional Tags} article in the Theme Developer Handbook.
1391   *
1392   * @since 2.0.0
1393   *
1394   * @param string $username Username.
1395   * @return int|false The user's ID on success, and false on failure.
1396   */
1397  function username_exists( $username ) {
1398      $user = get_user_by( 'login', $username );
1399      if ( $user ) {
1400          $user_id = $user->ID;
1401      } else {
1402          $user_id = false;
1403      }
1404  
1405      /**
1406       * Filters whether the given username exists or not.
1407       *
1408       * @since 4.9.0
1409       *
1410       * @param int|false $user_id  The user's ID on success, and false on failure.
1411       * @param string    $username Username to check.
1412       */
1413      return apply_filters( 'username_exists', $user_id, $username );
1414  }
1415  
1416  /**
1417   * Determines whether the given email exists.
1418   *
1419   * For more information on this and similar theme functions, check out
1420   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
1421   * Conditional Tags} article in the Theme Developer Handbook.
1422   *
1423   * @since 2.1.0
1424   *
1425   * @param string $email Email.
1426   * @return int|false The user's ID on success, and false on failure.
1427   */
1428  function email_exists( $email ) {
1429      $user = get_user_by( 'email', $email );
1430      if ( $user ) {
1431          return $user->ID;
1432      }
1433      return false;
1434  }
1435  
1436  /**
1437   * Checks whether a username is valid.
1438   *
1439   * @since 2.0.1
1440   * @since 4.4.0 Empty sanitized usernames are now considered invalid
1441   *
1442   * @param string $username Username.
1443   * @return bool Whether username given is valid
1444   */
1445  function validate_username( $username ) {
1446      $sanitized = sanitize_user( $username, true );
1447      $valid     = ( $sanitized == $username && ! empty( $sanitized ) );
1448  
1449      /**
1450       * Filters whether the provided username is valid or not.
1451       *
1452       * @since 2.0.1
1453       *
1454       * @param bool   $valid    Whether given username is valid.
1455       * @param string $username Username to check.
1456       */
1457      return apply_filters( 'validate_username', $valid, $username );
1458  }
1459  
1460  /**
1461   * Insert a user into the database.
1462   *
1463   * Most of the `$userdata` array fields have filters associated with the values. Exceptions are
1464   * 'ID', 'rich_editing', 'syntax_highlighting', 'comment_shortcuts', 'admin_color', 'use_ssl',
1465   * 'user_registered', 'user_activation_key', 'spam', and 'role'. The filters have the prefix
1466   * 'pre_user_' followed by the field name. An example using 'description' would have the filter
1467   * called 'pre_user_description' that can be hooked into.
1468   *
1469   * @since 2.0.0
1470   * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact
1471   *              methods for new installations. See wp_get_user_contact_methods().
1472   * @since 4.7.0 The user's locale can be passed to `$userdata`.
1473   * @since 5.3.0 The `user_activation_key` field can be passed to `$userdata`.
1474   * @since 5.3.0 The `spam` field can be passed to `$userdata` (Multisite only).
1475   *
1476   * @global wpdb $wpdb WordPress database abstraction object.
1477   *
1478   * @param array|object|WP_User $userdata {
1479   *     An array, object, or WP_User object of user data arguments.
1480   *
1481   *     @type int         $ID                   User ID. If supplied, the user will be updated.
1482   *     @type string      $user_pass            The plain-text user password.
1483   *     @type string      $user_login           The user's login username.
1484   *     @type string      $user_nicename        The URL-friendly user name.
1485   *     @type string      $user_url             The user URL.
1486   *     @type string      $user_email           The user email address.
1487   *     @type string      $display_name         The user's display name.
1488   *                                             Default is the user's username.
1489   *     @type string      $nickname             The user's nickname.
1490   *                                             Default is the user's username.
1491   *     @type string      $first_name           The user's first name. For new users, will be used
1492   *                                             to build the first part of the user's display name
1493   *                                             if `$display_name` is not specified.
1494   *     @type string      $last_name            The user's last name. For new users, will be used
1495   *                                             to build the second part of the user's display name
1496   *                                             if `$display_name` is not specified.
1497   *     @type string      $description          The user's biographical description.
1498   *     @type string|bool $rich_editing         Whether to enable the rich-editor for the user.
1499   *                                             False if not empty.
1500   *     @type string|bool $syntax_highlighting  Whether to enable the rich code editor for the user.
1501   *                                             False if not empty.
1502   *     @type string|bool $comment_shortcuts    Whether to enable comment moderation keyboard
1503   *                                             shortcuts for the user. Default false.
1504   *     @type string      $admin_color          Admin color scheme for the user. Default 'fresh'.
1505   *     @type bool        $use_ssl              Whether the user should always access the admin over
1506   *                                             https. Default false.
1507   *     @type string      $user_registered      Date the user registered. Format is 'Y-m-d H:i:s'.
1508   *     @type string      $user_activation_key  Password reset key. Default empty.
1509   *     @type bool        $spam                 Multisite only. Whether the user is marked as spam.
1510   *                                             Default false.
1511   *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
1512   *                                             site's front end. Default true.
1513   *     @type string      $role                 User's role.
1514   *     @type string      $locale               User's locale. Default empty.
1515   * }
1516   * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1517   *                      be created.
1518   */
1519  function wp_insert_user( $userdata ) {
1520      global $wpdb;
1521  
1522      if ( $userdata instanceof stdClass ) {
1523          $userdata = get_object_vars( $userdata );
1524      } elseif ( $userdata instanceof WP_User ) {
1525          $userdata = $userdata->to_array();
1526      }
1527  
1528      // Are we updating or creating?
1529      if ( ! empty( $userdata['ID'] ) ) {
1530          $ID            = (int) $userdata['ID'];
1531          $update        = true;
1532          $old_user_data = get_userdata( $ID );
1533  
1534          if ( ! $old_user_data ) {
1535              return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1536          }
1537  
1538          // hashed in wp_update_user(), plaintext if called directly
1539          $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass;
1540      } else {
1541          $update = false;
1542          // Hash the password
1543          $user_pass = wp_hash_password( $userdata['user_pass'] );
1544      }
1545  
1546      $sanitized_user_login = sanitize_user( $userdata['user_login'], true );
1547  
1548      /**
1549       * Filters a username after it has been sanitized.
1550       *
1551       * This filter is called before the user is created or updated.
1552       *
1553       * @since 2.0.3
1554       *
1555       * @param string $sanitized_user_login Username after it has been sanitized.
1556       */
1557      $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login );
1558  
1559      //Remove any non-printable chars from the login string to see if we have ended up with an empty username
1560      $user_login = trim( $pre_user_login );
1561  
1562      // user_login must be between 0 and 60 characters.
1563      if ( empty( $user_login ) ) {
1564          return new WP_Error( 'empty_user_login', __( 'Cannot create a user with an empty login name.' ) );
1565      } elseif ( mb_strlen( $user_login ) > 60 ) {
1566          return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) );
1567      }
1568  
1569      if ( ! $update && username_exists( $user_login ) ) {
1570          return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
1571      }
1572  
1573      /**
1574       * Filters the list of blacklisted usernames.
1575       *
1576       * @since 4.4.0
1577       *
1578       * @param array $usernames Array of blacklisted usernames.
1579       */
1580      $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
1581  
1582      if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ) ) ) {
1583          return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) );
1584      }
1585  
1586      /*
1587       * If a nicename is provided, remove unsafe user characters before using it.
1588       * Otherwise build a nicename from the user_login.
1589       */
1590      if ( ! empty( $userdata['user_nicename'] ) ) {
1591          $user_nicename = sanitize_user( $userdata['user_nicename'], true );
1592          if ( mb_strlen( $user_nicename ) > 50 ) {
1593              return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) );
1594          }
1595      } else {
1596          $user_nicename = mb_substr( $user_login, 0, 50 );
1597      }
1598  
1599      $user_nicename = sanitize_title( $user_nicename );
1600  
1601      /**
1602       * Filters a user's nicename before the user is created or updated.
1603       *
1604       * @since 2.0.3
1605       *
1606       * @param string $user_nicename The user's nicename.
1607       */
1608      $user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
1609  
1610      $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 ) );
1611  
1612      if ( $user_nicename_check ) {
1613          $suffix = 2;
1614          while ( $user_nicename_check ) {
1615              // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix.
1616              $base_length         = 49 - mb_strlen( $suffix );
1617              $alt_user_nicename   = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix";
1618              $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 ) );
1619              $suffix++;
1620          }
1621          $user_nicename = $alt_user_nicename;
1622      }
1623  
1624      $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email'];
1625  
1626      /**
1627       * Filters a user's email before the user is created or updated.
1628       *
1629       * @since 2.0.3
1630       *
1631       * @param string $raw_user_email The user's email.
1632       */
1633      $user_email = apply_filters( 'pre_user_email', $raw_user_email );
1634  
1635      /*
1636       * If there is no update, just check for `email_exists`. If there is an update,
1637       * check if current email and new email are the same, or not, and check `email_exists`
1638       * accordingly.
1639       */
1640      if ( ( ! $update || ( ! empty( $old_user_data ) && 0 !== strcasecmp( $user_email, $old_user_data->user_email ) ) )
1641          && ! defined( 'WP_IMPORTING' )
1642          && email_exists( $user_email )
1643      ) {
1644          return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
1645      }
1646  
1647      $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url'];
1648  
1649      /**
1650       * Filters a user's URL before the user is created or updated.
1651       *
1652       * @since 2.0.3
1653       *
1654       * @param string $raw_user_url The user's URL.
1655       */
1656      $user_url = apply_filters( 'pre_user_url', $raw_user_url );
1657  
1658      $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered'];
1659  
1660      $user_activation_key = empty( $userdata['user_activation_key'] ) ? '' : $userdata['user_activation_key'];
1661  
1662      if ( ! empty( $userdata['spam'] ) && ! is_multisite() ) {
1663          return new WP_Error( 'no_spam', __( 'Sorry, marking a user as spam is only supported on Multisite.' ) );
1664      }
1665  
1666      $spam = empty( $userdata['spam'] ) ? 0 : (bool) $userdata['spam'];
1667  
1668      // Store values to save in user meta.
1669      $meta = array();
1670  
1671      $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname'];
1672  
1673      /**
1674       * Filters a user's nickname before the user is created or updated.
1675       *
1676       * @since 2.0.3
1677       *
1678       * @param string $nickname The user's nickname.
1679       */
1680      $meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname );
1681  
1682      $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name'];
1683  
1684      /**
1685       * Filters a user's first name before the user is created or updated.
1686       *
1687       * @since 2.0.3
1688       *
1689       * @param string $first_name The user's first name.
1690       */
1691      $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name );
1692  
1693      $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name'];
1694  
1695      /**
1696       * Filters a user's last name before the user is created or updated.
1697       *
1698       * @since 2.0.3
1699       *
1700       * @param string $last_name The user's last name.
1701       */
1702      $meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name );
1703  
1704      if ( empty( $userdata['display_name'] ) ) {
1705          if ( $update ) {
1706              $display_name = $user_login;
1707          } elseif ( $meta['first_name'] && $meta['last_name'] ) {
1708              /* translators: 1: User's first name, 2: Last name. */
1709              $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $meta['first_name'], $meta['last_name'] );
1710          } elseif ( $meta['first_name'] ) {
1711              $display_name = $meta['first_name'];
1712          } elseif ( $meta['last_name'] ) {
1713              $display_name = $meta['last_name'];
1714          } else {
1715              $display_name = $user_login;
1716          }
1717      } else {
1718          $display_name = $userdata['display_name'];
1719      }
1720  
1721      /**
1722       * Filters a user's display name before the user is created or updated.
1723       *
1724       * @since 2.0.3
1725       *
1726       * @param string $display_name The user's display name.
1727       */
1728      $display_name = apply_filters( 'pre_user_display_name', $display_name );
1729  
1730      $description = empty( $userdata['description'] ) ? '' : $userdata['description'];
1731  
1732      /**
1733       * Filters a user's description before the user is created or updated.
1734       *
1735       * @since 2.0.3
1736       *
1737       * @param string $description The user's description.
1738       */
1739      $meta['description'] = apply_filters( 'pre_user_description', $description );
1740  
1741      $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing'];
1742  
1743      $meta['syntax_highlighting'] = empty( $userdata['syntax_highlighting'] ) ? 'true' : $userdata['syntax_highlighting'];
1744  
1745      $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true';
1746  
1747      $admin_color         = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color'];
1748      $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color );
1749  
1750      $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : (bool) $userdata['use_ssl'];
1751  
1752      $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front'];
1753  
1754      $meta['locale'] = isset( $userdata['locale'] ) ? $userdata['locale'] : '';
1755  
1756      $compacted = compact( 'user_pass', 'user_nicename', 'user_email', 'user_url', 'user_registered', 'user_activation_key', 'display_name' );
1757      $data      = wp_unslash( $compacted );
1758  
1759      if ( ! $update ) {
1760          $data = $data + compact( 'user_login' );
1761      }
1762  
1763      if ( is_multisite() ) {
1764          $data = $data + compact( 'spam' );
1765      }
1766  
1767      /**
1768       * Filters user data before the record is created or updated.
1769       *
1770       * It only includes data in the wp_users table wp_user, not any user metadata.
1771       *
1772       * @since 4.9.0
1773       *
1774       * @param array    $data {
1775       *     Values and keys for the user.
1776       *
1777       *     @type string $user_login      The user's login. Only included if $update == false
1778       *     @type string $user_pass       The user's password.
1779       *     @type string $user_email      The user's email.
1780       *     @type string $user_url        The user's url.
1781       *     @type string $user_nicename   The user's nice name. Defaults to a URL-safe version of user's login
1782       *     @type string $display_name    The user's display name.
1783       *     @type string $user_registered MySQL timestamp describing the moment when the user registered. Defaults to
1784       *                                   the current UTC timestamp.
1785       * }
1786       * @param bool     $update Whether the user is being updated rather than created.
1787       * @param int|null $id     ID of the user to be updated, or NULL if the user is being created.
1788       */
1789      $data = apply_filters( 'wp_pre_insert_user_data', $data, $update, $update ? (int) $ID : null );
1790  
1791      if ( empty( $data ) || ! is_array( $data ) ) {
1792          return new WP_Error( 'empty_data', __( 'Not enough data to create this user.' ) );
1793      }
1794  
1795      if ( $update ) {
1796          if ( $user_email !== $old_user_data->user_email ) {
1797              $data['user_activation_key'] = '';
1798          }
1799          $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
1800          $user_id = (int) $ID;
1801      } else {
1802          $wpdb->insert( $wpdb->users, $data );
1803          $user_id = (int) $wpdb->insert_id;
1804      }
1805  
1806      $user = new WP_User( $user_id );
1807  
1808      /**
1809       * Filters a user's meta values and keys immediately after the user is created or updated
1810       * and before any user meta is inserted or updated.
1811       *
1812       * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`.
1813       *
1814       * @since 4.4.0
1815       *
1816       * @param array $meta {
1817       *     Default meta values and keys for the user.
1818       *
1819       *     @type string   $nickname             The user's nickname. Default is the user's username.
1820       *     @type string   $first_name           The user's first name.
1821       *     @type string   $last_name            The user's last name.
1822       *     @type string   $description          The user's description.
1823       *     @type bool     $rich_editing         Whether to enable the rich-editor for the user. False if not empty.
1824       *     @type bool     $syntax_highlighting  Whether to enable the rich code editor for the user. False if not empty.
1825       *     @type bool     $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default false.
1826       *     @type string   $admin_color          The color scheme for a user's admin screen. Default 'fresh'.
1827       *     @type int|bool $use_ssl              Whether to force SSL on the user's admin area. 0|false if SSL is
1828       *                                          not forced.
1829       *     @type bool     $show_admin_bar_front Whether to show the admin bar on the front end for the user.
1830       *                                          Default true.
1831       *     @type string   $locale               User's locale. Default empty.
1832       * }
1833       * @param WP_User $user   User object.
1834       * @param bool    $update Whether the user is being updated rather than created.
1835       */
1836      $meta = apply_filters( 'insert_user_meta', $meta, $user, $update );
1837  
1838      // Update user meta.
1839      foreach ( $meta as $key => $value ) {
1840          update_user_meta( $user_id, $key, $value );
1841      }
1842  
1843      foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) {
1844          if ( isset( $userdata[ $key ] ) ) {
1845              update_user_meta( $user_id, $key, $userdata[ $key ] );
1846          }
1847      }
1848  
1849      if ( isset( $userdata['role'] ) ) {
1850          $user->set_role( $userdata['role'] );
1851      } elseif ( ! $update ) {
1852          $user->set_role( get_option( 'default_role' ) );
1853      }
1854  
1855      clean_user_cache( $user_id );
1856  
1857      if ( $update ) {
1858          /**
1859           * Fires immediately after an existing user is updated.
1860           *
1861           * @since 2.0.0
1862           *
1863           * @param int     $user_id       User ID.
1864           * @param WP_User $old_user_data Object containing user's data prior to update.
1865           */
1866          do_action( 'profile_update', $user_id, $old_user_data );
1867  
1868          if ( isset( $userdata['spam'] ) && $userdata['spam'] != $old_user_data->spam ) {
1869              if ( $userdata['spam'] == 1 ) {
1870                  /**
1871                   * Fires after the user is marked as a SPAM user.
1872                   *
1873                   * @since 3.0.0
1874                   *
1875                   * @param int $user_id ID of the user marked as SPAM.
1876                   */
1877                  do_action( 'make_spam_user', $user_id );
1878              } else {
1879                  /**
1880                   * Fires after the user is marked as a HAM user. Opposite of SPAM.
1881                   *
1882                   * @since 3.0.0
1883                   *
1884                   * @param int $user_id ID of the user marked as HAM.
1885                   */
1886                  do_action( 'make_ham_user', $user_id );
1887              }
1888          }
1889      } else {
1890          /**
1891           * Fires immediately after a new user is registered.
1892           *
1893           * @since 1.5.0
1894           *
1895           * @param int $user_id User ID.
1896           */
1897          do_action( 'user_register', $user_id );
1898      }
1899  
1900      return $user_id;
1901  }
1902  
1903  /**
1904   * Update a user in the database.
1905   *
1906   * It is possible to update a user's password by specifying the 'user_pass'
1907   * value in the $userdata parameter array.
1908   *
1909   * If current user's password is being updated, then the cookies will be
1910   * cleared.
1911   *
1912   * @since 2.0.0
1913   *
1914   * @see wp_insert_user() For what fields can be set in $userdata.
1915   *
1916   * @param array|object|WP_User $userdata An array of user data or a user object of type stdClass or WP_User.
1917   * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
1918   */
1919  function wp_update_user( $userdata ) {
1920      if ( $userdata instanceof stdClass ) {
1921          $userdata = get_object_vars( $userdata );
1922      } elseif ( $userdata instanceof WP_User ) {
1923          $userdata = $userdata->to_array();
1924      }
1925  
1926      $ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
1927      if ( ! $ID ) {
1928          return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1929      }
1930  
1931      // First, get all of the original fields
1932      $user_obj = get_userdata( $ID );
1933      if ( ! $user_obj ) {
1934          return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1935      }
1936  
1937      $user = $user_obj->to_array();
1938  
1939      // Add additional custom fields
1940      foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
1941          $user[ $key ] = get_user_meta( $ID, $key, true );
1942      }
1943  
1944      // Escape data pulled from DB.
1945      $user = add_magic_quotes( $user );
1946  
1947      if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) {
1948          // If password is changing, hash it now
1949          $plaintext_pass        = $userdata['user_pass'];
1950          $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] );
1951  
1952          /**
1953           * Filters whether to send the password change email.
1954           *
1955           * @since 4.3.0
1956           *
1957           * @see wp_insert_user() For `$user` and `$userdata` fields.
1958           *
1959           * @param bool  $send     Whether to send the email.
1960           * @param array $user     The original user array.
1961           * @param array $userdata The updated user array.
1962           */
1963          $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata );
1964      }
1965  
1966      if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) {
1967          /**
1968           * Filters whether to send the email change email.
1969           *
1970           * @since 4.3.0
1971           *
1972           * @see wp_insert_user() For `$user` and `$userdata` fields.
1973           *
1974           * @param bool  $send     Whether to send the email.
1975           * @param array $user     The original user array.
1976           * @param array $userdata The updated user array.
1977           */
1978          $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata );
1979      }
1980  
1981      clean_user_cache( $user_obj );
1982  
1983      // Merge old and new fields with new fields overwriting old ones.
1984      $userdata = array_merge( $user, $userdata );
1985      $user_id  = wp_insert_user( $userdata );
1986  
1987      if ( ! is_wp_error( $user_id ) ) {
1988  
1989          $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
1990  
1991          $switched_locale = false;
1992          if ( ! empty( $send_password_change_email ) || ! empty( $send_email_change_email ) ) {
1993              $switched_locale = switch_to_locale( get_user_locale( $user_id ) );
1994          }
1995  
1996          if ( ! empty( $send_password_change_email ) ) {
1997              /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1998              $pass_change_text = __(
1999                  'Hi ###USERNAME###,
2000  
2001  This notice confirms that your password was changed on ###SITENAME###.
2002  
2003  If you did not change your password, please contact the Site Administrator at
2004  ###ADMIN_EMAIL###
2005  
2006  This email has been sent to ###EMAIL###
2007  
2008  Regards,
2009  All at ###SITENAME###
2010  ###SITEURL###'
2011              );
2012  
2013              $pass_change_email = array(
2014                  'to'      => $user['user_email'],
2015                  /* translators: Password change notification email subject. %s: Site title. */
2016                  'subject' => __( '[%s] Password Changed' ),
2017                  'message' => $pass_change_text,
2018                  'headers' => '',
2019              );
2020  
2021              /**
2022               * Filters the contents of the email sent when the user's password is changed.
2023               *
2024               * @since 4.3.0
2025               *
2026               * @param array $pass_change_email {
2027               *            Used to build wp_mail().
2028               *            @type string $to      The intended recipients. Add emails in a comma separated string.
2029               *            @type string $subject The subject of the email.
2030               *            @type string $message The content of the email.
2031               *                The following strings have a special meaning and will get replaced dynamically:
2032               *                - ###USERNAME###    The current user's username.
2033               *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
2034               *                - ###EMAIL###       The user's email address.
2035               *                - ###SITENAME###    The name of the site.
2036               *                - ###SITEURL###     The URL to the site.
2037               *            @type string $headers Headers. Add headers in a newline (\r\n) separated string.
2038               *        }
2039               * @param array $user     The original user array.
2040               * @param array $userdata The updated user array.
2041               */
2042              $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata );
2043  
2044              $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] );
2045              $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] );
2046              $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] );
2047              $pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] );
2048              $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] );
2049  
2050              wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] );
2051          }
2052  
2053          if ( ! empty( $send_email_change_email ) ) {
2054              /* translators: Do not translate USERNAME, ADMIN_EMAIL, NEW_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
2055              $email_change_text = __(
2056                  'Hi ###USERNAME###,
2057  
2058  This notice confirms that your email address on ###SITENAME### was changed to ###NEW_EMAIL###.
2059  
2060  If you did not change your email, please contact the Site Administrator at
2061  ###ADMIN_EMAIL###
2062  
2063  This email has been sent to ###EMAIL###
2064  
2065  Regards,
2066  All at ###SITENAME###
2067  ###SITEURL###'
2068              );
2069  
2070              $email_change_email = array(
2071                  'to'      => $user['user_email'],
2072                  /* translators: Email change notification email subject. %s: Site title. */
2073                  'subject' => __( '[%s] Email Changed' ),
2074                  'message' => $email_change_text,
2075                  'headers' => '',
2076              );
2077  
2078              /**
2079               * Filters the contents of the email sent when the user's email is changed.
2080               *
2081               * @since 4.3.0
2082               *
2083               * @param array $email_change_email {
2084               *            Used to build wp_mail().
2085               *            @type string $to      The intended recipients.
2086               *            @type string $subject The subject of the email.
2087               *            @type string $message The content of the email.
2088               *                The following strings have a special meaning and will get replaced dynamically:
2089               *                - ###USERNAME###    The current user's username.
2090               *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
2091               *                - ###NEW_EMAIL###   The new email address.
2092               *                - ###EMAIL###       The old email address.
2093               *                - ###SITENAME###    The name of the site.
2094               *                - ###SITEURL###     The URL to the site.
2095               *            @type string $headers Headers.
2096               *        }
2097               * @param array $user The original user array.
2098               * @param array $userdata The updated user array.
2099               */
2100              $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata );
2101  
2102              $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] );
2103              $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] );
2104              $email_change_email['message'] = str_replace( '###NEW_EMAIL###', $userdata['user_email'], $email_change_email['message'] );
2105              $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] );
2106              $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] );
2107              $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );
2108  
2109              wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] );
2110          }
2111  
2112          if ( $switched_locale ) {
2113              restore_previous_locale();
2114          }
2115      }
2116  
2117      // Update the cookies if the password changed.
2118      $current_user = wp_get_current_user();
2119      if ( $current_user->ID == $ID ) {
2120          if ( isset( $plaintext_pass ) ) {
2121              wp_clear_auth_cookie();
2122  
2123              // Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
2124              // If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
2125              $logged_in_cookie = wp_parse_auth_cookie( '', 'logged_in' );
2126              /** This filter is documented in wp-includes/pluggable.php */
2127              $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false );
2128              $remember            = false;
2129              if ( false !== $logged_in_cookie && ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life ) {
2130                  $remember = true;
2131              }
2132  
2133              wp_set_auth_cookie( $ID, $remember );
2134          }
2135      }
2136  
2137      return $user_id;
2138  }
2139  
2140  /**
2141   * A simpler way of inserting a user into the database.
2142   *
2143   * Creates a new user with just the username, password, and email. For more
2144   * complex user creation use wp_insert_user() to specify more information.
2145   *
2146   * @since 2.0.0
2147   * @see wp_insert_user() More complete way to create a new user
2148   *
2149   * @param string $username The user's username.
2150   * @param string $password The user's password.
2151   * @param string $email    Optional. The user's email. Default empty.
2152   * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
2153   *                      be created.
2154   */
2155  function wp_create_user( $username, $password, $email = '' ) {
2156      $user_login = wp_slash( $username );
2157      $user_email = wp_slash( $email );
2158      $user_pass  = $password;
2159  
2160      $userdata = compact( 'user_login', 'user_email', 'user_pass' );
2161      return wp_insert_user( $userdata );
2162  }
2163  
2164  /**
2165   * Returns a list of meta keys to be (maybe) populated in wp_update_user().
2166   *
2167   * The list of keys returned via this function are dependent on the presence
2168   * of those keys in the user meta data to be set.
2169   *
2170   * @since 3.3.0
2171   * @access private
2172   *
2173   * @param WP_User $user WP_User instance.
2174   * @return array List of user keys to be populated in wp_update_user().
2175   */
2176  function _get_additional_user_keys( $user ) {
2177      $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'syntax_highlighting', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front', 'locale' );
2178      return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
2179  }
2180  
2181  /**
2182   * Set up the user contact methods.
2183   *
2184   * Default contact methods were removed in 3.6. A filter dictates contact methods.
2185   *
2186   * @since 3.7.0
2187   *
2188   * @param WP_User $user Optional. WP_User object.
2189   * @return array Array of contact methods and their labels.
2190   */
2191  function wp_get_user_contact_methods( $user = null ) {
2192      $methods = array();
2193      if ( get_site_option( 'initial_db_version' ) < 23588 ) {
2194          $methods = array(
2195              'aim'    => __( 'AIM' ),
2196              'yim'    => __( 'Yahoo IM' ),
2197              'jabber' => __( 'Jabber / Google Talk' ),
2198          );
2199      }
2200  
2201      /**
2202       * Filters the user contact methods.
2203       *
2204       * @since 2.9.0
2205       *
2206       * @param array   $methods Array of contact methods and their labels.
2207       * @param WP_User $user    WP_User object.
2208       */
2209      return apply_filters( 'user_contactmethods', $methods, $user );
2210  }
2211  
2212  /**
2213   * The old private function for setting up user contact methods.
2214   *
2215   * Use wp_get_user_contact_methods() instead.
2216   *
2217   * @since 2.9.0
2218   * @access private
2219   *
2220   * @param WP_User $user Optional. WP_User object. Default null.
2221   * @return array Array of contact methods and their labels.
2222   */
2223  function _wp_get_user_contactmethods( $user = null ) {
2224      return wp_get_user_contact_methods( $user );
2225  }
2226  
2227  /**
2228   * Gets the text suggesting how to create strong passwords.
2229   *
2230   * @since 4.1.0
2231   *
2232   * @return string The password hint text.
2233   */
2234  function wp_get_password_hint() {
2235      $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; ).' );
2236  
2237      /**
2238       * Filters the text describing the site's password complexity policy.
2239       *
2240       * @since 4.1.0
2241       *
2242       * @param string $hint The password hint text.
2243       */
2244      return apply_filters( 'password_hint', $hint );
2245  }
2246  
2247  /**
2248   * Creates, stores, then returns a password reset key for user.
2249   *
2250   * @since 4.4.0
2251   *
2252   * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
2253   *
2254   * @param WP_User $user User to retrieve password reset key for.
2255   *
2256   * @return string|WP_Error Password reset key on success. WP_Error on error.
2257   */
2258  function get_password_reset_key( $user ) {
2259      global $wp_hasher;
2260  
2261      if ( ! ( $user instanceof WP_User ) ) {
2262          return new WP_Error( 'invalidcombo', __( '<strong>ERROR</strong>: There is no account with that username or email address.' ) );
2263      }
2264  
2265      /**
2266       * Fires before a new password is retrieved.
2267       *
2268       * Use the {@see 'retrieve_password'} hook instead.
2269       *
2270       * @since 1.5.0
2271       * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
2272       *
2273       * @param string $user_login The user login name.
2274       */
2275      do_action( 'retreive_password', $user->user_login );
2276  
2277      /**
2278       * Fires before a new password is retrieved.
2279       *
2280       * @since 1.5.1
2281       *
2282       * @param string $user_login The user login name.
2283       */
2284      do_action( 'retrieve_password', $user->user_login );
2285  
2286      $allow = true;
2287      if ( is_multisite() && is_user_spammy( $user ) ) {
2288          $allow = false;
2289      }
2290  
2291      /**
2292       * Filters whether to allow a password to be reset.
2293       *
2294       * @since 2.7.0
2295       *
2296       * @param bool $allow         Whether to allow the password to be reset. Default true.
2297       * @param int  $user_data->ID The ID of the user attempting to reset a password.
2298       */
2299      $allow = apply_filters( 'allow_password_reset', $allow, $user->ID );
2300  
2301      if ( ! $allow ) {
2302          return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );
2303      } elseif ( is_wp_error( $allow ) ) {
2304          return $allow;
2305      }
2306  
2307      // Generate something random for a password reset key.
2308      $key = wp_generate_password( 20, false );
2309  
2310      /**
2311       * Fires when a password reset key is generated.
2312       *
2313       * @since 2.5.0
2314       *
2315       * @param string $user_login The username for the user.
2316       * @param string $key        The generated password reset key.
2317       */
2318      do_action( 'retrieve_password_key', $user->user_login, $key );
2319  
2320      // Now insert the key, hashed, into the DB.
2321      if ( empty( $wp_hasher ) ) {
2322          require_once  ABSPATH . WPINC . '/class-phpass.php';
2323          $wp_hasher = new PasswordHash( 8, true );
2324      }
2325  
2326      $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
2327  
2328      $key_saved = wp_update_user(
2329          array(
2330              'ID'                  => $user->ID,
2331              'user_activation_key' => $hashed,
2332          )
2333      );
2334  
2335      if ( is_wp_error( $key_saved ) ) {
2336          return $key_saved;
2337      }
2338  
2339      return $key;
2340  }
2341  
2342  /**
2343   * Retrieves a user row based on password reset key and login
2344   *
2345   * A key is considered 'expired' if it exactly matches the value of the
2346   * user_activation_key field, rather than being matched after going through the
2347   * hashing process. This field is now hashed; old values are no longer accepted
2348   * but have a different WP_Error code so good user feedback can be provided.
2349   *
2350   * @since 3.1.0
2351   *
2352   * @global wpdb         $wpdb      WordPress database object for queries.
2353   * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
2354   *
2355   * @param string $key       Hash to validate sending user's password.
2356   * @param string $login     The user login.
2357   * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
2358   */
2359  function check_password_reset_key( $key, $login ) {
2360      global $wpdb, $wp_hasher;
2361  
2362      $key = preg_replace( '/[^a-z0-9]/i', '', $key );
2363  
2364      if ( empty( $key ) || ! is_string( $key ) ) {
2365          return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );
2366      }
2367  
2368      if ( empty( $login ) || ! is_string( $login ) ) {
2369          return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );
2370      }
2371  
2372      $user = get_user_by( 'login', $login );
2373  
2374      if ( ! $user ) {
2375          return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );
2376      }
2377  
2378      if ( empty( $wp_hasher ) ) {
2379          require_once  ABSPATH . WPINC . '/class-phpass.php';
2380          $wp_hasher = new PasswordHash( 8, true );
2381      }
2382  
2383      /**
2384       * Filters the expiration time of password reset keys.
2385       *
2386       * @since 4.3.0
2387       *
2388       * @param int $expiration The expiration time in seconds.
2389       */
2390      $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS );
2391  
2392      if ( false !== strpos( $user->user_activation_key, ':' ) ) {
2393          list( $pass_request_time, $pass_key ) = explode( ':', $user->user_activation_key, 2 );
2394          $expiration_time                      = $pass_request_time + $expiration_duration;
2395      } else {
2396          $pass_key        = $user->user_activation_key;
2397          $expiration_time = false;
2398      }
2399  
2400      if ( ! $pass_key ) {
2401          return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );
2402      }
2403  
2404      $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key );
2405  
2406      if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) {
2407          return $user;
2408      } elseif ( $hash_is_correct && $expiration_time ) {
2409          // Key has an expiration time that's passed
2410          return new WP_Error( 'expired_key', __( 'Invalid key.' ) );
2411      }
2412  
2413      if ( hash_equals( $user->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) {
2414          $return  = new WP_Error( 'expired_key', __( 'Invalid key.' ) );
2415          $user_id = $user->ID;
2416  
2417          /**
2418           * Filters the return value of check_password_reset_key() when an
2419           * old-style key is used.
2420           *
2421           * @since 3.7.0 Previously plain-text keys were stored in the database.
2422           * @since 4.3.0 Previously key hashes were stored without an expiration time.
2423           *
2424           * @param WP_Error $return  A WP_Error object denoting an expired key.
2425           *                          Return a WP_User object to validate the key.
2426           * @param int      $user_id The matched user ID.
2427           */
2428          return apply_filters( 'password_reset_key_expired', $return, $user_id );
2429      }
2430  
2431      return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );
2432  }
2433  
2434  /**
2435   * Handles resetting the user's password.
2436   *
2437   * @since 2.5.0
2438   *
2439   * @param WP_User $user     The user
2440   * @param string $new_pass New password for the user in plaintext
2441   */
2442  function reset_password( $user, $new_pass ) {
2443      /**
2444       * Fires before the user's password is reset.
2445       *
2446       * @since 1.5.0
2447       *
2448       * @param object $user     The user.
2449       * @param string $new_pass New user password.
2450       */
2451      do_action( 'password_reset', $user, $new_pass );
2452  
2453      wp_set_password( $new_pass, $user->ID );
2454      update_user_option( $user->ID, 'default_password_nag', false, true );
2455  
2456      /**
2457       * Fires after the user's password is reset.
2458       *
2459       * @since 4.4.0
2460       *
2461       * @param WP_User $user     The user.
2462       * @param string  $new_pass New user password.
2463       */
2464      do_action( 'after_password_reset', $user, $new_pass );
2465  }
2466  
2467  /**
2468   * Handles registering a new user.
2469   *
2470   * @since 2.5.0
2471   *
2472   * @param string $user_login User's username for logging in
2473   * @param string $user_email User's email address to send password and add
2474   * @return int|WP_Error Either user's ID or error on failure.
2475   */
2476  function register_new_user( $user_login, $user_email ) {
2477      $errors = new WP_Error();
2478  
2479      $sanitized_user_login = sanitize_user( $user_login );
2480      /**
2481       * Filters the email address of a user being registered.
2482       *
2483       * @since 2.1.0
2484       *
2485       * @param string $user_email The email address of the new user.
2486       */
2487      $user_email = apply_filters( 'user_registration_email', $user_email );
2488  
2489      // Check the username
2490      if ( $sanitized_user_login == '' ) {
2491          $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
2492      } elseif ( ! validate_username( $user_login ) ) {
2493          $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) );
2494          $sanitized_user_login = '';
2495      } elseif ( username_exists( $sanitized_user_login ) ) {
2496          $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) );
2497  
2498      } else {
2499          /** This filter is documented in wp-includes/user.php */
2500          $illegal_user_logins = (array) apply_filters( 'illegal_user_logins', array() );
2501          if ( in_array( strtolower( $sanitized_user_login ), array_map( 'strtolower', $illegal_user_logins ) ) ) {
2502              $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
2503          }
2504      }
2505  
2506      // Check the email address
2507      if ( $user_email == '' ) {
2508          $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) );
2509      } elseif ( ! is_email( $user_email ) ) {
2510          $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn&#8217;t correct.' ) );
2511          $user_email = '';
2512      } elseif ( email_exists( $user_email ) ) {
2513          $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
2514      }
2515  
2516      /**
2517       * Fires when submitting registration form data, before the user is created.
2518       *
2519       * @since 2.1.0
2520       *
2521       * @param string   $sanitized_user_login The submitted username after being sanitized.
2522       * @param string   $user_email           The submitted email.
2523       * @param WP_Error $errors               Contains any errors with submitted username and email,
2524       *                                       e.g., an empty field, an invalid username or email,
2525       *                                       or an existing username or email.
2526       */
2527      do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
2528  
2529      /**
2530       * Filters the errors encountered when a new user is being registered.
2531       *
2532       * The filtered WP_Error object may, for example, contain errors for an invalid
2533       * or existing username or email address. A WP_Error object should always returned,
2534       * but may or may not contain errors.
2535       *
2536       * If any errors are present in $errors, this will abort the user's registration.
2537       *
2538       * @since 2.1.0
2539       *
2540       * @param WP_Error $errors               A WP_Error object containing any errors encountered
2541       *                                       during registration.
2542       * @param string   $sanitized_user_login User's username after it has been sanitized.
2543       * @param string   $user_email           User's email.
2544       */
2545      $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
2546  
2547      if ( $errors->has_errors() ) {
2548          return $errors;
2549      }
2550  
2551      $user_pass = wp_generate_password( 12, false );
2552      $user_id   = wp_create_user( $sanitized_user_login, $user_pass, $user_email );
2553      if ( ! $user_id || is_wp_error( $user_id ) ) {
2554          $errors->add(
2555              'registerfail',
2556              sprintf(
2557                  /* translators: %s: Admin email address. */
2558                  __( '<strong>ERROR</strong>: Couldn&#8217;t register you&hellip; please contact the <a href="mailto:%s">webmaster</a> !' ),
2559                  get_option( 'admin_email' )
2560              )
2561          );
2562          return $errors;
2563      }
2564  
2565      update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
2566  
2567      /**
2568       * Fires after a new user registration has been recorded.
2569       *
2570       * @since 4.4.0
2571       *
2572       * @param int $user_id ID of the newly registered user.
2573       */
2574      do_action( 'register_new_user', $user_id );
2575  
2576      return $user_id;
2577  }
2578  
2579  /**
2580   * Initiates email notifications related to the creation of new users.
2581   *
2582   * Notifications are sent both to the site admin and to the newly created user.
2583   *
2584   * @since 4.4.0
2585   * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending
2586   *              notifications only to the user created.
2587   *
2588   * @param int    $user_id ID of the newly created user.
2589   * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin'
2590   *                        or an empty string (admin only), 'user', or 'both' (admin and user).
2591   *                        Default 'both'.
2592   */
2593  function wp_send_new_user_notifications( $user_id, $notify = 'both' ) {
2594      wp_new_user_notification( $user_id, null, $notify );
2595  }
2596  
2597  /**
2598   * Retrieve the current session token from the logged_in cookie.
2599   *
2600   * @since 4.0.0
2601   *
2602   * @return string Token.
2603   */
2604  function wp_get_session_token() {
2605      $cookie = wp_parse_auth_cookie( '', 'logged_in' );
2606      return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
2607  }
2608  
2609  /**
2610   * Retrieve a list of sessions for the current user.
2611   *
2612   * @since 4.0.0
2613   * @return array Array of sessions.
2614   */
2615  function wp_get_all_sessions() {
2616      $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2617      return $manager->get_all();
2618  }
2619  
2620  /**
2621   * Remove the current session token from the database.
2622   *
2623   * @since 4.0.0
2624   */
2625  function wp_destroy_current_session() {
2626      $token = wp_get_session_token();
2627      if ( $token ) {
2628          $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2629          $manager->destroy( $token );
2630      }
2631  }
2632  
2633  /**
2634   * Remove all but the current session token for the current user for the database.
2635   *
2636   * @since 4.0.0
2637   */
2638  function wp_destroy_other_sessions() {
2639      $token = wp_get_session_token();
2640      if ( $token ) {
2641          $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2642          $manager->destroy_others( $token );
2643      }
2644  }
2645  
2646  /**
2647   * Remove all session tokens for the current user from the database.
2648   *
2649   * @since 4.0.0
2650   */
2651  function wp_destroy_all_sessions() {
2652      $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2653      $manager->destroy_all();
2654  }
2655  
2656  /**
2657   * Get the user IDs of all users with no role on this site.
2658   *
2659   * @since 4.4.0
2660   * @since 4.9.0 The `$site_id` parameter was added to support multisite.
2661   *
2662   * @param int|null $site_id Optional. The site ID to get users with no role for. Defaults to the current site.
2663   * @return array Array of user IDs.
2664   */
2665  function wp_get_users_with_no_role( $site_id = null ) {
2666      global $wpdb;
2667  
2668      if ( ! $site_id ) {
2669          $site_id = get_current_blog_id();
2670      }
2671  
2672      $prefix = $wpdb->get_blog_prefix( $site_id );
2673  
2674      if ( is_multisite() && $site_id != get_current_blog_id() ) {
2675          switch_to_blog( $site_id );
2676          $role_names = wp_roles()->get_names();
2677          restore_current_blog();
2678      } else {
2679          $role_names = wp_roles()->get_names();
2680      }
2681  
2682      $regex = implode( '|', array_keys( $role_names ) );
2683      $regex = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex );
2684      $users = $wpdb->get_col(
2685          $wpdb->prepare(
2686              "
2687          SELECT user_id
2688          FROM $wpdb->usermeta
2689          WHERE meta_key = '{$prefix}capabilities'
2690          AND meta_value NOT REGEXP %s
2691      ",
2692              $regex
2693          )
2694      );
2695  
2696      return $users;
2697  }
2698  
2699  /**
2700   * Retrieves the current user object.
2701   *
2702   * Will set the current user, if the current user is not set. The current user
2703   * will be set to the logged-in person. If no user is logged-in, then it will
2704   * set the current user to 0, which is invalid and won't have any permissions.
2705   *
2706   * This function is used by the pluggable functions wp_get_current_user() and
2707   * get_currentuserinfo(), the latter of which is deprecated but used for backward
2708   * compatibility.
2709   *
2710   * @since 4.5.0
2711   * @access private
2712   *
2713   * @see wp_get_current_user()
2714   * @global WP_User $current_user Checks if the current user is set.
2715   *
2716   * @return WP_User Current WP_User instance.
2717   */
2718  function _wp_get_current_user() {
2719      global $current_user;
2720  
2721      if ( ! empty( $current_user ) ) {
2722          if ( $current_user instanceof WP_User ) {
2723              return $current_user;
2724          }
2725  
2726          // Upgrade stdClass to WP_User
2727          if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
2728              $cur_id       = $current_user->ID;
2729              $current_user = null;
2730              wp_set_current_user( $cur_id );
2731              return $current_user;
2732          }
2733  
2734          // $current_user has a junk value. Force to WP_User with ID 0.
2735          $current_user = null;
2736          wp_set_current_user( 0 );
2737          return $current_user;
2738      }
2739  
2740      if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
2741          wp_set_current_user( 0 );
2742          return $current_user;
2743      }
2744  
2745      /**
2746       * Filters the current user.
2747       *
2748       * The default filters use this to determine the current user from the
2749       * request's cookies, if available.
2750       *
2751       * Returning a value of false will effectively short-circuit setting
2752       * the current user.
2753       *
2754       * @since 3.9.0
2755       *
2756       * @param int|bool $user_id User ID if one has been determined, false otherwise.
2757       */
2758      $user_id = apply_filters( 'determine_current_user', false );
2759      if ( ! $user_id ) {
2760          wp_set_current_user( 0 );
2761          return $current_user;
2762      }
2763  
2764      wp_set_current_user( $user_id );
2765  
2766      return $current_user;
2767  }
2768  
2769  /**
2770   * Send a confirmation request email when a change of user email address is attempted.
2771   *
2772   * @since 3.0.0
2773   * @since 4.9.0 This function was moved from wp-admin/includes/ms.php so it's no longer Multisite specific.
2774   *
2775   * @global WP_Error $errors WP_Error object.
2776   */
2777  function send_confirmation_on_profile_email() {
2778      global $errors;
2779  
2780      $current_user = wp_get_current_user();
2781      if ( ! is_object( $errors ) ) {
2782          $errors = new WP_Error();
2783      }
2784  
2785      if ( $current_user->ID != $_POST['user_id'] ) {
2786          return false;
2787      }
2788  
2789      if ( $current_user->user_email != $_POST['email'] ) {
2790          if ( ! is_email( $_POST['email'] ) ) {
2791              $errors->add(
2792                  'user_email',
2793                  __( '<strong>ERROR</strong>: The email address isn&#8217;t correct.' ),
2794                  array(
2795                      'form-field' => 'email',
2796                  )
2797              );
2798  
2799              return;
2800          }
2801  
2802          if ( email_exists( $_POST['email'] ) ) {
2803              $errors->add(
2804                  'user_email',
2805                  __( '<strong>ERROR</strong>: The email address is already used.' ),
2806                  array(
2807                      'form-field' => 'email',
2808                  )
2809              );
2810              delete_user_meta( $current_user->ID, '_new_email' );
2811  
2812              return;
2813          }
2814  
2815          $hash           = md5( $_POST['email'] . time() . wp_rand() );
2816          $new_user_email = array(
2817              'hash'     => $hash,
2818              'newemail' => $_POST['email'],
2819          );
2820          update_user_meta( $current_user->ID, '_new_email', $new_user_email );
2821  
2822          $sitename = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
2823  
2824          /* translators: Do not translate USERNAME, ADMIN_URL, EMAIL, SITENAME, SITEURL: those are placeholders. */
2825          $email_text = __(
2826              'Howdy ###USERNAME###,
2827  
2828  You recently requested to have the email address on your account changed.
2829  
2830  If this is correct, please click on the following link to change it:
2831  ###ADMIN_URL###
2832  
2833  You can safely ignore and delete this email if you do not want to
2834  take this action.
2835  
2836  This email has been sent to ###EMAIL###
2837  
2838  Regards,
2839  All at ###SITENAME###
2840  ###SITEURL###'
2841          );
2842  
2843          /**
2844           * Filters the text of the email sent when a change of user email address is attempted.
2845           *
2846           * The following strings have a special meaning and will get replaced dynamically:
2847           * ###USERNAME###  The current user's username.
2848           * ###ADMIN_URL### The link to click on to confirm the email change.
2849           * ###EMAIL###     The new email.
2850           * ###SITENAME###  The name of the site.
2851           * ###SITEURL###   The URL to the site.
2852           *
2853           * @since MU (3.0.0)
2854           * @since 4.9.0 This filter is no longer Multisite specific.
2855           *
2856           * @param string $email_text     Text in the email.
2857           * @param array  $new_user_email {
2858           *     Data relating to the new user email address.
2859           *
2860           *     @type string $hash     The secure hash used in the confirmation link URL.
2861           *     @type string $newemail The proposed new email address.
2862           * }
2863           */
2864          $content = apply_filters( 'new_user_email_content', $email_text, $new_user_email );
2865  
2866          $content = str_replace( '###USERNAME###', $current_user->user_login, $content );
2867          $content = str_replace( '###ADMIN_URL###', esc_url( admin_url( 'profile.php?newuseremail=' . $hash ) ), $content );
2868          $content = str_replace( '###EMAIL###', $_POST['email'], $content );
2869          $content = str_replace( '###SITENAME###', $sitename, $content );
2870          $content = str_replace( '###SITEURL###', home_url(), $content );
2871  
2872          /* translators: New email address notification email subject. %s: Site title. */
2873          wp_mail( $_POST['email'], sprintf( __( '[%s] Email Change Request' ), $sitename ), $content );
2874  
2875          $_POST['email'] = $current_user->user_email;
2876      }
2877  }
2878  
2879  /**
2880   * Adds an admin notice alerting the user to check for confirmation request email
2881   * after email address change.
2882   *
2883   * @since 3.0.0
2884   * @since 4.9.0 This function was moved from wp-admin/includes/ms.php so it's no longer Multisite specific.
2885   *
2886   * @global string $pagenow
2887   */
2888  function new_user_email_admin_notice() {
2889      global $pagenow;
2890  
2891      if ( 'profile.php' === $pagenow && isset( $_GET['updated'] ) ) {
2892          $email = get_user_meta( get_current_user_id(), '_new_email', true );
2893          if ( $email ) {
2894              /* translators: %s: New email address. */
2895              echo '<div class="notice notice-info"><p>' . sprintf( __( 'Your email address has not been updated yet. Please check your inbox at %s for a confirmation email.' ), '<code>' . esc_html( $email['newemail'] ) . '</code>' ) . '</p></div>';
2896          }
2897      }
2898  }
2899  
2900  /**
2901   * Get all user privacy request types.
2902   *
2903   * @since 4.9.6
2904   * @access private
2905   *
2906   * @return array List of core privacy action types.
2907   */
2908  function _wp_privacy_action_request_types() {
2909      return array(
2910          'export_personal_data',
2911          'remove_personal_data',
2912      );
2913  }
2914  
2915  /**
2916   * Registers the personal data exporter for users.
2917   *
2918   * @since 4.9.6
2919   *
2920   * @param array $exporters  An array of personal data exporters.
2921   * @return array An array of personal data exporters.
2922   */
2923  function wp_register_user_personal_data_exporter( $exporters ) {
2924      $exporters['wordpress-user'] = array(
2925          'exporter_friendly_name' => __( 'WordPress User' ),
2926          'callback'               => 'wp_user_personal_data_exporter',
2927      );
2928  
2929      return $exporters;
2930  }
2931  
2932  /**
2933   * Finds and exports personal data associated with an email address from the user and user_meta table.
2934   *
2935   * @since 4.9.6
2936   *
2937   * @param string $email_address  The users email address.
2938   * @return array An array of personal data.
2939   */
2940  function wp_user_personal_data_exporter( $email_address ) {
2941      $email_address = trim( $email_address );
2942  
2943      $data_to_export = array();
2944  
2945      $user = get_user_by( 'email', $email_address );
2946  
2947      if ( ! $user ) {
2948          return array(
2949              'data' => array(),
2950              'done' => true,
2951          );
2952      }
2953  
2954      $user_meta = get_user_meta( $user->ID );
2955  
2956      $user_prop_to_export = array(
2957          'ID'              => __( 'User ID' ),
2958          'user_login'      => __( 'User Login Name' ),
2959          'user_nicename'   => __( 'User Nice Name' ),
2960          'user_email'      => __( 'User Email' ),
2961          'user_url'        => __( 'User URL' ),
2962          'user_registered' => __( 'User Registration Date' ),
2963          'display_name'    => __( 'User Display Name' ),
2964          'nickname'        => __( 'User Nickname' ),
2965          'first_name'      => __( 'User First Name' ),
2966          'last_name'       => __( 'User Last Name' ),
2967          'description'     => __( 'User Description' ),
2968      );
2969  
2970      $user_data_to_export = array();
2971  
2972      foreach ( $user_prop_to_export as $key => $name ) {
2973          $value = '';
2974  
2975          switch ( $key ) {
2976              case 'ID':
2977              case 'user_login':
2978              case 'user_nicename':
2979              case 'user_email':
2980              case 'user_url':
2981              case 'user_registered':
2982              case 'display_name':
2983                  $value = $user->data->$key;
2984                  break;
2985              case 'nickname':
2986              case 'first_name':
2987              case 'last_name':
2988              case 'description':
2989                  $value = $user_meta[ $key ][0];
2990                  break;
2991          }
2992  
2993          if ( ! empty( $value ) ) {
2994              $user_data_to_export[] = array(
2995                  'name'  => $name,
2996                  'value' => $value,
2997              );
2998          }
2999      }
3000  
3001      $data_to_export[] = array(
3002          'group_id'          => 'user',
3003          'group_label'       => __( 'User' ),
3004          'group_description' => __( 'User&#8217;s profile data.' ),
3005          'item_id'           => "user-{$user->ID}",
3006          'data'              => $user_data_to_export,
3007      );
3008  
3009      return array(
3010          'data' => $data_to_export,
3011          'done' => true,
3012      );
3013  }
3014  
3015  /**
3016   * Update log when privacy request is confirmed.
3017   *
3018   * @since 4.9.6
3019   * @access private
3020   *
3021   * @param int $request_id ID of the request.
3022   */
3023  function _wp_privacy_account_request_confirmed( $request_id ) {
3024      $request = wp_get_user_request_data( $request_id );
3025  
3026      if ( ! $request ) {
3027          return;
3028      }
3029  
3030      if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) {
3031          return;
3032      }
3033  
3034      update_post_meta( $request_id, '_wp_user_request_confirmed_timestamp', time() );
3035      wp_update_post(
3036          array(
3037              'ID'          => $request_id,
3038              'post_status' => 'request-confirmed',
3039          )
3040      );
3041  }
3042  
3043  /**
3044   * Notify the site administrator via email when a request is confirmed.
3045   *
3046   * Without this, the admin would have to manually check the site to see if any
3047   * action was needed on their part yet.
3048   *
3049   * @since 4.9.6
3050   *
3051   * @param int $request_id The ID of the request.
3052   */
3053  function _wp_privacy_send_request_confirmation_notification( $request_id ) {
3054      $request = wp_get_user_request_data( $request_id );
3055  
3056      if ( ! is_a( $request, 'WP_User_Request' ) || 'request-confirmed' !== $request->status ) {
3057          return;
3058      }
3059  
3060      $already_notified = (bool) get_post_meta( $request_id, '_wp_admin_notified', true );
3061  
3062      if ( $already_notified ) {
3063          return;
3064      }
3065  
3066      $manage_url         = add_query_arg( 'page', $request->action_name, admin_url( 'tools.php' ) );
3067      $action_description = wp_user_request_action_description( $request->action_name );
3068  
3069      /**
3070       * Filters the recipient of the data request confirmation notification.
3071       *
3072       * In a Multisite environment, this will default to the email address of the
3073       * network admin because, by default, single site admins do not have the
3074       * capabilities required to process requests. Some networks may wish to
3075       * delegate those capabilities to a single-site admin, or a dedicated person
3076       * responsible for managing privacy requests.
3077       *
3078       * @since 4.9.6
3079       *
3080       * @param string          $admin_email The email address of the notification recipient.
3081       * @param WP_User_Request $request     The request that is initiating the notification.
3082       */
3083      $admin_email = apply_filters( 'user_request_confirmed_email_to', get_site_option( 'admin_email' ), $request );
3084  
3085      $email_data = array(
3086          'request'     => $request,
3087          'user_email'  => $request->email,
3088          'description' => $action_description,
3089          'manage_url'  => $manage_url,
3090          'sitename'    => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),
3091          'siteurl'     => home_url(),
3092          'admin_email' => $admin_email,
3093      );
3094  
3095      /* translators: Do not translate SITENAME, USER_EMAIL, DESCRIPTION, MANAGE_URL, SITEURL; those are placeholders. */
3096      $email_text = __(
3097          'Howdy,
3098  
3099  A user data privacy request has been confirmed on ###SITENAME###:
3100  
3101  User: ###USER_EMAIL###
3102  Request: ###DESCRIPTION###
3103  
3104  You can view and manage these data privacy requests here:
3105  
3106  ###MANAGE_URL###
3107  
3108  Regards,
3109  All at ###SITENAME###
3110  ###SITEURL###'
3111      );
3112  
3113      /**
3114       * Filters the body of the user request confirmation email.
3115       *
3116       * The email is sent to an administrator when an user request is confirmed.
3117       * The following strings have a special meaning and will get replaced dynamically:
3118       *
3119       * ###SITENAME###    The name of the site.
3120       * ###USER_EMAIL###  The user email for the request.
3121       * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.
3122       * ###MANAGE_URL###  The URL to manage requests.
3123       * ###SITEURL###     The URL to the site.
3124       *
3125       * @since 4.9.6
3126       *
3127       * @param string $email_text Text in the email.
3128       * @param array  $email_data {
3129       *     Data relating to the account action email.
3130       *
3131       *     @type WP_User_Request $request     User request object.
3132       *     @type string          $user_email  The email address confirming a request
3133       *     @type string          $description Description of the action being performed so the user knows what the email is for.
3134       *     @type string          $manage_url  The link to click manage privacy requests of this type.
3135       *     @type string          $sitename    The site name sending the mail.
3136       *     @type string          $siteurl     The site URL sending the mail.
3137       *     @type string          $admin_email The administrator email receiving the mail.
3138       * }
3139       */
3140      $content = apply_filters( 'user_confirmed_action_email_content', $email_text, $email_data );
3141  
3142      $content = str_replace( '###SITENAME###', $email_data['sitename'], $content );
3143      $content = str_replace( '###USER_EMAIL###', $email_data['user_email'], $content );
3144      $content = str_replace( '###DESCRIPTION###', $email_data['description'], $content );
3145      $content = str_replace( '###MANAGE_URL###', esc_url_raw( $email_data['manage_url'] ), $content );
3146      $content = str_replace( '###SITEURL###', esc_url_raw( $email_data['siteurl'] ), $content );
3147  
3148      $subject = sprintf(
3149          /* translators: Privacy data request confirmed notification email subject. 1: Site title, 2: Name of the confirmed action. */
3150          __( '[%1$s] Action Confirmed: %2$s' ),
3151          $email_data['sitename'],
3152          $action_description
3153      );
3154  
3155      /**
3156       * Filters the subject of the user request confirmation email.
3157       *
3158       * @since 4.9.8
3159       *
3160       * @param string $subject    The email subject.
3161       * @param string $sitename   The name of the site.
3162       * @param array  $email_data {
3163       *     Data relating to the account action email.
3164       *
3165       *     @type WP_User_Request $request     User request object.
3166       *     @type string          $user_email  The email address confirming a request
3167       *     @type string          $description Description of the action being performed so the user knows what the email is for.
3168       *     @type string          $manage_url  The link to click manage privacy requests of this type.
3169       *     @type string          $sitename    The site name sending the mail.
3170       *     @type string          $siteurl     The site URL sending the mail.
3171       *     @type string          $admin_email The administrator email receiving the mail.
3172       * }
3173       */
3174      $subject = apply_filters( 'user_request_confirmed_email_subject', $subject, $email_data['sitename'], $email_data );
3175  
3176      $email_sent = wp_mail( $email_data['admin_email'], $subject, $content );
3177  
3178      if ( $email_sent ) {
3179          update_post_meta( $request_id, '_wp_admin_notified', true );
3180      }
3181  }
3182  
3183  /**
3184   * Notify the user when their erasure request is fulfilled.
3185   *
3186   * Without this, the user would never know if their data was actually erased.
3187   *
3188   * @since 4.9.6
3189   *
3190   * @param int $request_id The privacy request post ID associated with this request.
3191   */
3192  function _wp_privacy_send_erasure_fulfillment_notification( $request_id ) {
3193      $request = wp_get_user_request_data( $request_id );
3194  
3195      if ( ! is_a( $request, 'WP_User_Request' ) || 'request-completed' !== $request->status ) {
3196          return;
3197      }
3198  
3199      $already_notified = (bool) get_post_meta( $request_id, '_wp_user_notified', true );
3200  
3201      if ( $already_notified ) {
3202          return;
3203      }
3204  
3205      // Localize message content for user; fallback to site default for visitors.
3206      if ( ! empty( $request->user_id ) ) {
3207          $locale = get_user_locale( $request->user_id );
3208      } else {
3209          $locale = get_locale();
3210      }
3211  
3212      $switched_locale = switch_to_locale( $locale );
3213  
3214      /**
3215       * Filters the recipient of the data erasure fulfillment notification.
3216       *
3217       * @since 4.9.6
3218       *
3219       * @param string          $user_email The email address of the notification recipient.
3220       * @param WP_User_Request $request    The request that is initiating the notification.
3221       */
3222      $user_email = apply_filters( 'user_erasure_fulfillment_email_to', $request->email, $request );
3223  
3224      $email_data = array(
3225          'request'            => $request,
3226          'message_recipient'  => $user_email,
3227          'privacy_policy_url' => get_privacy_policy_url(),
3228          'sitename'           => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),
3229          'siteurl'            => home_url(),
3230      );
3231  
3232      $subject = sprintf(
3233          /* translators: Erasure request fulfilled notification email subject. %s: Site title. */
3234          __( '[%s] Erasure Request Fulfilled' ),
3235          $email_data['sitename']
3236      );
3237  
3238      /**
3239       * Filters the subject of the email sent when an erasure request is completed.
3240       *
3241       * @since 4.9.8
3242       *
3243       * @param string $subject    The email subject.
3244       * @param string $sitename   The name of the site.
3245       * @param array  $email_data {
3246       *     Data relating to the account action email.
3247       *
3248       *     @type WP_User_Request $request            User request object.
3249       *     @type string          $message_recipient  The address that the email will be sent to. Defaults
3250       *                                               to the value of `$request->email`, but can be changed
3251       *                                               by the `user_erasure_fulfillment_email_to` filter.
3252       *     @type string          $privacy_policy_url Privacy policy URL.
3253       *     @type string          $sitename           The site name sending the mail.
3254       *     @type string          $siteurl            The site URL sending the mail.
3255       * }
3256       */
3257      $subject = apply_filters( 'user_erasure_complete_email_subject', $subject, $email_data['sitename'], $email_data );
3258  
3259      if ( empty( $email_data['privacy_policy_url'] ) ) {
3260          /* translators: Do not translate SITENAME, SITEURL; those are placeholders. */
3261          $email_text = __(
3262              'Howdy,
3263  
3264  Your request to erase your personal data on ###SITENAME### has been completed.
3265  
3266  If you have any follow-up questions or concerns, please contact the site administrator.
3267  
3268  Regards,
3269  All at ###SITENAME###
3270  ###SITEURL###'
3271          );
3272      } else {
3273          /* translators: Do not translate SITENAME, SITEURL, PRIVACY_POLICY_URL; those are placeholders. */
3274          $email_text = __(
3275              'Howdy,
3276  
3277  Your request to erase your personal data on ###SITENAME### has been completed.
3278  
3279  If you have any follow-up questions or concerns, please contact the site administrator.
3280  
3281  For more information, you can also read our privacy policy: ###PRIVACY_POLICY_URL###
3282  
3283  Regards,
3284  All at ###SITENAME###
3285  ###SITEURL###'
3286          );
3287      }
3288  
3289      /**
3290       * Filters the body of the data erasure fulfillment notification.
3291       *
3292       * The email is sent to a user when a their data erasure request is fulfilled
3293       * by an administrator.
3294       *
3295       * The following strings have a special meaning and will get replaced dynamically:
3296       *
3297       * ###SITENAME###           The name of the site.
3298       * ###PRIVACY_POLICY_URL### Privacy policy page URL.
3299       * ###SITEURL###            The URL to the site.
3300       *
3301       * @since 4.9.6
3302       *
3303       * @param string $email_text Text in the email.
3304       * @param array  $email_data {
3305       *     Data relating to the account action email.
3306       *
3307       *     @type WP_User_Request $request            User request object.
3308       *     @type string          $message_recipient  The address that the email will be sent to. Defaults
3309       *                                               to the value of `$request->email`, but can be changed
3310       *                                               by the `user_erasure_fulfillment_email_to` filter.
3311       *     @type string          $privacy_policy_url Privacy policy URL.
3312       *     @type string          $sitename           The site name sending the mail.
3313       *     @type string          $siteurl            The site URL sending the mail.
3314       * }
3315       */
3316      $content = apply_filters( 'user_confirmed_action_email_content', $email_text, $email_data );
3317  
3318      $content = str_replace( '###SITENAME###', $email_data['sitename'], $content );
3319      $content = str_replace( '###PRIVACY_POLICY_URL###', $email_data['privacy_policy_url'], $content );
3320      $content = str_replace( '###SITEURL###', esc_url_raw( $email_data['siteurl'] ), $content );
3321  
3322      $email_sent = wp_mail( $user_email, $subject, $content );
3323  
3324      if ( $switched_locale ) {
3325          restore_previous_locale();
3326      }
3327  
3328      if ( $email_sent ) {
3329          update_post_meta( $request_id, '_wp_user_notified', true );
3330      }
3331  }
3332  
3333  /**
3334   * Return request confirmation message HTML.
3335   *
3336   * @since 4.9.6
3337   * @access private
3338   *
3339   * @param int $request_id The request ID being confirmed.
3340   * @return string $message The confirmation message.
3341   */
3342  function _wp_privacy_account_request_confirmed_message( $request_id ) {
3343      $request = wp_get_user_request_data( $request_id );
3344  
3345      $message  = '<p class="success">' . __( 'Action has been confirmed.' ) . '</p>';
3346      $message .= '<p>' . __( 'The site administrator has been notified and will fulfill your request as soon as possible.' ) . '</p>';
3347  
3348      if ( $request && in_array( $request->action_name, _wp_privacy_action_request_types(), true ) ) {
3349          if ( 'export_personal_data' === $request->action_name ) {
3350              $message  = '<p class="success">' . __( 'Thanks for confirming your export request.' ) . '</p>';
3351              $message .= '<p>' . __( 'The site administrator has been notified. You will receive a link to download your export via email when they fulfill your request.' ) . '</p>';
3352          } elseif ( 'remove_personal_data' === $request->action_name ) {
3353              $message  = '<p class="success">' . __( 'Thanks for confirming your erasure request.' ) . '</p>';
3354              $message .= '<p>' . __( 'The site administrator has been notified. You will receive an email confirmation when they erase your data.' ) . '</p>';
3355          }
3356      }
3357  
3358      /**
3359       * Filters the message displayed to a user when they confirm a data request.
3360       *
3361       * @since 4.9.6
3362       *
3363       * @param string $message    The message to the user.
3364       * @param int    $request_id The ID of the request being confirmed.
3365       */
3366      $message = apply_filters( 'user_request_action_confirmed_message', $message, $request_id );
3367  
3368      return $message;
3369  }
3370  
3371  /**
3372   * Create and log a user request to perform a specific action.
3373   *
3374   * Requests are stored inside a post type named `user_request` since they can apply to both
3375   * users on the site, or guests without a user account.
3376   *
3377   * @since 4.9.6
3378   *
3379   * @param string $email_address User email address. This can be the address of a registered or non-registered user.
3380   * @param string $action_name   Name of the action that is being confirmed. Required.
3381   * @param array  $request_data  Misc data you want to send with the verification request and pass to the actions once the request is confirmed.
3382   * @return int|WP_Error Returns the request ID if successful, or a WP_Error object on failure.
3383   */
3384  function wp_create_user_request( $email_address = '', $action_name = '', $request_data = array() ) {
3385      $email_address = sanitize_email( $email_address );
3386      $action_name   = sanitize_key( $action_name );
3387  
3388      if ( ! is_email( $email_address ) ) {
3389          return new WP_Error( 'invalid_email', __( 'Invalid email address.' ) );
3390      }
3391  
3392      if ( ! $action_name ) {
3393          return new WP_Error( 'invalid_action', __( 'Invalid action name.' ) );
3394      }
3395  
3396      $user    = get_user_by( 'email', $email_address );
3397      $user_id = $user && ! is_wp_error( $user ) ? $user->ID : 0;
3398  
3399      // Check for duplicates.
3400      $requests_query = new WP_Query(
3401          array(
3402              'post_type'     => 'user_request',
3403              'post_name__in' => array( $action_name ),  // Action name stored in post_name column.
3404              'title'         => $email_address, // Email address stored in post_title column.
3405              'post_status'   => array(
3406                  'request-pending',
3407                  'request-confirmed',
3408              ),
3409              'fields'        => 'ids',
3410          )
3411      );
3412  
3413      if ( $requests_query->found_posts ) {
3414          return new WP_Error( 'duplicate_request', __( 'An incomplete request for this email address already exists.' ) );
3415      }
3416  
3417      $request_id = wp_insert_post(
3418          array(
3419              'post_author'   => $user_id,
3420              'post_name'     => $action_name,
3421              'post_title'    => $email_address,
3422              'post_content'  => wp_json_encode( $request_data ),
3423              'post_status'   => 'request-pending',
3424              'post_type'     => 'user_request',
3425              'post_date'     => current_time( 'mysql', false ),
3426              'post_date_gmt' => current_time( 'mysql', true ),
3427          ),
3428          true
3429      );
3430  
3431      return $request_id;
3432  }
3433  
3434  /**
3435   * Get action description from the name and return a string.
3436   *
3437   * @since 4.9.6
3438   *
3439   * @param string $action_name Action name of the request.
3440   * @return string Human readable action name.
3441   */
3442  function wp_user_request_action_description( $action_name ) {
3443      switch ( $action_name ) {
3444          case 'export_personal_data':
3445              $description = __( 'Export Personal Data' );
3446              break;
3447          case 'remove_personal_data':
3448              $description = __( 'Erase Personal Data' );
3449              break;
3450          default:
3451              /* translators: %s: Action name. */
3452              $description = sprintf( __( 'Confirm the "%s" action' ), $action_name );
3453              break;
3454      }
3455  
3456      /**
3457       * Filters the user action description.
3458       *
3459       * @since 4.9.6
3460       *
3461       * @param string $description The default description.
3462       * @param string $action_name The name of the request.
3463       */
3464      return apply_filters( 'user_request_action_description', $description, $action_name );
3465  }
3466  
3467  /**
3468   * Send a confirmation request email to confirm an action.
3469   *
3470   * If the request is not already pending, it will be updated.
3471   *
3472   * @since 4.9.6
3473   *
3474   * @param string $request_id ID of the request created via wp_create_user_request().
3475   * @return bool|WP_Error True on success, `WP_Error` on failure.
3476   */
3477  function wp_send_user_request( $request_id ) {
3478      $request_id = absint( $request_id );
3479      $request    = wp_get_user_request_data( $request_id );
3480  
3481      if ( ! $request ) {
3482          return new WP_Error( 'invalid_request', __( 'Invalid user request.' ) );
3483      }
3484  
3485      // Localize message content for user; fallback to site default for visitors.
3486      if ( ! empty( $request->user_id ) ) {
3487          $locale = get_user_locale( $request->user_id );
3488      } else {
3489          $locale = get_locale();
3490      }
3491  
3492      $switched_locale = switch_to_locale( $locale );
3493  
3494      $email_data = array(
3495          'request'     => $request,
3496          'email'       => $request->email,
3497          'description' => wp_user_request_action_description( $request->action_name ),
3498          'confirm_url' => add_query_arg(
3499              array(
3500                  'action'      => 'confirmaction',
3501                  'request_id'  => $request_id,
3502                  'confirm_key' => wp_generate_user_request_key( $request_id ),
3503              ),
3504              wp_login_url()
3505          ),
3506          'sitename'    => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),
3507          'siteurl'     => home_url(),
3508      );
3509  
3510      /* translators: Do not translate DESCRIPTION, CONFIRM_URL, SITENAME, SITEURL: those are placeholders. */
3511      $email_text = __(
3512          'Howdy,
3513  
3514  A request has been made to perform the following action on your account:
3515  
3516       ###DESCRIPTION###
3517  
3518  To confirm this, please click on the following link:
3519  ###CONFIRM_URL###
3520  
3521  You can safely ignore and delete this email if you do not want to
3522  take this action.
3523  
3524  Regards,
3525  All at ###SITENAME###
3526  ###SITEURL###'
3527      );
3528  
3529      /**
3530       * Filters the text of the email sent when an account action is attempted.
3531       *
3532       * The following strings have a special meaning and will get replaced dynamically:
3533       *
3534       * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.
3535       * ###CONFIRM_URL### The link to click on to confirm the account action.
3536       * ###SITENAME###    The name of the site.
3537       * ###SITEURL###     The URL to the site.
3538       *
3539       * @since 4.9.6
3540       *
3541       * @param string $email_text Text in the email.
3542       * @param array  $email_data {
3543       *     Data relating to the account action email.
3544       *
3545       *     @type WP_User_Request $request     User request object.
3546       *     @type string          $email       The email address this is being sent to.
3547       *     @type string          $description Description of the action being performed so the user knows what the email is for.
3548       *     @type string          $confirm_url The link to click on to confirm the account action.
3549       *     @type string          $sitename    The site name sending the mail.
3550       *     @type string          $siteurl     The site URL sending the mail.
3551       * }
3552       */
3553      $content = apply_filters( 'user_request_action_email_content', $email_text, $email_data );
3554  
3555      $content = str_replace( '###DESCRIPTION###', $email_data['description'], $content );
3556      $content = str_replace( '###CONFIRM_URL###', esc_url_raw( $email_data['confirm_url'] ), $content );
3557      $content = str_replace( '###EMAIL###', $email_data['email'], $content );
3558      $content = str_replace( '###SITENAME###', $email_data['sitename'], $content );
3559      $content = str_replace( '###SITEURL###', esc_url_raw( $email_data['siteurl'] ), $content );
3560  
3561      /* translators: Confirm privacy data request notification email subject. 1: Site title, 2: Name of the action. */
3562      $subject = sprintf( __( '[%1$s] Confirm Action: %2$s' ), $email_data['sitename'], $email_data['description'] );
3563  
3564      /**
3565       * Filters the subject of the email sent when an account action is attempted.
3566       *
3567       * @since 4.9.6
3568       *
3569       * @param string $subject    The email subject.
3570       * @param string $sitename   The name of the site.
3571       * @param array  $email_data {
3572       *     Data relating to the account action email.
3573       *
3574       *     @type WP_User_Request $request     User request object.
3575       *     @type string          $email       The email address this is being sent to.
3576       *     @type string          $description Description of the action being performed so the user knows what the email is for.
3577       *     @type string          $confirm_url The link to click on to confirm the account action.
3578       *     @type string          $sitename    The site name sending the mail.
3579       *     @type string          $siteurl     The site URL sending the mail.
3580       * }
3581       */
3582      $subject = apply_filters( 'user_request_action_email_subject', $subject, $email_data['sitename'], $email_data );
3583  
3584      $email_sent = wp_mail( $email_data['email'], $subject, $content );
3585  
3586      if ( $switched_locale ) {
3587          restore_previous_locale();
3588      }
3589  
3590      if ( ! $email_sent ) {
3591          return new WP_Error( 'privacy_email_error', __( 'Unable to send personal data export confirmation email.' ) );
3592      }
3593  
3594      return true;
3595  }
3596  
3597  /**
3598   * Returns a confirmation key for a user action and stores the hashed version for future comparison.
3599   *
3600   * @since 4.9.6
3601   *
3602   * @param int $request_id Request ID.
3603   * @return string Confirmation key.
3604   */
3605  function wp_generate_user_request_key( $request_id ) {
3606      global $wp_hasher;
3607  
3608      // Generate something random for a confirmation key.
3609      $key = wp_generate_password( 20, false );
3610  
3611      // Return the key, hashed.
3612      if ( empty( $wp_hasher ) ) {
3613          require_once  ABSPATH . WPINC . '/class-phpass.php';
3614          $wp_hasher = new PasswordHash( 8, true );
3615      }
3616  
3617      wp_update_post(
3618          array(
3619              'ID'            => $request_id,
3620              'post_status'   => 'request-pending',
3621              'post_password' => $wp_hasher->HashPassword( $key ),
3622          )
3623      );
3624  
3625      return $key;
3626  }
3627  
3628  /**
3629   * Validate a user request by comparing the key with the request's key.
3630   *
3631   * @since 4.9.6
3632   *
3633   * @param string $request_id ID of the request being confirmed.
3634   * @param string $key        Provided key to validate.
3635   * @return bool|WP_Error WP_Error on failure, true on success.
3636   */
3637  function wp_validate_user_request_key( $request_id, $key ) {
3638      global $wp_hasher;
3639  
3640      $request_id = absint( $request_id );
3641      $request    = wp_get_user_request_data( $request_id );
3642  
3643      if ( ! $request ) {
3644          return new WP_Error( 'invalid_request', __( 'Invalid request.' ) );
3645      }
3646  
3647      if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) {
3648          return new WP_Error( 'expired_link', __( 'This link has expired.' ) );
3649      }
3650  
3651      if ( empty( $key ) ) {
3652          return new WP_Error( 'missing_key', __( 'Missing confirm key.' ) );
3653      }
3654  
3655      if ( empty( $wp_hasher ) ) {
3656          require_once  ABSPATH . WPINC . '/class-phpass.php';
3657          $wp_hasher = new PasswordHash( 8, true );
3658      }
3659  
3660      $key_request_time = $request->modified_timestamp;
3661      $saved_key        = $request->confirm_key;
3662  
3663      if ( ! $saved_key ) {
3664          return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );
3665      }
3666  
3667      if ( ! $key_request_time ) {
3668          return new WP_Error( 'invalid_key', __( 'Invalid action.' ) );
3669      }
3670  
3671      /**
3672       * Filters the expiration time of confirm keys.
3673       *
3674       * @since 4.9.6
3675       *
3676       * @param int $expiration The expiration time in seconds.
3677       */
3678      $expiration_duration = (int) apply_filters( 'user_request_key_expiration', DAY_IN_SECONDS );
3679      $expiration_time     = $key_request_time + $expiration_duration;
3680  
3681      if ( ! $wp_hasher->CheckPassword( $key, $saved_key ) ) {
3682          return new WP_Error( 'invalid_key', __( 'Invalid key.' ) );
3683      }
3684  
3685      if ( ! $expiration_time || time() > $expiration_time ) {
3686          return new WP_Error( 'expired_key', __( 'The confirmation email has expired.' ) );
3687      }
3688  
3689      return true;
3690  }
3691  
3692  /**
3693   * Return data about a user request.
3694   *
3695   * @since 4.9.6
3696   *
3697   * @param int $request_id Request ID to get data about.
3698   * @return WP_User_Request|false
3699   */
3700  function wp_get_user_request_data( $request_id ) {
3701      $request_id = absint( $request_id );
3702      $post       = get_post( $request_id );
3703  
3704      if ( ! $post || 'user_request' !== $post->post_type ) {
3705          return false;
3706      }
3707  
3708      return new WP_User_Request( $post );
3709  }


Generated: Fri Oct 25 08:20:01 2019 Cross-referenced by PHPXref 0.7