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