10 * Authenticates and logs a user in with 'remember' capability.
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.
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
22 * @global string $auth_secure_cookie
24 * @param array $credentials Optional. User info in order to sign on.
25 * @param string|bool $secure_cookie Optional. Whether to use secure cookie.
26 * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
28 function wp_signon( $credentials = array(), $secure_cookie = '' ) {
29 if ( empty($credentials) ) {
30 $credentials = array(); // Back-compat for plugins passing an empty string.
32 if ( ! empty($_POST['log']) )
33 $credentials['user_login'] = $_POST['log'];
34 if ( ! empty($_POST['pwd']) )
35 $credentials['user_password'] = $_POST['pwd'];
36 if ( ! empty($_POST['rememberme']) )
37 $credentials['remember'] = $_POST['rememberme'];
40 if ( !empty($credentials['remember']) )
41 $credentials['remember'] = true;
43 $credentials['remember'] = false;
46 * Fires before the user is authenticated.
48 * The variables passed to the callbacks are passed by reference,
49 * and can be modified by callback functions.
53 * @todo Decide whether to deprecate the wp_authenticate action.
55 * @param string $user_login Username, passed by reference.
56 * @param string $user_password User password, passed by reference.
58 do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
60 if ( '' === $secure_cookie )
61 $secure_cookie = is_ssl();
64 * Filters whether to use a secure sign-on cookie.
68 * @param bool $secure_cookie Whether to use a secure sign-on cookie.
69 * @param array $credentials {
70 * Array of entered sign-on data.
72 * @type string $user_login Username.
73 * @type string $user_password Password entered.
74 * @type bool $remember Whether to 'remember' the user. Increases the time
75 * that the cookie will be kept. Default false.
78 $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );
80 global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
81 $auth_secure_cookie = $secure_cookie;
83 add_filter('authenticate', 'wp_authenticate_cookie', 30, 3);
85 $user = wp_authenticate($credentials['user_login'], $credentials['user_password']);
87 if ( is_wp_error($user) ) {
88 if ( $user->get_error_codes() == array('empty_username', 'empty_password') ) {
89 $user = new WP_Error('', '');
95 wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie);
97 * Fires after the user has successfully logged in.
101 * @param string $user_login Username.
102 * @param WP_User $user WP_User object of the logged-in user.
104 do_action( 'wp_login', $user->user_login, $user );
109 * Authenticate a user, confirming the username and password are valid.
113 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
114 * @param string $username Username for authentication.
115 * @param string $password Password for authentication.
116 * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
118 function wp_authenticate_username_password($user, $username, $password) {
119 if ( $user instanceof WP_User ) {
123 if ( empty($username) || empty($password) ) {
124 if ( is_wp_error( $user ) )
127 $error = new WP_Error();
129 if ( empty($username) )
130 $error->add('empty_username', __('<strong>ERROR</strong>: The username field is empty.'));
132 if ( empty($password) )
133 $error->add('empty_password', __('<strong>ERROR</strong>: The password field is empty.'));
138 $user = get_user_by('login', $username);
141 return new WP_Error( 'invalid_username',
142 __( '<strong>ERROR</strong>: Invalid username.' ) .
143 ' <a href="' . wp_lostpassword_url() . '">' .
144 __( 'Lost your password?' ) .
150 * Filters whether the given user can be authenticated with the provided $password.
154 * @param WP_User|WP_Error $user WP_User or WP_Error object if a previous
155 * callback failed authentication.
156 * @param string $password Password to check against the user.
158 $user = apply_filters( 'wp_authenticate_user', $user, $password );
159 if ( is_wp_error($user) )
162 if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
163 return new WP_Error( 'incorrect_password',
165 /* translators: %s: user name */
166 __( '<strong>ERROR</strong>: The password you entered for the username %s is incorrect.' ),
167 '<strong>' . $username . '</strong>'
169 ' <a href="' . wp_lostpassword_url() . '">' .
170 __( 'Lost your password?' ) .
179 * Authenticates a user using the email and password.
183 * @param WP_User|WP_Error|null $user WP_User or WP_Error object if a previous
184 * callback failed authentication.
185 * @param string $email Email address for authentication.
186 * @param string $password Password for authentication.
187 * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
189 function wp_authenticate_email_password( $user, $email, $password ) {
190 if ( $user instanceof WP_User ) {
194 if ( empty( $email ) || empty( $password ) ) {
195 if ( is_wp_error( $user ) ) {
199 $error = new WP_Error();
201 if ( empty( $email ) ) {
202 $error->add( 'empty_username', __( '<strong>ERROR</strong>: The email field is empty.' ) ); // Uses 'empty_username' for back-compat with wp_signon()
205 if ( empty( $password ) ) {
206 $error->add( 'empty_password', __( '<strong>ERROR</strong>: The password field is empty.' ) );
212 if ( ! is_email( $email ) ) {
216 $user = get_user_by( 'email', $email );
219 return new WP_Error( 'invalid_email',
220 __( '<strong>ERROR</strong>: Invalid email address.' ) .
221 ' <a href="' . wp_lostpassword_url() . '">' .
222 __( 'Lost your password?' ) .
227 /** This filter is documented in wp-includes/user.php */
228 $user = apply_filters( 'wp_authenticate_user', $user, $password );
230 if ( is_wp_error( $user ) ) {
234 if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
235 return new WP_Error( 'incorrect_password',
237 /* translators: %s: email address */
238 __( '<strong>ERROR</strong>: The password you entered for the email address %s is incorrect.' ),
239 '<strong>' . $email . '</strong>'
241 ' <a href="' . wp_lostpassword_url() . '">' .
242 __( 'Lost your password?' ) .
251 * Authenticate the user using the WordPress auth cookie.
255 * @global string $auth_secure_cookie
257 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
258 * @param string $username Username. If not empty, cancels the cookie authentication.
259 * @param string $password Password. If not empty, cancels the cookie authentication.
260 * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
262 function wp_authenticate_cookie($user, $username, $password) {
263 if ( $user instanceof WP_User ) {
267 if ( empty($username) && empty($password) ) {
268 $user_id = wp_validate_auth_cookie();
270 return new WP_User($user_id);
272 global $auth_secure_cookie;
274 if ( $auth_secure_cookie )
275 $auth_cookie = SECURE_AUTH_COOKIE;
277 $auth_cookie = AUTH_COOKIE;
279 if ( !empty($_COOKIE[$auth_cookie]) )
280 return new WP_Error('expired_session', __('Please log in again.'));
282 // If the cookie is not set, be silent.
289 * For Multisite blogs, check if the authenticated user has been marked as a
290 * spammer, or if the user's primary blog has been marked as spam.
294 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
295 * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer.
297 function wp_authenticate_spam_check( $user ) {
298 if ( $user instanceof WP_User && is_multisite() ) {
300 * Filters whether the user has been marked as a spammer.
304 * @param bool $spammed Whether the user is considered a spammer.
305 * @param WP_User $user User to check against.
307 $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy( $user ), $user );
310 return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) );
316 * Validates the logged-in cookie.
318 * Checks the logged-in cookie if the previous auth cookie could not be
319 * validated and parsed.
321 * This is a callback for the {@see 'determine_current_user'} filter, rather than API.
325 * @param int|bool $user_id The user ID (or false) as received from the
326 * determine_current_user filter.
327 * @return int|false User ID if validated, false otherwise. If a user ID from
328 * an earlier filter callback is received, that value is returned.
330 function wp_validate_logged_in_cookie( $user_id ) {
335 if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) ) {
339 return wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' );
343 * Number of posts user has written.
346 * @since 4.1.0 Added `$post_type` argument.
347 * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array
348 * of post types to `$post_type`.
350 * @global wpdb $wpdb WordPress database abstraction object.
352 * @param int $userid User ID.
353 * @param array|string $post_type Optional. Single post type or array of post types to count the number of posts for. Default 'post'.
354 * @param bool $public_only Optional. Whether to only return counts for public posts. Default false.
355 * @return string Number of posts the user has written in this post type.
357 function count_user_posts( $userid, $post_type = 'post', $public_only = false ) {
360 $where = get_posts_by_author_sql( $post_type, true, $userid, $public_only );
362 $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
365 * Filters the number of posts a user has written.
368 * @since 4.1.0 Added `$post_type` argument.
369 * @since 4.3.1 Added `$public_only` argument.
371 * @param int $count The user's post count.
372 * @param int $userid User ID.
373 * @param string|array $post_type Single post type or array of post types to count the number of posts for.
374 * @param bool $public_only Whether to limit counted posts to public posts.
376 return apply_filters( 'get_usernumposts', $count, $userid, $post_type, $public_only );
380 * Number of posts written by a list of users.
384 * @global wpdb $wpdb WordPress database abstraction object.
386 * @param array $users Array of user IDs.
387 * @param string|array $post_type Optional. Single post type or array of post types to check. Defaults to 'post'.
388 * @param bool $public_only Optional. Only return counts for public posts. Defaults to false.
389 * @return array Amount of posts each user has written.
391 function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) {
395 if ( empty( $users ) || ! is_array( $users ) )
398 $userlist = implode( ',', array_map( 'absint', $users ) );
399 $where = get_posts_by_author_sql( $post_type, true, null, $public_only );
401 $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N );
402 foreach ( $result as $row ) {
403 $count[ $row[0] ] = $row[1];
406 foreach ( $users as $id ) {
407 if ( ! isset( $count[ $id ] ) )
415 // User option functions
419 * Get the current user's ID
423 * @return int The current user's ID
425 function get_current_user_id() {
426 if ( ! function_exists( 'wp_get_current_user' ) )
428 $user = wp_get_current_user();
429 return ( isset( $user->ID ) ? (int) $user->ID : 0 );
433 * Retrieve user option that can be either per Site or per Network.
435 * If the user ID is not given, then the current user will be used instead. If
436 * the user ID is given, then the user data will be retrieved. The filter for
437 * the result, will also pass the original option name and finally the user data
438 * object as the third parameter.
440 * The option will first check for the per site name and then the per Network name.
444 * @global wpdb $wpdb WordPress database abstraction object.
446 * @param string $option User option name.
447 * @param int $user Optional. User ID.
448 * @param string $deprecated Use get_option() to check for an option in the options table.
449 * @return mixed User option value on success, false on failure.
451 function get_user_option( $option, $user = 0, $deprecated = '' ) {
454 if ( !empty( $deprecated ) )
455 _deprecated_argument( __FUNCTION__, '3.0.0' );
457 if ( empty( $user ) )
458 $user = get_current_user_id();
460 if ( ! $user = get_userdata( $user ) )
463 $prefix = $wpdb->get_blog_prefix();
464 if ( $user->has_prop( $prefix . $option ) ) // Blog specific
465 $result = $user->get( $prefix . $option );
466 elseif ( $user->has_prop( $option ) ) // User specific and cross-blog
467 $result = $user->get( $option );
472 * Filters a specific user option value.
474 * The dynamic portion of the hook name, `$option`, refers to the user option name.
478 * @param mixed $result Value for the user's option.
479 * @param string $option Name of the option being retrieved.
480 * @param WP_User $user WP_User object of the user whose option is being retrieved.
482 return apply_filters( "get_user_option_{$option}", $result, $option, $user );
486 * Update user option with global blog capability.
488 * User options are just like user metadata except that they have support for
489 * global blog options. If the 'global' parameter is false, which it is by default
490 * it will prepend the WordPress table prefix to the option name.
492 * Deletes the user option if $newvalue is empty.
496 * @global wpdb $wpdb WordPress database abstraction object.
498 * @param int $user_id User ID.
499 * @param string $option_name User option name.
500 * @param mixed $newvalue User option value.
501 * @param bool $global Optional. Whether option name is global or blog specific.
502 * Default false (blog specific).
503 * @return int|bool User meta ID if the option didn't exist, true on successful update,
506 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
510 $option_name = $wpdb->get_blog_prefix() . $option_name;
512 return update_user_meta( $user_id, $option_name, $newvalue );
516 * Delete user option with global blog capability.
518 * User options are just like user metadata except that they have support for
519 * global blog options. If the 'global' parameter is false, which it is by default
520 * it will prepend the WordPress table prefix to the option name.
524 * @global wpdb $wpdb WordPress database abstraction object.
526 * @param int $user_id User ID
527 * @param string $option_name User option name.
528 * @param bool $global Optional. Whether option name is global or blog specific.
529 * Default false (blog specific).
530 * @return bool True on success, false on failure.
532 function delete_user_option( $user_id, $option_name, $global = false ) {
536 $option_name = $wpdb->get_blog_prefix() . $option_name;
537 return delete_user_meta( $user_id, $option_name );
541 * Retrieve list of users matching criteria.
547 * @param array $args Optional. Arguments to retrieve users. See WP_User_Query::prepare_query().
548 * for more information on accepted arguments.
549 * @return array List of users.
551 function get_users( $args = array() ) {
553 $args = wp_parse_args( $args );
554 $args['count_total'] = false;
556 $user_search = new WP_User_Query($args);
558 return (array) $user_search->get_results();
562 * Get the sites a user belongs to.
565 * @since 4.7.0 Converted to use get_sites().
567 * @global wpdb $wpdb WordPress database abstraction object.
569 * @param int $user_id User ID
570 * @param bool $all Whether to retrieve all sites, or only sites that are not
571 * marked as deleted, archived, or spam.
572 * @return array A list of the user's sites. An empty array if the user doesn't exist
573 * or belongs to no sites.
575 function get_blogs_of_user( $user_id, $all = false ) {
578 $user_id = (int) $user_id;
580 // Logged out users can't have sites
581 if ( empty( $user_id ) )
585 * Filters the list of a user's sites before it is populated.
587 * Passing a non-null value to the filter will effectively short circuit
588 * get_blogs_of_user(), returning that value instead.
592 * @param null|array $sites An array of site objects of which the user is a member.
593 * @param int $user_id User ID.
594 * @param bool $all Whether the returned array should contain all sites, including
595 * those marked 'deleted', 'archived', or 'spam'. Default false.
597 $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
599 if ( null !== $sites ) {
603 $keys = get_user_meta( $user_id );
604 if ( empty( $keys ) )
607 if ( ! is_multisite() ) {
608 $site_id = get_current_blog_id();
609 $sites = array( $site_id => new stdClass );
610 $sites[ $site_id ]->userblog_id = $site_id;
611 $sites[ $site_id ]->blogname = get_option('blogname');
612 $sites[ $site_id ]->domain = '';
613 $sites[ $site_id ]->path = '';
614 $sites[ $site_id ]->site_id = 1;
615 $sites[ $site_id ]->siteurl = get_option('siteurl');
616 $sites[ $site_id ]->archived = 0;
617 $sites[ $site_id ]->spam = 0;
618 $sites[ $site_id ]->deleted = 0;
624 if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
626 unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
629 $keys = array_keys( $keys );
631 foreach ( $keys as $key ) {
632 if ( 'capabilities' !== substr( $key, -12 ) )
634 if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) )
636 $site_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
637 if ( ! is_numeric( $site_id ) )
640 $site_ids[] = (int) $site_id;
645 if ( ! empty( $site_ids ) ) {
648 'site__in' => $site_ids,
651 $args['archived'] = 0;
653 $args['deleted'] = 0;
656 $_sites = get_sites( $args );
658 foreach ( $_sites as $site ) {
659 $sites[ $site->id ] = (object) array(
660 'userblog_id' => $site->id,
661 'blogname' => $site->blogname,
662 'domain' => $site->domain,
663 'path' => $site->path,
664 'site_id' => $site->network_id,
665 'siteurl' => $site->siteurl,
666 'archived' => $site->archived,
667 'mature' => $site->mature,
668 'spam' => $site->spam,
669 'deleted' => $site->deleted,
675 * Filters the list of sites a user belongs to.
679 * @param array $sites An array of site objects belonging to the user.
680 * @param int $user_id User ID.
681 * @param bool $all Whether the returned sites array should contain all sites, including
682 * those marked 'deleted', 'archived', or 'spam'. Default false.
684 return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all );
688 * Find out whether a user is a member of a given blog.
692 * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
693 * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
696 function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
699 $user_id = (int) $user_id;
700 $blog_id = (int) $blog_id;
702 if ( empty( $user_id ) ) {
703 $user_id = get_current_user_id();
706 // Technically not needed, but does save calls to get_site and get_user_meta
707 // in the event that the function is called when a user isn't logged in
708 if ( empty( $user_id ) ) {
711 $user = get_userdata( $user_id );
712 if ( ! $user instanceof WP_User ) {
717 if ( ! is_multisite() ) {
721 if ( empty( $blog_id ) ) {
722 $blog_id = get_current_blog_id();
725 $blog = get_site( $blog_id );
727 if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) {
731 $keys = get_user_meta( $user_id );
732 if ( empty( $keys ) ) {
736 // no underscore before capabilities in $base_capabilities_key
737 $base_capabilities_key = $wpdb->base_prefix . 'capabilities';
738 $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
740 if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) {
744 if ( isset( $keys[ $site_capabilities_key ] ) ) {
752 * Add meta data field to a user.
754 * Post meta data is called "Custom Fields" on the Administration Screens.
757 * @link https://codex.wordpress.org/Function_Reference/add_user_meta
759 * @param int $user_id User ID.
760 * @param string $meta_key Metadata name.
761 * @param mixed $meta_value Metadata value.
762 * @param bool $unique Optional, default is false. Whether the same key should not be added.
763 * @return int|false Meta ID on success, false on failure.
765 function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
766 return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
770 * Remove metadata matching criteria from a user.
772 * You can match based on the key, or key and value. Removing based on key and
773 * value, will keep from removing duplicate metadata with the same key. It also
774 * allows removing all metadata matching key, if needed.
777 * @link https://codex.wordpress.org/Function_Reference/delete_user_meta
779 * @param int $user_id User ID
780 * @param string $meta_key Metadata name.
781 * @param mixed $meta_value Optional. Metadata value.
782 * @return bool True on success, false on failure.
784 function delete_user_meta($user_id, $meta_key, $meta_value = '') {
785 return delete_metadata('user', $user_id, $meta_key, $meta_value);
789 * Retrieve user meta field for a user.
792 * @link https://codex.wordpress.org/Function_Reference/get_user_meta
794 * @param int $user_id User ID.
795 * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
796 * @param bool $single Whether to return a single value.
797 * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
799 function get_user_meta($user_id, $key = '', $single = false) {
800 return get_metadata('user', $user_id, $key, $single);
804 * Update user meta field based on user ID.
806 * Use the $prev_value parameter to differentiate between meta fields with the
807 * same key and user ID.
809 * If the meta field for the user does not exist, it will be added.
812 * @link https://codex.wordpress.org/Function_Reference/update_user_meta
814 * @param int $user_id User ID.
815 * @param string $meta_key Metadata key.
816 * @param mixed $meta_value Metadata value.
817 * @param mixed $prev_value Optional. Previous value to check before removing.
818 * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
820 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
821 return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
825 * Count number of users who have each of the user roles.
827 * Assumes there are neither duplicated nor orphaned capabilities meta_values.
828 * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query()
829 * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
830 * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
833 * @since 4.4.0 The number of users with no role is now included in the `none` element.
835 * @global wpdb $wpdb WordPress database abstraction object.
837 * @param string $strategy 'time' or 'memory'
838 * @return array Includes a grand total and an array of counts indexed by role strings.
840 function count_users($strategy = 'time') {
844 $id = get_current_blog_id();
845 $blog_prefix = $wpdb->get_blog_prefix($id);
848 if ( 'time' == $strategy ) {
849 $avail_roles = wp_roles()->get_names();
851 // Build a CPU-intensive query that will return concise information.
852 $select_count = array();
853 foreach ( $avail_roles as $this_role => $name ) {
854 $select_count[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%');
856 $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))";
857 $select_count = implode(', ', $select_count);
859 // Add the meta_value index to the selection list, then run the query.
860 $row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
862 // Run the previous loop again to associate results with role names.
864 $role_counts = array();
865 foreach ( $avail_roles as $this_role => $name ) {
866 $count = (int) $row[$col++];
868 $role_counts[$this_role] = $count;
872 $role_counts['none'] = (int) $row[$col++];
874 // Get the meta_value index from the end of the result set.
875 $total_users = (int) $row[$col];
877 $result['total_users'] = $total_users;
878 $result['avail_roles'] =& $role_counts;
880 $avail_roles = array(
884 $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" );
886 foreach ( $users_of_blog as $caps_meta ) {
887 $b_roles = maybe_unserialize($caps_meta);
888 if ( ! is_array( $b_roles ) )
890 if ( empty( $b_roles ) ) {
891 $avail_roles['none']++;
893 foreach ( $b_roles as $b_role => $val ) {
894 if ( isset($avail_roles[$b_role]) ) {
895 $avail_roles[$b_role]++;
897 $avail_roles[$b_role] = 1;
902 $result['total_users'] = count( $users_of_blog );
903 $result['avail_roles'] =& $avail_roles;
906 if ( is_multisite() ) {
907 $result['avail_roles']['none'] = 0;
914 // Private helper functions
918 * Set up global user vars.
920 * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
924 * @global string $user_login The user username for logging in
925 * @global object $userdata User data.
926 * @global int $user_level The level of the user
927 * @global int $user_ID The ID of the user
928 * @global string $user_email The email address of the user
929 * @global string $user_url The url in the user's profile
930 * @global string $user_identity The display name of the user
932 * @param int $for_user_id Optional. User ID to set up global data.
934 function setup_userdata($for_user_id = '') {
935 global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity;
937 if ( '' == $for_user_id )
938 $for_user_id = get_current_user_id();
939 $user = get_userdata( $for_user_id );
945 $user_login = $user_email = $user_url = $user_identity = '';
949 $user_ID = (int) $user->ID;
950 $user_level = (int) $user->user_level;
952 $user_login = $user->user_login;
953 $user_email = $user->user_email;
954 $user_url = $user->user_url;
955 $user_identity = $user->display_name;
959 * Create dropdown HTML content of users.
961 * The content can either be displayed, which it is by default or retrieved by
962 * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
963 * need to be used; all users will be displayed in that case. Only one can be
964 * used, either 'include' or 'exclude', but not both.
966 * The available arguments are as follows:
969 * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
970 * @since 4.7.0 Added the `$role`, `$role__in`, and `$role__not_in` parameters.
972 * @param array|string $args {
973 * Optional. Array or string of arguments to generate a drop-down of users.
974 * See WP_User_Query::prepare_query() for additional available arguments.
976 * @type string $show_option_all Text to show as the drop-down default (all).
978 * @type string $show_option_none Text to show as the drop-down default when no
979 * users were found. Default empty.
980 * @type int|string $option_none_value Value to use for $show_option_non when no users
981 * were found. Default -1.
982 * @type string $hide_if_only_one_author Whether to skip generating the drop-down
983 * if only one user was found. Default empty.
984 * @type string $orderby Field to order found users by. Accepts user fields.
985 * Default 'display_name'.
986 * @type string $order Whether to order users in ascending or descending
987 * order. Accepts 'ASC' (ascending) or 'DESC' (descending).
989 * @type array|string $include Array or comma-separated list of user IDs to include.
991 * @type array|string $exclude Array or comma-separated list of user IDs to exclude.
993 * @type bool|int $multi Whether to skip the ID attribute on the 'select' element.
994 * Accepts 1|true or 0|false. Default 0|false.
995 * @type string $show User data to display. If the selected item is empty
996 * then the 'user_login' will be displayed in parentheses.
997 * Accepts any user field, or 'display_name_with_login' to show
998 * the display name with user_login in parentheses.
999 * Default 'display_name'.
1000 * @type int|bool $echo Whether to echo or return the drop-down. Accepts 1|true (echo)
1001 * or 0|false (return). Default 1|true.
1002 * @type int $selected Which user ID should be selected. Default 0.
1003 * @type bool $include_selected Whether to always include the selected user ID in the drop-
1004 * down. Default false.
1005 * @type string $name Name attribute of select element. Default 'user'.
1006 * @type string $id ID attribute of the select element. Default is the value of $name.
1007 * @type string $class Class attribute of the select element. Default empty.
1008 * @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog.
1009 * @type string $who Which type of users to query. Accepts only an empty string or
1010 * 'authors'. Default empty.
1011 * @type string|array $role An array or a comma-separated list of role names that users must
1012 * match to be included in results. Note that this is an inclusive
1013 * list: users must match *each* role. Default empty.
1014 * @type array $role__in An array of role names. Matched users must have at least one of
1015 * these roles. Default empty array.
1016 * @type array $role__not_in An array of role names to exclude. Users matching one or more of
1017 * these roles will not be included in results. Default empty array.
1019 * @return string String of HTML content.
1021 function wp_dropdown_users( $args = '' ) {
1023 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
1024 'orderby' => 'display_name', 'order' => 'ASC',
1025 'include' => '', 'exclude' => '', 'multi' => 0,
1026 'show' => 'display_name', 'echo' => 1,
1027 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
1028 'blog_id' => get_current_blog_id(), 'who' => '', 'include_selected' => false,
1029 'option_none_value' => -1,
1031 'role__in' => array(),
1032 'role__not_in' => array(),
1035 $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
1037 $r = wp_parse_args( $args, $defaults );
1039 $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who', 'role', 'role__in', 'role__not_in' ) );
1041 $fields = array( 'ID', 'user_login' );
1043 $show = ! empty( $r['show'] ) ? $r['show'] : 'display_name';
1044 if ( 'display_name_with_login' === $show ) {
1045 $fields[] = 'display_name';
1050 $query_args['fields'] = $fields;
1052 $show_option_all = $r['show_option_all'];
1053 $show_option_none = $r['show_option_none'];
1054 $option_none_value = $r['option_none_value'];
1057 * Filters the query arguments for the list of users in the dropdown.
1061 * @param array $query_args The query arguments for get_users().
1062 * @param array $r The arguments passed to wp_dropdown_users() combined with the defaults.
1064 $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $r );
1066 $users = get_users( $query_args );
1069 if ( ! empty( $users ) && ( empty( $r['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
1070 $name = esc_attr( $r['name'] );
1071 if ( $r['multi'] && ! $r['id'] ) {
1074 $id = $r['id'] ? " id='" . esc_attr( $r['id'] ) . "'" : " id='$name'";
1076 $output = "<select name='{$name}'{$id} class='" . $r['class'] . "'>\n";
1078 if ( $show_option_all ) {
1079 $output .= "\t<option value='0'>$show_option_all</option>\n";
1082 if ( $show_option_none ) {
1083 $_selected = selected( $option_none_value, $r['selected'], false );
1084 $output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n";
1087 if ( $r['include_selected'] && ( $r['selected'] > 0 ) ) {
1088 $found_selected = false;
1089 $r['selected'] = (int) $r['selected'];
1090 foreach ( (array) $users as $user ) {
1091 $user->ID = (int) $user->ID;
1092 if ( $user->ID === $r['selected'] ) {
1093 $found_selected = true;
1097 if ( ! $found_selected ) {
1098 $users[] = get_userdata( $r['selected'] );
1102 foreach ( (array) $users as $user ) {
1103 if ( 'display_name_with_login' === $show ) {
1104 /* translators: 1: display name, 2: user_login */
1105 $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login );
1106 } elseif ( ! empty( $user->$show ) ) {
1107 $display = $user->$show;
1109 $display = '(' . $user->user_login . ')';
1112 $_selected = selected( $user->ID, $r['selected'], false );
1113 $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
1116 $output .= "</select>";
1120 * Filters the wp_dropdown_users() HTML output.
1124 * @param string $output HTML output generated by wp_dropdown_users().
1126 $html = apply_filters( 'wp_dropdown_users', $output );
1135 * Sanitize user field based on context.
1137 * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1138 * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1139 * when calling filters.
1143 * @param string $field The user Object field name.
1144 * @param mixed $value The user Object value.
1145 * @param int $user_id User ID.
1146 * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
1147 * 'attribute' and 'js'.
1148 * @return mixed Sanitized value.
1150 function sanitize_user_field($field, $value, $user_id, $context) {
1151 $int_fields = array('ID');
1152 if ( in_array($field, $int_fields) )
1153 $value = (int) $value;
1155 if ( 'raw' == $context )
1158 if ( !is_string($value) && !is_numeric($value) )
1161 $prefixed = false !== strpos( $field, 'user_' );
1163 if ( 'edit' == $context ) {
1166 /** This filter is documented in wp-includes/post.php */
1167 $value = apply_filters( "edit_{$field}", $value, $user_id );
1171 * Filters a user field value in the 'edit' context.
1173 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1174 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1178 * @param mixed $value Value of the prefixed user field.
1179 * @param int $user_id User ID.
1181 $value = apply_filters( "edit_user_{$field}", $value, $user_id );
1184 if ( 'description' == $field )
1185 $value = esc_html( $value ); // textarea_escaped?
1187 $value = esc_attr($value);
1188 } elseif ( 'db' == $context ) {
1190 /** This filter is documented in wp-includes/post.php */
1191 $value = apply_filters( "pre_{$field}", $value );
1195 * Filters the value of a user field in the 'db' context.
1197 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1198 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1202 * @param mixed $value Value of the prefixed user field.
1204 $value = apply_filters( "pre_user_{$field}", $value );
1207 // Use display filters by default.
1210 /** This filter is documented in wp-includes/post.php */
1211 $value = apply_filters( $field, $value, $user_id, $context );
1215 * Filters the value of a user field in a standard context.
1217 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1218 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1222 * @param mixed $value The user object value to sanitize.
1223 * @param int $user_id User ID.
1224 * @param string $context The context to filter within.
1226 $value = apply_filters( "user_{$field}", $value, $user_id, $context );
1230 if ( 'user_url' == $field )
1231 $value = esc_url($value);
1233 if ( 'attribute' == $context ) {
1234 $value = esc_attr( $value );
1235 } elseif ( 'js' == $context ) {
1236 $value = esc_js( $value );
1242 * Update all user caches
1246 * @param object|WP_User $user User object to be cached
1247 * @return bool|null Returns false on failure.
1249 function update_user_caches( $user ) {
1250 if ( $user instanceof WP_User ) {
1251 if ( ! $user->exists() ) {
1255 $user = $user->data;
1258 wp_cache_add($user->ID, $user, 'users');
1259 wp_cache_add($user->user_login, $user->ID, 'userlogins');
1260 wp_cache_add($user->user_email, $user->ID, 'useremail');
1261 wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
1265 * Clean all user caches
1268 * @since 4.4.0 'clean_user_cache' action was added.
1270 * @param WP_User|int $user User object or ID to be cleaned from the cache
1272 function clean_user_cache( $user ) {
1273 if ( is_numeric( $user ) )
1274 $user = new WP_User( $user );
1276 if ( ! $user->exists() )
1279 wp_cache_delete( $user->ID, 'users' );
1280 wp_cache_delete( $user->user_login, 'userlogins' );
1281 wp_cache_delete( $user->user_email, 'useremail' );
1282 wp_cache_delete( $user->user_nicename, 'userslugs' );
1285 * Fires immediately after the given user's cache is cleaned.
1289 * @param int $user_id User ID.
1290 * @param WP_User $user User object.
1292 do_action( 'clean_user_cache', $user->ID, $user );
1296 * Checks whether the given username exists.
1300 * @param string $username Username.
1301 * @return int|false The user's ID on success, and false on failure.
1303 function username_exists( $username ) {
1304 if ( $user = get_user_by( 'login', $username ) ) {
1311 * Checks whether the given email exists.
1315 * @param string $email Email.
1316 * @return int|false The user's ID on success, and false on failure.
1318 function email_exists( $email ) {
1319 if ( $user = get_user_by( 'email', $email) ) {
1326 * Checks whether a username is valid.
1329 * @since 4.4.0 Empty sanitized usernames are now considered invalid
1331 * @param string $username Username.
1332 * @return bool Whether username given is valid
1334 function validate_username( $username ) {
1335 $sanitized = sanitize_user( $username, true );
1336 $valid = ( $sanitized == $username && ! empty( $sanitized ) );
1339 * Filters whether the provided username is valid or not.
1343 * @param bool $valid Whether given username is valid.
1344 * @param string $username Username to check.
1346 return apply_filters( 'validate_username', $valid, $username );
1350 * Insert a user into the database.
1352 * Most of the `$userdata` array fields have filters associated with the values. Exceptions are
1353 * 'ID', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl',
1354 * 'user_registered', and 'role'. The filters have the prefix 'pre_user_' followed by the field
1355 * name. An example using 'description' would have the filter called, 'pre_user_description' that
1356 * can be hooked into.
1359 * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact
1360 * methods for new installs. See wp_get_user_contact_methods().
1361 * @since 4.7.0 The user's locale can be passed to `$userdata`.
1363 * @global wpdb $wpdb WordPress database abstraction object.
1365 * @param array|object|WP_User $userdata {
1366 * An array, object, or WP_User object of user data arguments.
1368 * @type int $ID User ID. If supplied, the user will be updated.
1369 * @type string $user_pass The plain-text user password.
1370 * @type string $user_login The user's login username.
1371 * @type string $user_nicename The URL-friendly user name.
1372 * @type string $user_url The user URL.
1373 * @type string $user_email The user email address.
1374 * @type string $display_name The user's display name.
1375 * Default is the user's username.
1376 * @type string $nickname The user's nickname.
1377 * Default is the user's username.
1378 * @type string $first_name The user's first name. For new users, will be used
1379 * to build the first part of the user's display name
1380 * if `$display_name` is not specified.
1381 * @type string $last_name The user's last name. For new users, will be used
1382 * to build the second part of the user's display name
1383 * if `$display_name` is not specified.
1384 * @type string $description The user's biographical description.
1385 * @type string|bool $rich_editing Whether to enable the rich-editor for the user.
1386 * False if not empty.
1387 * @type string|bool $comment_shortcuts Whether to enable comment moderation keyboard
1388 * shortcuts for the user. Default false.
1389 * @type string $admin_color Admin color scheme for the user. Default 'fresh'.
1390 * @type bool $use_ssl Whether the user should always access the admin over
1391 * https. Default false.
1392 * @type string $user_registered Date the user registered. Format is 'Y-m-d H:i:s'.
1393 * @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
1394 * site's front end. Default true.
1395 * @type string $role User's role.
1396 * @type string $locale User's locale. Default empty.
1398 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1401 function wp_insert_user( $userdata ) {
1404 if ( $userdata instanceof stdClass ) {
1405 $userdata = get_object_vars( $userdata );
1406 } elseif ( $userdata instanceof WP_User ) {
1407 $userdata = $userdata->to_array();
1410 // Are we updating or creating?
1411 if ( ! empty( $userdata['ID'] ) ) {
1412 $ID = (int) $userdata['ID'];
1414 $old_user_data = get_userdata( $ID );
1416 if ( ! $old_user_data ) {
1417 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1420 // hashed in wp_update_user(), plaintext if called directly
1421 $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass;
1424 // Hash the password
1425 $user_pass = wp_hash_password( $userdata['user_pass'] );
1428 $sanitized_user_login = sanitize_user( $userdata['user_login'], true );
1431 * Filters a username after it has been sanitized.
1433 * This filter is called before the user is created or updated.
1437 * @param string $sanitized_user_login Username after it has been sanitized.
1439 $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login );
1441 //Remove any non-printable chars from the login string to see if we have ended up with an empty username
1442 $user_login = trim( $pre_user_login );
1444 // user_login must be between 0 and 60 characters.
1445 if ( empty( $user_login ) ) {
1446 return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
1447 } elseif ( mb_strlen( $user_login ) > 60 ) {
1448 return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) );
1451 if ( ! $update && username_exists( $user_login ) ) {
1452 return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
1456 * Filters the list of blacklisted usernames.
1460 * @param array $usernames Array of blacklisted usernames.
1462 $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
1464 if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ) ) ) {
1465 return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) );
1469 * If a nicename is provided, remove unsafe user characters before using it.
1470 * Otherwise build a nicename from the user_login.
1472 if ( ! empty( $userdata['user_nicename'] ) ) {
1473 $user_nicename = sanitize_user( $userdata['user_nicename'], true );
1474 if ( mb_strlen( $user_nicename ) > 50 ) {
1475 return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) );
1478 $user_nicename = mb_substr( $user_login, 0, 50 );
1481 $user_nicename = sanitize_title( $user_nicename );
1483 // Store values to save in user meta.
1487 * Filters a user's nicename before the user is created or updated.
1491 * @param string $user_nicename The user's nicename.
1493 $user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
1495 $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url'];
1498 * Filters a user's URL before the user is created or updated.
1502 * @param string $raw_user_url The user's URL.
1504 $user_url = apply_filters( 'pre_user_url', $raw_user_url );
1506 $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email'];
1509 * Filters a user's email before the user is created or updated.
1513 * @param string $raw_user_email The user's email.
1515 $user_email = apply_filters( 'pre_user_email', $raw_user_email );
1518 * If there is no update, just check for `email_exists`. If there is an update,
1519 * check if current email and new email are the same, or not, and check `email_exists`
1522 if ( ( ! $update || ( ! empty( $old_user_data ) && 0 !== strcasecmp( $user_email, $old_user_data->user_email ) ) )
1523 && ! defined( 'WP_IMPORTING' )
1524 && email_exists( $user_email )
1526 return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
1528 $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname'];
1531 * Filters a user's nickname before the user is created or updated.
1535 * @param string $nickname The user's nickname.
1537 $meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname );
1539 $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name'];
1542 * Filters a user's first name before the user is created or updated.
1546 * @param string $first_name The user's first name.
1548 $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name );
1550 $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name'];
1553 * Filters a user's last name before the user is created or updated.
1557 * @param string $last_name The user's last name.
1559 $meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name );
1561 if ( empty( $userdata['display_name'] ) ) {
1563 $display_name = $user_login;
1564 } elseif ( $meta['first_name'] && $meta['last_name'] ) {
1565 /* translators: 1: first name, 2: last name */
1566 $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $meta['first_name'], $meta['last_name'] );
1567 } elseif ( $meta['first_name'] ) {
1568 $display_name = $meta['first_name'];
1569 } elseif ( $meta['last_name'] ) {
1570 $display_name = $meta['last_name'];
1572 $display_name = $user_login;
1575 $display_name = $userdata['display_name'];
1579 * Filters a user's display name before the user is created or updated.
1583 * @param string $display_name The user's display name.
1585 $display_name = apply_filters( 'pre_user_display_name', $display_name );
1587 $description = empty( $userdata['description'] ) ? '' : $userdata['description'];
1590 * Filters a user's description before the user is created or updated.
1594 * @param string $description The user's description.
1596 $meta['description'] = apply_filters( 'pre_user_description', $description );
1598 $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing'];
1600 $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true';
1602 $admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color'];
1603 $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color );
1605 $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : $userdata['use_ssl'];
1607 $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered'];
1609 $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front'];
1611 $meta['locale'] = isset( $userdata['locale'] ) ? $userdata['locale'] : '';
1613 $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));
1615 if ( $user_nicename_check ) {
1617 while ($user_nicename_check) {
1618 // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix.
1619 $base_length = 49 - mb_strlen( $suffix );
1620 $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix";
1621 $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));
1624 $user_nicename = $alt_user_nicename;
1627 $compacted = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
1628 $data = wp_unslash( $compacted );
1631 if ( $user_email !== $old_user_data->user_email ) {
1632 $data['user_activation_key'] = '';
1634 $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
1635 $user_id = (int) $ID;
1637 $wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) );
1638 $user_id = (int) $wpdb->insert_id;
1641 $user = new WP_User( $user_id );
1644 * Filters a user's meta values and keys before the user is created or updated.
1646 * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`.
1650 * @param array $meta {
1651 * Default meta values and keys for the user.
1653 * @type string $nickname The user's nickname. Default is the user's username.
1654 * @type string $first_name The user's first name.
1655 * @type string $last_name The user's last name.
1656 * @type string $description The user's description.
1657 * @type bool $rich_editing Whether to enable the rich-editor for the user. False if not empty.
1658 * @type bool $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default false.
1659 * @type string $admin_color The color scheme for a user's admin screen. Default 'fresh'.
1660 * @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL is
1662 * @type bool $show_admin_bar_front Whether to show the admin bar on the front end for the user.
1665 * @param WP_User $user User object.
1666 * @param bool $update Whether the user is being updated rather than created.
1668 $meta = apply_filters( 'insert_user_meta', $meta, $user, $update );
1670 // Update user meta.
1671 foreach ( $meta as $key => $value ) {
1672 update_user_meta( $user_id, $key, $value );
1675 foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) {
1676 if ( isset( $userdata[ $key ] ) ) {
1677 update_user_meta( $user_id, $key, $userdata[ $key ] );
1681 if ( isset( $userdata['role'] ) ) {
1682 $user->set_role( $userdata['role'] );
1683 } elseif ( ! $update ) {
1684 $user->set_role(get_option('default_role'));
1686 wp_cache_delete( $user_id, 'users' );
1687 wp_cache_delete( $user_login, 'userlogins' );
1691 * Fires immediately after an existing user is updated.
1695 * @param int $user_id User ID.
1696 * @param object $old_user_data Object containing user's data prior to update.
1698 do_action( 'profile_update', $user_id, $old_user_data );
1701 * Fires immediately after a new user is registered.
1705 * @param int $user_id User ID.
1707 do_action( 'user_register', $user_id );
1714 * Update a user in the database.
1716 * It is possible to update a user's password by specifying the 'user_pass'
1717 * value in the $userdata parameter array.
1719 * If current user's password is being updated, then the cookies will be
1724 * @see wp_insert_user() For what fields can be set in $userdata.
1726 * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
1727 * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
1729 function wp_update_user($userdata) {
1730 if ( $userdata instanceof stdClass ) {
1731 $userdata = get_object_vars( $userdata );
1732 } elseif ( $userdata instanceof WP_User ) {
1733 $userdata = $userdata->to_array();
1736 $ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
1738 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1741 // First, get all of the original fields
1742 $user_obj = get_userdata( $ID );
1743 if ( ! $user_obj ) {
1744 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1747 $user = $user_obj->to_array();
1749 // Add additional custom fields
1750 foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
1751 $user[ $key ] = get_user_meta( $ID, $key, true );
1754 // Escape data pulled from DB.
1755 $user = add_magic_quotes( $user );
1757 if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) {
1758 // If password is changing, hash it now
1759 $plaintext_pass = $userdata['user_pass'];
1760 $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] );
1763 * Filters whether to send the password change email.
1767 * @see wp_insert_user() For `$user` and `$userdata` fields.
1769 * @param bool $send Whether to send the email.
1770 * @param array $user The original user array.
1771 * @param array $userdata The updated user array.
1774 $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata );
1777 if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) {
1779 * Filters whether to send the email change email.
1783 * @see wp_insert_user() For `$user` and `$userdata` fields.
1785 * @param bool $send Whether to send the email.
1786 * @param array $user The original user array.
1787 * @param array $userdata The updated user array.
1790 $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata );
1793 wp_cache_delete( $user['user_email'], 'useremail' );
1794 wp_cache_delete( $user['user_nicename'], 'userslugs' );
1796 // Merge old and new fields with new fields overwriting old ones.
1797 $userdata = array_merge( $user, $userdata );
1798 $user_id = wp_insert_user( $userdata );
1800 if ( ! is_wp_error( $user_id ) ) {
1802 $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
1804 $switched_locale = false;
1805 if ( ! empty( $send_password_change_email ) || ! empty( $send_email_change_email ) ) {
1806 $switched_locale = switch_to_locale( get_user_locale( $user_id ) );
1809 if ( ! empty( $send_password_change_email ) ) {
1810 /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1811 $pass_change_text = __( 'Hi ###USERNAME###,
1813 This notice confirms that your password was changed on ###SITENAME###.
1815 If you did not change your password, please contact the Site Administrator at
1818 This email has been sent to ###EMAIL###
1821 All at ###SITENAME###
1824 $pass_change_email = array(
1825 'to' => $user['user_email'],
1826 /* translators: User password change notification email subject. 1: Site name */
1827 'subject' => __( '[%s] Notice of Password Change' ),
1828 'message' => $pass_change_text,
1833 * Filters the contents of the email sent when the user's password is changed.
1837 * @param array $pass_change_email {
1838 * Used to build wp_mail().
1839 * @type string $to The intended recipients. Add emails in a comma separated string.
1840 * @type string $subject The subject of the email.
1841 * @type string $message The content of the email.
1842 * The following strings have a special meaning and will get replaced dynamically:
1843 * - ###USERNAME### The current user's username.
1844 * - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1845 * - ###EMAIL### The old email.
1846 * - ###SITENAME### The name of the site.
1847 * - ###SITEURL### The URL to the site.
1848 * @type string $headers Headers. Add headers in a newline (\r\n) separated string.
1850 * @param array $user The original user array.
1851 * @param array $userdata The updated user array.
1854 $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata );
1856 $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] );
1857 $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] );
1858 $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] );
1859 $pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] );
1860 $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] );
1862 wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] );
1865 if ( ! empty( $send_email_change_email ) ) {
1866 /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1867 $email_change_text = __( 'Hi ###USERNAME###,
1869 This notice confirms that your email was changed on ###SITENAME###.
1871 If you did not change your email, please contact the Site Administrator at
1874 This email has been sent to ###EMAIL###
1877 All at ###SITENAME###
1880 $email_change_email = array(
1881 'to' => $user['user_email'],
1882 /* translators: User email change notification email subject. 1: Site name */
1883 'subject' => __( '[%s] Notice of Email Change' ),
1884 'message' => $email_change_text,
1889 * Filters the contents of the email sent when the user's email is changed.
1893 * @param array $email_change_email {
1894 * Used to build wp_mail().
1895 * @type string $to The intended recipients.
1896 * @type string $subject The subject of the email.
1897 * @type string $message The content of the email.
1898 * The following strings have a special meaning and will get replaced dynamically:
1899 * - ###USERNAME### The current user's username.
1900 * - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1901 * - ###EMAIL### The old email.
1902 * - ###SITENAME### The name of the site.
1903 * - ###SITEURL### The URL to the site.
1904 * @type string $headers Headers.
1906 * @param array $user The original user array.
1907 * @param array $userdata The updated user array.
1909 $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata );
1911 $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] );
1912 $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] );
1913 $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] );
1914 $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] );
1915 $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );
1917 wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] );
1920 if ( $switched_locale ) {
1921 restore_previous_locale();
1925 // Update the cookies if the password changed.
1926 $current_user = wp_get_current_user();
1927 if ( $current_user->ID == $ID ) {
1928 if ( isset($plaintext_pass) ) {
1929 wp_clear_auth_cookie();
1931 // Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
1932 // If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
1933 $logged_in_cookie = wp_parse_auth_cookie( '', 'logged_in' );
1934 /** This filter is documented in wp-includes/pluggable.php */
1935 $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false );
1936 $remember = ( ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life );
1938 wp_set_auth_cookie( $ID, $remember );
1946 * A simpler way of inserting a user into the database.
1948 * Creates a new user with just the username, password, and email. For more
1949 * complex user creation use wp_insert_user() to specify more information.
1952 * @see wp_insert_user() More complete way to create a new user
1954 * @param string $username The user's username.
1955 * @param string $password The user's password.
1956 * @param string $email Optional. The user's email. Default empty.
1957 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1960 function wp_create_user($username, $password, $email = '') {
1961 $user_login = wp_slash( $username );
1962 $user_email = wp_slash( $email );
1963 $user_pass = $password;
1965 $userdata = compact('user_login', 'user_email', 'user_pass');
1966 return wp_insert_user($userdata);
1970 * Returns a list of meta keys to be (maybe) populated in wp_update_user().
1972 * The list of keys returned via this function are dependent on the presence
1973 * of those keys in the user meta data to be set.
1978 * @param WP_User $user WP_User instance.
1979 * @return array List of user keys to be populated in wp_update_user().
1981 function _get_additional_user_keys( $user ) {
1982 $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front', 'locale' );
1983 return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
1987 * Set up the user contact methods.
1989 * Default contact methods were removed in 3.6. A filter dictates contact methods.
1993 * @param WP_User $user Optional. WP_User object.
1994 * @return array Array of contact methods and their labels.
1996 function wp_get_user_contact_methods( $user = null ) {
1998 if ( get_site_option( 'initial_db_version' ) < 23588 ) {
2000 'aim' => __( 'AIM' ),
2001 'yim' => __( 'Yahoo IM' ),
2002 'jabber' => __( 'Jabber / Google Talk' )
2007 * Filters the user contact methods.
2011 * @param array $methods Array of contact methods and their labels.
2012 * @param WP_User $user WP_User object.
2014 return apply_filters( 'user_contactmethods', $methods, $user );
2018 * The old private function for setting up user contact methods.
2020 * Use wp_get_user_contact_methods() instead.
2025 * @param WP_User $user Optional. WP_User object. Default null.
2026 * @return array Array of contact methods and their labels.
2028 function _wp_get_user_contactmethods( $user = null ) {
2029 return wp_get_user_contact_methods( $user );
2033 * Gets the text suggesting how to create strong passwords.
2037 * @return string The password hint text.
2039 function wp_get_password_hint() {
2040 $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 ! " ? $ % ^ & ).' );
2043 * Filters the text describing the site's password complexity policy.
2047 * @param string $hint The password hint text.
2049 return apply_filters( 'password_hint', $hint );
2053 * Creates, stores, then returns a password reset key for user.
2057 * @global wpdb $wpdb WordPress database abstraction object.
2058 * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
2060 * @param WP_User $user User to retrieve password reset key for.
2062 * @return string|WP_Error Password reset key on success. WP_Error on error.
2064 function get_password_reset_key( $user ) {
2065 global $wpdb, $wp_hasher;
2068 * Fires before a new password is retrieved.
2070 * Use the {@see 'retrieve_password'} hook instead.
2073 * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
2075 * @param string $user_login The user login name.
2077 do_action( 'retreive_password', $user->user_login );
2080 * Fires before a new password is retrieved.
2084 * @param string $user_login The user login name.
2086 do_action( 'retrieve_password', $user->user_login );
2089 if ( is_multisite() && is_user_spammy( $user ) ) {
2094 * Filters whether to allow a password to be reset.
2098 * @param bool $allow Whether to allow the password to be reset. Default true.
2099 * @param int $user_data->ID The ID of the user attempting to reset a password.
2101 $allow = apply_filters( 'allow_password_reset', $allow, $user->ID );
2104 return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );
2105 } elseif ( is_wp_error( $allow ) ) {
2109 // Generate something random for a password reset key.
2110 $key = wp_generate_password( 20, false );
2113 * Fires when a password reset key is generated.
2117 * @param string $user_login The username for the user.
2118 * @param string $key The generated password reset key.
2120 do_action( 'retrieve_password_key', $user->user_login, $key );
2122 // Now insert the key, hashed, into the DB.
2123 if ( empty( $wp_hasher ) ) {
2124 $wp_hasher = new PasswordHash( 8, true );
2126 $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
2127 $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
2128 if ( false === $key_saved ) {
2129 return new WP_Error( 'no_password_key_update', __( 'Could not save password reset key to database.' ) );
2136 * Retrieves a user row based on password reset key and login
2138 * A key is considered 'expired' if it exactly matches the value of the
2139 * user_activation_key field, rather than being matched after going through the
2140 * hashing process. This field is now hashed; old values are no longer accepted
2141 * but have a different WP_Error code so good user feedback can be provided.
2145 * @global wpdb $wpdb WordPress database object for queries.
2146 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
2148 * @param string $key Hash to validate sending user's password.
2149 * @param string $login The user login.
2150 * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
2152 function check_password_reset_key($key, $login) {
2153 global $wpdb, $wp_hasher;
2155 $key = preg_replace('/[^a-z0-9]/i', '', $key);
2157 if ( empty( $key ) || !is_string( $key ) )
2158 return new WP_Error('invalid_key', __('Invalid key'));
2160 if ( empty($login) || !is_string($login) )
2161 return new WP_Error('invalid_key', __('Invalid key'));
2163 $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
2165 return new WP_Error('invalid_key', __('Invalid key'));
2167 if ( empty( $wp_hasher ) ) {
2168 $wp_hasher = new PasswordHash( 8, true );
2172 * Filters the expiration time of password reset keys.
2176 * @param int $expiration The expiration time in seconds.
2178 $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS );
2180 if ( false !== strpos( $row->user_activation_key, ':' ) ) {
2181 list( $pass_request_time, $pass_key ) = explode( ':', $row->user_activation_key, 2 );
2182 $expiration_time = $pass_request_time + $expiration_duration;
2184 $pass_key = $row->user_activation_key;
2185 $expiration_time = false;
2188 if ( ! $pass_key ) {
2189 return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2192 $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key );
2194 if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) {
2195 return get_userdata( $row->ID );
2196 } elseif ( $hash_is_correct && $expiration_time ) {
2197 // Key has an expiration time that's passed
2198 return new WP_Error( 'expired_key', __( 'Invalid key' ) );
2201 if ( hash_equals( $row->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) {
2202 $return = new WP_Error( 'expired_key', __( 'Invalid key' ) );
2203 $user_id = $row->ID;
2206 * Filters the return value of check_password_reset_key() when an
2207 * old-style key is used.
2209 * @since 3.7.0 Previously plain-text keys were stored in the database.
2210 * @since 4.3.0 Previously key hashes were stored without an expiration time.
2212 * @param WP_Error $return A WP_Error object denoting an expired key.
2213 * Return a WP_User object to validate the key.
2214 * @param int $user_id The matched user ID.
2216 return apply_filters( 'password_reset_key_expired', $return, $user_id );
2219 return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2223 * Handles resetting the user's password.
2227 * @param object $user The user
2228 * @param string $new_pass New password for the user in plaintext
2230 function reset_password( $user, $new_pass ) {
2232 * Fires before the user's password is reset.
2236 * @param object $user The user.
2237 * @param string $new_pass New user password.
2239 do_action( 'password_reset', $user, $new_pass );
2241 wp_set_password( $new_pass, $user->ID );
2242 update_user_option( $user->ID, 'default_password_nag', false, true );
2245 * Fires after the user's password is reset.
2249 * @param object $user The user.
2250 * @param string $new_pass New user password.
2252 do_action( 'after_password_reset', $user, $new_pass );
2256 * Handles registering a new user.
2260 * @param string $user_login User's username for logging in
2261 * @param string $user_email User's email address to send password and add
2262 * @return int|WP_Error Either user's ID or error on failure.
2264 function register_new_user( $user_login, $user_email ) {
2265 $errors = new WP_Error();
2267 $sanitized_user_login = sanitize_user( $user_login );
2269 * Filters the email address of a user being registered.
2273 * @param string $user_email The email address of the new user.
2275 $user_email = apply_filters( 'user_registration_email', $user_email );
2277 // Check the username
2278 if ( $sanitized_user_login == '' ) {
2279 $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
2280 } elseif ( ! validate_username( $user_login ) ) {
2281 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) );
2282 $sanitized_user_login = '';
2283 } elseif ( username_exists( $sanitized_user_login ) ) {
2284 $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) );
2287 /** This filter is documented in wp-includes/user.php */
2288 $illegal_user_logins = array_map( 'strtolower', (array) apply_filters( 'illegal_user_logins', array() ) );
2289 if ( in_array( strtolower( $sanitized_user_login ), $illegal_user_logins ) ) {
2290 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
2294 // Check the email address
2295 if ( $user_email == '' ) {
2296 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) );
2297 } elseif ( ! is_email( $user_email ) ) {
2298 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn’t correct.' ) );
2300 } elseif ( email_exists( $user_email ) ) {
2301 $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
2305 * Fires when submitting registration form data, before the user is created.
2309 * @param string $sanitized_user_login The submitted username after being sanitized.
2310 * @param string $user_email The submitted email.
2311 * @param WP_Error $errors Contains any errors with submitted username and email,
2312 * e.g., an empty field, an invalid username or email,
2313 * or an existing username or email.
2315 do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
2318 * Filters the errors encountered when a new user is being registered.
2320 * The filtered WP_Error object may, for example, contain errors for an invalid
2321 * or existing username or email address. A WP_Error object should always returned,
2322 * but may or may not contain errors.
2324 * If any errors are present in $errors, this will abort the user's registration.
2328 * @param WP_Error $errors A WP_Error object containing any errors encountered
2329 * during registration.
2330 * @param string $sanitized_user_login User's username after it has been sanitized.
2331 * @param string $user_email User's email.
2333 $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
2335 if ( $errors->get_error_code() )
2338 $user_pass = wp_generate_password( 12, false );
2339 $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email );
2340 if ( ! $user_id || is_wp_error( $user_id ) ) {
2341 $errors->add( 'registerfail', sprintf( __( '<strong>ERROR</strong>: Couldn’t register you… please contact the <a href="mailto:%s">webmaster</a> !' ), get_option( 'admin_email' ) ) );
2345 update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
2348 * Fires after a new user registration has been recorded.
2352 * @param int $user_id ID of the newly registered user.
2354 do_action( 'register_new_user', $user_id );
2360 * Initiates email notifications related to the creation of new users.
2362 * Notifications are sent both to the site admin and to the newly created user.
2365 * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending
2366 * notifications only to the user created.
2368 * @param int $user_id ID of the newly created user.
2369 * @param string $notify Optional. Type of notification that should happen. Accepts 'admin'
2370 * or an empty string (admin only), 'user', or 'both' (admin and user).
2373 function wp_send_new_user_notifications( $user_id, $notify = 'both' ) {
2374 wp_new_user_notification( $user_id, null, $notify );
2378 * Retrieve the current session token from the logged_in cookie.
2382 * @return string Token.
2384 function wp_get_session_token() {
2385 $cookie = wp_parse_auth_cookie( '', 'logged_in' );
2386 return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
2390 * Retrieve a list of sessions for the current user.
2393 * @return array Array of sessions.
2395 function wp_get_all_sessions() {
2396 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2397 return $manager->get_all();
2401 * Remove the current session token from the database.
2405 function wp_destroy_current_session() {
2406 $token = wp_get_session_token();
2408 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2409 $manager->destroy( $token );
2414 * Remove all but the current session token for the current user for the database.
2418 function wp_destroy_other_sessions() {
2419 $token = wp_get_session_token();
2421 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2422 $manager->destroy_others( $token );
2427 * Remove all session tokens for the current user from the database.
2431 function wp_destroy_all_sessions() {
2432 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2433 $manager->destroy_all();
2437 * Get the user IDs of all users with no role on this site.
2439 * This function returns an empty array when used on Multisite.
2443 * @return array Array of user IDs.
2445 function wp_get_users_with_no_role() {
2448 if ( is_multisite() ) {
2452 $prefix = $wpdb->get_blog_prefix();
2453 $regex = implode( '|', array_keys( wp_roles()->get_names() ) );
2454 $regex = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex );
2455 $users = $wpdb->get_col( $wpdb->prepare( "
2457 FROM $wpdb->usermeta
2458 WHERE meta_key = '{$prefix}capabilities'
2459 AND meta_value NOT REGEXP %s
2466 * Retrieves the current user object.
2468 * Will set the current user, if the current user is not set. The current user
2469 * will be set to the logged-in person. If no user is logged-in, then it will
2470 * set the current user to 0, which is invalid and won't have any permissions.
2472 * This function is used by the pluggable functions wp_get_current_user() and
2473 * get_currentuserinfo(), the latter of which is deprecated but used for backward
2479 * @see wp_get_current_user()
2480 * @global WP_User $current_user Checks if the current user is set.
2482 * @return WP_User Current WP_User instance.
2484 function _wp_get_current_user() {
2485 global $current_user;
2487 if ( ! empty( $current_user ) ) {
2488 if ( $current_user instanceof WP_User ) {
2489 return $current_user;
2492 // Upgrade stdClass to WP_User
2493 if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
2494 $cur_id = $current_user->ID;
2495 $current_user = null;
2496 wp_set_current_user( $cur_id );
2497 return $current_user;
2500 // $current_user has a junk value. Force to WP_User with ID 0.
2501 $current_user = null;
2502 wp_set_current_user( 0 );
2503 return $current_user;
2506 if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) {
2507 wp_set_current_user( 0 );
2508 return $current_user;
2512 * Filters the current user.
2514 * The default filters use this to determine the current user from the
2515 * request's cookies, if available.
2517 * Returning a value of false will effectively short-circuit setting
2522 * @param int|bool $user_id User ID if one has been determined, false otherwise.
2524 $user_id = apply_filters( 'determine_current_user', false );
2526 wp_set_current_user( 0 );
2527 return $current_user;
2530 wp_set_current_user( $user_id );
2532 return $current_user;