10 * Authenticate user 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 if ( ! empty($_POST['log']) )
31 $credentials['user_login'] = $_POST['log'];
32 if ( ! empty($_POST['pwd']) )
33 $credentials['user_password'] = $_POST['pwd'];
34 if ( ! empty($_POST['rememberme']) )
35 $credentials['remember'] = $_POST['rememberme'];
38 if ( !empty($credentials['remember']) )
39 $credentials['remember'] = true;
41 $credentials['remember'] = false;
44 * Fires before the user is authenticated.
46 * The variables passed to the callbacks are passed by reference,
47 * and can be modified by callback functions.
51 * @todo Decide whether to deprecate the wp_authenticate action.
53 * @param string $user_login Username, passed by reference.
54 * @param string $user_password User password, passed by reference.
56 do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
58 if ( '' === $secure_cookie )
59 $secure_cookie = is_ssl();
62 * Filter whether to use a secure sign-on cookie.
66 * @param bool $secure_cookie Whether to use a secure sign-on cookie.
67 * @param array $credentials {
68 * Array of entered sign-on data.
70 * @type string $user_login Username.
71 * @type string $user_password Password entered.
72 * @type bool $remember Whether to 'remember' the user. Increases the time
73 * that the cookie will be kept. Default false.
76 $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );
78 global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
79 $auth_secure_cookie = $secure_cookie;
81 add_filter('authenticate', 'wp_authenticate_cookie', 30, 3);
83 $user = wp_authenticate($credentials['user_login'], $credentials['user_password']);
85 if ( is_wp_error($user) ) {
86 if ( $user->get_error_codes() == array('empty_username', 'empty_password') ) {
87 $user = new WP_Error('', '');
93 wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie);
95 * Fires after the user has successfully logged in.
99 * @param string $user_login Username.
100 * @param WP_User $user WP_User object of the logged-in user.
102 do_action( 'wp_login', $user->user_login, $user );
107 * Authenticate the user using the username and password.
111 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
112 * @param string $username Username for authentication.
113 * @param string $password Password for authentication.
114 * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
116 function wp_authenticate_username_password($user, $username, $password) {
117 if ( $user instanceof WP_User ) {
121 if ( empty($username) || empty($password) ) {
122 if ( is_wp_error( $user ) )
125 $error = new WP_Error();
127 if ( empty($username) )
128 $error->add('empty_username', __('<strong>ERROR</strong>: The username field is empty.'));
130 if ( empty($password) )
131 $error->add('empty_password', __('<strong>ERROR</strong>: The password field is empty.'));
136 $user = get_user_by('login', $username);
139 return new WP_Error( 'invalid_username',
140 __( '<strong>ERROR</strong>: Invalid username.' ) .
141 ' <a href="' . wp_lostpassword_url() . '">' .
142 __( 'Lost your password?' ) .
148 * Filter whether the given user can be authenticated with the provided $password.
152 * @param WP_User|WP_Error $user WP_User or WP_Error object if a previous
153 * callback failed authentication.
154 * @param string $password Password to check against the user.
156 $user = apply_filters( 'wp_authenticate_user', $user, $password );
157 if ( is_wp_error($user) )
160 if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
161 return new WP_Error( 'incorrect_password',
163 /* translators: %s: user name */
164 __( '<strong>ERROR</strong>: The password you entered for the username %s is incorrect.' ),
165 '<strong>' . $username . '</strong>'
167 ' <a href="' . wp_lostpassword_url() . '">' .
168 __( 'Lost your password?' ) .
177 * Authenticate the user using the WordPress auth cookie.
181 * @global string $auth_secure_cookie
183 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
184 * @param string $username Username. If not empty, cancels the cookie authentication.
185 * @param string $password Password. If not empty, cancels the cookie authentication.
186 * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
188 function wp_authenticate_cookie($user, $username, $password) {
189 if ( $user instanceof WP_User ) {
193 if ( empty($username) && empty($password) ) {
194 $user_id = wp_validate_auth_cookie();
196 return new WP_User($user_id);
198 global $auth_secure_cookie;
200 if ( $auth_secure_cookie )
201 $auth_cookie = SECURE_AUTH_COOKIE;
203 $auth_cookie = AUTH_COOKIE;
205 if ( !empty($_COOKIE[$auth_cookie]) )
206 return new WP_Error('expired_session', __('Please log in again.'));
208 // If the cookie is not set, be silent.
215 * For Multisite blogs, check if the authenticated user has been marked as a
216 * spammer, or if the user's primary blog has been marked as spam.
220 * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
221 * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer.
223 function wp_authenticate_spam_check( $user ) {
224 if ( $user instanceof WP_User && is_multisite() ) {
226 * Filter whether the user has been marked as a spammer.
230 * @param bool $spammed Whether the user is considered a spammer.
231 * @param WP_User $user User to check against.
233 $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy(), $user );
236 return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) );
242 * Validate the logged-in cookie.
244 * Checks the logged-in cookie if the previous auth cookie could not be
245 * validated and parsed.
247 * This is a callback for the determine_current_user filter, rather than API.
251 * @param int|bool $user_id The user ID (or false) as received from the
252 * determine_current_user filter.
253 * @return int|false User ID if validated, false otherwise. If a user ID from
254 * an earlier filter callback is received, that value is returned.
256 function wp_validate_logged_in_cookie( $user_id ) {
261 if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) ) {
265 return wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' );
269 * Number of posts user has written.
272 * @since 4.1.0 Added `$post_type` argument.
273 * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array
274 * of post types to `$post_type`.
276 * @global wpdb $wpdb WordPress database abstraction object.
278 * @param int $userid User ID.
279 * @param array|string $post_type Optional. Single post type or array of post types to count the number of posts for. Default 'post'.
280 * @param bool $public_only Optional. Whether to only return counts for public posts. Default false.
281 * @return int Number of posts the user has written in this post type.
283 function count_user_posts( $userid, $post_type = 'post', $public_only = false ) {
286 $where = get_posts_by_author_sql( $post_type, true, $userid, $public_only );
288 $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
291 * Filter the number of posts a user has written.
294 * @since 4.1.0 Added `$post_type` argument.
295 * @since 4.3.1 Added `$public_only` argument.
297 * @param int $count The user's post count.
298 * @param int $userid User ID.
299 * @param string|array $post_type Single post type or array of post types to count the number of posts for.
300 * @param bool $public_only Whether to limit counted posts to public posts.
302 return apply_filters( 'get_usernumposts', $count, $userid, $post_type, $public_only );
306 * Number of posts written by a list of users.
310 * @global wpdb $wpdb WordPress database abstraction object.
312 * @param array $users Array of user IDs.
313 * @param string|array $post_type Optional. Single post type or array of post types to check. Defaults to 'post'.
314 * @param bool $public_only Optional. Only return counts for public posts. Defaults to false.
315 * @return array Amount of posts each user has written.
317 function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) {
321 if ( empty( $users ) || ! is_array( $users ) )
324 $userlist = implode( ',', array_map( 'absint', $users ) );
325 $where = get_posts_by_author_sql( $post_type, true, null, $public_only );
327 $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N );
328 foreach ( $result as $row ) {
329 $count[ $row[0] ] = $row[1];
332 foreach ( $users as $id ) {
333 if ( ! isset( $count[ $id ] ) )
341 // User option functions
345 * Get the current user's ID
349 * @return int The current user's ID
351 function get_current_user_id() {
352 if ( ! function_exists( 'wp_get_current_user' ) )
354 $user = wp_get_current_user();
355 return ( isset( $user->ID ) ? (int) $user->ID : 0 );
359 * Retrieve user option that can be either per Site or per Network.
361 * If the user ID is not given, then the current user will be used instead. If
362 * the user ID is given, then the user data will be retrieved. The filter for
363 * the result, will also pass the original option name and finally the user data
364 * object as the third parameter.
366 * The option will first check for the per site name and then the per Network name.
370 * @global wpdb $wpdb WordPress database abstraction object.
372 * @param string $option User option name.
373 * @param int $user Optional. User ID.
374 * @param string $deprecated Use get_option() to check for an option in the options table.
375 * @return mixed User option value on success, false on failure.
377 function get_user_option( $option, $user = 0, $deprecated = '' ) {
380 if ( !empty( $deprecated ) )
381 _deprecated_argument( __FUNCTION__, '3.0' );
383 if ( empty( $user ) )
384 $user = get_current_user_id();
386 if ( ! $user = get_userdata( $user ) )
389 $prefix = $wpdb->get_blog_prefix();
390 if ( $user->has_prop( $prefix . $option ) ) // Blog specific
391 $result = $user->get( $prefix . $option );
392 elseif ( $user->has_prop( $option ) ) // User specific and cross-blog
393 $result = $user->get( $option );
398 * Filter a specific user option value.
400 * The dynamic portion of the hook name, `$option`, refers to the user option name.
404 * @param mixed $result Value for the user's option.
405 * @param string $option Name of the option being retrieved.
406 * @param WP_User $user WP_User object of the user whose option is being retrieved.
408 return apply_filters( "get_user_option_{$option}", $result, $option, $user );
412 * Update user option with global blog capability.
414 * User options are just like user metadata except that they have support for
415 * global blog options. If the 'global' parameter is false, which it is by default
416 * it will prepend the WordPress table prefix to the option name.
418 * Deletes the user option if $newvalue is empty.
422 * @global wpdb $wpdb WordPress database abstraction object.
424 * @param int $user_id User ID.
425 * @param string $option_name User option name.
426 * @param mixed $newvalue User option value.
427 * @param bool $global Optional. Whether option name is global or blog specific.
428 * Default false (blog specific).
429 * @return int|bool User meta ID if the option didn't exist, true on successful update,
432 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
436 $option_name = $wpdb->get_blog_prefix() . $option_name;
438 return update_user_meta( $user_id, $option_name, $newvalue );
442 * Delete user option with global blog capability.
444 * User options are just like user metadata except that they have support for
445 * global blog options. If the 'global' parameter is false, which it is by default
446 * it will prepend the WordPress table prefix to the option name.
450 * @global wpdb $wpdb WordPress database abstraction object.
452 * @param int $user_id User ID
453 * @param string $option_name User option name.
454 * @param bool $global Optional. Whether option name is global or blog specific.
455 * Default false (blog specific).
456 * @return bool True on success, false on failure.
458 function delete_user_option( $user_id, $option_name, $global = false ) {
462 $option_name = $wpdb->get_blog_prefix() . $option_name;
463 return delete_user_meta( $user_id, $option_name );
467 * Retrieve list of users matching criteria.
473 * @param array $args Optional. Arguments to retrieve users. See {@see WP_User_Query::prepare_query()}
474 * for more information on accepted arguments.
475 * @return array List of users.
477 function get_users( $args = array() ) {
479 $args = wp_parse_args( $args );
480 $args['count_total'] = false;
482 $user_search = new WP_User_Query($args);
484 return (array) $user_search->get_results();
488 * Get the blogs a user belongs to.
492 * @global wpdb $wpdb WordPress database abstraction object.
494 * @param int $user_id User ID
495 * @param bool $all Whether to retrieve all blogs, or only blogs that are not
496 * marked as deleted, archived, or spam.
497 * @return array A list of the user's blogs. An empty array if the user doesn't exist
498 * or belongs to no blogs.
500 function get_blogs_of_user( $user_id, $all = false ) {
503 $user_id = (int) $user_id;
505 // Logged out users can't have blogs
506 if ( empty( $user_id ) )
509 $keys = get_user_meta( $user_id );
510 if ( empty( $keys ) )
513 if ( ! is_multisite() ) {
514 $blog_id = get_current_blog_id();
515 $blogs = array( $blog_id => new stdClass );
516 $blogs[ $blog_id ]->userblog_id = $blog_id;
517 $blogs[ $blog_id ]->blogname = get_option('blogname');
518 $blogs[ $blog_id ]->domain = '';
519 $blogs[ $blog_id ]->path = '';
520 $blogs[ $blog_id ]->site_id = 1;
521 $blogs[ $blog_id ]->siteurl = get_option('siteurl');
522 $blogs[ $blog_id ]->archived = 0;
523 $blogs[ $blog_id ]->spam = 0;
524 $blogs[ $blog_id ]->deleted = 0;
530 if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
531 $blog = get_blog_details( 1 );
532 if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
533 $blogs[ 1 ] = (object) array(
535 'blogname' => $blog->blogname,
536 'domain' => $blog->domain,
537 'path' => $blog->path,
538 'site_id' => $blog->site_id,
539 'siteurl' => $blog->siteurl,
540 'archived' => $blog->archived,
541 'mature' => $blog->mature,
542 'spam' => $blog->spam,
543 'deleted' => $blog->deleted,
546 unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
549 $keys = array_keys( $keys );
551 foreach ( $keys as $key ) {
552 if ( 'capabilities' !== substr( $key, -12 ) )
554 if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) )
556 $blog_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
557 if ( ! is_numeric( $blog_id ) )
560 $blog_id = (int) $blog_id;
561 $blog = get_blog_details( $blog_id );
562 if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
563 $blogs[ $blog_id ] = (object) array(
564 'userblog_id' => $blog_id,
565 'blogname' => $blog->blogname,
566 'domain' => $blog->domain,
567 'path' => $blog->path,
568 'site_id' => $blog->site_id,
569 'siteurl' => $blog->siteurl,
570 'archived' => $blog->archived,
571 'mature' => $blog->mature,
572 'spam' => $blog->spam,
573 'deleted' => $blog->deleted,
579 * Filter the list of blogs a user belongs to.
583 * @param array $blogs An array of blog objects belonging to the user.
584 * @param int $user_id User ID.
585 * @param bool $all Whether the returned blogs array should contain all blogs, including
586 * those marked 'deleted', 'archived', or 'spam'. Default false.
588 return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all );
592 * Find out whether a user is a member of a given blog.
596 * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
597 * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
600 function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
603 $user_id = (int) $user_id;
604 $blog_id = (int) $blog_id;
606 if ( empty( $user_id ) ) {
607 $user_id = get_current_user_id();
610 // Technically not needed, but does save calls to get_blog_details and get_user_meta
611 // in the event that the function is called when a user isn't logged in
612 if ( empty( $user_id ) ) {
615 $user = get_userdata( $user_id );
616 if ( ! $user instanceof WP_User ) {
621 if ( ! is_multisite() ) {
625 if ( empty( $blog_id ) ) {
626 $blog_id = get_current_blog_id();
629 $blog = get_blog_details( $blog_id );
631 if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) {
635 $keys = get_user_meta( $user_id );
636 if ( empty( $keys ) ) {
640 // no underscore before capabilities in $base_capabilities_key
641 $base_capabilities_key = $wpdb->base_prefix . 'capabilities';
642 $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
644 if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) {
648 if ( isset( $keys[ $site_capabilities_key ] ) ) {
656 * Add meta data field to a user.
658 * Post meta data is called "Custom Fields" on the Administration Screens.
661 * @link https://codex.wordpress.org/Function_Reference/add_user_meta
663 * @param int $user_id User ID.
664 * @param string $meta_key Metadata name.
665 * @param mixed $meta_value Metadata value.
666 * @param bool $unique Optional, default is false. Whether the same key should not be added.
667 * @return int|false Meta ID on success, false on failure.
669 function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
670 return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
674 * Remove metadata matching criteria from a user.
676 * You can match based on the key, or key and value. Removing based on key and
677 * value, will keep from removing duplicate metadata with the same key. It also
678 * allows removing all metadata matching key, if needed.
681 * @link https://codex.wordpress.org/Function_Reference/delete_user_meta
683 * @param int $user_id User ID
684 * @param string $meta_key Metadata name.
685 * @param mixed $meta_value Optional. Metadata value.
686 * @return bool True on success, false on failure.
688 function delete_user_meta($user_id, $meta_key, $meta_value = '') {
689 return delete_metadata('user', $user_id, $meta_key, $meta_value);
693 * Retrieve user meta field for a user.
696 * @link https://codex.wordpress.org/Function_Reference/get_user_meta
698 * @param int $user_id User ID.
699 * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
700 * @param bool $single Whether to return a single value.
701 * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
703 function get_user_meta($user_id, $key = '', $single = false) {
704 return get_metadata('user', $user_id, $key, $single);
708 * Update user meta field based on user ID.
710 * Use the $prev_value parameter to differentiate between meta fields with the
711 * same key and user ID.
713 * If the meta field for the user does not exist, it will be added.
716 * @link https://codex.wordpress.org/Function_Reference/update_user_meta
718 * @param int $user_id User ID.
719 * @param string $meta_key Metadata key.
720 * @param mixed $meta_value Metadata value.
721 * @param mixed $prev_value Optional. Previous value to check before removing.
722 * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
724 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
725 return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
729 * Count number of users who have each of the user roles.
731 * Assumes there are neither duplicated nor orphaned capabilities meta_values.
732 * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query()
733 * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
734 * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
737 * @since 4.4.0 The number of users with no role is now included in the `none` element.
739 * @global wpdb $wpdb WordPress database abstraction object.
741 * @param string $strategy 'time' or 'memory'
742 * @return array Includes a grand total and an array of counts indexed by role strings.
744 function count_users($strategy = 'time') {
748 $id = get_current_blog_id();
749 $blog_prefix = $wpdb->get_blog_prefix($id);
752 if ( 'time' == $strategy ) {
753 $avail_roles = wp_roles()->get_names();
755 // Build a CPU-intensive query that will return concise information.
756 $select_count = array();
757 foreach ( $avail_roles as $this_role => $name ) {
758 $select_count[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%');
760 $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))";
761 $select_count = implode(', ', $select_count);
763 // Add the meta_value index to the selection list, then run the query.
764 $row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
766 // Run the previous loop again to associate results with role names.
768 $role_counts = array();
769 foreach ( $avail_roles as $this_role => $name ) {
770 $count = (int) $row[$col++];
772 $role_counts[$this_role] = $count;
776 $role_counts['none'] = (int) $row[$col++];
778 // Get the meta_value index from the end of the result set.
779 $total_users = (int) $row[$col];
781 $result['total_users'] = $total_users;
782 $result['avail_roles'] =& $role_counts;
784 $avail_roles = array(
788 $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" );
790 foreach ( $users_of_blog as $caps_meta ) {
791 $b_roles = maybe_unserialize($caps_meta);
792 if ( ! is_array( $b_roles ) )
794 if ( empty( $b_roles ) ) {
795 $avail_roles['none']++;
797 foreach ( $b_roles as $b_role => $val ) {
798 if ( isset($avail_roles[$b_role]) ) {
799 $avail_roles[$b_role]++;
801 $avail_roles[$b_role] = 1;
806 $result['total_users'] = count( $users_of_blog );
807 $result['avail_roles'] =& $avail_roles;
810 if ( is_multisite() ) {
811 $result['avail_roles']['none'] = 0;
818 // Private helper functions
822 * Set up global user vars.
824 * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
828 * @global string $user_login The user username for logging in
829 * @global object $userdata User data.
830 * @global int $user_level The level of the user
831 * @global int $user_ID The ID of the user
832 * @global string $user_email The email address of the user
833 * @global string $user_url The url in the user's profile
834 * @global string $user_identity The display name of the user
836 * @param int $for_user_id Optional. User ID to set up global data.
838 function setup_userdata($for_user_id = '') {
839 global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity;
841 if ( '' == $for_user_id )
842 $for_user_id = get_current_user_id();
843 $user = get_userdata( $for_user_id );
849 $user_login = $user_email = $user_url = $user_identity = '';
853 $user_ID = (int) $user->ID;
854 $user_level = (int) $user->user_level;
856 $user_login = $user->user_login;
857 $user_email = $user->user_email;
858 $user_url = $user->user_url;
859 $user_identity = $user->display_name;
863 * Create dropdown HTML content of users.
865 * The content can either be displayed, which it is by default or retrieved by
866 * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
867 * need to be used; all users will be displayed in that case. Only one can be
868 * used, either 'include' or 'exclude', but not both.
870 * The available arguments are as follows:
874 * @global int $blog_id
876 * @param array|string $args {
877 * Optional. Array or string of arguments to generate a drop-down of users.
878 * {@see WP_User_Query::prepare_query() for additional available arguments.
880 * @type string $show_option_all Text to show as the drop-down default (all).
882 * @type string $show_option_none Text to show as the drop-down default when no
883 * users were found. Default empty.
884 * @type int|string $option_none_value Value to use for $show_option_non when no users
885 * were found. Default -1.
886 * @type string $hide_if_only_one_author Whether to skip generating the drop-down
887 * if only one user was found. Default empty.
888 * @type string $orderby Field to order found users by. Accepts user fields.
889 * Default 'display_name'.
890 * @type string $order Whether to order users in ascending or descending
891 * order. Accepts 'ASC' (ascending) or 'DESC' (descending).
893 * @type array|string $include Array or comma-separated list of user IDs to include.
895 * @type array|string $exclude Array or comma-separated list of user IDs to exclude.
897 * @type bool|int $multi Whether to skip the ID attribute on the 'select' element.
898 * Accepts 1|true or 0|false. Default 0|false.
899 * @type string $show User table column to display. If the selected item is empty
900 * then the 'user_login' will be displayed in parentheses.
901 * Accepts user fields. Default 'display_name'.
902 * @type int|bool $echo Whether to echo or return the drop-down. Accepts 1|true (echo)
903 * or 0|false (return). Default 1|true.
904 * @type int $selected Which user ID should be selected. Default 0.
905 * @type bool $include_selected Whether to always include the selected user ID in the drop-
906 * down. Default false.
907 * @type string $name Name attribute of select element. Default 'user'.
908 * @type string $id ID attribute of the select element. Default is the value of $name.
909 * @type string $class Class attribute of the select element. Default empty.
910 * @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog.
911 * @type string $who Which type of users to query. Accepts only an empty string or
912 * 'authors'. Default empty.
914 * @return string String of HTML content.
916 function wp_dropdown_users( $args = '' ) {
918 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
919 'orderby' => 'display_name', 'order' => 'ASC',
920 'include' => '', 'exclude' => '', 'multi' => 0,
921 'show' => 'display_name', 'echo' => 1,
922 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
923 'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false,
924 'option_none_value' => -1
927 $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
929 $r = wp_parse_args( $args, $defaults );
931 $show_option_all = $r['show_option_all'];
932 $show_option_none = $r['show_option_none'];
933 $option_none_value = $r['option_none_value'];
935 $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
936 $query_args['fields'] = array( 'ID', 'user_login', $show );
939 * Filter the query arguments for the user drop-down.
943 * @param array $query_args The query arguments for wp_dropdown_users().
944 * @param array $r The default arguments for wp_dropdown_users().
946 $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $r );
948 $users = get_users( $query_args );
951 if ( ! empty( $users ) && ( empty( $r['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
952 $name = esc_attr( $r['name'] );
953 if ( $r['multi'] && ! $r['id'] ) {
956 $id = $r['id'] ? " id='" . esc_attr( $r['id'] ) . "'" : " id='$name'";
958 $output = "<select name='{$name}'{$id} class='" . $r['class'] . "'>\n";
960 if ( $show_option_all ) {
961 $output .= "\t<option value='0'>$show_option_all</option>\n";
964 if ( $show_option_none ) {
965 $_selected = selected( $option_none_value, $r['selected'], false );
966 $output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n";
969 $found_selected = false;
970 foreach ( (array) $users as $user ) {
971 $user->ID = (int) $user->ID;
972 $_selected = selected( $user->ID, $r['selected'], false );
974 $found_selected = true;
976 $display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')';
977 $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
980 if ( $r['include_selected'] && ! $found_selected && ( $r['selected'] > 0 ) ) {
981 $user = get_userdata( $r['selected'] );
982 $_selected = selected( $user->ID, $r['selected'], false );
983 $display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')';
984 $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
987 $output .= "</select>";
991 * Filter the wp_dropdown_users() HTML output.
995 * @param string $output HTML output generated by wp_dropdown_users().
997 $html = apply_filters( 'wp_dropdown_users', $output );
1006 * Sanitize user field based on context.
1008 * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1009 * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1010 * when calling filters.
1014 * @param string $field The user Object field name.
1015 * @param mixed $value The user Object value.
1016 * @param int $user_id User ID.
1017 * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
1018 * 'attribute' and 'js'.
1019 * @return mixed Sanitized value.
1021 function sanitize_user_field($field, $value, $user_id, $context) {
1022 $int_fields = array('ID');
1023 if ( in_array($field, $int_fields) )
1024 $value = (int) $value;
1026 if ( 'raw' == $context )
1029 if ( !is_string($value) && !is_numeric($value) )
1032 $prefixed = false !== strpos( $field, 'user_' );
1034 if ( 'edit' == $context ) {
1037 /** This filter is documented in wp-includes/post.php */
1038 $value = apply_filters( "edit_{$field}", $value, $user_id );
1042 * Filter a user field value in the 'edit' context.
1044 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1045 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1049 * @param mixed $value Value of the prefixed user field.
1050 * @param int $user_id User ID.
1052 $value = apply_filters( "edit_user_{$field}", $value, $user_id );
1055 if ( 'description' == $field )
1056 $value = esc_html( $value ); // textarea_escaped?
1058 $value = esc_attr($value);
1059 } elseif ( 'db' == $context ) {
1061 /** This filter is documented in wp-includes/post.php */
1062 $value = apply_filters( "pre_{$field}", $value );
1066 * Filter the value of a user field in the 'db' context.
1068 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1069 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1073 * @param mixed $value Value of the prefixed user field.
1075 $value = apply_filters( "pre_user_{$field}", $value );
1078 // Use display filters by default.
1081 /** This filter is documented in wp-includes/post.php */
1082 $value = apply_filters( $field, $value, $user_id, $context );
1086 * Filter the value of a user field in a standard context.
1088 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1089 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1093 * @param mixed $value The user object value to sanitize.
1094 * @param int $user_id User ID.
1095 * @param string $context The context to filter within.
1097 $value = apply_filters( "user_{$field}", $value, $user_id, $context );
1101 if ( 'user_url' == $field )
1102 $value = esc_url($value);
1104 if ( 'attribute' == $context ) {
1105 $value = esc_attr( $value );
1106 } elseif ( 'js' == $context ) {
1107 $value = esc_js( $value );
1113 * Update all user caches
1117 * @param object|WP_User $user User object to be cached
1118 * @return bool|null Returns false on failure.
1120 function update_user_caches( $user ) {
1121 if ( $user instanceof WP_User ) {
1122 if ( ! $user->exists() ) {
1126 $user = $user->data;
1129 wp_cache_add($user->ID, $user, 'users');
1130 wp_cache_add($user->user_login, $user->ID, 'userlogins');
1131 wp_cache_add($user->user_email, $user->ID, 'useremail');
1132 wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
1136 * Clean all user caches
1139 * @since 4.4.0 'clean_user_cache' action was added.
1141 * @param WP_User|int $user User object or ID to be cleaned from the cache
1143 function clean_user_cache( $user ) {
1144 if ( is_numeric( $user ) )
1145 $user = new WP_User( $user );
1147 if ( ! $user->exists() )
1150 wp_cache_delete( $user->ID, 'users' );
1151 wp_cache_delete( $user->user_login, 'userlogins' );
1152 wp_cache_delete( $user->user_email, 'useremail' );
1153 wp_cache_delete( $user->user_nicename, 'userslugs' );
1156 * Fires immediately after the given user's cache is cleaned.
1160 * @param int $user_id User ID.
1161 * @param WP_User $user User object.
1163 do_action( 'clean_user_cache', $user->ID, $user );
1167 * Checks whether the given username exists.
1171 * @param string $username Username.
1172 * @return int|false The user's ID on success, and false on failure.
1174 function username_exists( $username ) {
1175 if ( $user = get_user_by( 'login', $username ) ) {
1182 * Checks whether the given email exists.
1186 * @param string $email Email.
1187 * @return int|false The user's ID on success, and false on failure.
1189 function email_exists( $email ) {
1190 if ( $user = get_user_by( 'email', $email) ) {
1197 * Checks whether a username is valid.
1200 * @since 4.4.0 Empty sanitized usernames are now considered invalid
1202 * @param string $username Username.
1203 * @return bool Whether username given is valid
1205 function validate_username( $username ) {
1206 $sanitized = sanitize_user( $username, true );
1207 $valid = ( $sanitized == $username && ! empty( $sanitized ) );
1210 * Filter whether the provided username is valid or not.
1214 * @param bool $valid Whether given username is valid.
1215 * @param string $username Username to check.
1217 return apply_filters( 'validate_username', $valid, $username );
1221 * Insert a user into the database.
1223 * Most of the `$userdata` array fields have filters associated with the values. Exceptions are
1224 * 'ID', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl',
1225 * 'user_registered', and 'role'. The filters have the prefix 'pre_user_' followed by the field
1226 * name. An example using 'description' would have the filter called, 'pre_user_description' that
1227 * can be hooked into.
1230 * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact
1231 * methods for new installs. See wp_get_user_contact_methods().
1233 * @global wpdb $wpdb WordPress database abstraction object.
1235 * @param array|object|WP_User $userdata {
1236 * An array, object, or WP_User object of user data arguments.
1238 * @type int $ID User ID. If supplied, the user will be updated.
1239 * @type string $user_pass The plain-text user password.
1240 * @type string $user_login The user's login username.
1241 * @type string $user_nicename The URL-friendly user name.
1242 * @type string $user_url The user URL.
1243 * @type string $user_email The user email address.
1244 * @type string $display_name The user's display name.
1245 * Default is the the user's username.
1246 * @type string $nickname The user's nickname.
1247 * Default is the the user's username.
1248 * @type string $first_name The user's first name. For new users, will be used
1249 * to build the first part of the user's display name
1250 * if `$display_name` is not specified.
1251 * @type string $last_name The user's last name. For new users, will be used
1252 * to build the second part of the user's display name
1253 * if `$display_name` is not specified.
1254 * @type string $description The user's biographical description.
1255 * @type string|bool $rich_editing Whether to enable the rich-editor for the user.
1256 * False if not empty.
1257 * @type string|bool $comment_shortcuts Whether to enable comment moderation keyboard
1258 * shortcuts for the user. Default false.
1259 * @type string $admin_color Admin color scheme for the user. Default 'fresh'.
1260 * @type bool $use_ssl Whether the user should always access the admin over
1261 * https. Default false.
1262 * @type string $user_registered Date the user registered. Format is 'Y-m-d H:i:s'.
1263 * @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
1264 * site's frontend. Default true.
1265 * @type string $role User's role.
1267 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1270 function wp_insert_user( $userdata ) {
1273 if ( $userdata instanceof stdClass ) {
1274 $userdata = get_object_vars( $userdata );
1275 } elseif ( $userdata instanceof WP_User ) {
1276 $userdata = $userdata->to_array();
1279 // Are we updating or creating?
1280 if ( ! empty( $userdata['ID'] ) ) {
1281 $ID = (int) $userdata['ID'];
1283 $old_user_data = get_userdata( $ID );
1285 if ( ! $old_user_data ) {
1286 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1289 // hashed in wp_update_user(), plaintext if called directly
1290 $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass;
1293 // Hash the password
1294 $user_pass = wp_hash_password( $userdata['user_pass'] );
1297 $sanitized_user_login = sanitize_user( $userdata['user_login'], true );
1300 * Filter a username after it has been sanitized.
1302 * This filter is called before the user is created or updated.
1306 * @param string $sanitized_user_login Username after it has been sanitized.
1308 $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login );
1310 //Remove any non-printable chars from the login string to see if we have ended up with an empty username
1311 $user_login = trim( $pre_user_login );
1313 // user_login must be between 0 and 60 characters.
1314 if ( empty( $user_login ) ) {
1315 return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
1316 } elseif ( mb_strlen( $user_login ) > 60 ) {
1317 return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) );
1320 if ( ! $update && username_exists( $user_login ) ) {
1321 return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
1325 * Filter the list of blacklisted usernames.
1329 * @param array $usernames Array of blacklisted usernames.
1331 $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
1333 if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ) ) ) {
1334 return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) );
1338 * If a nicename is provided, remove unsafe user characters before using it.
1339 * Otherwise build a nicename from the user_login.
1341 if ( ! empty( $userdata['user_nicename'] ) ) {
1342 $user_nicename = sanitize_user( $userdata['user_nicename'], true );
1343 if ( mb_strlen( $user_nicename ) > 50 ) {
1344 return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) );
1347 $user_nicename = mb_substr( $user_login, 0, 50 );
1350 $user_nicename = sanitize_title( $user_nicename );
1352 // Store values to save in user meta.
1356 * Filter a user's nicename before the user is created or updated.
1360 * @param string $user_nicename The user's nicename.
1362 $user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
1364 $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url'];
1367 * Filter a user's URL before the user is created or updated.
1371 * @param string $raw_user_url The user's URL.
1373 $user_url = apply_filters( 'pre_user_url', $raw_user_url );
1375 $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email'];
1378 * Filter a user's email before the user is created or updated.
1382 * @param string $raw_user_email The user's email.
1384 $user_email = apply_filters( 'pre_user_email', $raw_user_email );
1387 * If there is no update, just check for `email_exists`. If there is an update,
1388 * check if current email and new email are the same, or not, and check `email_exists`
1391 if ( ( ! $update || ( ! empty( $old_user_data ) && 0 !== strcasecmp( $user_email, $old_user_data->user_email ) ) )
1392 && ! defined( 'WP_IMPORTING' )
1393 && email_exists( $user_email )
1395 return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
1397 $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname'];
1400 * Filter a user's nickname before the user is created or updated.
1404 * @param string $nickname The user's nickname.
1406 $meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname );
1408 $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name'];
1411 * Filter a user's first name before the user is created or updated.
1415 * @param string $first_name The user's first name.
1417 $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name );
1419 $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name'];
1422 * Filter a user's last name before the user is created or updated.
1426 * @param string $last_name The user's last name.
1428 $meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name );
1430 if ( empty( $userdata['display_name'] ) ) {
1432 $display_name = $user_login;
1433 } elseif ( $meta['first_name'] && $meta['last_name'] ) {
1434 /* translators: 1: first name, 2: last name */
1435 $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $meta['first_name'], $meta['last_name'] );
1436 } elseif ( $meta['first_name'] ) {
1437 $display_name = $meta['first_name'];
1438 } elseif ( $meta['last_name'] ) {
1439 $display_name = $meta['last_name'];
1441 $display_name = $user_login;
1444 $display_name = $userdata['display_name'];
1448 * Filter a user's display name before the user is created or updated.
1452 * @param string $display_name The user's display name.
1454 $display_name = apply_filters( 'pre_user_display_name', $display_name );
1456 $description = empty( $userdata['description'] ) ? '' : $userdata['description'];
1459 * Filter a user's description before the user is created or updated.
1463 * @param string $description The user's description.
1465 $meta['description'] = apply_filters( 'pre_user_description', $description );
1467 $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing'];
1469 $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true';
1471 $admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color'];
1472 $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color );
1474 $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : $userdata['use_ssl'];
1476 $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered'];
1478 $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front'];
1480 $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));
1482 if ( $user_nicename_check ) {
1484 while ($user_nicename_check) {
1485 // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix.
1486 $base_length = 49 - mb_strlen( $suffix );
1487 $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix";
1488 $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));
1491 $user_nicename = $alt_user_nicename;
1494 $compacted = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
1495 $data = wp_unslash( $compacted );
1498 if ( $user_email !== $old_user_data->user_email ) {
1499 $data['user_activation_key'] = '';
1501 $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
1502 $user_id = (int) $ID;
1504 $wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) );
1505 $user_id = (int) $wpdb->insert_id;
1508 $user = new WP_User( $user_id );
1511 * Filter a user's meta values and keys before the user is created or updated.
1513 * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`.
1517 * @param array $meta {
1518 * Default meta values and keys for the user.
1520 * @type string $nickname The user's nickname. Default is the the user's username.
1521 * @type string $first_name The user's first name.
1522 * @type string $last_name The user's last name.
1523 * @type string $description The user's description.
1524 * @type bool $rich_editing Whether to enable the rich-editor for the user. False if not empty.
1525 * @type bool $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default false.
1526 * @type string $admin_color The color scheme for a user's admin screen. Default 'fresh'.
1527 * @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL is
1529 * @type bool $show_admin_bar_front Whether to show the admin bar on the front end for the user.
1532 * @param WP_User $user User object.
1533 * @param bool $update Whether the user is being updated rather than created.
1535 $meta = apply_filters( 'insert_user_meta', $meta, $user, $update );
1537 // Update user meta.
1538 foreach ( $meta as $key => $value ) {
1539 update_user_meta( $user_id, $key, $value );
1542 foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) {
1543 if ( isset( $userdata[ $key ] ) ) {
1544 update_user_meta( $user_id, $key, $userdata[ $key ] );
1548 if ( isset( $userdata['role'] ) ) {
1549 $user->set_role( $userdata['role'] );
1550 } elseif ( ! $update ) {
1551 $user->set_role(get_option('default_role'));
1553 wp_cache_delete( $user_id, 'users' );
1554 wp_cache_delete( $user_login, 'userlogins' );
1558 * Fires immediately after an existing user is updated.
1562 * @param int $user_id User ID.
1563 * @param object $old_user_data Object containing user's data prior to update.
1565 do_action( 'profile_update', $user_id, $old_user_data );
1568 * Fires immediately after a new user is registered.
1572 * @param int $user_id User ID.
1574 do_action( 'user_register', $user_id );
1581 * Update a user in the database.
1583 * It is possible to update a user's password by specifying the 'user_pass'
1584 * value in the $userdata parameter array.
1586 * If current user's password is being updated, then the cookies will be
1591 * @see wp_insert_user() For what fields can be set in $userdata.
1593 * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
1594 * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
1596 function wp_update_user($userdata) {
1597 if ( $userdata instanceof stdClass ) {
1598 $userdata = get_object_vars( $userdata );
1599 } elseif ( $userdata instanceof WP_User ) {
1600 $userdata = $userdata->to_array();
1603 $ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
1605 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1608 // First, get all of the original fields
1609 $user_obj = get_userdata( $ID );
1610 if ( ! $user_obj ) {
1611 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1614 $user = $user_obj->to_array();
1616 // Add additional custom fields
1617 foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
1618 $user[ $key ] = get_user_meta( $ID, $key, true );
1621 // Escape data pulled from DB.
1622 $user = add_magic_quotes( $user );
1624 if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) {
1625 // If password is changing, hash it now
1626 $plaintext_pass = $userdata['user_pass'];
1627 $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] );
1630 * Filter whether to send the password change email.
1634 * @see wp_insert_user() For `$user` and `$userdata` fields.
1636 * @param bool $send Whether to send the email.
1637 * @param array $user The original user array.
1638 * @param array $userdata The updated user array.
1641 $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata );
1644 if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) {
1646 * Filter whether to send the email change email.
1650 * @see wp_insert_user() For `$user` and `$userdata` fields.
1652 * @param bool $send Whether to send the email.
1653 * @param array $user The original user array.
1654 * @param array $userdata The updated user array.
1657 $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata );
1660 wp_cache_delete( $user['user_email'], 'useremail' );
1662 // Merge old and new fields with new fields overwriting old ones.
1663 $userdata = array_merge( $user, $userdata );
1664 $user_id = wp_insert_user( $userdata );
1666 if ( ! is_wp_error( $user_id ) ) {
1668 $blog_name = wp_specialchars_decode( get_option( 'blogname' ) );
1670 if ( ! empty( $send_password_change_email ) ) {
1672 /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1673 $pass_change_text = __( 'Hi ###USERNAME###,
1675 This notice confirms that your password was changed on ###SITENAME###.
1677 If you did not change your password, please contact the Site Administrator at
1680 This email has been sent to ###EMAIL###
1683 All at ###SITENAME###
1686 $pass_change_email = array(
1687 'to' => $user['user_email'],
1688 'subject' => __( '[%s] Notice of Password Change' ),
1689 'message' => $pass_change_text,
1694 * Filter the contents of the email sent when the user's password is changed.
1698 * @param array $pass_change_email {
1699 * Used to build wp_mail().
1700 * @type string $to The intended recipients. Add emails in a comma separated string.
1701 * @type string $subject The subject of the email.
1702 * @type string $message The content of the email.
1703 * The following strings have a special meaning and will get replaced dynamically:
1704 * - ###USERNAME### The current user's username.
1705 * - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1706 * - ###EMAIL### The old email.
1707 * - ###SITENAME### The name of the site.
1708 * - ###SITEURL### The URL to the site.
1709 * @type string $headers Headers. Add headers in a newline (\r\n) separated string.
1711 * @param array $user The original user array.
1712 * @param array $userdata The updated user array.
1715 $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata );
1717 $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] );
1718 $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] );
1719 $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] );
1720 $pass_change_email['message'] = str_replace( '###SITENAME###', get_option( 'blogname' ), $pass_change_email['message'] );
1721 $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] );
1723 wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] );
1726 if ( ! empty( $send_email_change_email ) ) {
1727 /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1728 $email_change_text = __( 'Hi ###USERNAME###,
1730 This notice confirms that your email was changed on ###SITENAME###.
1732 If you did not change your email, please contact the Site Administrator at
1735 This email has been sent to ###EMAIL###
1738 All at ###SITENAME###
1741 $email_change_email = array(
1742 'to' => $user['user_email'],
1743 'subject' => __( '[%s] Notice of Email Change' ),
1744 'message' => $email_change_text,
1749 * Filter the contents of the email sent when the user's email is changed.
1753 * @param array $email_change_email {
1754 * Used to build wp_mail().
1755 * @type string $to The intended recipients.
1756 * @type string $subject The subject of the email.
1757 * @type string $message The content of the email.
1758 * The following strings have a special meaning and will get replaced dynamically:
1759 * - ###USERNAME### The current user's username.
1760 * - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1761 * - ###EMAIL### The old email.
1762 * - ###SITENAME### The name of the site.
1763 * - ###SITEURL### The URL to the site.
1764 * @type string $headers Headers.
1766 * @param array $user The original user array.
1767 * @param array $userdata The updated user array.
1769 $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata );
1771 $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] );
1772 $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] );
1773 $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] );
1774 $email_change_email['message'] = str_replace( '###SITENAME###', get_option( 'blogname' ), $email_change_email['message'] );
1775 $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );
1777 wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] );
1781 // Update the cookies if the password changed.
1782 $current_user = wp_get_current_user();
1783 if ( $current_user->ID == $ID ) {
1784 if ( isset($plaintext_pass) ) {
1785 wp_clear_auth_cookie();
1787 // Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
1788 // If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
1789 $logged_in_cookie = wp_parse_auth_cookie( '', 'logged_in' );
1790 /** This filter is documented in wp-includes/pluggable.php */
1791 $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false );
1792 $remember = ( ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life );
1794 wp_set_auth_cookie( $ID, $remember );
1802 * A simpler way of inserting a user into the database.
1804 * Creates a new user with just the username, password, and email. For more
1805 * complex user creation use {@see wp_insert_user()} to specify more information.
1808 * @see wp_insert_user() More complete way to create a new user
1810 * @param string $username The user's username.
1811 * @param string $password The user's password.
1812 * @param string $email Optional. The user's email. Default empty.
1813 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1816 function wp_create_user($username, $password, $email = '') {
1817 $user_login = wp_slash( $username );
1818 $user_email = wp_slash( $email );
1819 $user_pass = $password;
1821 $userdata = compact('user_login', 'user_email', 'user_pass');
1822 return wp_insert_user($userdata);
1826 * Returns a list of meta keys to be (maybe) populated in wp_update_user().
1828 * The list of keys returned via this function are dependent on the presence
1829 * of those keys in the user meta data to be set.
1834 * @param WP_User $user WP_User instance.
1835 * @return array List of user keys to be populated in wp_update_user().
1837 function _get_additional_user_keys( $user ) {
1838 $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' );
1839 return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
1843 * Set up the user contact methods.
1845 * Default contact methods were removed in 3.6. A filter dictates contact methods.
1849 * @param WP_User $user Optional. WP_User object.
1850 * @return array Array of contact methods and their labels.
1852 function wp_get_user_contact_methods( $user = null ) {
1854 if ( get_site_option( 'initial_db_version' ) < 23588 ) {
1856 'aim' => __( 'AIM' ),
1857 'yim' => __( 'Yahoo IM' ),
1858 'jabber' => __( 'Jabber / Google Talk' )
1863 * Filter the user contact methods.
1867 * @param array $methods Array of contact methods and their labels.
1868 * @param WP_User $user WP_User object.
1870 return apply_filters( 'user_contactmethods', $methods, $user );
1874 * The old private function for setting up user contact methods.
1879 function _wp_get_user_contactmethods( $user = null ) {
1880 return wp_get_user_contact_methods( $user );
1884 * Gets the text suggesting how to create strong passwords.
1888 * @return string The password hint text.
1890 function wp_get_password_hint() {
1891 $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 ! " ? $ % ^ & ).' );
1894 * Filter the text describing the site's password complexity policy.
1898 * @param string $hint The password hint text.
1900 return apply_filters( 'password_hint', $hint );
1904 * Creates, stores, then returns a password reset key for user.
1908 * @global wpdb $wpdb WordPress database abstraction object.
1909 * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
1911 * @param WP_User $user User to retrieve password reset key for.
1913 * @return string|WP_Error Password reset key on success. WP_Error on error.
1915 function get_password_reset_key( $user ) {
1916 global $wpdb, $wp_hasher;
1919 * Fires before a new password is retrieved.
1922 * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
1924 * @param string $user_login The user login name.
1926 do_action( 'retreive_password', $user->user_login );
1929 * Fires before a new password is retrieved.
1933 * @param string $user_login The user login name.
1935 do_action( 'retrieve_password', $user->user_login );
1938 * Filter whether to allow a password to be reset.
1942 * @param bool true Whether to allow the password to be reset. Default true.
1943 * @param int $user_data->ID The ID of the user attempting to reset a password.
1945 $allow = apply_filters( 'allow_password_reset', true, $user->ID );
1948 return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );
1949 } elseif ( is_wp_error( $allow ) ) {
1953 // Generate something random for a password reset key.
1954 $key = wp_generate_password( 20, false );
1957 * Fires when a password reset key is generated.
1961 * @param string $user_login The username for the user.
1962 * @param string $key The generated password reset key.
1964 do_action( 'retrieve_password_key', $user->user_login, $key );
1966 // Now insert the key, hashed, into the DB.
1967 if ( empty( $wp_hasher ) ) {
1968 require_once ABSPATH . WPINC . '/class-phpass.php';
1969 $wp_hasher = new PasswordHash( 8, true );
1971 $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
1972 $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
1973 if ( false === $key_saved ) {
1974 return new WP_Error( 'no_password_key_update', __( 'Could not save password reset key to database.' ) );
1981 * Retrieves a user row based on password reset key and login
1983 * A key is considered 'expired' if it exactly matches the value of the
1984 * user_activation_key field, rather than being matched after going through the
1985 * hashing process. This field is now hashed; old values are no longer accepted
1986 * but have a different WP_Error code so good user feedback can be provided.
1990 * @global wpdb $wpdb WordPress database object for queries.
1991 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
1993 * @param string $key Hash to validate sending user's password.
1994 * @param string $login The user login.
1995 * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
1997 function check_password_reset_key($key, $login) {
1998 global $wpdb, $wp_hasher;
2000 $key = preg_replace('/[^a-z0-9]/i', '', $key);
2002 if ( empty( $key ) || !is_string( $key ) )
2003 return new WP_Error('invalid_key', __('Invalid key'));
2005 if ( empty($login) || !is_string($login) )
2006 return new WP_Error('invalid_key', __('Invalid key'));
2008 $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
2010 return new WP_Error('invalid_key', __('Invalid key'));
2012 if ( empty( $wp_hasher ) ) {
2013 require_once ABSPATH . WPINC . '/class-phpass.php';
2014 $wp_hasher = new PasswordHash( 8, true );
2018 * Filter the expiration time of password reset keys.
2022 * @param int $expiration The expiration time in seconds.
2024 $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS );
2026 if ( false !== strpos( $row->user_activation_key, ':' ) ) {
2027 list( $pass_request_time, $pass_key ) = explode( ':', $row->user_activation_key, 2 );
2028 $expiration_time = $pass_request_time + $expiration_duration;
2030 $pass_key = $row->user_activation_key;
2031 $expiration_time = false;
2034 $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key );
2036 if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) {
2037 return get_userdata( $row->ID );
2038 } elseif ( $hash_is_correct && $expiration_time ) {
2039 // Key has an expiration time that's passed
2040 return new WP_Error( 'expired_key', __( 'Invalid key' ) );
2043 if ( hash_equals( $row->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) {
2044 $return = new WP_Error( 'expired_key', __( 'Invalid key' ) );
2045 $user_id = $row->ID;
2048 * Filter the return value of check_password_reset_key() when an
2049 * old-style key is used.
2051 * @since 3.7.0 Previously plain-text keys were stored in the database.
2052 * @since 4.3.0 Previously key hashes were stored without an expiration time.
2054 * @param WP_Error $return A WP_Error object denoting an expired key.
2055 * Return a WP_User object to validate the key.
2056 * @param int $user_id The matched user ID.
2058 return apply_filters( 'password_reset_key_expired', $return, $user_id );
2061 return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2065 * Handles resetting the user's password.
2069 * @param object $user The user
2070 * @param string $new_pass New password for the user in plaintext
2072 function reset_password( $user, $new_pass ) {
2074 * Fires before the user's password is reset.
2078 * @param object $user The user.
2079 * @param string $new_pass New user password.
2081 do_action( 'password_reset', $user, $new_pass );
2083 wp_set_password( $new_pass, $user->ID );
2084 update_user_option( $user->ID, 'default_password_nag', false, true );
2087 * Fires after the user's password is reset.
2091 * @param object $user The user.
2092 * @param string $new_pass New user password.
2094 do_action( 'after_password_reset', $user, $new_pass );
2098 * Handles registering a new user.
2102 * @param string $user_login User's username for logging in
2103 * @param string $user_email User's email address to send password and add
2104 * @return int|WP_Error Either user's ID or error on failure.
2106 function register_new_user( $user_login, $user_email ) {
2107 $errors = new WP_Error();
2109 $sanitized_user_login = sanitize_user( $user_login );
2111 * Filter the email address of a user being registered.
2115 * @param string $user_email The email address of the new user.
2117 $user_email = apply_filters( 'user_registration_email', $user_email );
2119 // Check the username
2120 if ( $sanitized_user_login == '' ) {
2121 $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
2122 } elseif ( ! validate_username( $user_login ) ) {
2123 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) );
2124 $sanitized_user_login = '';
2125 } elseif ( username_exists( $sanitized_user_login ) ) {
2126 $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) );
2129 /** This filter is documented in wp-includes/user.php */
2130 $illegal_user_logins = array_map( 'strtolower', (array) apply_filters( 'illegal_user_logins', array() ) );
2131 if ( in_array( strtolower( $sanitized_user_login ), $illegal_user_logins ) ) {
2132 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
2136 // Check the email address
2137 if ( $user_email == '' ) {
2138 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) );
2139 } elseif ( ! is_email( $user_email ) ) {
2140 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn’t correct.' ) );
2142 } elseif ( email_exists( $user_email ) ) {
2143 $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
2147 * Fires when submitting registration form data, before the user is created.
2151 * @param string $sanitized_user_login The submitted username after being sanitized.
2152 * @param string $user_email The submitted email.
2153 * @param WP_Error $errors Contains any errors with submitted username and email,
2154 * e.g., an empty field, an invalid username or email,
2155 * or an existing username or email.
2157 do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
2160 * Filter the errors encountered when a new user is being registered.
2162 * The filtered WP_Error object may, for example, contain errors for an invalid
2163 * or existing username or email address. A WP_Error object should always returned,
2164 * but may or may not contain errors.
2166 * If any errors are present in $errors, this will abort the user's registration.
2170 * @param WP_Error $errors A WP_Error object containing any errors encountered
2171 * during registration.
2172 * @param string $sanitized_user_login User's username after it has been sanitized.
2173 * @param string $user_email User's email.
2175 $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
2177 if ( $errors->get_error_code() )
2180 $user_pass = wp_generate_password( 12, false );
2181 $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email );
2182 if ( ! $user_id || is_wp_error( $user_id ) ) {
2183 $errors->add( 'registerfail', sprintf( __( '<strong>ERROR</strong>: Couldn’t register you… please contact the <a href="mailto:%s">webmaster</a> !' ), get_option( 'admin_email' ) ) );
2187 update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
2190 * Fires after a new user registration has been recorded.
2194 * @param int $user_id ID of the newly registered user.
2196 do_action( 'register_new_user', $user_id );
2202 * Initiate email notifications related to the creation of new users.
2204 * Notifications are sent both to the site admin and to the newly created user.
2208 * @param int $user_id ID of the newly created user.
2209 * @param string $notify Optional. Type of notification that should happen. Accepts 'admin' or an empty string
2210 * (admin only), or 'both' (admin and user). Default 'both'.
2212 function wp_send_new_user_notifications( $user_id, $notify = 'both' ) {
2213 wp_new_user_notification( $user_id, null, $notify );
2217 * Retrieve the current session token from the logged_in cookie.
2221 * @return string Token.
2223 function wp_get_session_token() {
2224 $cookie = wp_parse_auth_cookie( '', 'logged_in' );
2225 return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
2229 * Retrieve a list of sessions for the current user.
2232 * @return array Array of sessions.
2234 function wp_get_all_sessions() {
2235 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2236 return $manager->get_all();
2240 * Remove the current session token from the database.
2244 function wp_destroy_current_session() {
2245 $token = wp_get_session_token();
2247 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2248 $manager->destroy( $token );
2253 * Remove all but the current session token for the current user for the database.
2257 function wp_destroy_other_sessions() {
2258 $token = wp_get_session_token();
2260 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2261 $manager->destroy_others( $token );
2266 * Remove all session tokens for the current user from the database.
2270 function wp_destroy_all_sessions() {
2271 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2272 $manager->destroy_all();
2276 * Get the user IDs of all users with no role on this site.
2278 * This function returns an empty array when used on Multisite.
2282 * @return array Array of user IDs.
2284 function wp_get_users_with_no_role() {
2287 if ( is_multisite() ) {
2291 $prefix = $wpdb->get_blog_prefix();
2292 $regex = implode( '|', wp_roles()->get_names() );
2293 $regex = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex );
2294 $users = $wpdb->get_col( $wpdb->prepare( "
2296 FROM $wpdb->usermeta
2297 WHERE meta_key = '{$prefix}capabilities'
2298 AND meta_value NOT REGEXP %s