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


Generated: Mon Jun 17 08:20:02 2019 Cross-referenced by PHPXref 0.7