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