| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
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 * @global wpdb $wpdb WordPress database abstraction object. 29 * 30 * @param array $credentials { 31 * Optional. User info in order to sign on. 32 * 33 * @type string $user_login Username. 34 * @type string $user_password User password. 35 * @type bool $remember Whether to 'remember' the user. Increases the time 36 * that the cookie will be kept. Default false. 37 * } 38 * @param string|bool $secure_cookie Optional. Whether to use secure cookie. 39 * @return WP_User|WP_Error WP_User on success, WP_Error on failure. 40 */ 41 function wp_signon( $credentials = array(), $secure_cookie = '' ) { 42 global $auth_secure_cookie, $wpdb; 43 44 if ( empty( $credentials ) ) { 45 $credentials = array( 46 'user_login' => '', 47 'user_password' => '', 48 'remember' => false, 49 ); 50 51 if ( ! empty( $_POST['log'] ) ) { 52 $credentials['user_login'] = wp_unslash( $_POST['log'] ); 53 } 54 if ( ! empty( $_POST['pwd'] ) ) { 55 $credentials['user_password'] = $_POST['pwd']; 56 } 57 if ( ! empty( $_POST['rememberme'] ) ) { 58 $credentials['remember'] = $_POST['rememberme']; 59 } 60 } 61 62 if ( ! empty( $credentials['remember'] ) ) { 63 $credentials['remember'] = true; 64 } else { 65 $credentials['remember'] = false; 66 } 67 68 /** 69 * Fires before the user is authenticated. 70 * 71 * The variables passed to the callbacks are passed by reference, 72 * and can be modified by callback functions. 73 * 74 * @since 1.5.1 75 * 76 * @todo Decide whether to deprecate the wp_authenticate action. 77 * 78 * @param string $user_login Username (passed by reference). 79 * @param string $user_password User password (passed by reference). 80 */ 81 do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) ); 82 83 if ( '' === $secure_cookie ) { 84 $secure_cookie = is_ssl(); 85 } 86 87 /** 88 * Filters whether to use a secure sign-on cookie. 89 * 90 * @since 3.1.0 91 * 92 * @param bool $secure_cookie Whether to use a secure sign-on cookie. 93 * @param array $credentials { 94 * Array of entered sign-on data. 95 * 96 * @type string $user_login Username. 97 * @type string $user_password Password entered. 98 * @type bool $remember Whether to 'remember' the user. Increases the time 99 * that the cookie will be kept. Default false. 100 * } 101 */ 102 $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials ); 103 104 // XXX ugly hack to pass this to wp_authenticate_cookie(). 105 $auth_secure_cookie = $secure_cookie; 106 107 add_filter( 'authenticate', 'wp_authenticate_cookie', 30, 3 ); 108 109 $user = wp_authenticate( $credentials['user_login'], $credentials['user_password'] ); 110 111 if ( is_wp_error( $user ) ) { 112 return $user; 113 } 114 115 wp_set_auth_cookie( $user->ID, $credentials['remember'], $secure_cookie ); 116 117 // Clear `user_activation_key` after a successful login. 118 if ( ! empty( $user->user_activation_key ) ) { 119 $wpdb->update( 120 $wpdb->users, 121 array( 122 'user_activation_key' => '', 123 ), 124 array( 'ID' => $user->ID ) 125 ); 126 127 $user->user_activation_key = ''; 128 } 129 130 /** 131 * Fires after the user has successfully logged in. 132 * 133 * @since 1.5.0 134 * 135 * @param string $user_login Username. 136 * @param WP_User $user WP_User object of the logged-in user. 137 */ 138 do_action( 'wp_login', $user->user_login, $user ); 139 140 return $user; 141 } 142 143 /** 144 * Authenticates a user, confirming the username and password are valid. 145 * 146 * @since 2.8.0 147 * 148 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. 149 * @param string $username Username for authentication. 150 * @param string $password Password for authentication. 151 * @return WP_User|WP_Error WP_User on success, WP_Error on failure. 152 */ 153 function wp_authenticate_username_password( $user, $username, $password ) { 154 if ( $user instanceof WP_User ) { 155 return $user; 156 } 157 158 if ( empty( $username ) || empty( $password ) ) { 159 if ( is_wp_error( $user ) ) { 160 return $user; 161 } 162 163 $error = new WP_Error(); 164 165 if ( empty( $username ) ) { 166 $error->add( 'empty_username', __( '<strong>Error:</strong> The username field is empty.' ) ); 167 } 168 169 if ( empty( $password ) ) { 170 $error->add( 'empty_password', __( '<strong>Error:</strong> The password field is empty.' ) ); 171 } 172 173 return $error; 174 } 175 176 $user = get_user_by( 'login', $username ); 177 178 if ( ! $user ) { 179 return new WP_Error( 180 'invalid_username', 181 sprintf( 182 /* translators: %s: User name. */ 183 __( '<strong>Error:</strong> The username <strong>%s</strong> is not registered on this site. If you are unsure of your username, try your email address instead.' ), 184 $username 185 ) 186 ); 187 } 188 189 /** 190 * Filters whether the given user can be authenticated with the provided password. 191 * 192 * @since 2.5.0 193 * 194 * @param WP_User|WP_Error $user WP_User or WP_Error object if a previous 195 * callback failed authentication. 196 * @param string $password Password to check against the user. 197 */ 198 $user = apply_filters( 'wp_authenticate_user', $user, $password ); 199 if ( is_wp_error( $user ) ) { 200 return $user; 201 } 202 203 if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) { 204 return new WP_Error( 205 'incorrect_password', 206 sprintf( 207 /* translators: %s: User name. */ 208 __( '<strong>Error:</strong> The password you entered for the username %s is incorrect.' ), 209 '<strong>' . $username . '</strong>' 210 ) . 211 ' <a href="' . wp_lostpassword_url() . '">' . 212 __( 'Lost your password?' ) . 213 '</a>' 214 ); 215 } 216 217 return $user; 218 } 219 220 /** 221 * Authenticates a user using the email and password. 222 * 223 * @since 4.5.0 224 * 225 * @param WP_User|WP_Error|null $user WP_User or WP_Error object if a previous 226 * callback failed authentication. 227 * @param string $email Email address for authentication. 228 * @param string $password Password for authentication. 229 * @return WP_User|WP_Error WP_User on success, WP_Error on failure. 230 */ 231 function wp_authenticate_email_password( $user, $email, $password ) { 232 if ( $user instanceof WP_User ) { 233 return $user; 234 } 235 236 if ( empty( $email ) || empty( $password ) ) { 237 if ( is_wp_error( $user ) ) { 238 return $user; 239 } 240 241 $error = new WP_Error(); 242 243 if ( empty( $email ) ) { 244 // Uses 'empty_username' for back-compat with wp_signon(). 245 $error->add( 'empty_username', __( '<strong>Error:</strong> The email field is empty.' ) ); 246 } 247 248 if ( empty( $password ) ) { 249 $error->add( 'empty_password', __( '<strong>Error:</strong> The password field is empty.' ) ); 250 } 251 252 return $error; 253 } 254 255 if ( ! is_email( $email ) ) { 256 return $user; 257 } 258 259 $user = get_user_by( 'email', $email ); 260 261 if ( ! $user ) { 262 return new WP_Error( 263 'invalid_email', 264 __( 'Unknown email address. Check again or try your username.' ) 265 ); 266 } 267 268 /** This filter is documented in wp-includes/user.php */ 269 $user = apply_filters( 'wp_authenticate_user', $user, $password ); 270 271 if ( is_wp_error( $user ) ) { 272 return $user; 273 } 274 275 if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) { 276 return new WP_Error( 277 'incorrect_password', 278 sprintf( 279 /* translators: %s: Email address. */ 280 __( '<strong>Error:</strong> The password you entered for the email address %s is incorrect.' ), 281 '<strong>' . $email . '</strong>' 282 ) . 283 ' <a href="' . wp_lostpassword_url() . '">' . 284 __( 'Lost your password?' ) . 285 '</a>' 286 ); 287 } 288 289 return $user; 290 } 291 292 /** 293 * Authenticates the user using the WordPress auth cookie. 294 * 295 * @since 2.8.0 296 * 297 * @global string $auth_secure_cookie 298 * 299 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. 300 * @param string $username Username. If not empty, cancels the cookie authentication. 301 * @param string $password Password. If not empty, cancels the cookie authentication. 302 * @return WP_User|WP_Error WP_User on success, WP_Error on failure. 303 */ 304 function wp_authenticate_cookie( $user, $username, $password ) { 305 global $auth_secure_cookie; 306 307 if ( $user instanceof WP_User ) { 308 return $user; 309 } 310 311 if ( empty( $username ) && empty( $password ) ) { 312 $user_id = wp_validate_auth_cookie(); 313 if ( $user_id ) { 314 return new WP_User( $user_id ); 315 } 316 317 if ( $auth_secure_cookie ) { 318 $auth_cookie = SECURE_AUTH_COOKIE; 319 } else { 320 $auth_cookie = AUTH_COOKIE; 321 } 322 323 if ( ! empty( $_COOKIE[ $auth_cookie ] ) ) { 324 return new WP_Error( 'expired_session', __( 'Please log in again.' ) ); 325 } 326 327 // If the cookie is not set, be silent. 328 } 329 330 return $user; 331 } 332 333 /** 334 * Authenticates the user using an application password. 335 * 336 * @since 5.6.0 337 * 338 * @param WP_User|WP_Error|null $input_user WP_User or WP_Error object if a previous 339 * callback failed authentication. 340 * @param string $username Username for authentication. 341 * @param string $password Password for authentication. 342 * @return WP_User|WP_Error|null WP_User on success, WP_Error on failure, null if 343 * null is passed in and this isn't an API request. 344 */ 345 function wp_authenticate_application_password( $input_user, $username, $password ) { 346 if ( $input_user instanceof WP_User ) { 347 return $input_user; 348 } 349 350 if ( ! WP_Application_Passwords::is_in_use() ) { 351 return $input_user; 352 } 353 354 // The 'REST_REQUEST' check here may happen too early for the constant to be available. 355 $is_api_request = ( ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ); 356 357 /** 358 * Filters whether this is an API request that Application Passwords can be used on. 359 * 360 * By default, Application Passwords is available for the REST API and XML-RPC. 361 * 362 * @since 5.6.0 363 * 364 * @param bool $is_api_request If this is an acceptable API request. 365 */ 366 $is_api_request = apply_filters( 'application_password_is_api_request', $is_api_request ); 367 368 if ( ! $is_api_request ) { 369 return $input_user; 370 } 371 372 $error = null; 373 $user = get_user_by( 'login', $username ); 374 375 if ( ! $user && is_email( $username ) ) { 376 $user = get_user_by( 'email', $username ); 377 } 378 379 // If the login name is invalid, short circuit. 380 if ( ! $user ) { 381 if ( is_email( $username ) ) { 382 $error = new WP_Error( 383 'invalid_email', 384 __( '<strong>Error:</strong> Unknown email address. Check again or try your username.' ) 385 ); 386 } else { 387 $error = new WP_Error( 388 'invalid_username', 389 __( '<strong>Error:</strong> Unknown username. Check again or try your email address.' ) 390 ); 391 } 392 } elseif ( ! wp_is_application_passwords_available() ) { 393 $error = new WP_Error( 394 'application_passwords_disabled', 395 __( 'Application passwords are not available.' ) 396 ); 397 } elseif ( ! wp_is_application_passwords_available_for_user( $user ) ) { 398 $error = new WP_Error( 399 'application_passwords_disabled_for_user', 400 __( 'Application passwords are not available for your account. Please contact the site administrator for assistance.' ) 401 ); 402 } 403 404 if ( $error ) { 405 /** 406 * Fires when an application password failed to authenticate the user. 407 * 408 * @since 5.6.0 409 * 410 * @param WP_Error $error The authentication error. 411 */ 412 do_action( 'application_password_failed_authentication', $error ); 413 414 return $error; 415 } 416 417 /* 418 * Strips out anything non-alphanumeric. This is so passwords can be used with 419 * or without spaces to indicate the groupings for readability. 420 * 421 * Generated application passwords are exclusively alphanumeric. 422 */ 423 $password = preg_replace( '/[^a-z\d]/i', '', $password ); 424 425 $hashed_passwords = WP_Application_Passwords::get_user_application_passwords( $user->ID ); 426 427 foreach ( $hashed_passwords as $key => $item ) { 428 if ( ! wp_check_password( $password, $item['password'], $user->ID ) ) { 429 continue; 430 } 431 432 $error = new WP_Error(); 433 434 /** 435 * Fires when an application password has been successfully checked as valid. 436 * 437 * This allows for plugins to add additional constraints to prevent an application password from being used. 438 * 439 * @since 5.6.0 440 * 441 * @param WP_Error $error The error object. 442 * @param WP_User $user The user authenticating. 443 * @param array $item The details about the application password. 444 * @param string $password The raw supplied password. 445 */ 446 do_action( 'wp_authenticate_application_password_errors', $error, $user, $item, $password ); 447 448 if ( is_wp_error( $error ) && $error->has_errors() ) { 449 /** This action is documented in wp-includes/user.php */ 450 do_action( 'application_password_failed_authentication', $error ); 451 452 return $error; 453 } 454 455 WP_Application_Passwords::record_application_password_usage( $user->ID, $item['uuid'] ); 456 457 /** 458 * Fires after an application password was used for authentication. 459 * 460 * @since 5.6.0 461 * 462 * @param WP_User $user The user who was authenticated. 463 * @param array $item The application password used. 464 */ 465 do_action( 'application_password_did_authenticate', $user, $item ); 466 467 return $user; 468 } 469 470 $error = new WP_Error( 471 'incorrect_password', 472 __( 'The provided password is an invalid application password.' ) 473 ); 474 475 /** This action is documented in wp-includes/user.php */ 476 do_action( 'application_password_failed_authentication', $error ); 477 478 return $error; 479 } 480 481 /** 482 * Validates the application password credentials passed via Basic Authentication. 483 * 484 * @since 5.6.0 485 * 486 * @param int|false $input_user User ID if one has been determined, false otherwise. 487 * @return int|false The authenticated user ID if successful, false otherwise. 488 */ 489 function wp_validate_application_password( $input_user ) { 490 // Don't authenticate twice. 491 if ( ! empty( $input_user ) ) { 492 return $input_user; 493 } 494 495 if ( ! wp_is_application_passwords_available() ) { 496 return $input_user; 497 } 498 499 // Both $_SERVER['PHP_AUTH_USER'] and $_SERVER['PHP_AUTH_PW'] must be set in order to attempt authentication. 500 if ( ! isset( $_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW'] ) ) { 501 return $input_user; 502 } 503 504 $authenticated = wp_authenticate_application_password( null, $_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW'] ); 505 506 if ( $authenticated instanceof WP_User ) { 507 return $authenticated->ID; 508 } 509 510 // If it wasn't a user what got returned, just pass on what we had received originally. 511 return $input_user; 512 } 513 514 /** 515 * For Multisite blogs, checks if the authenticated user has been marked as a 516 * spammer, or if the user's primary blog has been marked as spam. 517 * 518 * @since 3.7.0 519 * 520 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null. 521 * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer. 522 */ 523 function wp_authenticate_spam_check( $user ) { 524 if ( $user instanceof WP_User && is_multisite() ) { 525 /** 526 * Filters whether the user has been marked as a spammer. 527 * 528 * @since 3.7.0 529 * 530 * @param bool $spammed Whether the user is considered a spammer. 531 * @param WP_User $user User to check against. 532 */ 533 $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy( $user ), $user ); 534 535 if ( $spammed ) { 536 return new WP_Error( 'spammer_account', __( '<strong>Error:</strong> Your account has been marked as a spammer.' ) ); 537 } 538 } 539 return $user; 540 } 541 542 /** 543 * Validates the logged-in cookie. 544 * 545 * Checks the logged-in cookie if the previous auth cookie could not be 546 * validated and parsed. 547 * 548 * This is a callback for the {@see 'determine_current_user'} filter, rather than API. 549 * 550 * @since 3.9.0 551 * 552 * @param int|false $user_id The user ID (or false) as received from 553 * the `determine_current_user` filter. 554 * @return int|false User ID if validated, false otherwise. If a user ID from 555 * an earlier filter callback is received, that value is returned. 556 */ 557 function wp_validate_logged_in_cookie( $user_id ) { 558 if ( $user_id ) { 559 return $user_id; 560 } 561 562 if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[ LOGGED_IN_COOKIE ] ) ) { 563 return false; 564 } 565 566 return wp_validate_auth_cookie( $_COOKIE[ LOGGED_IN_COOKIE ], 'logged_in' ); 567 } 568 569 /** 570 * Gets the number of posts a user has written. 571 * 572 * @since 3.0.0 573 * @since 4.1.0 Added `$post_type` argument. 574 * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array 575 * of post types to `$post_type`. 576 * 577 * @global wpdb $wpdb WordPress database abstraction object. 578 * 579 * @param int $userid User ID. 580 * @param array|string $post_type Optional. Single post type or array of post types to count the number of posts for. Default 'post'. 581 * @param bool $public_only Optional. Whether to only return counts for public posts. Default false. 582 * @return string Number of posts the user has written in this post type. 583 */ 584 function count_user_posts( $userid, $post_type = 'post', $public_only = false ) { 585 global $wpdb; 586 587 $where = get_posts_by_author_sql( $post_type, true, $userid, $public_only ); 588 589 $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" ); 590 591 /** 592 * Filters the number of posts a user has written. 593 * 594 * @since 2.7.0 595 * @since 4.1.0 Added `$post_type` argument. 596 * @since 4.3.1 Added `$public_only` argument. 597 * 598 * @param int $count The user's post count. 599 * @param int $userid User ID. 600 * @param string|array $post_type Single post type or array of post types to count the number of posts for. 601 * @param bool $public_only Whether to limit counted posts to public posts. 602 */ 603 return apply_filters( 'get_usernumposts', $count, $userid, $post_type, $public_only ); 604 } 605 606 /** 607 * Gets the number of posts written by a list of users. 608 * 609 * @since 3.0.0 610 * 611 * @global wpdb $wpdb WordPress database abstraction object. 612 * 613 * @param int[] $users Array of user IDs. 614 * @param string|string[] $post_type Optional. Single post type or array of post types to check. Defaults to 'post'. 615 * @param bool $public_only Optional. Only return counts for public posts. Defaults to false. 616 * @return string[] Amount of posts each user has written, as strings, keyed by user ID. 617 */ 618 function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) { 619 global $wpdb; 620 621 $count = array(); 622 if ( empty( $users ) || ! is_array( $users ) ) { 623 return $count; 624 } 625 626 $userlist = implode( ',', array_map( 'absint', $users ) ); 627 $where = get_posts_by_author_sql( $post_type, true, null, $public_only ); 628 629 $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N ); 630 foreach ( $result as $row ) { 631 $count[ $row[0] ] = $row[1]; 632 } 633 634 foreach ( $users as $id ) { 635 if ( ! isset( $count[ $id ] ) ) { 636 $count[ $id ] = 0; 637 } 638 } 639 640 return $count; 641 } 642 643 // 644 // User option functions. 645 // 646 647 /** 648 * Gets the current user's ID. 649 * 650 * @since MU (3.0.0) 651 * 652 * @return int The current user's ID, or 0 if no user is logged in. 653 */ 654 function get_current_user_id() { 655 if ( ! function_exists( 'wp_get_current_user' ) ) { 656 return 0; 657 } 658 $user = wp_get_current_user(); 659 return ( isset( $user->ID ) ? (int) $user->ID : 0 ); 660 } 661 662 /** 663 * Retrieves user option that can be either per Site or per Network. 664 * 665 * If the user ID is not given, then the current user will be used instead. If 666 * the user ID is given, then the user data will be retrieved. The filter for 667 * the result, will also pass the original option name and finally the user data 668 * object as the third parameter. 669 * 670 * The option will first check for the per site name and then the per Network name. 671 * 672 * @since 2.0.0 673 * 674 * @global wpdb $wpdb WordPress database abstraction object. 675 * 676 * @param string $option User option name. 677 * @param int $user Optional. User ID. 678 * @param string $deprecated Use get_option() to check for an option in the options table. 679 * @return mixed User option value on success, false on failure. 680 */ 681 function get_user_option( $option, $user = 0, $deprecated = '' ) { 682 global $wpdb; 683 684 if ( ! empty( $deprecated ) ) { 685 _deprecated_argument( __FUNCTION__, '3.0.0' ); 686 } 687 688 if ( empty( $user ) ) { 689 $user = get_current_user_id(); 690 } 691 692 $user = get_userdata( $user ); 693 if ( ! $user ) { 694 return false; 695 } 696 697 $prefix = $wpdb->get_blog_prefix(); 698 if ( $user->has_prop( $prefix . $option ) ) { // Blog-specific. 699 $result = $user->get( $prefix . $option ); 700 } elseif ( $user->has_prop( $option ) ) { // User-specific and cross-blog. 701 $result = $user->get( $option ); 702 } else { 703 $result = false; 704 } 705 706 /** 707 * Filters a specific user option value. 708 * 709 * The dynamic portion of the hook name, `$option`, refers to the user option name. 710 * 711 * @since 2.5.0 712 * 713 * @param mixed $result Value for the user's option. 714 * @param string $option Name of the option being retrieved. 715 * @param WP_User $user WP_User object of the user whose option is being retrieved. 716 */ 717 return apply_filters( "get_user_option_{$option}", $result, $option, $user ); 718 } 719 720 /** 721 * Updates user option with global blog capability. 722 * 723 * User options are just like user metadata except that they have support for 724 * global blog options. If the 'is_global' parameter is false, which it is by default, 725 * it will prepend the WordPress table prefix to the option name. 726 * 727 * Deletes the user option if $newvalue is empty. 728 * 729 * @since 2.0.0 730 * 731 * @global wpdb $wpdb WordPress database abstraction object. 732 * 733 * @param int $user_id User ID. 734 * @param string $option_name User option name. 735 * @param mixed $newvalue User option value. 736 * @param bool $is_global Optional. Whether option name is global or blog specific. 737 * Default false (blog specific). 738 * @return int|bool User meta ID if the option didn't exist, true on successful update, 739 * false on failure. 740 */ 741 function update_user_option( $user_id, $option_name, $newvalue, $is_global = false ) { 742 global $wpdb; 743 744 if ( ! $is_global ) { 745 $option_name = $wpdb->get_blog_prefix() . $option_name; 746 } 747 748 return update_user_meta( $user_id, $option_name, $newvalue ); 749 } 750 751 /** 752 * Deletes user option with global blog capability. 753 * 754 * User options are just like user metadata except that they have support for 755 * global blog options. If the 'is_global' parameter is false, which it is by default, 756 * it will prepend the WordPress table prefix to the option name. 757 * 758 * @since 3.0.0 759 * 760 * @global wpdb $wpdb WordPress database abstraction object. 761 * 762 * @param int $user_id User ID 763 * @param string $option_name User option name. 764 * @param bool $is_global Optional. Whether option name is global or blog specific. 765 * Default false (blog specific). 766 * @return bool True on success, false on failure. 767 */ 768 function delete_user_option( $user_id, $option_name, $is_global = false ) { 769 global $wpdb; 770 771 if ( ! $is_global ) { 772 $option_name = $wpdb->get_blog_prefix() . $option_name; 773 } 774 775 return delete_user_meta( $user_id, $option_name ); 776 } 777 778 /** 779 * Retrieves user info by user ID. 780 * 781 * @since 6.7.0 782 * 783 * @param int $user_id User ID. 784 * 785 * @return WP_User|false WP_User object on success, false on failure. 786 */ 787 function get_user( $user_id ) { 788 return get_user_by( 'id', $user_id ); 789 } 790 791 /** 792 * Retrieves list of users matching criteria. 793 * 794 * @since 3.1.0 795 * 796 * @see WP_User_Query 797 * 798 * @param array $args Optional. Arguments to retrieve users. See WP_User_Query::prepare_query() 799 * for more information on accepted arguments. 800 * @return array List of users. 801 */ 802 function get_users( $args = array() ) { 803 804 $args = wp_parse_args( $args ); 805 $args['count_total'] = false; 806 807 $user_search = new WP_User_Query( $args ); 808 809 return (array) $user_search->get_results(); 810 } 811 812 /** 813 * Lists all the users of the site, with several options available. 814 * 815 * @since 5.9.0 816 * 817 * @param string|array $args { 818 * Optional. Array or string of default arguments. 819 * 820 * @type string $orderby How to sort the users. Accepts 'nicename', 'email', 'url', 'registered', 821 * 'user_nicename', 'user_email', 'user_url', 'user_registered', 'name', 822 * 'display_name', 'post_count', 'ID', 'meta_value', 'user_login'. Default 'name'. 823 * @type string $order Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'. 824 * @type int $number Maximum users to return or display. Default empty (all users). 825 * @type bool $exclude_admin Whether to exclude the 'admin' account, if it exists. Default false. 826 * @type bool $show_fullname Whether to show the user's full name. Default false. 827 * @type string $feed If not empty, show a link to the user's feed and use this text as the alt 828 * parameter of the link. Default empty. 829 * @type string $feed_image If not empty, show a link to the user's feed and use this image URL as 830 * clickable anchor. Default empty. 831 * @type string $feed_type The feed type to link to, such as 'rss2'. Defaults to default feed type. 832 * @type bool $echo Whether to output the result or instead return it. Default true. 833 * @type string $style If 'list', each user is wrapped in an `<li>` element, otherwise the users 834 * will be separated by commas. 835 * @type bool $html Whether to list the items in HTML form or plaintext. Default true. 836 * @type string $exclude An array, comma-, or space-separated list of user IDs to exclude. Default empty. 837 * @type string $include An array, comma-, or space-separated list of user IDs to include. Default empty. 838 * } 839 * @return string|null The output if echo is false. Otherwise null. 840 */ 841 function wp_list_users( $args = array() ) { 842 $defaults = array( 843 'orderby' => 'name', 844 'order' => 'ASC', 845 'number' => '', 846 'exclude_admin' => true, 847 'show_fullname' => false, 848 'feed' => '', 849 'feed_image' => '', 850 'feed_type' => '', 851 'echo' => true, 852 'style' => 'list', 853 'html' => true, 854 'exclude' => '', 855 'include' => '', 856 ); 857 858 $parsed_args = wp_parse_args( $args, $defaults ); 859 860 $return = ''; 861 862 $query_args = wp_array_slice_assoc( $parsed_args, array( 'orderby', 'order', 'number', 'exclude', 'include' ) ); 863 $query_args['fields'] = 'ids'; 864 865 /** 866 * Filters the query arguments for the list of all users of the site. 867 * 868 * @since 6.1.0 869 * 870 * @param array $query_args The query arguments for get_users(). 871 * @param array $parsed_args The arguments passed to wp_list_users() combined with the defaults. 872 */ 873 $query_args = apply_filters( 'wp_list_users_args', $query_args, $parsed_args ); 874 875 $users = get_users( $query_args ); 876 877 foreach ( $users as $user_id ) { 878 $user = get_userdata( $user_id ); 879 880 if ( $parsed_args['exclude_admin'] && 'admin' === $user->display_name ) { 881 continue; 882 } 883 884 if ( $parsed_args['show_fullname'] && '' !== $user->first_name && '' !== $user->last_name ) { 885 $name = sprintf( 886 /* translators: 1: User's first name, 2: Last name. */ 887 _x( '%1$s %2$s', 'Display name based on first name and last name' ), 888 $user->first_name, 889 $user->last_name 890 ); 891 } else { 892 $name = $user->display_name; 893 } 894 895 if ( ! $parsed_args['html'] ) { 896 $return .= $name . ', '; 897 898 continue; // No need to go further to process HTML. 899 } 900 901 if ( 'list' === $parsed_args['style'] ) { 902 $return .= '<li>'; 903 } 904 905 $row = $name; 906 907 if ( ! empty( $parsed_args['feed_image'] ) || ! empty( $parsed_args['feed'] ) ) { 908 $row .= ' '; 909 if ( empty( $parsed_args['feed_image'] ) ) { 910 $row .= '('; 911 } 912 913 $row .= '<a href="' . get_author_feed_link( $user->ID, $parsed_args['feed_type'] ) . '"'; 914 915 $alt = ''; 916 if ( ! empty( $parsed_args['feed'] ) ) { 917 $alt = ' alt="' . esc_attr( $parsed_args['feed'] ) . '"'; 918 $name = $parsed_args['feed']; 919 } 920 921 $row .= '>'; 922 923 if ( ! empty( $parsed_args['feed_image'] ) ) { 924 $row .= '<img src="' . esc_url( $parsed_args['feed_image'] ) . '" style="border: none;"' . $alt . ' />'; 925 } else { 926 $row .= $name; 927 } 928 929 $row .= '</a>'; 930 931 if ( empty( $parsed_args['feed_image'] ) ) { 932 $row .= ')'; 933 } 934 } 935 936 $return .= $row; 937 $return .= ( 'list' === $parsed_args['style'] ) ? '</li>' : ', '; 938 } 939 940 $return = rtrim( $return, ', ' ); 941 942 if ( ! $parsed_args['echo'] ) { 943 return $return; 944 } 945 echo $return; 946 } 947 948 /** 949 * Gets the sites a user belongs to. 950 * 951 * @since 3.0.0 952 * @since 4.7.0 Converted to use `get_sites()`. 953 * 954 * @global wpdb $wpdb WordPress database abstraction object. 955 * 956 * @param int $user_id User ID 957 * @param bool $all Whether to retrieve all sites, or only sites that are not 958 * marked as deleted, archived, or spam. 959 * @return object[] A list of the user's sites. An empty array if the user doesn't exist 960 * or belongs to no sites. 961 */ 962 function get_blogs_of_user( $user_id, $all = false ) { 963 global $wpdb; 964 965 $user_id = (int) $user_id; 966 967 // Logged out users can't have sites. 968 if ( empty( $user_id ) ) { 969 return array(); 970 } 971 972 /** 973 * Filters the list of a user's sites before it is populated. 974 * 975 * Returning a non-null value from the filter will effectively short circuit 976 * get_blogs_of_user(), returning that value instead. 977 * 978 * @since 4.6.0 979 * 980 * @param null|object[] $sites An array of site objects of which the user is a member. 981 * @param int $user_id User ID. 982 * @param bool $all Whether the returned array should contain all sites, including 983 * those marked 'deleted', 'archived', or 'spam'. Default false. 984 */ 985 $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all ); 986 987 if ( null !== $sites ) { 988 return $sites; 989 } 990 991 $keys = get_user_meta( $user_id ); 992 if ( empty( $keys ) ) { 993 return array(); 994 } 995 996 if ( ! is_multisite() ) { 997 $site_id = get_current_blog_id(); 998 $sites = array( $site_id => new stdClass() ); 999 $sites[ $site_id ]->userblog_id = $site_id; 1000 $sites[ $site_id ]->blogname = get_option( 'blogname' ); 1001 $sites[ $site_id ]->domain = ''; 1002 $sites[ $site_id ]->path = ''; 1003 $sites[ $site_id ]->site_id = 1; 1004 $sites[ $site_id ]->siteurl = get_option( 'siteurl' ); 1005 $sites[ $site_id ]->archived = 0; 1006 $sites[ $site_id ]->spam = 0; 1007 $sites[ $site_id ]->deleted = 0; 1008 return $sites; 1009 } 1010 1011 $site_ids = array(); 1012 1013 if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) { 1014 $site_ids[] = 1; 1015 unset( $keys[ $wpdb->base_prefix . 'capabilities' ] ); 1016 } 1017 1018 $keys = array_keys( $keys ); 1019 1020 foreach ( $keys as $key ) { 1021 if ( ! str_ends_with( $key, 'capabilities' ) ) { 1022 continue; 1023 } 1024 if ( $wpdb->base_prefix && ! str_starts_with( $key, $wpdb->base_prefix ) ) { 1025 continue; 1026 } 1027 $site_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key ); 1028 if ( ! is_numeric( $site_id ) ) { 1029 continue; 1030 } 1031 1032 $site_ids[] = (int) $site_id; 1033 } 1034 1035 $sites = array(); 1036 1037 if ( ! empty( $site_ids ) ) { 1038 $args = array( 1039 'number' => '', 1040 'site__in' => $site_ids, 1041 ); 1042 if ( ! $all ) { 1043 $args['archived'] = 0; 1044 $args['spam'] = 0; 1045 $args['deleted'] = 0; 1046 } 1047 1048 $_sites = get_sites( $args ); 1049 1050 foreach ( $_sites as $site ) { 1051 $sites[ $site->id ] = (object) array( 1052 'userblog_id' => $site->id, 1053 'blogname' => $site->blogname, 1054 'domain' => $site->domain, 1055 'path' => $site->path, 1056 'site_id' => $site->network_id, 1057 'siteurl' => $site->siteurl, 1058 'archived' => $site->archived, 1059 'mature' => $site->mature, 1060 'spam' => $site->spam, 1061 'deleted' => $site->deleted, 1062 ); 1063 } 1064 } 1065 1066 /** 1067 * Filters the list of sites a user belongs to. 1068 * 1069 * @since MU (3.0.0) 1070 * 1071 * @param object[] $sites An array of site objects belonging to the user. 1072 * @param int $user_id User ID. 1073 * @param bool $all Whether the returned sites array should contain all sites, including 1074 * those marked 'deleted', 'archived', or 'spam'. Default false. 1075 */ 1076 return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all ); 1077 } 1078 1079 /** 1080 * Finds out whether a user is a member of a given blog. 1081 * 1082 * @since MU (3.0.0) 1083 * 1084 * @global wpdb $wpdb WordPress database abstraction object. 1085 * 1086 * @param int $user_id Optional. The unique ID of the user. Defaults to the current user. 1087 * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site. 1088 * @return bool 1089 */ 1090 function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) { 1091 global $wpdb; 1092 1093 $user_id = (int) $user_id; 1094 $blog_id = (int) $blog_id; 1095 1096 if ( empty( $user_id ) ) { 1097 $user_id = get_current_user_id(); 1098 } 1099 1100 /* 1101 * Technically not needed, but does save calls to get_site() and get_user_meta() 1102 * in the event that the function is called when a user isn't logged in. 1103 */ 1104 if ( empty( $user_id ) ) { 1105 return false; 1106 } else { 1107 $user = get_userdata( $user_id ); 1108 if ( ! $user instanceof WP_User ) { 1109 return false; 1110 } 1111 } 1112 1113 if ( ! is_multisite() ) { 1114 return true; 1115 } 1116 1117 if ( empty( $blog_id ) ) { 1118 $blog_id = get_current_blog_id(); 1119 } 1120 1121 $blog = get_site( $blog_id ); 1122 1123 if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) { 1124 return false; 1125 } 1126 1127 $keys = get_user_meta( $user_id ); 1128 if ( empty( $keys ) ) { 1129 return false; 1130 } 1131 1132 // No underscore before capabilities in $base_capabilities_key. 1133 $base_capabilities_key = $wpdb->base_prefix . 'capabilities'; 1134 $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities'; 1135 1136 if ( isset( $keys[ $base_capabilities_key ] ) && 1 === $blog_id ) { 1137 return true; 1138 } 1139 1140 if ( isset( $keys[ $site_capabilities_key ] ) ) { 1141 return true; 1142 } 1143 1144 return false; 1145 } 1146 1147 /** 1148 * Adds meta data to a user. 1149 * 1150 * @since 3.0.0 1151 * 1152 * @param int $user_id User ID. 1153 * @param string $meta_key Metadata name. 1154 * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. 1155 * @param bool $unique Optional. Whether the same key should not be added. 1156 * Default false. 1157 * @return int|false Meta ID on success, false on failure. 1158 */ 1159 function add_user_meta( $user_id, $meta_key, $meta_value, $unique = false ) { 1160 return add_metadata( 'user', $user_id, $meta_key, $meta_value, $unique ); 1161 } 1162 1163 /** 1164 * Removes metadata matching criteria from a user. 1165 * 1166 * You can match based on the key, or key and value. Removing based on key and 1167 * value, will keep from removing duplicate metadata with the same key. It also 1168 * allows removing all metadata matching key, if needed. 1169 * 1170 * @since 3.0.0 1171 * 1172 * @link https://developer.wordpress.org/reference/functions/delete_user_meta/ 1173 * 1174 * @param int $user_id User ID 1175 * @param string $meta_key Metadata name. 1176 * @param mixed $meta_value Optional. Metadata value. If provided, 1177 * rows will only be removed that match the value. 1178 * Must be serializable if non-scalar. Default empty. 1179 * @return bool True on success, false on failure. 1180 */ 1181 function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) { 1182 return delete_metadata( 'user', $user_id, $meta_key, $meta_value ); 1183 } 1184 1185 /** 1186 * Retrieves user meta field for a user. 1187 * 1188 * @since 3.0.0 1189 * 1190 * @link https://developer.wordpress.org/reference/functions/get_user_meta/ 1191 * 1192 * @param int $user_id User ID. 1193 * @param string $key Optional. The meta key to retrieve. By default, 1194 * returns data for all keys. 1195 * @param bool $single Optional. Whether to return a single value. 1196 * This parameter has no effect if `$key` is not specified. 1197 * Default false. 1198 * @return mixed An array of values if `$single` is false. 1199 * The value of meta data field if `$single` is true. 1200 * False for an invalid `$user_id` (non-numeric, zero, or negative value). 1201 * An empty array if a valid but non-existing user ID is passed and `$single` is false. 1202 * An empty string if a valid but non-existing user ID is passed and `$single` is true. 1203 */ 1204 function get_user_meta( $user_id, $key = '', $single = false ) { 1205 return get_metadata( 'user', $user_id, $key, $single ); 1206 } 1207 1208 /** 1209 * Updates user meta field based on user ID. 1210 * 1211 * Use the $prev_value parameter to differentiate between meta fields with the 1212 * same key and user ID. 1213 * 1214 * If the meta field for the user does not exist, it will be added. 1215 * 1216 * @since 3.0.0 1217 * 1218 * @link https://developer.wordpress.org/reference/functions/update_user_meta/ 1219 * 1220 * @param int $user_id User ID. 1221 * @param string $meta_key Metadata key. 1222 * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. 1223 * @param mixed $prev_value Optional. Previous value to check before updating. 1224 * If specified, only update existing metadata entries with 1225 * this value. Otherwise, update all entries. Default empty. 1226 * @return int|bool Meta ID if the key didn't exist, true on successful update, 1227 * false on failure or if the value passed to the function 1228 * is the same as the one that is already in the database. 1229 */ 1230 function update_user_meta( $user_id, $meta_key, $meta_value, $prev_value = '' ) { 1231 return update_metadata( 'user', $user_id, $meta_key, $meta_value, $prev_value ); 1232 } 1233 1234 /** 1235 * Counts number of users who have each of the user roles. 1236 * 1237 * Assumes there are neither duplicated nor orphaned capabilities meta_values. 1238 * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query() 1239 * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users. 1240 * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257. 1241 * 1242 * @since 3.0.0 1243 * @since 4.4.0 The number of users with no role is now included in the `none` element. 1244 * @since 4.9.0 The `$site_id` parameter was added to support multisite. 1245 * 1246 * @global wpdb $wpdb WordPress database abstraction object. 1247 * 1248 * @param string $strategy Optional. The computational strategy to use when counting the users. 1249 * Accepts either 'time' or 'memory'. Default 'time'. 1250 * @param int|null $site_id Optional. The site ID to count users for. Defaults to the current site. 1251 * @return array { 1252 * User counts. 1253 * 1254 * @type int $total_users Total number of users on the site. 1255 * @type int[] $avail_roles Array of user counts keyed by user role. 1256 * } 1257 */ 1258 function count_users( $strategy = 'time', $site_id = null ) { 1259 global $wpdb; 1260 1261 // Initialize. 1262 if ( ! $site_id ) { 1263 $site_id = get_current_blog_id(); 1264 } 1265 1266 /** 1267 * Filters the user count before queries are run. 1268 * 1269 * Return a non-null value to cause count_users() to return early. 1270 * 1271 * @since 5.1.0 1272 * 1273 * @param null|array $result The value to return instead. Default null to continue with the query. 1274 * @param string $strategy Optional. The computational strategy to use when counting the users. 1275 * Accepts either 'time' or 'memory'. Default 'time'. 1276 * @param int $site_id The site ID to count users for. 1277 */ 1278 $pre = apply_filters( 'pre_count_users', null, $strategy, $site_id ); 1279 1280 if ( null !== $pre ) { 1281 return $pre; 1282 } 1283 1284 $blog_prefix = $wpdb->get_blog_prefix( $site_id ); 1285 $result = array(); 1286 1287 if ( 'time' === $strategy ) { 1288 if ( is_multisite() && get_current_blog_id() !== $site_id ) { 1289 switch_to_blog( $site_id ); 1290 $avail_roles = wp_roles()->get_names(); 1291 restore_current_blog(); 1292 } else { 1293 $avail_roles = wp_roles()->get_names(); 1294 } 1295 1296 // Build a CPU-intensive query that will return concise information. 1297 $select_count = array(); 1298 foreach ( $avail_roles as $this_role => $name ) { 1299 $select_count[] = $wpdb->prepare( 'COUNT(NULLIF(`meta_value` LIKE %s, false))', '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%' ); 1300 } 1301 $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))"; 1302 $select_count = implode( ', ', $select_count ); 1303 1304 // Add the meta_value index to the selection list, then run the query. 1305 $row = $wpdb->get_row( 1306 " 1307 SELECT {$select_count}, COUNT(*) 1308 FROM {$wpdb->usermeta} 1309 INNER JOIN {$wpdb->users} ON user_id = ID 1310 WHERE meta_key = '{$blog_prefix}capabilities' 1311 ", 1312 ARRAY_N 1313 ); 1314 1315 // Run the previous loop again to associate results with role names. 1316 $col = 0; 1317 $role_counts = array(); 1318 foreach ( $avail_roles as $this_role => $name ) { 1319 $count = (int) $row[ $col++ ]; 1320 if ( $count > 0 ) { 1321 $role_counts[ $this_role ] = $count; 1322 } 1323 } 1324 1325 $role_counts['none'] = (int) $row[ $col++ ]; 1326 1327 // Get the meta_value index from the end of the result set. 1328 $total_users = (int) $row[ $col ]; 1329 1330 $result['total_users'] = $total_users; 1331 $result['avail_roles'] =& $role_counts; 1332 } else { 1333 $avail_roles = array( 1334 'none' => 0, 1335 ); 1336 1337 $users_of_blog = $wpdb->get_col( 1338 " 1339 SELECT meta_value 1340 FROM {$wpdb->usermeta} 1341 INNER JOIN {$wpdb->users} ON user_id = ID 1342 WHERE meta_key = '{$blog_prefix}capabilities' 1343 " 1344 ); 1345 1346 foreach ( $users_of_blog as $caps_meta ) { 1347 $b_roles = maybe_unserialize( $caps_meta ); 1348 if ( ! is_array( $b_roles ) ) { 1349 continue; 1350 } 1351 if ( empty( $b_roles ) ) { 1352 ++$avail_roles['none']; 1353 } 1354 foreach ( $b_roles as $b_role => $val ) { 1355 if ( isset( $avail_roles[ $b_role ] ) ) { 1356 ++$avail_roles[ $b_role ]; 1357 } else { 1358 $avail_roles[ $b_role ] = 1; 1359 } 1360 } 1361 } 1362 1363 $result['total_users'] = count( $users_of_blog ); 1364 $result['avail_roles'] =& $avail_roles; 1365 } 1366 1367 return $result; 1368 } 1369 1370 /** 1371 * Returns the number of active users in your installation. 1372 * 1373 * Note that on a large site the count may be cached and only updated twice daily. 1374 * 1375 * @since MU (3.0.0) 1376 * @since 4.8.0 The `$network_id` parameter has been added. 1377 * @since 6.0.0 Moved to wp-includes/user.php. 1378 * 1379 * @param int|null $network_id ID of the network. Defaults to the current network. 1380 * @return int Number of active users on the network. 1381 */ 1382 function get_user_count( $network_id = null ) { 1383 if ( ! is_multisite() && null !== $network_id ) { 1384 _doing_it_wrong( 1385 __FUNCTION__, 1386 sprintf( 1387 /* translators: %s: $network_id */ 1388 __( 'Unable to pass %s if not using multisite.' ), 1389 '<code>$network_id</code>' 1390 ), 1391 '6.0.0' 1392 ); 1393 } 1394 1395 return (int) get_network_option( $network_id, 'user_count', -1 ); 1396 } 1397 1398 /** 1399 * Updates the total count of users on the site if live user counting is enabled. 1400 * 1401 * @since 6.0.0 1402 * 1403 * @param int|null $network_id ID of the network. Defaults to the current network. 1404 * @return bool Whether the update was successful. 1405 */ 1406 function wp_maybe_update_user_counts( $network_id = null ) { 1407 if ( ! is_multisite() && null !== $network_id ) { 1408 _doing_it_wrong( 1409 __FUNCTION__, 1410 sprintf( 1411 /* translators: %s: $network_id */ 1412 __( 'Unable to pass %s if not using multisite.' ), 1413 '<code>$network_id</code>' 1414 ), 1415 '6.0.0' 1416 ); 1417 } 1418 1419 $is_small_network = ! wp_is_large_user_count( $network_id ); 1420 /** This filter is documented in wp-includes/ms-functions.php */ 1421 if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) ) { 1422 return false; 1423 } 1424 1425 return wp_update_user_counts( $network_id ); 1426 } 1427 1428 /** 1429 * Updates the total count of users on the site. 1430 * 1431 * @global wpdb $wpdb WordPress database abstraction object. 1432 * @since 6.0.0 1433 * 1434 * @param int|null $network_id ID of the network. Defaults to the current network. 1435 * @return bool Whether the update was successful. 1436 */ 1437 function wp_update_user_counts( $network_id = null ) { 1438 global $wpdb; 1439 1440 if ( ! is_multisite() && null !== $network_id ) { 1441 _doing_it_wrong( 1442 __FUNCTION__, 1443 sprintf( 1444 /* translators: %s: $network_id */ 1445 __( 'Unable to pass %s if not using multisite.' ), 1446 '<code>$network_id</code>' 1447 ), 1448 '6.0.0' 1449 ); 1450 } 1451 1452 $query = "SELECT COUNT(ID) as c FROM $wpdb->users"; 1453 if ( is_multisite() ) { 1454 $query .= " WHERE spam = '0' AND deleted = '0'"; 1455 } 1456 1457 $count = $wpdb->get_var( $query ); 1458 1459 return update_network_option( $network_id, 'user_count', $count ); 1460 } 1461 1462 /** 1463 * Schedules a recurring recalculation of the total count of users. 1464 * 1465 * @since 6.0.0 1466 */ 1467 function wp_schedule_update_user_counts() { 1468 if ( ! is_main_site() ) { 1469 return; 1470 } 1471 1472 if ( ! wp_next_scheduled( 'wp_update_user_counts' ) && ! wp_installing() ) { 1473 wp_schedule_event( time(), 'twicedaily', 'wp_update_user_counts' ); 1474 } 1475 } 1476 1477 /** 1478 * Determines whether the site has a large number of users. 1479 * 1480 * The default criteria for a large site is more than 10,000 users. 1481 * 1482 * @since 6.0.0 1483 * 1484 * @param int|null $network_id ID of the network. Defaults to the current network. 1485 * @return bool Whether the site has a large number of users. 1486 */ 1487 function wp_is_large_user_count( $network_id = null ) { 1488 if ( ! is_multisite() && null !== $network_id ) { 1489 _doing_it_wrong( 1490 __FUNCTION__, 1491 sprintf( 1492 /* translators: %s: $network_id */ 1493 __( 'Unable to pass %s if not using multisite.' ), 1494 '<code>$network_id</code>' 1495 ), 1496 '6.0.0' 1497 ); 1498 } 1499 1500 $count = get_user_count( $network_id ); 1501 1502 /** 1503 * Filters whether the site is considered large, based on its number of users. 1504 * 1505 * @since 6.0.0 1506 * 1507 * @param bool $is_large_user_count Whether the site has a large number of users. 1508 * @param int $count The total number of users. 1509 * @param int|null $network_id ID of the network. `null` represents the current network. 1510 */ 1511 return apply_filters( 'wp_is_large_user_count', $count > 10000, $count, $network_id ); 1512 } 1513 1514 // 1515 // Private helper functions. 1516 // 1517 1518 /** 1519 * Sets up global user vars. 1520 * 1521 * Used by wp_set_current_user() for back compat. Might be deprecated in the future. 1522 * 1523 * @since 2.0.4 1524 * 1525 * @global string $user_login The user username for logging in 1526 * @global WP_User $userdata User data. 1527 * @global int $user_level The level of the user 1528 * @global int $user_ID The ID of the user 1529 * @global string $user_email The email address of the user 1530 * @global string $user_url The url in the user's profile 1531 * @global string $user_identity The display name of the user 1532 * 1533 * @param int $for_user_id Optional. User ID to set up global data. Default 0. 1534 */ 1535 function setup_userdata( $for_user_id = 0 ) { 1536 global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity; 1537 1538 if ( ! $for_user_id ) { 1539 $for_user_id = get_current_user_id(); 1540 } 1541 $user = get_userdata( $for_user_id ); 1542 1543 if ( ! $user ) { 1544 $user_ID = 0; 1545 $user_level = 0; 1546 $userdata = null; 1547 $user_login = ''; 1548 $user_email = ''; 1549 $user_url = ''; 1550 $user_identity = ''; 1551 return; 1552 } 1553 1554 $user_ID = (int) $user->ID; 1555 $user_level = (int) $user->user_level; 1556 $userdata = $user; 1557 $user_login = $user->user_login; 1558 $user_email = $user->user_email; 1559 $user_url = $user->user_url; 1560 $user_identity = $user->display_name; 1561 } 1562 1563 /** 1564 * Creates dropdown HTML content of users. 1565 * 1566 * The content can either be displayed, which it is by default, or retrieved by 1567 * setting the 'echo' argument to false. The 'include' and 'exclude' arguments 1568 * are optional; if they are not specified, all users will be displayed. Only one 1569 * can be used in a single call, either 'include' or 'exclude', but not both. 1570 * 1571 * @since 2.3.0 1572 * @since 4.5.0 Added the 'display_name_with_login' value for 'show'. 1573 * @since 4.7.0 Added the 'role', 'role__in', and 'role__not_in' parameters. 1574 * @since 5.9.0 Added the 'capability', 'capability__in', and 'capability__not_in' parameters. 1575 * Deprecated the 'who' parameter. 1576 * 1577 * @param array|string $args { 1578 * Optional. Array or string of arguments to generate a drop-down of users. 1579 * See WP_User_Query::prepare_query() for additional available arguments. 1580 * 1581 * @type string $show_option_all Text to show as the drop-down default (all). 1582 * Default empty. 1583 * @type string $show_option_none Text to show as the drop-down default when no 1584 * users were found. Default empty. 1585 * @type int|string $option_none_value Value to use for `$show_option_none` when no users 1586 * were found. Default -1. 1587 * @type string $hide_if_only_one_author Whether to skip generating the drop-down 1588 * if only one user was found. Default empty. 1589 * @type string $orderby Field to order found users by. Accepts user fields. 1590 * Default 'display_name'. 1591 * @type string $order Whether to order users in ascending or descending 1592 * order. Accepts 'ASC' (ascending) or 'DESC' (descending). 1593 * Default 'ASC'. 1594 * @type int[]|string $include Array or comma-separated list of user IDs to include. 1595 * Default empty. 1596 * @type int[]|string $exclude Array or comma-separated list of user IDs to exclude. 1597 * Default empty. 1598 * @type bool|int $multi Whether to skip the ID attribute on the 'select' element. 1599 * Accepts 1|true or 0|false. Default 0|false. 1600 * @type string $show User data to display. If the selected item is empty 1601 * then the 'user_login' will be displayed in parentheses. 1602 * Accepts any user field, or 'display_name_with_login' to show 1603 * the display name with user_login in parentheses. 1604 * Default 'display_name'. 1605 * @type int|bool $echo Whether to echo or return the drop-down. Accepts 1|true (echo) 1606 * or 0|false (return). Default 1|true. 1607 * @type int $selected Which user ID should be selected. Default 0. 1608 * @type bool $include_selected Whether to always include the selected user ID in the drop- 1609 * down. Default false. 1610 * @type string $name Name attribute of select element. Default 'user'. 1611 * @type string $id ID attribute of the select element. Default is the value of `$name`. 1612 * @type string $class Class attribute of the select element. Default empty. 1613 * @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog. 1614 * @type string $who Deprecated, use `$capability` instead. 1615 * Which type of users to query. Accepts only an empty string or 1616 * 'authors'. Default empty (all users). 1617 * @type string|string[] $role An array or a comma-separated list of role names that users 1618 * must match to be included in results. Note that this is 1619 * an inclusive list: users must match *each* role. Default empty. 1620 * @type string[] $role__in An array of role names. Matched users must have at least one 1621 * of these roles. Default empty array. 1622 * @type string[] $role__not_in An array of role names to exclude. Users matching one or more 1623 * of these roles will not be included in results. Default empty array. 1624 * @type string|string[] $capability An array or a comma-separated list of capability names that users 1625 * must match to be included in results. Note that this is 1626 * an inclusive list: users must match *each* capability. 1627 * Does NOT work for capabilities not in the database or filtered 1628 * via {@see 'map_meta_cap'}. Default empty. 1629 * @type string[] $capability__in An array of capability names. Matched users must have at least one 1630 * of these capabilities. 1631 * Does NOT work for capabilities not in the database or filtered 1632 * via {@see 'map_meta_cap'}. Default empty array. 1633 * @type string[] $capability__not_in An array of capability names to exclude. Users matching one or more 1634 * of these capabilities will not be included in results. 1635 * Does NOT work for capabilities not in the database or filtered 1636 * via {@see 'map_meta_cap'}. Default empty array. 1637 * } 1638 * @return string HTML dropdown list of users. 1639 */ 1640 function wp_dropdown_users( $args = '' ) { 1641 $defaults = array( 1642 'show_option_all' => '', 1643 'show_option_none' => '', 1644 'hide_if_only_one_author' => '', 1645 'orderby' => 'display_name', 1646 'order' => 'ASC', 1647 'include' => '', 1648 'exclude' => '', 1649 'multi' => 0, 1650 'show' => 'display_name', 1651 'echo' => 1, 1652 'selected' => 0, 1653 'name' => 'user', 1654 'class' => '', 1655 'id' => '', 1656 'blog_id' => get_current_blog_id(), 1657 'who' => '', 1658 'include_selected' => false, 1659 'option_none_value' => -1, 1660 'role' => '', 1661 'role__in' => array(), 1662 'role__not_in' => array(), 1663 'capability' => '', 1664 'capability__in' => array(), 1665 'capability__not_in' => array(), 1666 ); 1667 1668 $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0; 1669 1670 $parsed_args = wp_parse_args( $args, $defaults ); 1671 1672 $query_args = wp_array_slice_assoc( 1673 $parsed_args, 1674 array( 1675 'blog_id', 1676 'include', 1677 'exclude', 1678 'orderby', 1679 'order', 1680 'who', 1681 'role', 1682 'role__in', 1683 'role__not_in', 1684 'capability', 1685 'capability__in', 1686 'capability__not_in', 1687 ) 1688 ); 1689 1690 $fields = array( 'ID', 'user_login' ); 1691 1692 $show = ! empty( $parsed_args['show'] ) ? $parsed_args['show'] : 'display_name'; 1693 if ( 'display_name_with_login' === $show ) { 1694 $fields[] = 'display_name'; 1695 } else { 1696 $fields[] = $show; 1697 } 1698 1699 $query_args['fields'] = $fields; 1700 1701 $show_option_all = $parsed_args['show_option_all']; 1702 $show_option_none = $parsed_args['show_option_none']; 1703 $option_none_value = $parsed_args['option_none_value']; 1704 1705 /** 1706 * Filters the query arguments for the list of users in the dropdown. 1707 * 1708 * @since 4.4.0 1709 * 1710 * @param array $query_args The query arguments for get_users(). 1711 * @param array $parsed_args The arguments passed to wp_dropdown_users() combined with the defaults. 1712 */ 1713 $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $parsed_args ); 1714 1715 $users = get_users( $query_args ); 1716 1717 $output = ''; 1718 if ( ! empty( $users ) && ( empty( $parsed_args['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) { 1719 $name = esc_attr( $parsed_args['name'] ); 1720 if ( $parsed_args['multi'] && ! $parsed_args['id'] ) { 1721 $id = ''; 1722 } else { 1723 $id = $parsed_args['id'] ? " id='" . esc_attr( $parsed_args['id'] ) . "'" : " id='$name'"; 1724 } 1725 $output = "<select name='{$name}'{$id} class='" . $parsed_args['class'] . "'>\n"; 1726 1727 if ( $show_option_all ) { 1728 $output .= "\t<option value='0'>$show_option_all</option>\n"; 1729 } 1730 1731 if ( $show_option_none ) { 1732 $_selected = selected( $option_none_value, $parsed_args['selected'], false ); 1733 $output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n"; 1734 } 1735 1736 if ( $parsed_args['include_selected'] && ( $parsed_args['selected'] > 0 ) ) { 1737 $found_selected = false; 1738 $parsed_args['selected'] = (int) $parsed_args['selected']; 1739 1740 foreach ( (array) $users as $user ) { 1741 $user->ID = (int) $user->ID; 1742 if ( $user->ID === $parsed_args['selected'] ) { 1743 $found_selected = true; 1744 } 1745 } 1746 1747 if ( ! $found_selected ) { 1748 $selected_user = get_userdata( $parsed_args['selected'] ); 1749 if ( $selected_user ) { 1750 $users[] = $selected_user; 1751 } 1752 } 1753 } 1754 1755 foreach ( (array) $users as $user ) { 1756 if ( 'display_name_with_login' === $show ) { 1757 /* translators: 1: User's display name, 2: User login. */ 1758 $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login ); 1759 } elseif ( ! empty( $user->$show ) ) { 1760 $display = $user->$show; 1761 } else { 1762 $display = '(' . $user->user_login . ')'; 1763 } 1764 1765 $_selected = selected( $user->ID, $parsed_args['selected'], false ); 1766 $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n"; 1767 } 1768 1769 $output .= '</select>'; 1770 } 1771 1772 /** 1773 * Filters the wp_dropdown_users() HTML output. 1774 * 1775 * @since 2.3.0 1776 * 1777 * @param string $output HTML output generated by wp_dropdown_users(). 1778 */ 1779 $html = apply_filters( 'wp_dropdown_users', $output ); 1780 1781 if ( $parsed_args['echo'] ) { 1782 echo $html; 1783 } 1784 return $html; 1785 } 1786 1787 /** 1788 * Sanitizes user field based on context. 1789 * 1790 * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The 1791 * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display' 1792 * when calling filters. 1793 * 1794 * @since 2.3.0 1795 * 1796 * @param string $field The user Object field name. 1797 * @param mixed $value The user Object value. 1798 * @param int $user_id User ID. 1799 * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display', 1800 * 'attribute' and 'js'. 1801 * @return mixed Sanitized value. 1802 */ 1803 function sanitize_user_field( $field, $value, $user_id, $context ) { 1804 $int_fields = array( 'ID' ); 1805 if ( in_array( $field, $int_fields, true ) ) { 1806 $value = (int) $value; 1807 } 1808 1809 if ( 'raw' === $context ) { 1810 return $value; 1811 } 1812 1813 if ( ! is_string( $value ) && ! is_numeric( $value ) ) { 1814 return $value; 1815 } 1816 1817 $prefixed = str_contains( $field, 'user_' ); 1818 1819 if ( 'edit' === $context ) { 1820 if ( $prefixed ) { 1821 1822 /** This filter is documented in wp-includes/post.php */ 1823 $value = apply_filters( "edit_{$field}", $value, $user_id ); 1824 } else { 1825 1826 /** 1827 * Filters a user field value in the 'edit' context. 1828 * 1829 * The dynamic portion of the hook name, `$field`, refers to the prefixed user 1830 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc. 1831 * 1832 * @since 2.9.0 1833 * 1834 * @param mixed $value Value of the prefixed user field. 1835 * @param int $user_id User ID. 1836 */ 1837 $value = apply_filters( "edit_user_{$field}", $value, $user_id ); 1838 } 1839 1840 if ( 'description' === $field ) { 1841 $value = esc_html( $value ); // textarea_escaped? 1842 } else { 1843 $value = esc_attr( $value ); 1844 } 1845 } elseif ( 'db' === $context ) { 1846 if ( $prefixed ) { 1847 /** This filter is documented in wp-includes/post.php */ 1848 $value = apply_filters( "pre_{$field}", $value ); 1849 } else { 1850 1851 /** 1852 * Filters the value of a user field in the 'db' context. 1853 * 1854 * The dynamic portion of the hook name, `$field`, refers to the prefixed user 1855 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc. 1856 * 1857 * @since 2.9.0 1858 * 1859 * @param mixed $value Value of the prefixed user field. 1860 */ 1861 $value = apply_filters( "pre_user_{$field}", $value ); 1862 } 1863 } else { 1864 // Use display filters by default. 1865 if ( $prefixed ) { 1866 1867 /** This filter is documented in wp-includes/post.php */ 1868 $value = apply_filters( "{$field}", $value, $user_id, $context ); 1869 } else { 1870 1871 /** 1872 * Filters the value of a user field in a standard context. 1873 * 1874 * The dynamic portion of the hook name, `$field`, refers to the prefixed user 1875 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc. 1876 * 1877 * @since 2.9.0 1878 * 1879 * @param mixed $value The user object value to sanitize. 1880 * @param int $user_id User ID. 1881 * @param string $context The context to filter within. 1882 */ 1883 $value = apply_filters( "user_{$field}", $value, $user_id, $context ); 1884 } 1885 } 1886 1887 if ( 'user_url' === $field ) { 1888 $value = esc_url( $value ); 1889 } 1890 1891 if ( 'attribute' === $context ) { 1892 $value = esc_attr( $value ); 1893 } elseif ( 'js' === $context ) { 1894 $value = esc_js( $value ); 1895 } 1896 1897 // Restore the type for integer fields after esc_attr(). 1898 if ( in_array( $field, $int_fields, true ) ) { 1899 $value = (int) $value; 1900 } 1901 1902 return $value; 1903 } 1904 1905 /** 1906 * Updates all user caches. 1907 * 1908 * @since 3.0.0 1909 * 1910 * @param object|WP_User $user User object or database row to be cached 1911 * @return void|false Void on success, false on failure. 1912 */ 1913 function update_user_caches( $user ) { 1914 if ( $user instanceof WP_User ) { 1915 if ( ! $user->exists() ) { 1916 return false; 1917 } 1918 1919 $user = $user->data; 1920 } 1921 1922 wp_cache_add( $user->ID, $user, 'users' ); 1923 wp_cache_add( $user->user_login, $user->ID, 'userlogins' ); 1924 wp_cache_add( $user->user_nicename, $user->ID, 'userslugs' ); 1925 1926 if ( ! empty( $user->user_email ) ) { 1927 wp_cache_add( $user->user_email, $user->ID, 'useremail' ); 1928 } 1929 } 1930 1931 /** 1932 * Cleans all user caches. 1933 * 1934 * @since 3.0.0 1935 * @since 4.4.0 'clean_user_cache' action was added. 1936 * @since 6.2.0 User metadata caches are now cleared. 1937 * 1938 * @param WP_User|int $user User object or ID to be cleaned from the cache 1939 */ 1940 function clean_user_cache( $user ) { 1941 if ( is_numeric( $user ) ) { 1942 $user = new WP_User( $user ); 1943 } 1944 1945 if ( ! $user->exists() ) { 1946 return; 1947 } 1948 1949 wp_cache_delete( $user->ID, 'users' ); 1950 wp_cache_delete( $user->user_login, 'userlogins' ); 1951 wp_cache_delete( $user->user_nicename, 'userslugs' ); 1952 1953 if ( ! empty( $user->user_email ) ) { 1954 wp_cache_delete( $user->user_email, 'useremail' ); 1955 } 1956 1957 wp_cache_delete( $user->ID, 'user_meta' ); 1958 wp_cache_set_users_last_changed(); 1959 1960 /** 1961 * Fires immediately after the given user's cache is cleaned. 1962 * 1963 * @since 4.4.0 1964 * 1965 * @param int $user_id User ID. 1966 * @param WP_User $user User object. 1967 */ 1968 do_action( 'clean_user_cache', $user->ID, $user ); 1969 } 1970 1971 /** 1972 * Determines whether the given username exists. 1973 * 1974 * For more information on this and similar theme functions, check out 1975 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1976 * Conditional Tags} article in the Theme Developer Handbook. 1977 * 1978 * @since 2.0.0 1979 * 1980 * @param string $username The username to check for existence. 1981 * @return int|false The user ID on success, false on failure. 1982 */ 1983 function username_exists( $username ) { 1984 $user = get_user_by( 'login', $username ); 1985 if ( $user ) { 1986 $user_id = $user->ID; 1987 } else { 1988 $user_id = false; 1989 } 1990 1991 /** 1992 * Filters whether the given username exists. 1993 * 1994 * @since 4.9.0 1995 * 1996 * @param int|false $user_id The user ID associated with the username, 1997 * or false if the username does not exist. 1998 * @param string $username The username to check for existence. 1999 */ 2000 return apply_filters( 'username_exists', $user_id, $username ); 2001 } 2002 2003 /** 2004 * Determines whether the given email exists. 2005 * 2006 * For more information on this and similar theme functions, check out 2007 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 2008 * Conditional Tags} article in the Theme Developer Handbook. 2009 * 2010 * @since 2.1.0 2011 * 2012 * @param string $email The email to check for existence. 2013 * @return int|false The user ID on success, false on failure. 2014 */ 2015 function email_exists( $email ) { 2016 $user = get_user_by( 'email', $email ); 2017 if ( $user ) { 2018 $user_id = $user->ID; 2019 } else { 2020 $user_id = false; 2021 } 2022 2023 /** 2024 * Filters whether the given email exists. 2025 * 2026 * @since 5.6.0 2027 * 2028 * @param int|false $user_id The user ID associated with the email, 2029 * or false if the email does not exist. 2030 * @param string $email The email to check for existence. 2031 */ 2032 return apply_filters( 'email_exists', $user_id, $email ); 2033 } 2034 2035 /** 2036 * Checks whether a username is valid. 2037 * 2038 * @since 2.0.1 2039 * @since 4.4.0 Empty sanitized usernames are now considered invalid. 2040 * 2041 * @param string $username Username. 2042 * @return bool Whether username given is valid. 2043 */ 2044 function validate_username( $username ) { 2045 $sanitized = sanitize_user( $username, true ); 2046 $valid = ( $sanitized === $username && ! empty( $sanitized ) ); 2047 2048 /** 2049 * Filters whether the provided username is valid. 2050 * 2051 * @since 2.0.1 2052 * 2053 * @param bool $valid Whether given username is valid. 2054 * @param string $username Username to check. 2055 */ 2056 return apply_filters( 'validate_username', $valid, $username ); 2057 } 2058 2059 /** 2060 * Inserts a user into the database. 2061 * 2062 * Most of the `$userdata` array fields have filters associated with the values. Exceptions are 2063 * 'ID', 'rich_editing', 'syntax_highlighting', 'comment_shortcuts', 'admin_color', 'use_ssl', 2064 * 'user_registered', 'user_activation_key', 'spam', and 'role'. The filters have the prefix 2065 * 'pre_user_' followed by the field name. An example using 'description' would have the filter 2066 * called 'pre_user_description' that can be hooked into. 2067 * 2068 * @since 2.0.0 2069 * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact 2070 * methods for new installations. See wp_get_user_contact_methods(). 2071 * @since 4.7.0 The `locale` field can be passed to `$userdata`. 2072 * @since 5.3.0 The `user_activation_key` field can be passed to `$userdata`. 2073 * @since 5.3.0 The `spam` field can be passed to `$userdata` (Multisite only). 2074 * @since 5.9.0 The `meta_input` field can be passed to `$userdata` to allow addition of user meta data. 2075 * 2076 * @global wpdb $wpdb WordPress database abstraction object. 2077 * 2078 * @param array|object|WP_User $userdata { 2079 * An array, object, or WP_User object of user data arguments. 2080 * 2081 * @type int $ID User ID. If supplied, the user will be updated. 2082 * @type string $user_pass The plain-text user password for new users. 2083 * Hashed password for existing users. 2084 * @type string $user_login The user's login username. 2085 * @type string $user_nicename The URL-friendly user name. 2086 * @type string $user_url The user URL. 2087 * @type string $user_email The user email address. 2088 * @type string $display_name The user's display name. 2089 * Default is the user's username. 2090 * @type string $nickname The user's nickname. 2091 * Default is the user's username. 2092 * @type string $first_name The user's first name. For new users, will be used 2093 * to build the first part of the user's display name 2094 * if `$display_name` is not specified. 2095 * @type string $last_name The user's last name. For new users, will be used 2096 * to build the second part of the user's display name 2097 * if `$display_name` is not specified. 2098 * @type string $description The user's biographical description. 2099 * @type string $rich_editing Whether to enable the rich-editor for the user. 2100 * Accepts 'true' or 'false' as a string literal, 2101 * not boolean. Default 'true'. 2102 * @type string $syntax_highlighting Whether to enable the rich code editor for the user. 2103 * Accepts 'true' or 'false' as a string literal, 2104 * not boolean. Default 'true'. 2105 * @type string $comment_shortcuts Whether to enable comment moderation keyboard 2106 * shortcuts for the user. Accepts 'true' or 'false' 2107 * as a string literal, not boolean. Default 'false'. 2108 * @type string $admin_color Admin color scheme for the user. Default 'fresh'. 2109 * @type bool $use_ssl Whether the user should always access the admin over 2110 * https. Default false. 2111 * @type string $user_registered Date the user registered in UTC. Format is 'Y-m-d H:i:s'. 2112 * @type string $user_activation_key Password reset key. Default empty. 2113 * @type bool $spam Multisite only. Whether the user is marked as spam. 2114 * Default false. 2115 * @type string $show_admin_bar_front Whether to display the Admin Bar for the user 2116 * on the site's front end. Accepts 'true' or 'false' 2117 * as a string literal, not boolean. Default 'true'. 2118 * @type string $role User's role. 2119 * @type string $locale User's locale. Default empty. 2120 * @type array $meta_input Array of custom user meta values keyed by meta key. 2121 * Default empty. 2122 * } 2123 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not 2124 * be created. 2125 */ 2126 function wp_insert_user( $userdata ) { 2127 global $wpdb; 2128 2129 if ( $userdata instanceof stdClass ) { 2130 $userdata = get_object_vars( $userdata ); 2131 } elseif ( $userdata instanceof WP_User ) { 2132 $userdata = $userdata->to_array(); 2133 } 2134 2135 // Are we updating or creating? 2136 if ( ! empty( $userdata['ID'] ) ) { 2137 $user_id = (int) $userdata['ID']; 2138 $update = true; 2139 $old_user_data = get_userdata( $user_id ); 2140 2141 if ( ! $old_user_data ) { 2142 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) ); 2143 } 2144 2145 // Slash current user email to compare it later with slashed new user email. 2146 $old_user_data->user_email = wp_slash( $old_user_data->user_email ); 2147 2148 // Hashed in wp_update_user(), plaintext if called directly. 2149 $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass; 2150 } else { 2151 $update = false; 2152 // Hash the password. 2153 $user_pass = wp_hash_password( $userdata['user_pass'] ); 2154 } 2155 2156 $sanitized_user_login = sanitize_user( $userdata['user_login'], true ); 2157 2158 /** 2159 * Filters a username after it has been sanitized. 2160 * 2161 * This filter is called before the user is created or updated. 2162 * 2163 * @since 2.0.3 2164 * 2165 * @param string $sanitized_user_login Username after it has been sanitized. 2166 */ 2167 $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login ); 2168 2169 // Remove any non-printable chars from the login string to see if we have ended up with an empty username. 2170 $user_login = trim( $pre_user_login ); 2171 2172 // user_login must be between 0 and 60 characters. 2173 if ( empty( $user_login ) ) { 2174 return new WP_Error( 'empty_user_login', __( 'Cannot create a user with an empty login name.' ) ); 2175 } elseif ( mb_strlen( $user_login ) > 60 ) { 2176 return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) ); 2177 } 2178 2179 if ( ! $update && username_exists( $user_login ) ) { 2180 return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) ); 2181 } 2182 2183 /** 2184 * Filters the list of disallowed usernames. 2185 * 2186 * @since 4.4.0 2187 * 2188 * @param array $usernames Array of disallowed usernames. 2189 */ 2190 $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() ); 2191 2192 if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ), true ) ) { 2193 return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) ); 2194 } 2195 2196 /* 2197 * If a nicename is provided, remove unsafe user characters before using it. 2198 * Otherwise build a nicename from the user_login. 2199 */ 2200 if ( ! empty( $userdata['user_nicename'] ) ) { 2201 $user_nicename = sanitize_user( $userdata['user_nicename'], true ); 2202 } else { 2203 $user_nicename = mb_substr( $user_login, 0, 50 ); 2204 } 2205 2206 $user_nicename = sanitize_title( $user_nicename ); 2207 2208 /** 2209 * Filters a user's nicename before the user is created or updated. 2210 * 2211 * @since 2.0.3 2212 * 2213 * @param string $user_nicename The user's nicename. 2214 */ 2215 $user_nicename = apply_filters( 'pre_user_nicename', $user_nicename ); 2216 2217 if ( mb_strlen( $user_nicename ) > 50 ) { 2218 return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) ); 2219 } 2220 2221 $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 ) ); 2222 2223 if ( $user_nicename_check ) { 2224 $suffix = 2; 2225 while ( $user_nicename_check ) { 2226 // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix. 2227 $base_length = 49 - mb_strlen( $suffix ); 2228 $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix"; 2229 $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 ) ); 2230 ++$suffix; 2231 } 2232 $user_nicename = $alt_user_nicename; 2233 } 2234 2235 $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email']; 2236 2237 /** 2238 * Filters a user's email before the user is created or updated. 2239 * 2240 * @since 2.0.3 2241 * 2242 * @param string $raw_user_email The user's email. 2243 */ 2244 $user_email = apply_filters( 'pre_user_email', $raw_user_email ); 2245 2246 /* 2247 * If there is no update, just check for `email_exists`. If there is an update, 2248 * check if current email and new email are the same, and check `email_exists` 2249 * accordingly. 2250 */ 2251 if ( ( ! $update || ( ! empty( $old_user_data ) && 0 !== strcasecmp( $user_email, $old_user_data->user_email ) ) ) 2252 && ! defined( 'WP_IMPORTING' ) 2253 && email_exists( $user_email ) 2254 ) { 2255 return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) ); 2256 } 2257 2258 $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url']; 2259 2260 /** 2261 * Filters a user's URL before the user is created or updated. 2262 * 2263 * @since 2.0.3 2264 * 2265 * @param string $raw_user_url The user's URL. 2266 */ 2267 $user_url = apply_filters( 'pre_user_url', $raw_user_url ); 2268 2269 if ( mb_strlen( $user_url ) > 100 ) { 2270 return new WP_Error( 'user_url_too_long', __( 'User URL may not be longer than 100 characters.' ) ); 2271 } 2272 2273 $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered']; 2274 2275 $user_activation_key = empty( $userdata['user_activation_key'] ) ? '' : $userdata['user_activation_key']; 2276 2277 if ( ! empty( $userdata['spam'] ) && ! is_multisite() ) { 2278 return new WP_Error( 'no_spam', __( 'Sorry, marking a user as spam is only supported on Multisite.' ) ); 2279 } 2280 2281 $spam = empty( $userdata['spam'] ) ? 0 : (bool) $userdata['spam']; 2282 2283 // Store values to save in user meta. 2284 $meta = array(); 2285 2286 $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname']; 2287 2288 /** 2289 * Filters a user's nickname before the user is created or updated. 2290 * 2291 * @since 2.0.3 2292 * 2293 * @param string $nickname The user's nickname. 2294 */ 2295 $meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname ); 2296 2297 $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name']; 2298 2299 /** 2300 * Filters a user's first name before the user is created or updated. 2301 * 2302 * @since 2.0.3 2303 * 2304 * @param string $first_name The user's first name. 2305 */ 2306 $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name ); 2307 2308 $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name']; 2309 2310 /** 2311 * Filters a user's last name before the user is created or updated. 2312 * 2313 * @since 2.0.3 2314 * 2315 * @param string $last_name The user's last name. 2316 */ 2317 $meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name ); 2318 2319 if ( empty( $userdata['display_name'] ) ) { 2320 if ( $update ) { 2321 $display_name = $user_login; 2322 } elseif ( $meta['first_name'] && $meta['last_name'] ) { 2323 $display_name = sprintf( 2324 /* translators: 1: User's first name, 2: Last name. */ 2325 _x( '%1$s %2$s', 'Display name based on first name and last name' ), 2326 $meta['first_name'], 2327 $meta['last_name'] 2328 ); 2329 } elseif ( $meta['first_name'] ) { 2330 $display_name = $meta['first_name']; 2331 } elseif ( $meta['last_name'] ) { 2332 $display_name = $meta['last_name']; 2333 } else { 2334 $display_name = $user_login; 2335 } 2336 } else { 2337 $display_name = $userdata['display_name']; 2338 } 2339 2340 /** 2341 * Filters a user's display name before the user is created or updated. 2342 * 2343 * @since 2.0.3 2344 * 2345 * @param string $display_name The user's display name. 2346 */ 2347 $display_name = apply_filters( 'pre_user_display_name', $display_name ); 2348 2349 $description = empty( $userdata['description'] ) ? '' : $userdata['description']; 2350 2351 /** 2352 * Filters a user's description before the user is created or updated. 2353 * 2354 * @since 2.0.3 2355 * 2356 * @param string $description The user's description. 2357 */ 2358 $meta['description'] = apply_filters( 'pre_user_description', $description ); 2359 2360 $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing']; 2361 2362 $meta['syntax_highlighting'] = empty( $userdata['syntax_highlighting'] ) ? 'true' : $userdata['syntax_highlighting']; 2363 2364 $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true'; 2365 2366 $admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color']; 2367 $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color ); 2368 2369 $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? '0' : '1'; 2370 2371 $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front']; 2372 2373 $meta['locale'] = isset( $userdata['locale'] ) ? $userdata['locale'] : ''; 2374 2375 $compacted = compact( 'user_pass', 'user_nicename', 'user_email', 'user_url', 'user_registered', 'user_activation_key', 'display_name' ); 2376 $data = wp_unslash( $compacted ); 2377 2378 if ( ! $update ) { 2379 $data = $data + compact( 'user_login' ); 2380 } 2381 2382 if ( is_multisite() ) { 2383 $data = $data + compact( 'spam' ); 2384 } 2385 2386 /** 2387 * Filters user data before the record is created or updated. 2388 * 2389 * It only includes data in the users table, not any user metadata. 2390 * 2391 * @since 4.9.0 2392 * @since 5.8.0 The `$userdata` parameter was added. 2393 * 2394 * @param array $data { 2395 * Values and keys for the user. 2396 * 2397 * @type string $user_login The user's login. Only included if $update == false 2398 * @type string $user_pass The user's password. 2399 * @type string $user_email The user's email. 2400 * @type string $user_url The user's url. 2401 * @type string $user_nicename The user's nice name. Defaults to a URL-safe version of user's login. 2402 * @type string $display_name The user's display name. 2403 * @type string $user_registered MySQL timestamp describing the moment when the user registered. Defaults to 2404 * the current UTC timestamp. 2405 * } 2406 * @param bool $update Whether the user is being updated rather than created. 2407 * @param int|null $user_id ID of the user to be updated, or NULL if the user is being created. 2408 * @param array $userdata The raw array of data passed to wp_insert_user(). 2409 */ 2410 $data = apply_filters( 'wp_pre_insert_user_data', $data, $update, ( $update ? $user_id : null ), $userdata ); 2411 2412 if ( empty( $data ) || ! is_array( $data ) ) { 2413 return new WP_Error( 'empty_data', __( 'Not enough data to create this user.' ) ); 2414 } 2415 2416 if ( $update ) { 2417 if ( $user_email !== $old_user_data->user_email || $user_pass !== $old_user_data->user_pass ) { 2418 $data['user_activation_key'] = ''; 2419 } 2420 $wpdb->update( $wpdb->users, $data, array( 'ID' => $user_id ) ); 2421 } else { 2422 $wpdb->insert( $wpdb->users, $data ); 2423 $user_id = (int) $wpdb->insert_id; 2424 } 2425 2426 $user = new WP_User( $user_id ); 2427 2428 /** 2429 * Filters a user's meta values and keys immediately after the user is created or updated 2430 * and before any user meta is inserted or updated. 2431 * 2432 * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`. 2433 * 2434 * For custom meta fields, see the {@see 'insert_custom_user_meta'} filter. 2435 * 2436 * @since 4.4.0 2437 * @since 5.8.0 The `$userdata` parameter was added. 2438 * 2439 * @param array $meta { 2440 * Default meta values and keys for the user. 2441 * 2442 * @type string $nickname The user's nickname. Default is the user's username. 2443 * @type string $first_name The user's first name. 2444 * @type string $last_name The user's last name. 2445 * @type string $description The user's description. 2446 * @type string $rich_editing Whether to enable the rich-editor for the user. Default 'true'. 2447 * @type string $syntax_highlighting Whether to enable the rich code editor for the user. Default 'true'. 2448 * @type string $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default 'false'. 2449 * @type string $admin_color The color scheme for a user's admin screen. Default 'fresh'. 2450 * @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL 2451 * is not forced. 2452 * @type string $show_admin_bar_front Whether to show the admin bar on the front end for the user. 2453 * Default 'true'. 2454 * @type string $locale User's locale. Default empty. 2455 * } 2456 * @param WP_User $user User object. 2457 * @param bool $update Whether the user is being updated rather than created. 2458 * @param array $userdata The raw array of data passed to wp_insert_user(). 2459 */ 2460 $meta = apply_filters( 'insert_user_meta', $meta, $user, $update, $userdata ); 2461 2462 $custom_meta = array(); 2463 if ( array_key_exists( 'meta_input', $userdata ) && is_array( $userdata['meta_input'] ) && ! empty( $userdata['meta_input'] ) ) { 2464 $custom_meta = $userdata['meta_input']; 2465 } 2466 2467 /** 2468 * Filters a user's custom meta values and keys immediately after the user is created or updated 2469 * and before any user meta is inserted or updated. 2470 * 2471 * For non-custom meta fields, see the {@see 'insert_user_meta'} filter. 2472 * 2473 * @since 5.9.0 2474 * 2475 * @param array $custom_meta Array of custom user meta values keyed by meta key. 2476 * @param WP_User $user User object. 2477 * @param bool $update Whether the user is being updated rather than created. 2478 * @param array $userdata The raw array of data passed to wp_insert_user(). 2479 */ 2480 $custom_meta = apply_filters( 'insert_custom_user_meta', $custom_meta, $user, $update, $userdata ); 2481 2482 $meta = array_merge( $meta, $custom_meta ); 2483 2484 if ( $update ) { 2485 // Update user meta. 2486 foreach ( $meta as $key => $value ) { 2487 update_user_meta( $user_id, $key, $value ); 2488 } 2489 } else { 2490 // Add user meta. 2491 foreach ( $meta as $key => $value ) { 2492 add_user_meta( $user_id, $key, $value ); 2493 } 2494 } 2495 2496 foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) { 2497 if ( isset( $userdata[ $key ] ) ) { 2498 update_user_meta( $user_id, $key, $userdata[ $key ] ); 2499 } 2500 } 2501 2502 if ( isset( $userdata['role'] ) ) { 2503 $user->set_role( $userdata['role'] ); 2504 } elseif ( ! $update ) { 2505 $user->set_role( get_option( 'default_role' ) ); 2506 } 2507 2508 clean_user_cache( $user_id ); 2509 2510 if ( $update ) { 2511 /** 2512 * Fires immediately after an existing user is updated. 2513 * 2514 * @since 2.0.0 2515 * @since 5.8.0 The `$userdata` parameter was added. 2516 * 2517 * @param int $user_id User ID. 2518 * @param WP_User $old_user_data Object containing user's data prior to update. 2519 * @param array $userdata The raw array of data passed to wp_insert_user(). 2520 */ 2521 do_action( 'profile_update', $user_id, $old_user_data, $userdata ); 2522 2523 if ( isset( $userdata['spam'] ) && $userdata['spam'] !== $old_user_data->spam ) { 2524 if ( '1' === $userdata['spam'] ) { 2525 /** 2526 * Fires after the user is marked as a SPAM user. 2527 * 2528 * @since 3.0.0 2529 * 2530 * @param int $user_id ID of the user marked as SPAM. 2531 */ 2532 do_action( 'make_spam_user', $user_id ); 2533 } else { 2534 /** 2535 * Fires after the user is marked as a HAM user. Opposite of SPAM. 2536 * 2537 * @since 3.0.0 2538 * 2539 * @param int $user_id ID of the user marked as HAM. 2540 */ 2541 do_action( 'make_ham_user', $user_id ); 2542 } 2543 } 2544 } else { 2545 /** 2546 * Fires immediately after a new user is registered. 2547 * 2548 * @since 1.5.0 2549 * @since 5.8.0 The `$userdata` parameter was added. 2550 * 2551 * @param int $user_id User ID. 2552 * @param array $userdata The raw array of data passed to wp_insert_user(). 2553 */ 2554 do_action( 'user_register', $user_id, $userdata ); 2555 } 2556 2557 return $user_id; 2558 } 2559 2560 /** 2561 * Updates a user in the database. 2562 * 2563 * It is possible to update a user's password by specifying the 'user_pass' 2564 * value in the $userdata parameter array. 2565 * 2566 * If current user's password is being updated, then the cookies will be 2567 * cleared. 2568 * 2569 * @since 2.0.0 2570 * 2571 * @see wp_insert_user() For what fields can be set in $userdata. 2572 * 2573 * @param array|object|WP_User $userdata An array of user data or a user object of type stdClass or WP_User. 2574 * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated. 2575 */ 2576 function wp_update_user( $userdata ) { 2577 if ( $userdata instanceof stdClass ) { 2578 $userdata = get_object_vars( $userdata ); 2579 } elseif ( $userdata instanceof WP_User ) { 2580 $userdata = $userdata->to_array(); 2581 } 2582 2583 $userdata_raw = $userdata; 2584 2585 $user_id = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0; 2586 if ( ! $user_id ) { 2587 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) ); 2588 } 2589 2590 // First, get all of the original fields. 2591 $user_obj = get_userdata( $user_id ); 2592 if ( ! $user_obj ) { 2593 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) ); 2594 } 2595 2596 $user = $user_obj->to_array(); 2597 2598 // Add additional custom fields. 2599 foreach ( _get_additional_user_keys( $user_obj ) as $key ) { 2600 $user[ $key ] = get_user_meta( $user_id, $key, true ); 2601 } 2602 2603 // Escape data pulled from DB. 2604 $user = add_magic_quotes( $user ); 2605 2606 if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) { 2607 // If password is changing, hash it now. 2608 $plaintext_pass = $userdata['user_pass']; 2609 $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] ); 2610 2611 /** 2612 * Filters whether to send the password change email. 2613 * 2614 * @since 4.3.0 2615 * 2616 * @see wp_insert_user() For `$user` and `$userdata` fields. 2617 * 2618 * @param bool $send Whether to send the email. 2619 * @param array $user The original user array. 2620 * @param array $userdata The updated user array. 2621 */ 2622 $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata ); 2623 } 2624 2625 if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) { 2626 /** 2627 * Filters whether to send the email change email. 2628 * 2629 * @since 4.3.0 2630 * 2631 * @see wp_insert_user() For `$user` and `$userdata` fields. 2632 * 2633 * @param bool $send Whether to send the email. 2634 * @param array $user The original user array. 2635 * @param array $userdata The updated user array. 2636 */ 2637 $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata ); 2638 } 2639 2640 clean_user_cache( $user_obj ); 2641 2642 // Merge old and new fields with new fields overwriting old ones. 2643 $userdata = array_merge( $user, $userdata ); 2644 $user_id = wp_insert_user( $userdata ); 2645 2646 if ( is_wp_error( $user_id ) ) { 2647 return $user_id; 2648 } 2649 2650 $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ); 2651 2652 $switched_locale = false; 2653 if ( ! empty( $send_password_change_email ) || ! empty( $send_email_change_email ) ) { 2654 $switched_locale = switch_to_user_locale( $user_id ); 2655 } 2656 2657 if ( ! empty( $send_password_change_email ) ) { 2658 /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */ 2659 $pass_change_text = __( 2660 'Hi ###USERNAME###, 2661 2662 This notice confirms that your password was changed on ###SITENAME###. 2663 2664 If you did not change your password, please contact the Site Administrator at 2665 ###ADMIN_EMAIL### 2666 2667 This email has been sent to ###EMAIL### 2668 2669 Regards, 2670 All at ###SITENAME### 2671 ###SITEURL###' 2672 ); 2673 2674 $pass_change_email = array( 2675 'to' => $user['user_email'], 2676 /* translators: Password change notification email subject. %s: Site title. */ 2677 'subject' => __( '[%s] Password Changed' ), 2678 'message' => $pass_change_text, 2679 'headers' => '', 2680 ); 2681 2682 /** 2683 * Filters the contents of the email sent when the user's password is changed. 2684 * 2685 * @since 4.3.0 2686 * 2687 * @param array $pass_change_email { 2688 * Used to build wp_mail(). 2689 * 2690 * @type string $to The intended recipients. Add emails in a comma separated string. 2691 * @type string $subject The subject of the email. 2692 * @type string $message The content of the email. 2693 * The following strings have a special meaning and will get replaced dynamically: 2694 * - ###USERNAME### The current user's username. 2695 * - ###ADMIN_EMAIL### The admin email in case this was unexpected. 2696 * - ###EMAIL### The user's email address. 2697 * - ###SITENAME### The name of the site. 2698 * - ###SITEURL### The URL to the site. 2699 * @type string $headers Headers. Add headers in a newline (\r\n) separated string. 2700 * } 2701 * @param array $user The original user array. 2702 * @param array $userdata The updated user array. 2703 */ 2704 $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata ); 2705 2706 $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] ); 2707 $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] ); 2708 $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] ); 2709 $pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] ); 2710 $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] ); 2711 2712 wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] ); 2713 } 2714 2715 if ( ! empty( $send_email_change_email ) ) { 2716 /* translators: Do not translate USERNAME, ADMIN_EMAIL, NEW_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */ 2717 $email_change_text = __( 2718 'Hi ###USERNAME###, 2719 2720 This notice confirms that your email address on ###SITENAME### was changed to ###NEW_EMAIL###. 2721 2722 If you did not change your email, please contact the Site Administrator at 2723 ###ADMIN_EMAIL### 2724 2725 This email has been sent to ###EMAIL### 2726 2727 Regards, 2728 All at ###SITENAME### 2729 ###SITEURL###' 2730 ); 2731 2732 $email_change_email = array( 2733 'to' => $user['user_email'], 2734 /* translators: Email change notification email subject. %s: Site title. */ 2735 'subject' => __( '[%s] Email Changed' ), 2736 'message' => $email_change_text, 2737 'headers' => '', 2738 ); 2739 2740 /** 2741 * Filters the contents of the email sent when the user's email is changed. 2742 * 2743 * @since 4.3.0 2744 * 2745 * @param array $email_change_email { 2746 * Used to build wp_mail(). 2747 * 2748 * @type string $to The intended recipients. 2749 * @type string $subject The subject of the email. 2750 * @type string $message The content of the email. 2751 * The following strings have a special meaning and will get replaced dynamically: 2752 * - ###USERNAME### The current user's username. 2753 * - ###ADMIN_EMAIL### The admin email in case this was unexpected. 2754 * - ###NEW_EMAIL### The new email address. 2755 * - ###EMAIL### The old email address. 2756 * - ###SITENAME### The name of the site. 2757 * - ###SITEURL### The URL to the site. 2758 * @type string $headers Headers. 2759 * } 2760 * @param array $user The original user array. 2761 * @param array $userdata The updated user array. 2762 */ 2763 $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata ); 2764 2765 $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] ); 2766 $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] ); 2767 $email_change_email['message'] = str_replace( '###NEW_EMAIL###', $userdata['user_email'], $email_change_email['message'] ); 2768 $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] ); 2769 $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] ); 2770 $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] ); 2771 2772 wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] ); 2773 } 2774 2775 if ( $switched_locale ) { 2776 restore_previous_locale(); 2777 } 2778 2779 // Update the cookies if the password changed. 2780 $current_user = wp_get_current_user(); 2781 if ( $current_user->ID === $user_id ) { 2782 if ( isset( $plaintext_pass ) ) { 2783 wp_clear_auth_cookie(); 2784 2785 /* 2786 * Here we calculate the expiration length of the current auth cookie and compare it to the default expiration. 2787 * If it's greater than this, then we know the user checked 'Remember Me' when they logged in. 2788 */ 2789 $logged_in_cookie = wp_parse_auth_cookie( '', 'logged_in' ); 2790 /** This filter is documented in wp-includes/pluggable.php */ 2791 $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $user_id, false ); 2792 2793 $remember = false; 2794 2795 if ( false !== $logged_in_cookie && ( (int) $logged_in_cookie['expiration'] - time() ) > $default_cookie_life ) { 2796 $remember = true; 2797 } 2798 2799 wp_set_auth_cookie( $user_id, $remember ); 2800 } 2801 } 2802 2803 /** 2804 * Fires after the user has been updated and emails have been sent. 2805 * 2806 * @since 6.3.0 2807 * 2808 * @param int $user_id The ID of the user that was just updated. 2809 * @param array $userdata The array of user data that was updated. 2810 * @param array $userdata_raw The unedited array of user data that was updated. 2811 */ 2812 do_action( 'wp_update_user', $user_id, $userdata, $userdata_raw ); 2813 2814 return $user_id; 2815 } 2816 2817 /** 2818 * Provides a simpler way of inserting a user into the database. 2819 * 2820 * Creates a new user with just the username, password, and email. For more 2821 * complex user creation use wp_insert_user() to specify more information. 2822 * 2823 * @since 2.0.0 2824 * 2825 * @see wp_insert_user() More complete way to create a new user. 2826 * 2827 * @param string $username The user's username. 2828 * @param string $password The user's password. 2829 * @param string $email Optional. The user's email. Default empty. 2830 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not 2831 * be created. 2832 */ 2833 function wp_create_user( $username, $password, $email = '' ) { 2834 $user_login = wp_slash( $username ); 2835 $user_email = wp_slash( $email ); 2836 $user_pass = $password; 2837 2838 $userdata = compact( 'user_login', 'user_email', 'user_pass' ); 2839 return wp_insert_user( $userdata ); 2840 } 2841 2842 /** 2843 * Returns a list of meta keys to be (maybe) populated in wp_update_user(). 2844 * 2845 * The list of keys returned via this function are dependent on the presence 2846 * of those keys in the user meta data to be set. 2847 * 2848 * @since 3.3.0 2849 * @access private 2850 * 2851 * @param WP_User $user WP_User instance. 2852 * @return string[] List of user keys to be populated in wp_update_user(). 2853 */ 2854 function _get_additional_user_keys( $user ) { 2855 $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'syntax_highlighting', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front', 'locale' ); 2856 return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) ); 2857 } 2858 2859 /** 2860 * Sets up the user contact methods. 2861 * 2862 * Default contact methods were removed in 3.6. A filter dictates contact methods. 2863 * 2864 * @since 3.7.0 2865 * 2866 * @param WP_User|null $user Optional. WP_User object. 2867 * @return string[] Array of contact method labels keyed by contact method. 2868 */ 2869 function wp_get_user_contact_methods( $user = null ) { 2870 $methods = array(); 2871 if ( get_site_option( 'initial_db_version' ) < 23588 ) { 2872 $methods = array( 2873 'aim' => __( 'AIM' ), 2874 'yim' => __( 'Yahoo IM' ), 2875 'jabber' => __( 'Jabber / Google Talk' ), 2876 ); 2877 } 2878 2879 /** 2880 * Filters the user contact methods. 2881 * 2882 * @since 2.9.0 2883 * 2884 * @param string[] $methods Array of contact method labels keyed by contact method. 2885 * @param WP_User|null $user WP_User object or null if none was provided. 2886 */ 2887 return apply_filters( 'user_contactmethods', $methods, $user ); 2888 } 2889 2890 /** 2891 * The old private function for setting up user contact methods. 2892 * 2893 * Use wp_get_user_contact_methods() instead. 2894 * 2895 * @since 2.9.0 2896 * @access private 2897 * 2898 * @param WP_User|null $user Optional. WP_User object. Default null. 2899 * @return string[] Array of contact method labels keyed by contact method. 2900 */ 2901 function _wp_get_user_contactmethods( $user = null ) { 2902 return wp_get_user_contact_methods( $user ); 2903 } 2904 2905 /** 2906 * Gets the text suggesting how to create strong passwords. 2907 * 2908 * @since 4.1.0 2909 * 2910 * @return string The password hint text. 2911 */ 2912 function wp_get_password_hint() { 2913 $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 ! " ? $ % ^ & ).' ); 2914 2915 /** 2916 * Filters the text describing the site's password complexity policy. 2917 * 2918 * @since 4.1.0 2919 * 2920 * @param string $hint The password hint text. 2921 */ 2922 return apply_filters( 'password_hint', $hint ); 2923 } 2924 2925 /** 2926 * Creates, stores, then returns a password reset key for user. 2927 * 2928 * @since 4.4.0 2929 * 2930 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance. 2931 * 2932 * @param WP_User $user User to retrieve password reset key for. 2933 * @return string|WP_Error Password reset key on success. WP_Error on error. 2934 */ 2935 function get_password_reset_key( $user ) { 2936 global $wp_hasher; 2937 2938 if ( ! ( $user instanceof WP_User ) ) { 2939 return new WP_Error( 'invalidcombo', __( '<strong>Error:</strong> There is no account with that username or email address.' ) ); 2940 } 2941 2942 /** 2943 * Fires before a new password is retrieved. 2944 * 2945 * Use the {@see 'retrieve_password'} hook instead. 2946 * 2947 * @since 1.5.0 2948 * @deprecated 1.5.1 Misspelled. Use {@see 'retrieve_password'} hook instead. 2949 * 2950 * @param string $user_login The user login name. 2951 */ 2952 do_action_deprecated( 'retreive_password', array( $user->user_login ), '1.5.1', 'retrieve_password' ); 2953 2954 /** 2955 * Fires before a new password is retrieved. 2956 * 2957 * @since 1.5.1 2958 * 2959 * @param string $user_login The user login name. 2960 */ 2961 do_action( 'retrieve_password', $user->user_login ); 2962 2963 $password_reset_allowed = wp_is_password_reset_allowed_for_user( $user ); 2964 if ( ! $password_reset_allowed ) { 2965 return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) ); 2966 } elseif ( is_wp_error( $password_reset_allowed ) ) { 2967 return $password_reset_allowed; 2968 } 2969 2970 // Generate something random for a password reset key. 2971 $key = wp_generate_password( 20, false ); 2972 2973 /** 2974 * Fires when a password reset key is generated. 2975 * 2976 * @since 2.5.0 2977 * 2978 * @param string $user_login The username for the user. 2979 * @param string $key The generated password reset key. 2980 */ 2981 do_action( 'retrieve_password_key', $user->user_login, $key ); 2982 2983 // Now insert the key, hashed, into the DB. 2984 if ( empty( $wp_hasher ) ) { 2985 require_once ABSPATH . WPINC . '/class-phpass.php'; 2986 $wp_hasher = new PasswordHash( 8, true ); 2987 } 2988 2989 $hashed = time() . ':' . $wp_hasher->HashPassword( $key ); 2990 2991 $key_saved = wp_update_user( 2992 array( 2993 'ID' => $user->ID, 2994 'user_activation_key' => $hashed, 2995 ) 2996 ); 2997 2998 if ( is_wp_error( $key_saved ) ) { 2999 return $key_saved; 3000 } 3001 3002 return $key; 3003 } 3004 3005 /** 3006 * Retrieves a user row based on password reset key and login. 3007 * 3008 * A key is considered 'expired' if it exactly matches the value of the 3009 * user_activation_key field, rather than being matched after going through the 3010 * hashing process. This field is now hashed; old values are no longer accepted 3011 * but have a different WP_Error code so good user feedback can be provided. 3012 * 3013 * @since 3.1.0 3014 * 3015 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance. 3016 * 3017 * @param string $key Hash to validate sending user's password. 3018 * @param string $login The user login. 3019 * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys. 3020 */ 3021 function check_password_reset_key( $key, $login ) { 3022 global $wp_hasher; 3023 3024 $key = preg_replace( '/[^a-z0-9]/i', '', $key ); 3025 3026 if ( empty( $key ) || ! is_string( $key ) ) { 3027 return new WP_Error( 'invalid_key', __( 'Invalid key.' ) ); 3028 } 3029 3030 if ( empty( $login ) || ! is_string( $login ) ) { 3031 return new WP_Error( 'invalid_key', __( 'Invalid key.' ) ); 3032 } 3033 3034 $user = get_user_by( 'login', $login ); 3035 3036 if ( ! $user ) { 3037 return new WP_Error( 'invalid_key', __( 'Invalid key.' ) ); 3038 } 3039 3040 if ( empty( $wp_hasher ) ) { 3041 require_once ABSPATH . WPINC . '/class-phpass.php'; 3042 $wp_hasher = new PasswordHash( 8, true ); 3043 } 3044 3045 /** 3046 * Filters the expiration time of password reset keys. 3047 * 3048 * @since 4.3.0 3049 * 3050 * @param int $expiration The expiration time in seconds. 3051 */ 3052 $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS ); 3053 3054 if ( str_contains( $user->user_activation_key, ':' ) ) { 3055 list( $pass_request_time, $pass_key ) = explode( ':', $user->user_activation_key, 2 ); 3056 $expiration_time = $pass_request_time + $expiration_duration; 3057 } else { 3058 $pass_key = $user->user_activation_key; 3059 $expiration_time = false; 3060 } 3061 3062 if ( ! $pass_key ) { 3063 return new WP_Error( 'invalid_key', __( 'Invalid key.' ) ); 3064 } 3065 3066 $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key ); 3067 3068 if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) { 3069 return $user; 3070 } elseif ( $hash_is_correct && $expiration_time ) { 3071 // Key has an expiration time that's passed. 3072 return new WP_Error( 'expired_key', __( 'Invalid key.' ) ); 3073 } 3074 3075 if ( hash_equals( $user->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) { 3076 $return = new WP_Error( 'expired_key', __( 'Invalid key.' ) ); 3077 $user_id = $user->ID; 3078 3079 /** 3080 * Filters the return value of check_password_reset_key() when an 3081 * old-style key is used. 3082 * 3083 * @since 3.7.0 Previously plain-text keys were stored in the database. 3084 * @since 4.3.0 Previously key hashes were stored without an expiration time. 3085 * 3086 * @param WP_Error $return A WP_Error object denoting an expired key. 3087 * Return a WP_User object to validate the key. 3088 * @param int $user_id The matched user ID. 3089 */ 3090 return apply_filters( 'password_reset_key_expired', $return, $user_id ); 3091 } 3092 3093 return new WP_Error( 'invalid_key', __( 'Invalid key.' ) ); 3094 } 3095 3096 /** 3097 * Handles sending a password retrieval email to a user. 3098 * 3099 * @since 2.5.0 3100 * @since 5.7.0 Added `$user_login` parameter. 3101 * 3102 * @global wpdb $wpdb WordPress database abstraction object. 3103 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance. 3104 * 3105 * @param string $user_login Optional. Username to send a password retrieval email for. 3106 * Defaults to `$_POST['user_login']` if not set. 3107 * @return true|WP_Error True when finished, WP_Error object on error. 3108 */ 3109 function retrieve_password( $user_login = '' ) { 3110 $errors = new WP_Error(); 3111 $user_data = false; 3112 3113 // Use the passed $user_login if available, otherwise use $_POST['user_login']. 3114 if ( ! $user_login && ! empty( $_POST['user_login'] ) ) { 3115 $user_login = $_POST['user_login']; 3116 } 3117 3118 $user_login = trim( wp_unslash( $user_login ) ); 3119 3120 if ( empty( $user_login ) ) { 3121 $errors->add( 'empty_username', __( '<strong>Error:</strong> Please enter a username or email address.' ) ); 3122 } elseif ( strpos( $user_login, '@' ) ) { 3123 $user_data = get_user_by( 'email', $user_login ); 3124 3125 if ( empty( $user_data ) ) { 3126 $user_data = get_user_by( 'login', $user_login ); 3127 } 3128 3129 if ( empty( $user_data ) ) { 3130 $errors->add( 'invalid_email', __( '<strong>Error:</strong> There is no account with that username or email address.' ) ); 3131 } 3132 } else { 3133 $user_data = get_user_by( 'login', $user_login ); 3134 } 3135 3136 /** 3137 * Filters the user data during a password reset request. 3138 * 3139 * Allows, for example, custom validation using data other than username or email address. 3140 * 3141 * @since 5.7.0 3142 * 3143 * @param WP_User|false $user_data WP_User object if found, false if the user does not exist. 3144 * @param WP_Error $errors A WP_Error object containing any errors generated 3145 * by using invalid credentials. 3146 */ 3147 $user_data = apply_filters( 'lostpassword_user_data', $user_data, $errors ); 3148 3149 /** 3150 * Fires before errors are returned from a password reset request. 3151 * 3152 * @since 2.1.0 3153 * @since 4.4.0 Added the `$errors` parameter. 3154 * @since 5.4.0 Added the `$user_data` parameter. 3155 * 3156 * @param WP_Error $errors A WP_Error object containing any errors generated 3157 * by using invalid credentials. 3158 * @param WP_User|false $user_data WP_User object if found, false if the user does not exist. 3159 */ 3160 do_action( 'lostpassword_post', $errors, $user_data ); 3161 3162 /** 3163 * Filters the errors encountered on a password reset request. 3164 * 3165 * The filtered WP_Error object may, for example, contain errors for an invalid 3166 * username or email address. A WP_Error object should always be returned, 3167 * but may or may not contain errors. 3168 * 3169 * If any errors are present in $errors, this will abort the password reset request. 3170 * 3171 * @since 5.5.0 3172 * 3173 * @param WP_Error $errors A WP_Error object containing any errors generated 3174 * by using invalid credentials. 3175 * @param WP_User|false $user_data WP_User object if found, false if the user does not exist. 3176 */ 3177 $errors = apply_filters( 'lostpassword_errors', $errors, $user_data ); 3178 3179 if ( $errors->has_errors() ) { 3180 return $errors; 3181 } 3182 3183 if ( ! $user_data ) { 3184 $errors->add( 'invalidcombo', __( '<strong>Error:</strong> There is no account with that username or email address.' ) ); 3185 return $errors; 3186 } 3187 3188 /** 3189 * Filters whether to send the retrieve password email. 3190 * 3191 * Return false to disable sending the email. 3192 * 3193 * @since 6.0.0 3194 * 3195 * @param bool $send Whether to send the email. 3196 * @param string $user_login The username for the user. 3197 * @param WP_User $user_data WP_User object. 3198 */ 3199 if ( ! apply_filters( 'send_retrieve_password_email', true, $user_login, $user_data ) ) { 3200 return true; 3201 } 3202 3203 // Redefining user_login ensures we return the right case in the email. 3204 $user_login = $user_data->user_login; 3205 $user_email = $user_data->user_email; 3206 $key = get_password_reset_key( $user_data ); 3207 3208 if ( is_wp_error( $key ) ) { 3209 return $key; 3210 } 3211 3212 // Localize password reset message content for user. 3213 $locale = get_user_locale( $user_data ); 3214 3215 $switched_locale = switch_to_user_locale( $user_data->ID ); 3216 3217 if ( is_multisite() ) { 3218 $site_name = get_network()->site_name; 3219 } else { 3220 /* 3221 * The blogname option is escaped with esc_html on the way into the database 3222 * in sanitize_option. We want to reverse this for the plain text arena of emails. 3223 */ 3224 $site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ); 3225 } 3226 3227 $message = __( 'Someone has requested a password reset for the following account:' ) . "\r\n\r\n"; 3228 /* translators: %s: Site name. */ 3229 $message .= sprintf( __( 'Site Name: %s' ), $site_name ) . "\r\n\r\n"; 3230 /* translators: %s: User login. */ 3231 $message .= sprintf( __( 'Username: %s' ), $user_login ) . "\r\n\r\n"; 3232 $message .= __( 'If this was a mistake, ignore this email and nothing will happen.' ) . "\r\n\r\n"; 3233 $message .= __( 'To reset your password, visit the following address:' ) . "\r\n\r\n"; 3234 3235 /* 3236 * Since some user login names end in a period, this could produce ambiguous URLs that 3237 * end in a period. To avoid the ambiguity, ensure that the login is not the last query 3238 * arg in the URL. If moving it to the end, a trailing period will need to be escaped. 3239 * 3240 * @see https://core.trac.wordpress.org/tickets/42957 3241 */ 3242 $message .= network_site_url( 'wp-login.php?login=' . rawurlencode( $user_login ) . "&key=$key&action=rp", 'login' ) . '&wp_lang=' . $locale . "\r\n\r\n"; 3243 3244 if ( ! is_user_logged_in() ) { 3245 $requester_ip = $_SERVER['REMOTE_ADDR']; 3246 if ( $requester_ip ) { 3247 $message .= sprintf( 3248 /* translators: %s: IP address of password reset requester. */ 3249 __( 'This password reset request originated from the IP address %s.' ), 3250 $requester_ip 3251 ) . "\r\n"; 3252 } 3253 } 3254 3255 /* translators: Password reset notification email subject. %s: Site title. */ 3256 $title = sprintf( __( '[%s] Password Reset' ), $site_name ); 3257 3258 /** 3259 * Filters the subject of the password reset email. 3260 * 3261 * @since 2.8.0 3262 * @since 4.4.0 Added the `$user_login` and `$user_data` parameters. 3263 * 3264 * @param string $title Email subject. 3265 * @param string $user_login The username for the user. 3266 * @param WP_User $user_data WP_User object. 3267 */ 3268 $title = apply_filters( 'retrieve_password_title', $title, $user_login, $user_data ); 3269 3270 /** 3271 * Filters the message body of the password reset mail. 3272 * 3273 * If the filtered message is empty, the password reset email will not be sent. 3274 * 3275 * @since 2.8.0 3276 * @since 4.1.0 Added `$user_login` and `$user_data` parameters. 3277 * 3278 * @param string $message Email message. 3279 * @param string $key The activation key. 3280 * @param string $user_login The username for the user. 3281 * @param WP_User $user_data WP_User object. 3282 */ 3283 $message = apply_filters( 'retrieve_password_message', $message, $key, $user_login, $user_data ); 3284 3285 // Short-circuit on falsey $message value for backwards compatibility. 3286 if ( ! $message ) { 3287 return true; 3288 } 3289 3290 /* 3291 * Wrap the single notification email arguments in an array 3292 * to pass them to the retrieve_password_notification_email filter. 3293 */ 3294 $defaults = array( 3295 'to' => $user_email, 3296 'subject' => $title, 3297 'message' => $message, 3298 'headers' => '', 3299 ); 3300 3301 /** 3302 * Filters the contents of the reset password notification email sent to the user. 3303 * 3304 * @since 6.0.0 3305 * 3306 * @param array $defaults { 3307 * The default notification email arguments. Used to build wp_mail(). 3308 * 3309 * @type string $to The intended recipient - user email address. 3310 * @type string $subject The subject of the email. 3311 * @type string $message The body of the email. 3312 * @type string $headers The headers of the email. 3313 * } 3314 * @param string $key The activation key. 3315 * @param string $user_login The username for the user. 3316 * @param WP_User $user_data WP_User object. 3317 */ 3318 $notification_email = apply_filters( 'retrieve_password_notification_email', $defaults, $key, $user_login, $user_data ); 3319 3320 if ( $switched_locale ) { 3321 restore_previous_locale(); 3322 } 3323 3324 if ( is_array( $notification_email ) ) { 3325 // Force key order and merge defaults in case any value is missing in the filtered array. 3326 $notification_email = array_merge( $defaults, $notification_email ); 3327 } else { 3328 $notification_email = $defaults; 3329 } 3330 3331 list( $to, $subject, $message, $headers ) = array_values( $notification_email ); 3332 3333 $subject = wp_specialchars_decode( $subject ); 3334 3335 if ( ! wp_mail( $to, $subject, $message, $headers ) ) { 3336 $errors->add( 3337 'retrieve_password_email_failure', 3338 sprintf( 3339 /* translators: %s: Documentation URL. */ 3340 __( '<strong>Error:</strong> The email could not be sent. Your site may not be correctly configured to send emails. <a href="%s">Get support for resetting your password</a>.' ), 3341 esc_url( __( 'https://wordpress.org/documentation/article/reset-your-password/' ) ) 3342 ) 3343 ); 3344 return $errors; 3345 } 3346 3347 return true; 3348 } 3349 3350 /** 3351 * Handles resetting the user's password. 3352 * 3353 * @since 2.5.0 3354 * 3355 * @param WP_User $user The user 3356 * @param string $new_pass New password for the user in plaintext 3357 */ 3358 function reset_password( $user, $new_pass ) { 3359 /** 3360 * Fires before the user's password is reset. 3361 * 3362 * @since 1.5.0 3363 * 3364 * @param WP_User $user The user. 3365 * @param string $new_pass New user password. 3366 */ 3367 do_action( 'password_reset', $user, $new_pass ); 3368 3369 wp_set_password( $new_pass, $user->ID ); 3370 update_user_meta( $user->ID, 'default_password_nag', false ); 3371 3372 /** 3373 * Fires after the user's password is reset. 3374 * 3375 * @since 4.4.0 3376 * 3377 * @param WP_User $user The user. 3378 * @param string $new_pass New user password. 3379 */ 3380 do_action( 'after_password_reset', $user, $new_pass ); 3381 } 3382 3383 /** 3384 * Handles registering a new user. 3385 * 3386 * @since 2.5.0 3387 * 3388 * @param string $user_login User's username for logging in 3389 * @param string $user_email User's email address to send password and add 3390 * @return int|WP_Error Either user's ID or error on failure. 3391 */ 3392 function register_new_user( $user_login, $user_email ) { 3393 $errors = new WP_Error(); 3394 3395 $sanitized_user_login = sanitize_user( $user_login ); 3396 /** 3397 * Filters the email address of a user being registered. 3398 * 3399 * @since 2.1.0 3400 * 3401 * @param string $user_email The email address of the new user. 3402 */ 3403 $user_email = apply_filters( 'user_registration_email', $user_email ); 3404 3405 // Check the username. 3406 if ( '' === $sanitized_user_login ) { 3407 $errors->add( 'empty_username', __( '<strong>Error:</strong> Please enter a username.' ) ); 3408 } elseif ( ! validate_username( $user_login ) ) { 3409 $errors->add( 'invalid_username', __( '<strong>Error:</strong> This username is invalid because it uses illegal characters. Please enter a valid username.' ) ); 3410 $sanitized_user_login = ''; 3411 } elseif ( username_exists( $sanitized_user_login ) ) { 3412 $errors->add( 'username_exists', __( '<strong>Error:</strong> This username is already registered. Please choose another one.' ) ); 3413 } else { 3414 /** This filter is documented in wp-includes/user.php */ 3415 $illegal_user_logins = (array) apply_filters( 'illegal_user_logins', array() ); 3416 if ( in_array( strtolower( $sanitized_user_login ), array_map( 'strtolower', $illegal_user_logins ), true ) ) { 3417 $errors->add( 'invalid_username', __( '<strong>Error:</strong> Sorry, that username is not allowed.' ) ); 3418 } 3419 } 3420 3421 // Check the email address. 3422 if ( '' === $user_email ) { 3423 $errors->add( 'empty_email', __( '<strong>Error:</strong> Please type your email address.' ) ); 3424 } elseif ( ! is_email( $user_email ) ) { 3425 $errors->add( 'invalid_email', __( '<strong>Error:</strong> The email address is not correct.' ) ); 3426 $user_email = ''; 3427 } elseif ( email_exists( $user_email ) ) { 3428 $errors->add( 3429 'email_exists', 3430 sprintf( 3431 /* translators: %s: Link to the login page. */ 3432 __( '<strong>Error:</strong> This email address is already registered. <a href="%s">Log in</a> with this address or choose another one.' ), 3433 wp_login_url() 3434 ) 3435 ); 3436 } 3437 3438 /** 3439 * Fires when submitting registration form data, before the user is created. 3440 * 3441 * @since 2.1.0 3442 * 3443 * @param string $sanitized_user_login The submitted username after being sanitized. 3444 * @param string $user_email The submitted email. 3445 * @param WP_Error $errors Contains any errors with submitted username and email, 3446 * e.g., an empty field, an invalid username or email, 3447 * or an existing username or email. 3448 */ 3449 do_action( 'register_post', $sanitized_user_login, $user_email, $errors ); 3450 3451 /** 3452 * Filters the errors encountered when a new user is being registered. 3453 * 3454 * The filtered WP_Error object may, for example, contain errors for an invalid 3455 * or existing username or email address. A WP_Error object should always be returned, 3456 * but may or may not contain errors. 3457 * 3458 * If any errors are present in $errors, this will abort the user's registration. 3459 * 3460 * @since 2.1.0 3461 * 3462 * @param WP_Error $errors A WP_Error object containing any errors encountered 3463 * during registration. 3464 * @param string $sanitized_user_login User's username after it has been sanitized. 3465 * @param string $user_email User's email. 3466 */ 3467 $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email ); 3468 3469 if ( $errors->has_errors() ) { 3470 return $errors; 3471 } 3472 3473 $user_pass = wp_generate_password( 12, false ); 3474 $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email ); 3475 if ( ! $user_id || is_wp_error( $user_id ) ) { 3476 $errors->add( 3477 'registerfail', 3478 sprintf( 3479 /* translators: %s: Admin email address. */ 3480 __( '<strong>Error:</strong> Could not register you… please contact the <a href="mailto:%s">site admin</a>!' ), 3481 get_option( 'admin_email' ) 3482 ) 3483 ); 3484 return $errors; 3485 } 3486 3487 update_user_meta( $user_id, 'default_password_nag', true ); // Set up the password change nag. 3488 3489 if ( ! empty( $_COOKIE['wp_lang'] ) ) { 3490 $wp_lang = sanitize_text_field( $_COOKIE['wp_lang'] ); 3491 if ( in_array( $wp_lang, get_available_languages(), true ) ) { 3492 update_user_meta( $user_id, 'locale', $wp_lang ); // Set user locale if defined on registration. 3493 } 3494 } 3495 3496 /** 3497 * Fires after a new user registration has been recorded. 3498 * 3499 * @since 4.4.0 3500 * 3501 * @param int $user_id ID of the newly registered user. 3502 */ 3503 do_action( 'register_new_user', $user_id ); 3504 3505 return $user_id; 3506 } 3507 3508 /** 3509 * Initiates email notifications related to the creation of new users. 3510 * 3511 * Notifications are sent both to the site admin and to the newly created user. 3512 * 3513 * @since 4.4.0 3514 * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending 3515 * notifications only to the user created. 3516 * 3517 * @param int $user_id ID of the newly created user. 3518 * @param string $notify Optional. Type of notification that should happen. Accepts 'admin' 3519 * or an empty string (admin only), 'user', or 'both' (admin and user). 3520 * Default 'both'. 3521 */ 3522 function wp_send_new_user_notifications( $user_id, $notify = 'both' ) { 3523 wp_new_user_notification( $user_id, null, $notify ); 3524 } 3525 3526 /** 3527 * Retrieves the current session token from the logged_in cookie. 3528 * 3529 * @since 4.0.0 3530 * 3531 * @return string Token. 3532 */ 3533 function wp_get_session_token() { 3534 $cookie = wp_parse_auth_cookie( '', 'logged_in' ); 3535 return ! empty( $cookie['token'] ) ? $cookie['token'] : ''; 3536 } 3537 3538 /** 3539 * Retrieves a list of sessions for the current user. 3540 * 3541 * @since 4.0.0 3542 * 3543 * @return array Array of sessions. 3544 */ 3545 function wp_get_all_sessions() { 3546 $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); 3547 return $manager->get_all(); 3548 } 3549 3550 /** 3551 * Removes the current session token from the database. 3552 * 3553 * @since 4.0.0 3554 */ 3555 function wp_destroy_current_session() { 3556 $token = wp_get_session_token(); 3557 if ( $token ) { 3558 $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); 3559 $manager->destroy( $token ); 3560 } 3561 } 3562 3563 /** 3564 * Removes all but the current session token for the current user for the database. 3565 * 3566 * @since 4.0.0 3567 */ 3568 function wp_destroy_other_sessions() { 3569 $token = wp_get_session_token(); 3570 if ( $token ) { 3571 $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); 3572 $manager->destroy_others( $token ); 3573 } 3574 } 3575 3576 /** 3577 * Removes all session tokens for the current user from the database. 3578 * 3579 * @since 4.0.0 3580 */ 3581 function wp_destroy_all_sessions() { 3582 $manager = WP_Session_Tokens::get_instance( get_current_user_id() ); 3583 $manager->destroy_all(); 3584 } 3585 3586 /** 3587 * Gets the user IDs of all users with no role on this site. 3588 * 3589 * @since 4.4.0 3590 * @since 4.9.0 The `$site_id` parameter was added to support multisite. 3591 * 3592 * @global wpdb $wpdb WordPress database abstraction object. 3593 * 3594 * @param int|null $site_id Optional. The site ID to get users with no role for. Defaults to the current site. 3595 * @return string[] Array of user IDs as strings. 3596 */ 3597 function wp_get_users_with_no_role( $site_id = null ) { 3598 global $wpdb; 3599 3600 if ( ! $site_id ) { 3601 $site_id = get_current_blog_id(); 3602 } 3603 3604 $prefix = $wpdb->get_blog_prefix( $site_id ); 3605 3606 if ( is_multisite() && get_current_blog_id() !== $site_id ) { 3607 switch_to_blog( $site_id ); 3608 $role_names = wp_roles()->get_names(); 3609 restore_current_blog(); 3610 } else { 3611 $role_names = wp_roles()->get_names(); 3612 } 3613 3614 $regex = implode( '|', array_keys( $role_names ) ); 3615 $regex = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex ); 3616 $users = $wpdb->get_col( 3617 $wpdb->prepare( 3618 "SELECT user_id 3619 FROM $wpdb->usermeta 3620 WHERE meta_key = '{$prefix}capabilities' 3621 AND meta_value NOT REGEXP %s", 3622 $regex 3623 ) 3624 ); 3625 3626 return $users; 3627 } 3628 3629 /** 3630 * Retrieves the current user object. 3631 * 3632 * Will set the current user, if the current user is not set. The current user 3633 * will be set to the logged-in person. If no user is logged-in, then it will 3634 * set the current user to 0, which is invalid and won't have any permissions. 3635 * 3636 * This function is used by the pluggable functions wp_get_current_user() and 3637 * get_currentuserinfo(), the latter of which is deprecated but used for backward 3638 * compatibility. 3639 * 3640 * @since 4.5.0 3641 * @access private 3642 * 3643 * @see wp_get_current_user() 3644 * @global WP_User $current_user Checks if the current user is set. 3645 * 3646 * @return WP_User Current WP_User instance. 3647 */ 3648 function _wp_get_current_user() { 3649 global $current_user; 3650 3651 if ( ! empty( $current_user ) ) { 3652 if ( $current_user instanceof WP_User ) { 3653 return $current_user; 3654 } 3655 3656 // Upgrade stdClass to WP_User. 3657 if ( is_object( $current_user ) && isset( $current_user->ID ) ) { 3658 $cur_id = $current_user->ID; 3659 $current_user = null; 3660 wp_set_current_user( $cur_id ); 3661 return $current_user; 3662 } 3663 3664 // $current_user has a junk value. Force to WP_User with ID 0. 3665 $current_user = null; 3666 wp_set_current_user( 0 ); 3667 return $current_user; 3668 } 3669 3670 if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) { 3671 wp_set_current_user( 0 ); 3672 return $current_user; 3673 } 3674 3675 /** 3676 * Filters the current user. 3677 * 3678 * The default filters use this to determine the current user from the 3679 * request's cookies, if available. 3680 * 3681 * Returning a value of false will effectively short-circuit setting 3682 * the current user. 3683 * 3684 * @since 3.9.0 3685 * 3686 * @param int|false $user_id User ID if one has been determined, false otherwise. 3687 */ 3688 $user_id = apply_filters( 'determine_current_user', false ); 3689 if ( ! $user_id ) { 3690 wp_set_current_user( 0 ); 3691 return $current_user; 3692 } 3693 3694 wp_set_current_user( $user_id ); 3695 3696 return $current_user; 3697 } 3698 3699 /** 3700 * Sends a confirmation request email when a change of user email address is attempted. 3701 * 3702 * @since 3.0.0 3703 * @since 4.9.0 This function was moved from wp-admin/includes/ms.php so it's no longer Multisite specific. 3704 * 3705 * @global WP_Error $errors WP_Error object. 3706 */ 3707 function send_confirmation_on_profile_email() { 3708 global $errors; 3709 3710 $current_user = wp_get_current_user(); 3711 if ( ! is_object( $errors ) ) { 3712 $errors = new WP_Error(); 3713 } 3714 3715 if ( $current_user->ID !== (int) $_POST['user_id'] ) { 3716 return false; 3717 } 3718 3719 if ( $current_user->user_email !== $_POST['email'] ) { 3720 if ( ! is_email( $_POST['email'] ) ) { 3721 $errors->add( 3722 'user_email', 3723 __( '<strong>Error:</strong> The email address is not correct.' ), 3724 array( 3725 'form-field' => 'email', 3726 ) 3727 ); 3728 3729 return; 3730 } 3731 3732 if ( email_exists( $_POST['email'] ) ) { 3733 $errors->add( 3734 'user_email', 3735 __( '<strong>Error:</strong> The email address is already used.' ), 3736 array( 3737 'form-field' => 'email', 3738 ) 3739 ); 3740 delete_user_meta( $current_user->ID, '_new_email' ); 3741 3742 return; 3743 } 3744 3745 $hash = md5( $_POST['email'] . time() . wp_rand() ); 3746 $new_user_email = array( 3747 'hash' => $hash, 3748 'newemail' => $_POST['email'], 3749 ); 3750 update_user_meta( $current_user->ID, '_new_email', $new_user_email ); 3751 3752 $sitename = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ); 3753 3754 /* translators: Do not translate USERNAME, ADMIN_URL, EMAIL, SITENAME, SITEURL: those are placeholders. */ 3755 $email_text = __( 3756 'Howdy ###USERNAME###, 3757 3758 You recently requested to have the email address on your account changed. 3759 3760 If this is correct, please click on the following link to change it: 3761 ###ADMIN_URL### 3762 3763 You can safely ignore and delete this email if you do not want to 3764 take this action. 3765 3766 This email has been sent to ###EMAIL### 3767 3768 Regards, 3769 All at ###SITENAME### 3770 ###SITEURL###' 3771 ); 3772 3773 /** 3774 * Filters the text of the email sent when a change of user email address is attempted. 3775 * 3776 * The following strings have a special meaning and will get replaced dynamically: 3777 * - ###USERNAME### The current user's username. 3778 * - ###ADMIN_URL### The link to click on to confirm the email change. 3779 * - ###EMAIL### The new email. 3780 * - ###SITENAME### The name of the site. 3781 * - ###SITEURL### The URL to the site. 3782 * 3783 * @since MU (3.0.0) 3784 * @since 4.9.0 This filter is no longer Multisite specific. 3785 * 3786 * @param string $email_text Text in the email. 3787 * @param array $new_user_email { 3788 * Data relating to the new user email address. 3789 * 3790 * @type string $hash The secure hash used in the confirmation link URL. 3791 * @type string $newemail The proposed new email address. 3792 * } 3793 */ 3794 $content = apply_filters( 'new_user_email_content', $email_text, $new_user_email ); 3795 3796 $content = str_replace( '###USERNAME###', $current_user->user_login, $content ); 3797 $content = str_replace( '###ADMIN_URL###', esc_url( self_admin_url( 'profile.php?newuseremail=' . $hash ) ), $content ); 3798 $content = str_replace( '###EMAIL###', $_POST['email'], $content ); 3799 $content = str_replace( '###SITENAME###', $sitename, $content ); 3800 $content = str_replace( '###SITEURL###', home_url(), $content ); 3801 3802 /* translators: New email address notification email subject. %s: Site title. */ 3803 wp_mail( $_POST['email'], sprintf( __( '[%s] Email Change Request' ), $sitename ), $content ); 3804 3805 $_POST['email'] = $current_user->user_email; 3806 } 3807 } 3808 3809 /** 3810 * Adds an admin notice alerting the user to check for confirmation request email 3811 * after email address change. 3812 * 3813 * @since 3.0.0 3814 * @since 4.9.0 This function was moved from wp-admin/includes/ms.php so it's no longer Multisite specific. 3815 * 3816 * @global string $pagenow The filename of the current screen. 3817 */ 3818 function new_user_email_admin_notice() { 3819 global $pagenow; 3820 3821 if ( 'profile.php' === $pagenow && isset( $_GET['updated'] ) ) { 3822 $email = get_user_meta( get_current_user_id(), '_new_email', true ); 3823 if ( $email ) { 3824 $message = sprintf( 3825 /* translators: %s: New email address. */ 3826 __( 'Your email address has not been updated yet. Please check your inbox at %s for a confirmation email.' ), 3827 '<code>' . esc_html( $email['newemail'] ) . '</code>' 3828 ); 3829 wp_admin_notice( $message, array( 'type' => 'info' ) ); 3830 } 3831 } 3832 } 3833 3834 /** 3835 * Gets all personal data request types. 3836 * 3837 * @since 4.9.6 3838 * @access private 3839 * 3840 * @return string[] List of core privacy action types. 3841 */ 3842 function _wp_privacy_action_request_types() { 3843 return array( 3844 'export_personal_data', 3845 'remove_personal_data', 3846 ); 3847 } 3848 3849 /** 3850 * Registers the personal data exporter for users. 3851 * 3852 * @since 4.9.6 3853 * 3854 * @param array[] $exporters An array of personal data exporters. 3855 * @return array[] An array of personal data exporters. 3856 */ 3857 function wp_register_user_personal_data_exporter( $exporters ) { 3858 $exporters['wordpress-user'] = array( 3859 'exporter_friendly_name' => __( 'WordPress User' ), 3860 'callback' => 'wp_user_personal_data_exporter', 3861 ); 3862 3863 return $exporters; 3864 } 3865 3866 /** 3867 * Finds and exports personal data associated with an email address from the user and user_meta table. 3868 * 3869 * @since 4.9.6 3870 * @since 5.4.0 Added 'Community Events Location' group to the export data. 3871 * @since 5.4.0 Added 'Session Tokens' group to the export data. 3872 * 3873 * @param string $email_address The user's email address. 3874 * @return array { 3875 * An array of personal data. 3876 * 3877 * @type array[] $data An array of personal data arrays. 3878 * @type bool $done Whether the exporter is finished. 3879 * } 3880 */ 3881 function wp_user_personal_data_exporter( $email_address ) { 3882 $email_address = trim( $email_address ); 3883 3884 $data_to_export = array(); 3885 3886 $user = get_user_by( 'email', $email_address ); 3887 3888 if ( ! $user ) { 3889 return array( 3890 'data' => array(), 3891 'done' => true, 3892 ); 3893 } 3894 3895 $user_meta = get_user_meta( $user->ID ); 3896 3897 $user_props_to_export = array( 3898 'ID' => __( 'User ID' ), 3899 'user_login' => __( 'User Login Name' ), 3900 'user_nicename' => __( 'User Nice Name' ), 3901 'user_email' => __( 'User Email' ), 3902 'user_url' => __( 'User URL' ), 3903 'user_registered' => __( 'User Registration Date' ), 3904 'display_name' => __( 'User Display Name' ), 3905 'nickname' => __( 'User Nickname' ), 3906 'first_name' => __( 'User First Name' ), 3907 'last_name' => __( 'User Last Name' ), 3908 'description' => __( 'User Description' ), 3909 ); 3910 3911 $user_data_to_export = array(); 3912 3913 foreach ( $user_props_to_export as $key => $name ) { 3914 $value = ''; 3915 3916 switch ( $key ) { 3917 case 'ID': 3918 case 'user_login': 3919 case 'user_nicename': 3920 case 'user_email': 3921 case 'user_url': 3922 case 'user_registered': 3923 case 'display_name': 3924 $value = $user->data->$key; 3925 break; 3926 case 'nickname': 3927 case 'first_name': 3928 case 'last_name': 3929 case 'description': 3930 $value = $user_meta[ $key ][0]; 3931 break; 3932 } 3933 3934 if ( ! empty( $value ) ) { 3935 $user_data_to_export[] = array( 3936 'name' => $name, 3937 'value' => $value, 3938 ); 3939 } 3940 } 3941 3942 // Get the list of reserved names. 3943 $reserved_names = array_values( $user_props_to_export ); 3944 3945 /** 3946 * Filters the user's profile data for the privacy exporter. 3947 * 3948 * @since 5.4.0 3949 * 3950 * @param array $additional_user_profile_data { 3951 * An array of name-value pairs of additional user data items. Default empty array. 3952 * 3953 * @type string $name The user-facing name of an item name-value pair,e.g. 'IP Address'. 3954 * @type string $value The user-facing value of an item data pair, e.g. '50.60.70.0'. 3955 * } 3956 * @param WP_User $user The user whose data is being exported. 3957 * @param string[] $reserved_names An array of reserved names. Any item in `$additional_user_data` 3958 * that uses one of these for its `name` will not be included in the export. 3959 */ 3960 $_extra_data = apply_filters( 'wp_privacy_additional_user_profile_data', array(), $user, $reserved_names ); 3961 3962 if ( is_array( $_extra_data ) && ! empty( $_extra_data ) ) { 3963 // Remove items that use reserved names. 3964 $extra_data = array_filter( 3965 $_extra_data, 3966 static function ( $item ) use ( $reserved_names ) { 3967 return ! in_array( $item['name'], $reserved_names, true ); 3968 } 3969 ); 3970 3971 if ( count( $extra_data ) !== count( $_extra_data ) ) { 3972 _doing_it_wrong( 3973 __FUNCTION__, 3974 sprintf( 3975 /* translators: %s: wp_privacy_additional_user_profile_data */ 3976 __( 'Filter %s returned items with reserved names.' ), 3977 '<code>wp_privacy_additional_user_profile_data</code>' 3978 ), 3979 '5.4.0' 3980 ); 3981 } 3982 3983 if ( ! empty( $extra_data ) ) { 3984 $user_data_to_export = array_merge( $user_data_to_export, $extra_data ); 3985 } 3986 } 3987 3988 $data_to_export[] = array( 3989 'group_id' => 'user', 3990 'group_label' => __( 'User' ), 3991 'group_description' => __( 'User’s profile data.' ), 3992 'item_id' => "user-{$user->ID}", 3993 'data' => $user_data_to_export, 3994 ); 3995 3996 if ( isset( $user_meta['community-events-location'] ) ) { 3997 $location = maybe_unserialize( $user_meta['community-events-location'][0] ); 3998 3999 $location_props_to_export = array( 4000 'description' => __( 'City' ), 4001 'country' => __( 'Country' ), 4002 'latitude' => __( 'Latitude' ), 4003 'longitude' => __( 'Longitude' ), 4004 'ip' => __( 'IP' ), 4005 ); 4006 4007 $location_data_to_export = array(); 4008 4009 foreach ( $location_props_to_export as $key => $name ) { 4010 if ( ! empty( $location[ $key ] ) ) { 4011 $location_data_to_export[] = array( 4012 'name' => $name, 4013 'value' => $location[ $key ], 4014 ); 4015 } 4016 } 4017 4018 $data_to_export[] = array( 4019 'group_id' => 'community-events-location', 4020 'group_label' => __( 'Community Events Location' ), 4021 'group_description' => __( 'User’s location data used for the Community Events in the WordPress Events and News dashboard widget.' ), 4022 'item_id' => "community-events-location-{$user->ID}", 4023 'data' => $location_data_to_export, 4024 ); 4025 } 4026 4027 if ( isset( $user_meta['session_tokens'] ) ) { 4028 $session_tokens = maybe_unserialize( $user_meta['session_tokens'][0] ); 4029 4030 $session_tokens_props_to_export = array( 4031 'expiration' => __( 'Expiration' ), 4032 'ip' => __( 'IP' ), 4033 'ua' => __( 'User Agent' ), 4034 'login' => __( 'Last Login' ), 4035 ); 4036 4037 foreach ( $session_tokens as $token_key => $session_token ) { 4038 $session_tokens_data_to_export = array(); 4039 4040 foreach ( $session_tokens_props_to_export as $key => $name ) { 4041 if ( ! empty( $session_token[ $key ] ) ) { 4042 $value = $session_token[ $key ]; 4043 if ( in_array( $key, array( 'expiration', 'login' ), true ) ) { 4044 $value = date_i18n( 'F d, Y H:i A', $value ); 4045 } 4046 $session_tokens_data_to_export[] = array( 4047 'name' => $name, 4048 'value' => $value, 4049 ); 4050 } 4051 } 4052 4053 $data_to_export[] = array( 4054 'group_id' => 'session-tokens', 4055 'group_label' => __( 'Session Tokens' ), 4056 'group_description' => __( 'User’s Session Tokens data.' ), 4057 'item_id' => "session-tokens-{$user->ID}-{$token_key}", 4058 'data' => $session_tokens_data_to_export, 4059 ); 4060 } 4061 } 4062 4063 return array( 4064 'data' => $data_to_export, 4065 'done' => true, 4066 ); 4067 } 4068 4069 /** 4070 * Updates log when privacy request is confirmed. 4071 * 4072 * @since 4.9.6 4073 * @access private 4074 * 4075 * @param int $request_id ID of the request. 4076 */ 4077 function _wp_privacy_account_request_confirmed( $request_id ) { 4078 $request = wp_get_user_request( $request_id ); 4079 4080 if ( ! $request ) { 4081 return; 4082 } 4083 4084 if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) { 4085 return; 4086 } 4087 4088 update_post_meta( $request_id, '_wp_user_request_confirmed_timestamp', time() ); 4089 wp_update_post( 4090 array( 4091 'ID' => $request_id, 4092 'post_status' => 'request-confirmed', 4093 ) 4094 ); 4095 } 4096 4097 /** 4098 * Notifies the site administrator via email when a request is confirmed. 4099 * 4100 * Without this, the admin would have to manually check the site to see if any 4101 * action was needed on their part yet. 4102 * 4103 * @since 4.9.6 4104 * 4105 * @param int $request_id The ID of the request. 4106 */ 4107 function _wp_privacy_send_request_confirmation_notification( $request_id ) { 4108 $request = wp_get_user_request( $request_id ); 4109 4110 if ( ! ( $request instanceof WP_User_Request ) || 'request-confirmed' !== $request->status ) { 4111 return; 4112 } 4113 4114 $already_notified = (bool) get_post_meta( $request_id, '_wp_admin_notified', true ); 4115 4116 if ( $already_notified ) { 4117 return; 4118 } 4119 4120 if ( 'export_personal_data' === $request->action_name ) { 4121 $manage_url = admin_url( 'export-personal-data.php' ); 4122 } elseif ( 'remove_personal_data' === $request->action_name ) { 4123 $manage_url = admin_url( 'erase-personal-data.php' ); 4124 } 4125 $action_description = wp_user_request_action_description( $request->action_name ); 4126 4127 /** 4128 * Filters the recipient of the data request confirmation notification. 4129 * 4130 * In a Multisite environment, this will default to the email address of the 4131 * network admin because, by default, single site admins do not have the 4132 * capabilities required to process requests. Some networks may wish to 4133 * delegate those capabilities to a single-site admin, or a dedicated person 4134 * responsible for managing privacy requests. 4135 * 4136 * @since 4.9.6 4137 * 4138 * @param string $admin_email The email address of the notification recipient. 4139 * @param WP_User_Request $request The request that is initiating the notification. 4140 */ 4141 $admin_email = apply_filters( 'user_request_confirmed_email_to', get_site_option( 'admin_email' ), $request ); 4142 4143 $email_data = array( 4144 'request' => $request, 4145 'user_email' => $request->email, 4146 'description' => $action_description, 4147 'manage_url' => $manage_url, 4148 'sitename' => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), 4149 'siteurl' => home_url(), 4150 'admin_email' => $admin_email, 4151 ); 4152 4153 $subject = sprintf( 4154 /* translators: Privacy data request confirmed notification email subject. 1: Site title, 2: Name of the confirmed action. */ 4155 __( '[%1$s] Action Confirmed: %2$s' ), 4156 $email_data['sitename'], 4157 $action_description 4158 ); 4159 4160 /** 4161 * Filters the subject of the user request confirmation email. 4162 * 4163 * @since 4.9.8 4164 * 4165 * @param string $subject The email subject. 4166 * @param string $sitename The name of the site. 4167 * @param array $email_data { 4168 * Data relating to the account action email. 4169 * 4170 * @type WP_User_Request $request User request object. 4171 * @type string $user_email The email address confirming a request. 4172 * @type string $description Description of the action being performed so the user knows what the email is for. 4173 * @type string $manage_url The link to click manage privacy requests of this type. 4174 * @type string $sitename The site name sending the mail. 4175 * @type string $siteurl The site URL sending the mail. 4176 * @type string $admin_email The administrator email receiving the mail. 4177 * } 4178 */ 4179 $subject = apply_filters( 'user_request_confirmed_email_subject', $subject, $email_data['sitename'], $email_data ); 4180 4181 /* translators: Do not translate SITENAME, USER_EMAIL, DESCRIPTION, MANAGE_URL, SITEURL; those are placeholders. */ 4182 $content = __( 4183 'Howdy, 4184 4185 A user data privacy request has been confirmed on ###SITENAME###: 4186 4187 User: ###USER_EMAIL### 4188 Request: ###DESCRIPTION### 4189 4190 You can view and manage these data privacy requests here: 4191 4192 ###MANAGE_URL### 4193 4194 Regards, 4195 All at ###SITENAME### 4196 ###SITEURL###' 4197 ); 4198 4199 /** 4200 * Filters the body of the user request confirmation email. 4201 * 4202 * The email is sent to an administrator when a user request is confirmed. 4203 * 4204 * The following strings have a special meaning and will get replaced dynamically: 4205 * 4206 * ###SITENAME### The name of the site. 4207 * ###USER_EMAIL### The user email for the request. 4208 * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for. 4209 * ###MANAGE_URL### The URL to manage requests. 4210 * ###SITEURL### The URL to the site. 4211 * 4212 * @since 4.9.6 4213 * @deprecated 5.8.0 Use {@see 'user_request_confirmed_email_content'} instead. 4214 * For user erasure fulfillment email content 4215 * use {@see 'user_erasure_fulfillment_email_content'} instead. 4216 * 4217 * @param string $content The email content. 4218 * @param array $email_data { 4219 * Data relating to the account action email. 4220 * 4221 * @type WP_User_Request $request User request object. 4222 * @type string $user_email The email address confirming a request. 4223 * @type string $description Description of the action being performed 4224 * so the user knows what the email is for. 4225 * @type string $manage_url The link to click manage privacy requests of this type. 4226 * @type string $sitename The site name sending the mail. 4227 * @type string $siteurl The site URL sending the mail. 4228 * @type string $admin_email The administrator email receiving the mail. 4229 * } 4230 */ 4231 $content = apply_filters_deprecated( 4232 'user_confirmed_action_email_content', 4233 array( $content, $email_data ), 4234 '5.8.0', 4235 sprintf( 4236 /* translators: 1 & 2: Deprecation replacement options. */ 4237 __( '%1$s or %2$s' ), 4238 'user_request_confirmed_email_content', 4239 'user_erasure_fulfillment_email_content' 4240 ) 4241 ); 4242 4243 /** 4244 * Filters the body of the user request confirmation email. 4245 * 4246 * The email is sent to an administrator when a user request is confirmed. 4247 * The following strings have a special meaning and will get replaced dynamically: 4248 * 4249 * ###SITENAME### The name of the site. 4250 * ###USER_EMAIL### The user email for the request. 4251 * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for. 4252 * ###MANAGE_URL### The URL to manage requests. 4253 * ###SITEURL### The URL to the site. 4254 * 4255 * @since 5.8.0 4256 * 4257 * @param string $content The email content. 4258 * @param array $email_data { 4259 * Data relating to the account action email. 4260 * 4261 * @type WP_User_Request $request User request object. 4262 * @type string $user_email The email address confirming a request. 4263 * @type string $description Description of the action being performed so the user knows what the email is for. 4264 * @type string $manage_url The link to click manage privacy requests of this type. 4265 * @type string $sitename The site name sending the mail. 4266 * @type string $siteurl The site URL sending the mail. 4267 * @type string $admin_email The administrator email receiving the mail. 4268 * } 4269 */ 4270 $content = apply_filters( 'user_request_confirmed_email_content', $content, $email_data ); 4271 4272 $content = str_replace( '###SITENAME###', $email_data['sitename'], $content ); 4273 $content = str_replace( '###USER_EMAIL###', $email_data['user_email'], $content ); 4274 $content = str_replace( '###DESCRIPTION###', $email_data['description'], $content ); 4275 $content = str_replace( '###MANAGE_URL###', sanitize_url( $email_data['manage_url'] ), $content ); 4276 $content = str_replace( '###SITEURL###', sanitize_url( $email_data['siteurl'] ), $content ); 4277 4278 $headers = ''; 4279 4280 /** 4281 * Filters the headers of the user request confirmation email. 4282 * 4283 * @since 5.4.0 4284 * 4285 * @param string|array $headers The email headers. 4286 * @param string $subject The email subject. 4287 * @param string $content The email content. 4288 * @param int $request_id The request ID. 4289 * @param array $email_data { 4290 * Data relating to the account action email. 4291 * 4292 * @type WP_User_Request $request User request object. 4293 * @type string $user_email The email address confirming a request. 4294 * @type string $description Description of the action being performed so the user knows what the email is for. 4295 * @type string $manage_url The link to click manage privacy requests of this type. 4296 * @type string $sitename The site name sending the mail. 4297 * @type string $siteurl The site URL sending the mail. 4298 * @type string $admin_email The administrator email receiving the mail. 4299 * } 4300 */ 4301 $headers = apply_filters( 'user_request_confirmed_email_headers', $headers, $subject, $content, $request_id, $email_data ); 4302 4303 $email_sent = wp_mail( $email_data['admin_email'], $subject, $content, $headers ); 4304 4305 if ( $email_sent ) { 4306 update_post_meta( $request_id, '_wp_admin_notified', true ); 4307 } 4308 } 4309 4310 /** 4311 * Notifies the user when their erasure request is fulfilled. 4312 * 4313 * Without this, the user would never know if their data was actually erased. 4314 * 4315 * @since 4.9.6 4316 * 4317 * @param int $request_id The privacy request post ID associated with this request. 4318 */ 4319 function _wp_privacy_send_erasure_fulfillment_notification( $request_id ) { 4320 $request = wp_get_user_request( $request_id ); 4321 4322 if ( ! ( $request instanceof WP_User_Request ) || 'request-completed' !== $request->status ) { 4323 return; 4324 } 4325 4326 $already_notified = (bool) get_post_meta( $request_id, '_wp_user_notified', true ); 4327 4328 if ( $already_notified ) { 4329 return; 4330 } 4331 4332 // Localize message content for user; fallback to site default for visitors. 4333 if ( ! empty( $request->user_id ) ) { 4334 $switched_locale = switch_to_user_locale( $request->user_id ); 4335 } else { 4336 $switched_locale = switch_to_locale( get_locale() ); 4337 } 4338 4339 /** 4340 * Filters the recipient of the data erasure fulfillment notification. 4341 * 4342 * @since 4.9.6 4343 * 4344 * @param string $user_email The email address of the notification recipient. 4345 * @param WP_User_Request $request The request that is initiating the notification. 4346 */ 4347 $user_email = apply_filters( 'user_erasure_fulfillment_email_to', $request->email, $request ); 4348 4349 $email_data = array( 4350 'request' => $request, 4351 'message_recipient' => $user_email, 4352 'privacy_policy_url' => get_privacy_policy_url(), 4353 'sitename' => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), 4354 'siteurl' => home_url(), 4355 ); 4356 4357 $subject = sprintf( 4358 /* translators: Erasure request fulfilled notification email subject. %s: Site title. */ 4359 __( '[%s] Erasure Request Fulfilled' ), 4360 $email_data['sitename'] 4361 ); 4362 4363 /** 4364 * Filters the subject of the email sent when an erasure request is completed. 4365 * 4366 * @since 4.9.8 4367 * @deprecated 5.8.0 Use {@see 'user_erasure_fulfillment_email_subject'} instead. 4368 * 4369 * @param string $subject The email subject. 4370 * @param string $sitename The name of the site. 4371 * @param array $email_data { 4372 * Data relating to the account action email. 4373 * 4374 * @type WP_User_Request $request User request object. 4375 * @type string $message_recipient The address that the email will be sent to. Defaults 4376 * to the value of `$request->email`, but can be changed 4377 * by the `user_erasure_fulfillment_email_to` filter. 4378 * @type string $privacy_policy_url Privacy policy URL. 4379 * @type string $sitename The site name sending the mail. 4380 * @type string $siteurl The site URL sending the mail. 4381 * } 4382 */ 4383 $subject = apply_filters_deprecated( 4384 'user_erasure_complete_email_subject', 4385 array( $subject, $email_data['sitename'], $email_data ), 4386 '5.8.0', 4387 'user_erasure_fulfillment_email_subject' 4388 ); 4389 4390 /** 4391 * Filters the subject of the email sent when an erasure request is completed. 4392 * 4393 * @since 5.8.0 4394 * 4395 * @param string $subject The email subject. 4396 * @param string $sitename The name of the site. 4397 * @param array $email_data { 4398 * Data relating to the account action email. 4399 * 4400 * @type WP_User_Request $request User request object. 4401 * @type string $message_recipient The address that the email will be sent to. Defaults 4402 * to the value of `$request->email`, but can be changed 4403 * by the `user_erasure_fulfillment_email_to` filter. 4404 * @type string $privacy_policy_url Privacy policy URL. 4405 * @type string $sitename The site name sending the mail. 4406 * @type string $siteurl The site URL sending the mail. 4407 * } 4408 */ 4409 $subject = apply_filters( 'user_erasure_fulfillment_email_subject', $subject, $email_data['sitename'], $email_data ); 4410 4411 /* translators: Do not translate SITENAME, SITEURL; those are placeholders. */ 4412 $content = __( 4413 'Howdy, 4414 4415 Your request to erase your personal data on ###SITENAME### has been completed. 4416 4417 If you have any follow-up questions or concerns, please contact the site administrator. 4418 4419 Regards, 4420 All at ###SITENAME### 4421 ###SITEURL###' 4422 ); 4423 4424 if ( ! empty( $email_data['privacy_policy_url'] ) ) { 4425 /* translators: Do not translate SITENAME, SITEURL, PRIVACY_POLICY_URL; those are placeholders. */ 4426 $content = __( 4427 'Howdy, 4428 4429 Your request to erase your personal data on ###SITENAME### has been completed. 4430 4431 If you have any follow-up questions or concerns, please contact the site administrator. 4432 4433 For more information, you can also read our privacy policy: ###PRIVACY_POLICY_URL### 4434 4435 Regards, 4436 All at ###SITENAME### 4437 ###SITEURL###' 4438 ); 4439 } 4440 4441 /** 4442 * Filters the body of the data erasure fulfillment notification. 4443 * 4444 * The email is sent to a user when their data erasure request is fulfilled 4445 * by an administrator. 4446 * 4447 * The following strings have a special meaning and will get replaced dynamically: 4448 * 4449 * ###SITENAME### The name of the site. 4450 * ###PRIVACY_POLICY_URL### Privacy policy page URL. 4451 * ###SITEURL### The URL to the site. 4452 * 4453 * @since 4.9.6 4454 * @deprecated 5.8.0 Use {@see 'user_erasure_fulfillment_email_content'} instead. 4455 * For user request confirmation email content 4456 * use {@see 'user_request_confirmed_email_content'} instead. 4457 * 4458 * @param string $content The email content. 4459 * @param array $email_data { 4460 * Data relating to the account action email. 4461 * 4462 * @type WP_User_Request $request User request object. 4463 * @type string $message_recipient The address that the email will be sent to. Defaults 4464 * to the value of `$request->email`, but can be changed 4465 * by the `user_erasure_fulfillment_email_to` filter. 4466 * @type string $privacy_policy_url Privacy policy URL. 4467 * @type string $sitename The site name sending the mail. 4468 * @type string $siteurl The site URL sending the mail. 4469 * } 4470 */ 4471 $content = apply_filters_deprecated( 4472 'user_confirmed_action_email_content', 4473 array( $content, $email_data ), 4474 '5.8.0', 4475 sprintf( 4476 /* translators: 1 & 2: Deprecation replacement options. */ 4477 __( '%1$s or %2$s' ), 4478 'user_erasure_fulfillment_email_content', 4479 'user_request_confirmed_email_content' 4480 ) 4481 ); 4482 4483 /** 4484 * Filters the body of the data erasure fulfillment notification. 4485 * 4486 * The email is sent to a user when their data erasure request is fulfilled 4487 * by an administrator. 4488 * 4489 * The following strings have a special meaning and will get replaced dynamically: 4490 * 4491 * ###SITENAME### The name of the site. 4492 * ###PRIVACY_POLICY_URL### Privacy policy page URL. 4493 * ###SITEURL### The URL to the site. 4494 * 4495 * @since 5.8.0 4496 * 4497 * @param string $content The email content. 4498 * @param array $email_data { 4499 * Data relating to the account action email. 4500 * 4501 * @type WP_User_Request $request User request object. 4502 * @type string $message_recipient The address that the email will be sent to. Defaults 4503 * to the value of `$request->email`, but can be changed 4504 * by the `user_erasure_fulfillment_email_to` filter. 4505 * @type string $privacy_policy_url Privacy policy URL. 4506 * @type string $sitename The site name sending the mail. 4507 * @type string $siteurl The site URL sending the mail. 4508 * } 4509 */ 4510 $content = apply_filters( 'user_erasure_fulfillment_email_content', $content, $email_data ); 4511 4512 $content = str_replace( '###SITENAME###', $email_data['sitename'], $content ); 4513 $content = str_replace( '###PRIVACY_POLICY_URL###', $email_data['privacy_policy_url'], $content ); 4514 $content = str_replace( '###SITEURL###', sanitize_url( $email_data['siteurl'] ), $content ); 4515 4516 $headers = ''; 4517 4518 /** 4519 * Filters the headers of the data erasure fulfillment notification. 4520 * 4521 * @since 5.4.0 4522 * @deprecated 5.8.0 Use {@see 'user_erasure_fulfillment_email_headers'} instead. 4523 * 4524 * @param string|array $headers The email headers. 4525 * @param string $subject The email subject. 4526 * @param string $content The email content. 4527 * @param int $request_id The request ID. 4528 * @param array $email_data { 4529 * Data relating to the account action email. 4530 * 4531 * @type WP_User_Request $request User request object. 4532 * @type string $message_recipient The address that the email will be sent to. Defaults 4533 * to the value of `$request->email`, but can be changed 4534 * by the `user_erasure_fulfillment_email_to` filter. 4535 * @type string $privacy_policy_url Privacy policy URL. 4536 * @type string $sitename The site name sending the mail. 4537 * @type string $siteurl The site URL sending the mail. 4538 * } 4539 */ 4540 $headers = apply_filters_deprecated( 4541 'user_erasure_complete_email_headers', 4542 array( $headers, $subject, $content, $request_id, $email_data ), 4543 '5.8.0', 4544 'user_erasure_fulfillment_email_headers' 4545 ); 4546 4547 /** 4548 * Filters the headers of the data erasure fulfillment notification. 4549 * 4550 * @since 5.8.0 4551 * 4552 * @param string|array $headers The email headers. 4553 * @param string $subject The email subject. 4554 * @param string $content The email content. 4555 * @param int $request_id The request ID. 4556 * @param array $email_data { 4557 * Data relating to the account action email. 4558 * 4559 * @type WP_User_Request $request User request object. 4560 * @type string $message_recipient The address that the email will be sent to. Defaults 4561 * to the value of `$request->email`, but can be changed 4562 * by the `user_erasure_fulfillment_email_to` filter. 4563 * @type string $privacy_policy_url Privacy policy URL. 4564 * @type string $sitename The site name sending the mail. 4565 * @type string $siteurl The site URL sending the mail. 4566 * } 4567 */ 4568 $headers = apply_filters( 'user_erasure_fulfillment_email_headers', $headers, $subject, $content, $request_id, $email_data ); 4569 4570 $email_sent = wp_mail( $user_email, $subject, $content, $headers ); 4571 4572 if ( $switched_locale ) { 4573 restore_previous_locale(); 4574 } 4575 4576 if ( $email_sent ) { 4577 update_post_meta( $request_id, '_wp_user_notified', true ); 4578 } 4579 } 4580 4581 /** 4582 * Returns request confirmation message HTML. 4583 * 4584 * @since 4.9.6 4585 * @access private 4586 * 4587 * @param int $request_id The request ID being confirmed. 4588 * @return string The confirmation message. 4589 */ 4590 function _wp_privacy_account_request_confirmed_message( $request_id ) { 4591 $request = wp_get_user_request( $request_id ); 4592 4593 $message = '<p class="success">' . __( 'Action has been confirmed.' ) . '</p>'; 4594 $message .= '<p>' . __( 'The site administrator has been notified and will fulfill your request as soon as possible.' ) . '</p>'; 4595 4596 if ( $request && in_array( $request->action_name, _wp_privacy_action_request_types(), true ) ) { 4597 if ( 'export_personal_data' === $request->action_name ) { 4598 $message = '<p class="success">' . __( 'Thanks for confirming your export request.' ) . '</p>'; 4599 $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>'; 4600 } elseif ( 'remove_personal_data' === $request->action_name ) { 4601 $message = '<p class="success">' . __( 'Thanks for confirming your erasure request.' ) . '</p>'; 4602 $message .= '<p>' . __( 'The site administrator has been notified. You will receive an email confirmation when they erase your data.' ) . '</p>'; 4603 } 4604 } 4605 4606 /** 4607 * Filters the message displayed to a user when they confirm a data request. 4608 * 4609 * @since 4.9.6 4610 * 4611 * @param string $message The message to the user. 4612 * @param int $request_id The ID of the request being confirmed. 4613 */ 4614 $message = apply_filters( 'user_request_action_confirmed_message', $message, $request_id ); 4615 4616 return $message; 4617 } 4618 4619 /** 4620 * Creates and logs a user request to perform a specific action. 4621 * 4622 * Requests are stored inside a post type named `user_request` since they can apply to both 4623 * users on the site, or guests without a user account. 4624 * 4625 * @since 4.9.6 4626 * @since 5.7.0 Added the `$status` parameter. 4627 * 4628 * @param string $email_address User email address. This can be the address of a registered 4629 * or non-registered user. 4630 * @param string $action_name Name of the action that is being confirmed. Required. 4631 * @param array $request_data Misc data you want to send with the verification request and pass 4632 * to the actions once the request is confirmed. 4633 * @param string $status Optional request status (pending or confirmed). Default 'pending'. 4634 * @return int|WP_Error Returns the request ID if successful, or a WP_Error object on failure. 4635 */ 4636 function wp_create_user_request( $email_address = '', $action_name = '', $request_data = array(), $status = 'pending' ) { 4637 $email_address = sanitize_email( $email_address ); 4638 $action_name = sanitize_key( $action_name ); 4639 4640 if ( ! is_email( $email_address ) ) { 4641 return new WP_Error( 'invalid_email', __( 'Invalid email address.' ) ); 4642 } 4643 4644 if ( ! in_array( $action_name, _wp_privacy_action_request_types(), true ) ) { 4645 return new WP_Error( 'invalid_action', __( 'Invalid action name.' ) ); 4646 } 4647 4648 if ( ! in_array( $status, array( 'pending', 'confirmed' ), true ) ) { 4649 return new WP_Error( 'invalid_status', __( 'Invalid request status.' ) ); 4650 } 4651 4652 $user = get_user_by( 'email', $email_address ); 4653 $user_id = $user && ! is_wp_error( $user ) ? $user->ID : 0; 4654 4655 // Check for duplicates. 4656 $requests_query = new WP_Query( 4657 array( 4658 'post_type' => 'user_request', 4659 'post_name__in' => array( $action_name ), // Action name stored in post_name column. 4660 'title' => $email_address, // Email address stored in post_title column. 4661 'post_status' => array( 4662 'request-pending', 4663 'request-confirmed', 4664 ), 4665 'fields' => 'ids', 4666 ) 4667 ); 4668 4669 if ( $requests_query->found_posts ) { 4670 return new WP_Error( 'duplicate_request', __( 'An incomplete personal data request for this email address already exists.' ) ); 4671 } 4672 4673 $request_id = wp_insert_post( 4674 array( 4675 'post_author' => $user_id, 4676 'post_name' => $action_name, 4677 'post_title' => $email_address, 4678 'post_content' => wp_json_encode( $request_data ), 4679 'post_status' => 'request-' . $status, 4680 'post_type' => 'user_request', 4681 'post_date' => current_time( 'mysql', false ), 4682 'post_date_gmt' => current_time( 'mysql', true ), 4683 ), 4684 true 4685 ); 4686 4687 return $request_id; 4688 } 4689 4690 /** 4691 * Gets action description from the name and return a string. 4692 * 4693 * @since 4.9.6 4694 * 4695 * @param string $action_name Action name of the request. 4696 * @return string Human readable action name. 4697 */ 4698 function wp_user_request_action_description( $action_name ) { 4699 switch ( $action_name ) { 4700 case 'export_personal_data': 4701 $description = __( 'Export Personal Data' ); 4702 break; 4703 case 'remove_personal_data': 4704 $description = __( 'Erase Personal Data' ); 4705 break; 4706 default: 4707 /* translators: %s: Action name. */ 4708 $description = sprintf( __( 'Confirm the "%s" action' ), $action_name ); 4709 break; 4710 } 4711 4712 /** 4713 * Filters the user action description. 4714 * 4715 * @since 4.9.6 4716 * 4717 * @param string $description The default description. 4718 * @param string $action_name The name of the request. 4719 */ 4720 return apply_filters( 'user_request_action_description', $description, $action_name ); 4721 } 4722 4723 /** 4724 * Send a confirmation request email to confirm an action. 4725 * 4726 * If the request is not already pending, it will be updated. 4727 * 4728 * @since 4.9.6 4729 * 4730 * @param string $request_id ID of the request created via wp_create_user_request(). 4731 * @return true|WP_Error True on success, `WP_Error` on failure. 4732 */ 4733 function wp_send_user_request( $request_id ) { 4734 $request_id = absint( $request_id ); 4735 $request = wp_get_user_request( $request_id ); 4736 4737 if ( ! $request ) { 4738 return new WP_Error( 'invalid_request', __( 'Invalid personal data request.' ) ); 4739 } 4740 4741 // Localize message content for user; fallback to site default for visitors. 4742 if ( ! empty( $request->user_id ) ) { 4743 $switched_locale = switch_to_user_locale( $request->user_id ); 4744 } else { 4745 $switched_locale = switch_to_locale( get_locale() ); 4746 } 4747 4748 $email_data = array( 4749 'request' => $request, 4750 'email' => $request->email, 4751 'description' => wp_user_request_action_description( $request->action_name ), 4752 'confirm_url' => add_query_arg( 4753 array( 4754 'action' => 'confirmaction', 4755 'request_id' => $request_id, 4756 'confirm_key' => wp_generate_user_request_key( $request_id ), 4757 ), 4758 wp_login_url() 4759 ), 4760 'sitename' => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ), 4761 'siteurl' => home_url(), 4762 ); 4763 4764 /* translators: Confirm privacy data request notification email subject. 1: Site title, 2: Name of the action. */ 4765 $subject = sprintf( __( '[%1$s] Confirm Action: %2$s' ), $email_data['sitename'], $email_data['description'] ); 4766 4767 /** 4768 * Filters the subject of the email sent when an account action is attempted. 4769 * 4770 * @since 4.9.6 4771 * 4772 * @param string $subject The email subject. 4773 * @param string $sitename The name of the site. 4774 * @param array $email_data { 4775 * Data relating to the account action email. 4776 * 4777 * @type WP_User_Request $request User request object. 4778 * @type string $email The email address this is being sent to. 4779 * @type string $description Description of the action being performed so the user knows what the email is for. 4780 * @type string $confirm_url The link to click on to confirm the account action. 4781 * @type string $sitename The site name sending the mail. 4782 * @type string $siteurl The site URL sending the mail. 4783 * } 4784 */ 4785 $subject = apply_filters( 'user_request_action_email_subject', $subject, $email_data['sitename'], $email_data ); 4786 4787 /* translators: Do not translate DESCRIPTION, CONFIRM_URL, SITENAME, SITEURL: those are placeholders. */ 4788 $content = __( 4789 'Howdy, 4790 4791 A request has been made to perform the following action on your account: 4792 4793 ###DESCRIPTION### 4794 4795 To confirm this, please click on the following link: 4796 ###CONFIRM_URL### 4797 4798 You can safely ignore and delete this email if you do not want to 4799 take this action. 4800 4801 Regards, 4802 All at ###SITENAME### 4803 ###SITEURL###' 4804 ); 4805 4806 /** 4807 * Filters the text of the email sent when an account action is attempted. 4808 * 4809 * The following strings have a special meaning and will get replaced dynamically: 4810 * 4811 * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for. 4812 * ###CONFIRM_URL### The link to click on to confirm the account action. 4813 * ###SITENAME### The name of the site. 4814 * ###SITEURL### The URL to the site. 4815 * 4816 * @since 4.9.6 4817 * 4818 * @param string $content Text in the email. 4819 * @param array $email_data { 4820 * Data relating to the account action email. 4821 * 4822 * @type WP_User_Request $request User request object. 4823 * @type string $email The email address this is being sent to. 4824 * @type string $description Description of the action being performed so the user knows what the email is for. 4825 * @type string $confirm_url The link to click on to confirm the account action. 4826 * @type string $sitename The site name sending the mail. 4827 * @type string $siteurl The site URL sending the mail. 4828 * } 4829 */ 4830 $content = apply_filters( 'user_request_action_email_content', $content, $email_data ); 4831 4832 $content = str_replace( '###DESCRIPTION###', $email_data['description'], $content ); 4833 $content = str_replace( '###CONFIRM_URL###', sanitize_url( $email_data['confirm_url'] ), $content ); 4834 $content = str_replace( '###EMAIL###', $email_data['email'], $content ); 4835 $content = str_replace( '###SITENAME###', $email_data['sitename'], $content ); 4836 $content = str_replace( '###SITEURL###', sanitize_url( $email_data['siteurl'] ), $content ); 4837 4838 $headers = ''; 4839 4840 /** 4841 * Filters the headers of the email sent when an account action is attempted. 4842 * 4843 * @since 5.4.0 4844 * 4845 * @param string|array $headers The email headers. 4846 * @param string $subject The email subject. 4847 * @param string $content The email content. 4848 * @param int $request_id The request ID. 4849 * @param array $email_data { 4850 * Data relating to the account action email. 4851 * 4852 * @type WP_User_Request $request User request object. 4853 * @type string $email The email address this is being sent to. 4854 * @type string $description Description of the action being performed so the user knows what the email is for. 4855 * @type string $confirm_url The link to click on to confirm the account action. 4856 * @type string $sitename The site name sending the mail. 4857 * @type string $siteurl The site URL sending the mail. 4858 * } 4859 */ 4860 $headers = apply_filters( 'user_request_action_email_headers', $headers, $subject, $content, $request_id, $email_data ); 4861 4862 $email_sent = wp_mail( $email_data['email'], $subject, $content, $headers ); 4863 4864 if ( $switched_locale ) { 4865 restore_previous_locale(); 4866 } 4867 4868 if ( ! $email_sent ) { 4869 return new WP_Error( 'privacy_email_error', __( 'Unable to send personal data export confirmation email.' ) ); 4870 } 4871 4872 return true; 4873 } 4874 4875 /** 4876 * Returns a confirmation key for a user action and stores the hashed version for future comparison. 4877 * 4878 * @since 4.9.6 4879 * 4880 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance. 4881 * 4882 * @param int $request_id Request ID. 4883 * @return string Confirmation key. 4884 */ 4885 function wp_generate_user_request_key( $request_id ) { 4886 global $wp_hasher; 4887 4888 // Generate something random for a confirmation key. 4889 $key = wp_generate_password( 20, false ); 4890 4891 // Return the key, hashed. 4892 if ( empty( $wp_hasher ) ) { 4893 require_once ABSPATH . WPINC . '/class-phpass.php'; 4894 $wp_hasher = new PasswordHash( 8, true ); 4895 } 4896 4897 wp_update_post( 4898 array( 4899 'ID' => $request_id, 4900 'post_status' => 'request-pending', 4901 'post_password' => $wp_hasher->HashPassword( $key ), 4902 ) 4903 ); 4904 4905 return $key; 4906 } 4907 4908 /** 4909 * Validates a user request by comparing the key with the request's key. 4910 * 4911 * @since 4.9.6 4912 * 4913 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance. 4914 * 4915 * @param string $request_id ID of the request being confirmed. 4916 * @param string $key Provided key to validate. 4917 * @return true|WP_Error True on success, WP_Error on failure. 4918 */ 4919 function wp_validate_user_request_key( $request_id, $key ) { 4920 global $wp_hasher; 4921 4922 $request_id = absint( $request_id ); 4923 $request = wp_get_user_request( $request_id ); 4924 $saved_key = $request->confirm_key; 4925 $key_request_time = $request->modified_timestamp; 4926 4927 if ( ! $request || ! $saved_key || ! $key_request_time ) { 4928 return new WP_Error( 'invalid_request', __( 'Invalid personal data request.' ) ); 4929 } 4930 4931 if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) { 4932 return new WP_Error( 'expired_request', __( 'This personal data request has expired.' ) ); 4933 } 4934 4935 if ( empty( $key ) ) { 4936 return new WP_Error( 'missing_key', __( 'The confirmation key is missing from this personal data request.' ) ); 4937 } 4938 4939 if ( empty( $wp_hasher ) ) { 4940 require_once ABSPATH . WPINC . '/class-phpass.php'; 4941 $wp_hasher = new PasswordHash( 8, true ); 4942 } 4943 4944 /** 4945 * Filters the expiration time of confirm keys. 4946 * 4947 * @since 4.9.6 4948 * 4949 * @param int $expiration The expiration time in seconds. 4950 */ 4951 $expiration_duration = (int) apply_filters( 'user_request_key_expiration', DAY_IN_SECONDS ); 4952 $expiration_time = $key_request_time + $expiration_duration; 4953 4954 if ( ! $wp_hasher->CheckPassword( $key, $saved_key ) ) { 4955 return new WP_Error( 'invalid_key', __( 'The confirmation key is invalid for this personal data request.' ) ); 4956 } 4957 4958 if ( ! $expiration_time || time() > $expiration_time ) { 4959 return new WP_Error( 'expired_key', __( 'The confirmation key has expired for this personal data request.' ) ); 4960 } 4961 4962 return true; 4963 } 4964 4965 /** 4966 * Returns the user request object for the specified request ID. 4967 * 4968 * @since 4.9.6 4969 * 4970 * @param int $request_id The ID of the user request. 4971 * @return WP_User_Request|false 4972 */ 4973 function wp_get_user_request( $request_id ) { 4974 $request_id = absint( $request_id ); 4975 $post = get_post( $request_id ); 4976 4977 if ( ! $post || 'user_request' !== $post->post_type ) { 4978 return false; 4979 } 4980 4981 return new WP_User_Request( $post ); 4982 } 4983 4984 /** 4985 * Checks if Application Passwords is supported. 4986 * 4987 * Application Passwords is supported only by sites using SSL or local environments 4988 * but may be made available using the {@see 'wp_is_application_passwords_available'} filter. 4989 * 4990 * @since 5.9.0 4991 * 4992 * @return bool 4993 */ 4994 function wp_is_application_passwords_supported() { 4995 return is_ssl() || 'local' === wp_get_environment_type(); 4996 } 4997 4998 /** 4999 * Checks if Application Passwords is globally available. 5000 * 5001 * By default, Application Passwords is available to all sites using SSL or to local environments. 5002 * Use the {@see 'wp_is_application_passwords_available'} filter to adjust its availability. 5003 * 5004 * @since 5.6.0 5005 * 5006 * @return bool 5007 */ 5008 function wp_is_application_passwords_available() { 5009 /** 5010 * Filters whether Application Passwords is available. 5011 * 5012 * @since 5.6.0 5013 * 5014 * @param bool $available True if available, false otherwise. 5015 */ 5016 return apply_filters( 'wp_is_application_passwords_available', wp_is_application_passwords_supported() ); 5017 } 5018 5019 /** 5020 * Checks if Application Passwords is available for a specific user. 5021 * 5022 * By default all users can use Application Passwords. Use {@see 'wp_is_application_passwords_available_for_user'} 5023 * to restrict availability to certain users. 5024 * 5025 * @since 5.6.0 5026 * 5027 * @param int|WP_User $user The user to check. 5028 * @return bool 5029 */ 5030 function wp_is_application_passwords_available_for_user( $user ) { 5031 if ( ! wp_is_application_passwords_available() ) { 5032 return false; 5033 } 5034 5035 if ( ! is_object( $user ) ) { 5036 $user = get_userdata( $user ); 5037 } 5038 5039 if ( ! $user || ! $user->exists() ) { 5040 return false; 5041 } 5042 5043 /** 5044 * Filters whether Application Passwords is available for a specific user. 5045 * 5046 * @since 5.6.0 5047 * 5048 * @param bool $available True if available, false otherwise. 5049 * @param WP_User $user The user to check. 5050 */ 5051 return apply_filters( 'wp_is_application_passwords_available_for_user', true, $user ); 5052 } 5053 5054 /** 5055 * Registers the user meta property for persisted preferences. 5056 * 5057 * This property is used to store user preferences across page reloads and is 5058 * currently used by the block editor for preferences like 'fullscreenMode' and 5059 * 'fixedToolbar'. 5060 * 5061 * @since 6.1.0 5062 * @access private 5063 * 5064 * @global wpdb $wpdb WordPress database abstraction object. 5065 */ 5066 function wp_register_persisted_preferences_meta() { 5067 /* 5068 * Create a meta key that incorporates the blog prefix so that each site 5069 * on a multisite can have distinct user preferences. 5070 */ 5071 global $wpdb; 5072 $meta_key = $wpdb->get_blog_prefix() . 'persisted_preferences'; 5073 5074 register_meta( 5075 'user', 5076 $meta_key, 5077 array( 5078 'type' => 'object', 5079 'single' => true, 5080 'show_in_rest' => array( 5081 'name' => 'persisted_preferences', 5082 'type' => 'object', 5083 'schema' => array( 5084 'type' => 'object', 5085 'context' => array( 'edit' ), 5086 'properties' => array( 5087 '_modified' => array( 5088 'description' => __( 'The date and time the preferences were updated.' ), 5089 'type' => 'string', 5090 'format' => 'date-time', 5091 'readonly' => false, 5092 ), 5093 ), 5094 'additionalProperties' => true, 5095 ), 5096 ), 5097 ) 5098 ); 5099 } 5100 5101 /** 5102 * Sets the last changed time for the 'users' cache group. 5103 * 5104 * @since 6.3.0 5105 */ 5106 function wp_cache_set_users_last_changed() { 5107 wp_cache_set_last_changed( 'users' ); 5108 } 5109 5110 /** 5111 * Checks if password reset is allowed for a specific user. 5112 * 5113 * @since 6.3.0 5114 * 5115 * @param int|WP_User $user The user to check. 5116 * @return bool|WP_Error True if allowed, false or WP_Error otherwise. 5117 */ 5118 function wp_is_password_reset_allowed_for_user( $user ) { 5119 if ( ! is_object( $user ) ) { 5120 $user = get_userdata( $user ); 5121 } 5122 5123 if ( ! $user || ! $user->exists() ) { 5124 return false; 5125 } 5126 $allow = true; 5127 if ( is_multisite() && is_user_spammy( $user ) ) { 5128 $allow = false; 5129 } 5130 5131 /** 5132 * Filters whether to allow a password to be reset. 5133 * 5134 * @since 2.7.0 5135 * 5136 * @param bool $allow Whether to allow the password to be reset. Default true. 5137 * @param int $user_id The ID of the user attempting to reset a password. 5138 */ 5139 return apply_filters( 'allow_password_reset', $allow, $user->ID ); 5140 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sat Dec 21 08:20:01 2024 | Cross-referenced by PHPXref |