9 * Authenticate user with remember capability.
11 * The credentials is an array that has 'user_login', 'user_password', and
12 * 'remember' indices. If the credentials is not given, then the log in form
13 * will be assumed and used if set.
15 * The various authentication cookies will be set by this function and will be
16 * set for a longer period depending on if the 'remember' credential is set to
21 * @param array $credentials Optional. User info in order to sign on.
22 * @param bool $secure_cookie Optional. Whether to use secure cookie.
23 * @return object Either WP_Error on failure, or WP_User on success.
25 function wp_signon( $credentials = '', $secure_cookie = '' ) {
26 if ( empty($credentials) ) {
27 if ( ! empty($_POST['log']) )
28 $credentials['user_login'] = $_POST['log'];
29 if ( ! empty($_POST['pwd']) )
30 $credentials['user_password'] = $_POST['pwd'];
31 if ( ! empty($_POST['rememberme']) )
32 $credentials['remember'] = $_POST['rememberme'];
35 if ( !empty($credentials['remember']) )
36 $credentials['remember'] = true;
38 $credentials['remember'] = false;
40 // TODO do we deprecate the wp_authentication action?
41 do_action_ref_array('wp_authenticate', array(&$credentials['user_login'], &$credentials['user_password']));
43 if ( '' === $secure_cookie )
44 $secure_cookie = is_ssl();
46 $secure_cookie = apply_filters('secure_signon_cookie', $secure_cookie, $credentials);
48 global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
49 $auth_secure_cookie = $secure_cookie;
51 add_filter('authenticate', 'wp_authenticate_cookie', 30, 3);
53 $user = wp_authenticate($credentials['user_login'], $credentials['user_password']);
55 if ( is_wp_error($user) ) {
56 if ( $user->get_error_codes() == array('empty_username', 'empty_password') ) {
57 $user = new WP_Error('', '');
63 wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie);
64 do_action('wp_login', $user->user_login, $user);
69 * Authenticate the user using the username and password.
71 add_filter('authenticate', 'wp_authenticate_username_password', 20, 3);
72 function wp_authenticate_username_password($user, $username, $password) {
73 if ( is_a($user, 'WP_User') ) { return $user; }
75 if ( empty($username) || empty($password) ) {
76 if ( is_wp_error( $user ) )
79 $error = new WP_Error();
81 if ( empty($username) )
82 $error->add('empty_username', __('<strong>ERROR</strong>: The username field is empty.'));
84 if ( empty($password) )
85 $error->add('empty_password', __('<strong>ERROR</strong>: The password field is empty.'));
90 $user = get_user_by('login', $username);
93 return new WP_Error( 'invalid_username', sprintf( __( '<strong>ERROR</strong>: Invalid username. <a href="%s" title="Password Lost and Found">Lost your password</a>?' ), wp_lostpassword_url() ) );
95 $user = apply_filters('wp_authenticate_user', $user, $password);
96 if ( is_wp_error($user) )
99 if ( !wp_check_password($password, $user->user_pass, $user->ID) )
100 return new WP_Error( 'incorrect_password', sprintf( __( '<strong>ERROR</strong>: The password you entered for the username <strong>%1$s</strong> is incorrect. <a href="%2$s" title="Password Lost and Found">Lost your password</a>?' ),
101 $username, wp_lostpassword_url() ) );
107 * Authenticate the user using the WordPress auth cookie.
109 function wp_authenticate_cookie($user, $username, $password) {
110 if ( is_a($user, 'WP_User') ) { return $user; }
112 if ( empty($username) && empty($password) ) {
113 $user_id = wp_validate_auth_cookie();
115 return new WP_User($user_id);
117 global $auth_secure_cookie;
119 if ( $auth_secure_cookie )
120 $auth_cookie = SECURE_AUTH_COOKIE;
122 $auth_cookie = AUTH_COOKIE;
124 if ( !empty($_COOKIE[$auth_cookie]) )
125 return new WP_Error('expired_session', __('Please log in again.'));
127 // If the cookie is not set, be silent.
134 * For multisite blogs, check if the authenticated user has been marked as a
135 * spammer, or if the user's primary blog has been marked as spam.
139 function wp_authenticate_spam_check( $user ) {
140 if ( $user && is_a( $user, 'WP_User' ) && is_multisite() ) {
141 $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy(), $user );
144 return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) );
150 * Number of posts user has written.
153 * @uses $wpdb WordPress database object for queries.
155 * @param int $userid User ID.
156 * @return int Amount of posts user has written.
158 function count_user_posts($userid) {
161 $where = get_posts_by_author_sql('post', true, $userid);
163 $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
165 return apply_filters('get_usernumposts', $count, $userid);
169 * Number of posts written by a list of users.
173 * @param array $users Array of user IDs.
174 * @param string $post_type Optional. Post type to check. Defaults to post.
175 * @param bool $public_only Optional. Only return counts for public posts. Defaults to false.
176 * @return array Amount of posts each user has written.
178 function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) {
182 if ( empty( $users ) || ! is_array( $users ) )
185 $userlist = implode( ',', array_map( 'absint', $users ) );
186 $where = get_posts_by_author_sql( $post_type, true, null, $public_only );
188 $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N );
189 foreach ( $result as $row ) {
190 $count[ $row[0] ] = $row[1];
193 foreach ( $users as $id ) {
194 if ( ! isset( $count[ $id ] ) )
202 // User option functions
206 * Get the current user's ID
210 * @uses wp_get_current_user
212 * @return int The current user's ID
214 function get_current_user_id() {
215 if ( ! function_exists( 'wp_get_current_user' ) )
217 $user = wp_get_current_user();
218 return ( isset( $user->ID ) ? (int) $user->ID : 0 );
222 * Retrieve user option that can be either per Site or per Network.
224 * If the user ID is not given, then the current user will be used instead. If
225 * the user ID is given, then the user data will be retrieved. The filter for
226 * the result, will also pass the original option name and finally the user data
227 * object as the third parameter.
229 * The option will first check for the per site name and then the per Network name.
232 * @uses $wpdb WordPress database object for queries.
233 * @uses apply_filters() Calls 'get_user_option_$option' hook with result,
234 * option parameter, and user data object.
236 * @param string $option User option name.
237 * @param int $user Optional. User ID.
238 * @param bool $deprecated Use get_option() to check for an option in the options table.
241 function get_user_option( $option, $user = 0, $deprecated = '' ) {
244 if ( !empty( $deprecated ) )
245 _deprecated_argument( __FUNCTION__, '3.0' );
247 if ( empty( $user ) )
248 $user = get_current_user_id();
250 if ( ! $user = get_userdata( $user ) )
253 $prefix = $wpdb->get_blog_prefix();
254 if ( $user->has_prop( $prefix . $option ) ) // Blog specific
255 $result = $user->get( $prefix . $option );
256 elseif ( $user->has_prop( $option ) ) // User specific and cross-blog
257 $result = $user->get( $option );
261 return apply_filters("get_user_option_{$option}", $result, $option, $user);
265 * Update user option with global blog capability.
267 * User options are just like user metadata except that they have support for
268 * global blog options. If the 'global' parameter is false, which it is by default
269 * it will prepend the WordPress table prefix to the option name.
271 * Deletes the user option if $newvalue is empty.
274 * @uses $wpdb WordPress database object for queries
276 * @param int $user_id User ID
277 * @param string $option_name User option name.
278 * @param mixed $newvalue User option value.
279 * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
282 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
286 $option_name = $wpdb->get_blog_prefix() . $option_name;
288 return update_user_meta( $user_id, $option_name, $newvalue );
292 * Delete user option with global blog capability.
294 * User options are just like user metadata except that they have support for
295 * global blog options. If the 'global' parameter is false, which it is by default
296 * it will prepend the WordPress table prefix to the option name.
299 * @uses $wpdb WordPress database object for queries
301 * @param int $user_id User ID
302 * @param string $option_name User option name.
303 * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
306 function delete_user_option( $user_id, $option_name, $global = false ) {
310 $option_name = $wpdb->get_blog_prefix() . $option_name;
311 return delete_user_meta( $user_id, $option_name );
315 * WordPress User Query class.
319 class WP_User_Query {
322 * Query vars, after parsing
328 var $query_vars = array();
331 * List of found user ids
340 * Total number of found users for the current query
346 var $total_users = 0;
360 * @param string|array $args The query variables
361 * @return WP_User_Query
363 function __construct( $query = null ) {
364 if ( !empty( $query ) ) {
365 $this->query_vars = wp_parse_args( $query, array(
366 'blog_id' => $GLOBALS['blog_id'],
370 'meta_compare' => '',
371 'include' => array(),
372 'exclude' => array(),
374 'search_columns' => array(),
375 'orderby' => 'login',
379 'count_total' => true,
384 $this->prepare_query();
390 * Prepare the query variables
395 function prepare_query() {
398 $qv =& $this->query_vars;
400 if ( is_array( $qv['fields'] ) ) {
401 $qv['fields'] = array_unique( $qv['fields'] );
403 $this->query_fields = array();
404 foreach ( $qv['fields'] as $field ) {
405 $field = 'ID' === $field ? 'ID' : sanitize_key( $field );
406 $this->query_fields[] = "$wpdb->users.$field";
408 $this->query_fields = implode( ',', $this->query_fields );
409 } elseif ( 'all' == $qv['fields'] ) {
410 $this->query_fields = "$wpdb->users.*";
412 $this->query_fields = "$wpdb->users.ID";
415 if ( isset( $qv['count_total'] ) && $qv['count_total'] )
416 $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
418 $this->query_from = "FROM $wpdb->users";
419 $this->query_where = "WHERE 1=1";
422 if ( isset( $qv['orderby'] ) ) {
423 if ( in_array( $qv['orderby'], array('nicename', 'email', 'url', 'registered') ) ) {
424 $orderby = 'user_' . $qv['orderby'];
425 } elseif ( in_array( $qv['orderby'], array('user_nicename', 'user_email', 'user_url', 'user_registered') ) ) {
426 $orderby = $qv['orderby'];
427 } elseif ( 'name' == $qv['orderby'] || 'display_name' == $qv['orderby'] ) {
428 $orderby = 'display_name';
429 } elseif ( 'post_count' == $qv['orderby'] ) {
430 // todo: avoid the JOIN
431 $where = get_posts_by_author_sql('post');
432 $this->query_from .= " LEFT OUTER JOIN (
433 SELECT post_author, COUNT(*) as post_count
437 ) p ON ({$wpdb->users}.ID = p.post_author)
439 $orderby = 'post_count';
440 } elseif ( 'ID' == $qv['orderby'] || 'id' == $qv['orderby'] ) {
442 } elseif ( 'meta_value' == $qv['orderby'] ) {
443 $orderby = "$wpdb->usermeta.meta_value";
445 $orderby = 'user_login';
449 if ( empty( $orderby ) )
450 $orderby = 'user_login';
452 $qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
453 if ( 'ASC' == $qv['order'] )
457 $this->query_orderby = "ORDER BY $orderby $order";
460 if ( isset( $qv['number'] ) && $qv['number'] ) {
462 $this->query_limit = $wpdb->prepare("LIMIT %d, %d", $qv['offset'], $qv['number']);
464 $this->query_limit = $wpdb->prepare("LIMIT %d", $qv['number']);
468 if ( isset( $qv['search'] ) )
469 $search = trim( $qv['search'] );
472 $leading_wild = ( ltrim($search, '*') != $search );
473 $trailing_wild = ( rtrim($search, '*') != $search );
474 if ( $leading_wild && $trailing_wild )
476 elseif ( $leading_wild )
478 elseif ( $trailing_wild )
483 $search = trim($search, '*');
485 $search_columns = array();
486 if ( $qv['search_columns'] )
487 $search_columns = array_intersect( $qv['search_columns'], array( 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename' ) );
488 if ( ! $search_columns ) {
489 if ( false !== strpos( $search, '@') )
490 $search_columns = array('user_email');
491 elseif ( is_numeric($search) )
492 $search_columns = array('user_login', 'ID');
493 elseif ( preg_match('|^https?://|', $search) && ! ( is_multisite() && wp_is_large_network( 'users' ) ) )
494 $search_columns = array('user_url');
496 $search_columns = array('user_login', 'user_nicename');
499 $search_columns = apply_filters( 'user_search_columns', $search_columns, $search, $this );
501 $this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
505 if ( isset( $qv['blog_id'] ) )
506 $blog_id = absint( $qv['blog_id'] );
508 if ( isset( $qv['who'] ) && 'authors' == $qv['who'] && $blog_id ) {
509 $qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
510 $qv['meta_value'] = 0;
511 $qv['meta_compare'] = '!=';
512 $qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
516 if ( isset( $qv['role'] ) )
517 $role = trim( $qv['role'] );
519 if ( $blog_id && ( $role || is_multisite() ) ) {
520 $cap_meta_query = array();
521 $cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
524 $cap_meta_query['value'] = '"' . $role . '"';
525 $cap_meta_query['compare'] = 'like';
528 $qv['meta_query'][] = $cap_meta_query;
531 $meta_query = new WP_Meta_Query();
532 $meta_query->parse_query_vars( $qv );
534 if ( !empty( $meta_query->queries ) ) {
535 $clauses = $meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
536 $this->query_from .= $clauses['join'];
537 $this->query_where .= $clauses['where'];
539 if ( 'OR' == $meta_query->relation )
540 $this->query_fields = 'DISTINCT ' . $this->query_fields;
543 if ( ! empty( $qv['include'] ) ) {
544 $ids = implode( ',', wp_parse_id_list( $qv['include'] ) );
545 $this->query_where .= " AND $wpdb->users.ID IN ($ids)";
546 } elseif ( ! empty( $qv['exclude'] ) ) {
547 $ids = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
548 $this->query_where .= " AND $wpdb->users.ID NOT IN ($ids)";
551 do_action_ref_array( 'pre_user_query', array( &$this ) );
555 * Execute the query, with the current variables
563 $qv =& $this->query_vars;
565 if ( is_array( $qv['fields'] ) || 'all' == $qv['fields'] ) {
566 $this->results = $wpdb->get_results("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
568 $this->results = $wpdb->get_col("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
571 if ( isset( $qv['count_total'] ) && $qv['count_total'] )
572 $this->total_users = $wpdb->get_var( apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()' ) );
574 if ( !$this->results )
577 if ( 'all_with_meta' == $qv['fields'] ) {
578 cache_users( $this->results );
581 foreach ( $this->results as $userid )
582 $r[ $userid ] = new WP_User( $userid, '', $qv['blog_id'] );
585 } elseif ( 'all' == $qv['fields'] ) {
586 foreach ( $this->results as $key => $user ) {
587 $this->results[ $key ] = new WP_User( $user );
593 * Retrieve query variable.
598 * @param string $query_var Query variable key.
601 function get( $query_var ) {
602 if ( isset( $this->query_vars[$query_var] ) )
603 return $this->query_vars[$query_var];
609 * Set query variable.
614 * @param string $query_var Query variable key.
615 * @param mixed $value Query variable value.
617 function set( $query_var, $value ) {
618 $this->query_vars[$query_var] = $value;
622 * Used internally to generate an SQL string for searching across multiple columns
627 * @param string $string
629 * @param bool $wild Whether to allow wildcard searches. Default is false for Network Admin, true for
630 * single site. Single site allows leading and trailing wildcards, Network Admin only trailing.
633 function get_search_sql( $string, $cols, $wild = false ) {
634 $string = esc_sql( $string );
637 $leading_wild = ( 'leading' == $wild || 'both' == $wild ) ? '%' : '';
638 $trailing_wild = ( 'trailing' == $wild || 'both' == $wild ) ? '%' : '';
639 foreach ( $cols as $col ) {
641 $searches[] = "$col = '$string'";
643 $searches[] = "$col LIKE '$leading_wild" . like_escape($string) . "$trailing_wild'";
646 return ' AND (' . implode(' OR ', $searches) . ')';
650 * Return the list of users
657 function get_results() {
658 return $this->results;
662 * Return the total number of users for the current query
669 function get_total() {
670 return $this->total_users;
675 * Retrieve list of users matching criteria.
679 * @uses WP_User_Query See for default arguments and information.
681 * @param array $args Optional.
682 * @return array List of users.
684 function get_users( $args = array() ) {
686 $args = wp_parse_args( $args );
687 $args['count_total'] = false;
689 $user_search = new WP_User_Query($args);
691 return (array) $user_search->get_results();
695 * Get the blogs a user belongs to.
699 * @param int $user_id User ID
700 * @param bool $all Whether to retrieve all blogs, or only blogs that are not marked as deleted, archived, or spam.
701 * @return array A list of the user's blogs. An empty array if the user doesn't exist or belongs to no blogs.
703 function get_blogs_of_user( $user_id, $all = false ) {
706 $user_id = (int) $user_id;
708 // Logged out users can't have blogs
709 if ( empty( $user_id ) )
712 $keys = get_user_meta( $user_id );
713 if ( empty( $keys ) )
716 if ( ! is_multisite() ) {
717 $blog_id = get_current_blog_id();
718 $blogs = array( $blog_id => new stdClass );
719 $blogs[ $blog_id ]->userblog_id = $blog_id;
720 $blogs[ $blog_id ]->blogname = get_option('blogname');
721 $blogs[ $blog_id ]->domain = '';
722 $blogs[ $blog_id ]->path = '';
723 $blogs[ $blog_id ]->site_id = 1;
724 $blogs[ $blog_id ]->siteurl = get_option('siteurl');
725 $blogs[ $blog_id ]->archived = 0;
726 $blogs[ $blog_id ]->spam = 0;
727 $blogs[ $blog_id ]->deleted = 0;
733 if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
734 $blog = get_blog_details( 1 );
735 if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
736 $blogs[ 1 ] = (object) array(
738 'blogname' => $blog->blogname,
739 'domain' => $blog->domain,
740 'path' => $blog->path,
741 'site_id' => $blog->site_id,
742 'siteurl' => $blog->siteurl,
748 unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
751 $keys = array_keys( $keys );
753 foreach ( $keys as $key ) {
754 if ( 'capabilities' !== substr( $key, -12 ) )
756 if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) )
758 $blog_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
759 if ( ! is_numeric( $blog_id ) )
762 $blog_id = (int) $blog_id;
763 $blog = get_blog_details( $blog_id );
764 if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
765 $blogs[ $blog_id ] = (object) array(
766 'userblog_id' => $blog_id,
767 'blogname' => $blog->blogname,
768 'domain' => $blog->domain,
769 'path' => $blog->path,
770 'site_id' => $blog->site_id,
771 'siteurl' => $blog->siteurl,
779 return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all );
783 * Find out whether a user is a member of a given blog.
786 * @uses get_blogs_of_user()
788 * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
789 * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
792 function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
793 $user_id = (int) $user_id;
794 $blog_id = (int) $blog_id;
796 if ( empty( $user_id ) )
797 $user_id = get_current_user_id();
799 if ( empty( $blog_id ) )
800 $blog_id = get_current_blog_id();
802 $blogs = get_blogs_of_user( $user_id );
803 return array_key_exists( $blog_id, $blogs );
807 * Add meta data field to a user.
809 * Post meta data is called "Custom Fields" on the Administration Screens.
812 * @uses add_metadata()
813 * @link http://codex.wordpress.org/Function_Reference/add_user_meta
815 * @param int $user_id User ID.
816 * @param string $meta_key Metadata name.
817 * @param mixed $meta_value Metadata value.
818 * @param bool $unique Optional, default is false. Whether the same key should not be added.
819 * @return int|bool Meta ID on success, false on failure.
821 function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
822 return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
826 * Remove metadata matching criteria from a user.
828 * You can match based on the key, or key and value. Removing based on key and
829 * value, will keep from removing duplicate metadata with the same key. It also
830 * allows removing all metadata matching key, if needed.
833 * @uses delete_metadata()
834 * @link http://codex.wordpress.org/Function_Reference/delete_user_meta
836 * @param int $user_id user ID
837 * @param string $meta_key Metadata name.
838 * @param mixed $meta_value Optional. Metadata value.
839 * @return bool True on success, false on failure.
841 function delete_user_meta($user_id, $meta_key, $meta_value = '') {
842 return delete_metadata('user', $user_id, $meta_key, $meta_value);
846 * Retrieve user meta field for a user.
849 * @uses get_metadata()
850 * @link http://codex.wordpress.org/Function_Reference/get_user_meta
852 * @param int $user_id User ID.
853 * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
854 * @param bool $single Whether to return a single value.
855 * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
858 function get_user_meta($user_id, $key = '', $single = false) {
859 return get_metadata('user', $user_id, $key, $single);
863 * Update user meta field based on user ID.
865 * Use the $prev_value parameter to differentiate between meta fields with the
866 * same key and user ID.
868 * If the meta field for the user does not exist, it will be added.
871 * @uses update_metadata
872 * @link http://codex.wordpress.org/Function_Reference/update_user_meta
874 * @param int $user_id User ID.
875 * @param string $meta_key Metadata key.
876 * @param mixed $meta_value Metadata value.
877 * @param mixed $prev_value Optional. Previous value to check before removing.
878 * @return bool True on success, false on failure.
880 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
881 return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
885 * Count number of users who have each of the user roles.
887 * Assumes there are neither duplicated nor orphaned capabilities meta_values.
888 * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query()
889 * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
890 * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
893 * @param string $strategy 'time' or 'memory'
894 * @return array Includes a grand total and an array of counts indexed by role strings.
896 function count_users($strategy = 'time') {
897 global $wpdb, $wp_roles;
900 $id = get_current_blog_id();
901 $blog_prefix = $wpdb->get_blog_prefix($id);
904 if ( 'time' == $strategy ) {
907 if ( ! isset( $wp_roles ) )
908 $wp_roles = new WP_Roles();
910 $avail_roles = $wp_roles->get_names();
912 // Build a CPU-intensive query that will return concise information.
913 $select_count = array();
914 foreach ( $avail_roles as $this_role => $name ) {
915 $select_count[] = "COUNT(NULLIF(`meta_value` LIKE '%\"" . like_escape( $this_role ) . "\"%', false))";
917 $select_count = implode(', ', $select_count);
919 // Add the meta_value index to the selection list, then run the query.
920 $row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
922 // Run the previous loop again to associate results with role names.
924 $role_counts = array();
925 foreach ( $avail_roles as $this_role => $name ) {
926 $count = (int) $row[$col++];
928 $role_counts[$this_role] = $count;
932 // Get the meta_value index from the end of the result set.
933 $total_users = (int) $row[$col];
935 $result['total_users'] = $total_users;
936 $result['avail_roles'] =& $role_counts;
938 $avail_roles = array();
940 $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" );
942 foreach ( $users_of_blog as $caps_meta ) {
943 $b_roles = maybe_unserialize($caps_meta);
944 if ( ! is_array( $b_roles ) )
946 foreach ( $b_roles as $b_role => $val ) {
947 if ( isset($avail_roles[$b_role]) ) {
948 $avail_roles[$b_role]++;
950 $avail_roles[$b_role] = 1;
955 $result['total_users'] = count( $users_of_blog );
956 $result['avail_roles'] =& $avail_roles;
963 // Private helper functions
967 * Set up global user vars.
969 * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
972 * @global string $userdata User description.
973 * @global string $user_login The user username for logging in
974 * @global int $user_level The level of the user
975 * @global int $user_ID The ID of the user
976 * @global string $user_email The email address of the user
977 * @global string $user_url The url in the user's profile
978 * @global string $user_identity The display name of the user
980 * @param int $for_user_id Optional. User ID to set up global data.
982 function setup_userdata($for_user_id = '') {
983 global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity;
985 if ( '' == $for_user_id )
986 $for_user_id = get_current_user_id();
987 $user = get_userdata( $for_user_id );
993 $user_login = $user_email = $user_url = $user_identity = '';
997 $user_ID = (int) $user->ID;
998 $user_level = (int) $user->user_level;
1000 $user_login = $user->user_login;
1001 $user_email = $user->user_email;
1002 $user_url = $user->user_url;
1003 $user_identity = $user->display_name;
1007 * Create dropdown HTML content of users.
1009 * The content can either be displayed, which it is by default or retrieved by
1010 * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
1011 * need to be used; all users will be displayed in that case. Only one can be
1012 * used, either 'include' or 'exclude', but not both.
1014 * The available arguments are as follows:
1016 * <li>show_option_all - Text to show all and whether HTML option exists.</li>
1017 * <li>show_option_none - Text for show none and whether HTML option exists.</li>
1018 * <li>hide_if_only_one_author - Don't create the dropdown if there is only one user.</li>
1019 * <li>orderby - SQL order by clause for what order the users appear. Default is 'display_name'.</li>
1020 * <li>order - Default is 'ASC'. Can also be 'DESC'.</li>
1021 * <li>include - User IDs to include.</li>
1022 * <li>exclude - User IDs to exclude.</li>
1023 * <li>multi - Default is 'false'. Whether to skip the ID attribute on the 'select' element. A 'true' value is overridden when id argument is set.</li>
1024 * <li>show - Default is 'display_name'. User table column to display. If the selected item is empty then the user_login will be displayed in parentheses</li>
1025 * <li>echo - Default is '1'. Whether to display or retrieve content.</li>
1026 * <li>selected - Which User ID is selected.</li>
1027 * <li>include_selected - Always include the selected user ID in the dropdown. Default is false.</li>
1028 * <li>name - Default is 'user'. Name attribute of select element.</li>
1029 * <li>id - Default is the value of the 'name' parameter. ID attribute of select element.</li>
1030 * <li>class - Class attribute of select element.</li>
1031 * <li>blog_id - ID of blog (Multisite only). Defaults to ID of current blog.</li>
1032 * <li>who - Which users to query. Currently only 'authors' is supported. Default is all users.</li>
1036 * @uses $wpdb WordPress database object for queries
1038 * @param string|array $args Optional. Override defaults.
1039 * @return string|null Null on display. String of HTML content on retrieve.
1041 function wp_dropdown_users( $args = '' ) {
1043 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
1044 'orderby' => 'display_name', 'order' => 'ASC',
1045 'include' => '', 'exclude' => '', 'multi' => 0,
1046 'show' => 'display_name', 'echo' => 1,
1047 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
1048 'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false
1051 $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
1053 $r = wp_parse_args( $args, $defaults );
1054 extract( $r, EXTR_SKIP );
1056 $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
1057 $query_args['fields'] = array( 'ID', 'user_login', $show );
1058 $users = get_users( $query_args );
1061 if ( !empty($users) && ( empty($hide_if_only_one_author) || count($users) > 1 ) ) {
1062 $name = esc_attr( $name );
1063 if ( $multi && ! $id )
1066 $id = $id ? " id='" . esc_attr( $id ) . "'" : " id='$name'";
1068 $output = "<select name='{$name}'{$id} class='$class'>\n";
1070 if ( $show_option_all )
1071 $output .= "\t<option value='0'>$show_option_all</option>\n";
1073 if ( $show_option_none ) {
1074 $_selected = selected( -1, $selected, false );
1075 $output .= "\t<option value='-1'$_selected>$show_option_none</option>\n";
1078 $found_selected = false;
1079 foreach ( (array) $users as $user ) {
1080 $user->ID = (int) $user->ID;
1081 $_selected = selected( $user->ID, $selected, false );
1083 $found_selected = true;
1084 $display = !empty($user->$show) ? $user->$show : '('. $user->user_login . ')';
1085 $output .= "\t<option value='$user->ID'$_selected>" . esc_html($display) . "</option>\n";
1088 if ( $include_selected && ! $found_selected && ( $selected > 0 ) ) {
1089 $user = get_userdata( $selected );
1090 $_selected = selected( $user->ID, $selected, false );
1091 $display = !empty($user->$show) ? $user->$show : '('. $user->user_login . ')';
1092 $output .= "\t<option value='$user->ID'$_selected>" . esc_html($display) . "</option>\n";
1095 $output .= "</select>";
1098 $output = apply_filters('wp_dropdown_users', $output);
1107 * Sanitize user field based on context.
1109 * Possible context values are: 'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1110 * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1111 * when calling filters.
1114 * @uses apply_filters() Calls 'edit_$field' passing $value and $user_id if $context == 'edit'.
1115 * $field is prefixed with 'user_' if it isn't already.
1116 * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db'. $field is prefixed with
1117 * 'user_' if it isn't already.
1118 * @uses apply_filters() Calls '$field' passing $value, $user_id and $context if $context == anything
1119 * other than 'raw', 'edit' and 'db'. $field is prefixed with 'user_' if it isn't already.
1121 * @param string $field The user Object field name.
1122 * @param mixed $value The user Object value.
1123 * @param int $user_id user ID.
1124 * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
1125 * 'attribute' and 'js'.
1126 * @return mixed Sanitized value.
1128 function sanitize_user_field($field, $value, $user_id, $context) {
1129 $int_fields = array('ID');
1130 if ( in_array($field, $int_fields) )
1131 $value = (int) $value;
1133 if ( 'raw' == $context )
1136 if ( !is_string($value) && !is_numeric($value) )
1139 $prefixed = false !== strpos( $field, 'user_' );
1141 if ( 'edit' == $context ) {
1143 $value = apply_filters("edit_{$field}", $value, $user_id);
1145 $value = apply_filters("edit_user_{$field}", $value, $user_id);
1148 if ( 'description' == $field )
1149 $value = esc_html( $value ); // textarea_escaped?
1151 $value = esc_attr($value);
1152 } else if ( 'db' == $context ) {
1154 $value = apply_filters("pre_{$field}", $value);
1156 $value = apply_filters("pre_user_{$field}", $value);
1159 // Use display filters by default.
1161 $value = apply_filters($field, $value, $user_id, $context);
1163 $value = apply_filters("user_{$field}", $value, $user_id, $context);
1166 if ( 'user_url' == $field )
1167 $value = esc_url($value);
1169 if ( 'attribute' == $context )
1170 $value = esc_attr($value);
1171 else if ( 'js' == $context )
1172 $value = esc_js($value);
1178 * Update all user caches
1182 * @param object $user User object to be cached
1184 function update_user_caches($user) {
1185 wp_cache_add($user->ID, $user, 'users');
1186 wp_cache_add($user->user_login, $user->ID, 'userlogins');
1187 wp_cache_add($user->user_email, $user->ID, 'useremail');
1188 wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
1192 * Clean all user caches
1196 * @param WP_User|int $user User object or ID to be cleaned from the cache
1198 function clean_user_cache( $user ) {
1199 if ( is_numeric( $user ) )
1200 $user = new WP_User( $user );
1202 if ( ! $user->exists() )
1205 wp_cache_delete( $user->ID, 'users' );
1206 wp_cache_delete( $user->user_login, 'userlogins' );
1207 wp_cache_delete( $user->user_email, 'useremail' );
1208 wp_cache_delete( $user->user_nicename, 'userslugs' );
1212 * Checks whether the given username exists.
1216 * @param string $username Username.
1217 * @return null|int The user's ID on success, and null on failure.
1219 function username_exists( $username ) {
1220 if ( $user = get_user_by('login', $username ) ) {
1228 * Checks whether the given email exists.
1233 * @param string $email Email.
1234 * @return bool|int The user's ID on success, and false on failure.
1236 function email_exists( $email ) {
1237 if ( $user = get_user_by('email', $email) )
1244 * Checks whether an username is valid.
1247 * @uses apply_filters() Calls 'validate_username' hook on $valid check and $username as parameters
1249 * @param string $username Username.
1250 * @return bool Whether username given is valid
1252 function validate_username( $username ) {
1253 $sanitized = sanitize_user( $username, true );
1254 $valid = ( $sanitized == $username );
1255 return apply_filters( 'validate_username', $valid, $username );
1259 * Insert an user into the database.
1261 * Most of the $userdata array fields have filters associated with the values.
1262 * The exceptions are 'rich_editing', 'role', 'jabber', 'aim', 'yim',
1263 * 'user_registered', and 'ID'. The filters have the prefix 'pre_user_' followed
1264 * by the field name. An example using 'description' would have the filter
1265 * called, 'pre_user_description' that can be hooked into.
1267 * The $userdata array can contain the following fields:
1268 * 'ID' - An integer that will be used for updating an existing user.
1269 * 'user_pass' - A string that contains the plain text password for the user.
1270 * 'user_login' - A string that contains the user's username for logging in.
1271 * 'user_nicename' - A string that contains a URL-friendly name for the user.
1272 * The default is the user's username.
1273 * 'user_url' - A string containing the user's URL for the user's web site.
1274 * 'user_email' - A string containing the user's email address.
1275 * 'display_name' - A string that will be shown on the site. Defaults to user's
1276 * username. It is likely that you will want to change this, for appearance.
1277 * 'nickname' - The user's nickname, defaults to the user's username.
1278 * 'first_name' - The user's first name.
1279 * 'last_name' - The user's last name.
1280 * 'description' - A string containing content about the user.
1281 * 'rich_editing' - A string for whether to enable the rich editor. False
1283 * 'user_registered' - The date the user registered. Format is 'Y-m-d H:i:s'.
1284 * 'role' - A string used to set the user's role.
1285 * 'jabber' - User's Jabber account.
1286 * 'aim' - User's AOL IM account.
1287 * 'yim' - User's Yahoo IM account.
1290 * @uses $wpdb WordPress database layer.
1291 * @uses apply_filters() Calls filters for most of the $userdata fields with the prefix 'pre_user'. See note above.
1292 * @uses do_action() Calls 'profile_update' hook when updating giving the user's ID
1293 * @uses do_action() Calls 'user_register' hook when creating a new user giving the user's ID
1295 * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
1296 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not be created.
1298 function wp_insert_user( $userdata ) {
1301 if ( is_a( $userdata, 'stdClass' ) )
1302 $userdata = get_object_vars( $userdata );
1303 elseif ( is_a( $userdata, 'WP_User' ) )
1304 $userdata = $userdata->to_array();
1306 extract( $userdata, EXTR_SKIP );
1308 // Are we updating or creating?
1309 if ( !empty($ID) ) {
1312 $old_user_data = WP_User::get_data_by( 'id', $ID );
1315 // Hash the password
1316 $user_pass = wp_hash_password($user_pass);
1319 $user_login = sanitize_user($user_login, true);
1320 $user_login = apply_filters('pre_user_login', $user_login);
1322 //Remove any non-printable chars from the login string to see if we have ended up with an empty username
1323 $user_login = trim($user_login);
1325 if ( empty($user_login) )
1326 return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
1328 if ( !$update && username_exists( $user_login ) )
1329 return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
1331 if ( empty($user_nicename) )
1332 $user_nicename = sanitize_title( $user_login );
1333 $user_nicename = apply_filters('pre_user_nicename', $user_nicename);
1335 if ( empty($user_url) )
1337 $user_url = apply_filters('pre_user_url', $user_url);
1339 if ( empty($user_email) )
1341 $user_email = apply_filters('pre_user_email', $user_email);
1343 if ( !$update && ! defined( 'WP_IMPORTING' ) && email_exists($user_email) )
1344 return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
1346 if ( empty($nickname) )
1347 $nickname = $user_login;
1348 $nickname = apply_filters('pre_user_nickname', $nickname);
1350 if ( empty($first_name) )
1352 $first_name = apply_filters('pre_user_first_name', $first_name);
1354 if ( empty($last_name) )
1356 $last_name = apply_filters('pre_user_last_name', $last_name);
1358 if ( empty( $display_name ) ) {
1360 $display_name = $user_login;
1361 elseif ( $first_name && $last_name )
1362 /* translators: 1: first name, 2: last name */
1363 $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $first_name, $last_name );
1364 elseif ( $first_name )
1365 $display_name = $first_name;
1366 elseif ( $last_name )
1367 $display_name = $last_name;
1369 $display_name = $user_login;
1371 $display_name = apply_filters( 'pre_user_display_name', $display_name );
1373 if ( empty($description) )
1375 $description = apply_filters('pre_user_description', $description);
1377 if ( empty($rich_editing) )
1378 $rich_editing = 'true';
1380 if ( empty($comment_shortcuts) )
1381 $comment_shortcuts = 'false';
1383 if ( empty($admin_color) )
1384 $admin_color = 'fresh';
1385 $admin_color = preg_replace('|[^a-z0-9 _.\-@]|i', '', $admin_color);
1387 if ( empty($use_ssl) )
1390 if ( empty($user_registered) )
1391 $user_registered = gmdate('Y-m-d H:i:s');
1393 if ( empty($show_admin_bar_front) )
1394 $show_admin_bar_front = 'true';
1396 $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));
1398 if ( $user_nicename_check ) {
1400 while ($user_nicename_check) {
1401 $alt_user_nicename = $user_nicename . "-$suffix";
1402 $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));
1405 $user_nicename = $alt_user_nicename;
1408 $data = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
1409 $data = wp_unslash( $data );
1412 $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
1413 $user_id = (int) $ID;
1415 $wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) );
1416 $user_id = (int) $wpdb->insert_id;
1419 $user = new WP_User( $user_id );
1421 foreach ( _get_additional_user_keys( $user ) as $key ) {
1422 if ( isset( $$key ) )
1423 update_user_meta( $user_id, $key, $$key );
1427 $user->set_role($role);
1429 $user->set_role(get_option('default_role'));
1431 wp_cache_delete($user_id, 'users');
1432 wp_cache_delete($user_login, 'userlogins');
1435 do_action('profile_update', $user_id, $old_user_data);
1437 do_action('user_register', $user_id);
1443 * Update an user in the database.
1445 * It is possible to update a user's password by specifying the 'user_pass'
1446 * value in the $userdata parameter array.
1448 * If current user's password is being updated, then the cookies will be
1452 * @see wp_insert_user() For what fields can be set in $userdata
1454 * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
1455 * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
1457 function wp_update_user($userdata) {
1458 if ( is_a( $userdata, 'stdClass' ) )
1459 $userdata = get_object_vars( $userdata );
1460 elseif ( is_a( $userdata, 'WP_User' ) )
1461 $userdata = $userdata->to_array();
1463 $ID = (int) $userdata['ID'];
1465 // First, get all of the original fields
1466 $user_obj = get_userdata( $ID );
1468 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1470 $user = $user_obj->to_array();
1472 // Add additional custom fields
1473 foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
1474 $user[ $key ] = get_user_meta( $ID, $key, true );
1477 // Escape data pulled from DB.
1478 $user = add_magic_quotes( $user );
1480 // If password is changing, hash it now.
1481 if ( ! empty($userdata['user_pass']) ) {
1482 $plaintext_pass = $userdata['user_pass'];
1483 $userdata['user_pass'] = wp_hash_password($userdata['user_pass']);
1486 wp_cache_delete($user[ 'user_email' ], 'useremail');
1488 // Merge old and new fields with new fields overwriting old ones.
1489 $userdata = array_merge($user, $userdata);
1490 $user_id = wp_insert_user($userdata);
1492 // Update the cookies if the password changed.
1493 $current_user = wp_get_current_user();
1494 if ( $current_user->ID == $ID ) {
1495 if ( isset($plaintext_pass) ) {
1496 wp_clear_auth_cookie();
1497 wp_set_auth_cookie($ID);
1505 * A simpler way of inserting an user into the database.
1507 * Creates a new user with just the username, password, and email. For more
1508 * complex user creation use wp_insert_user() to specify more information.
1511 * @see wp_insert_user() More complete way to create a new user
1513 * @param string $username The user's username.
1514 * @param string $password The user's password.
1515 * @param string $email The user's email (optional).
1516 * @return int The new user's ID.
1518 function wp_create_user($username, $password, $email = '') {
1519 $user_login = wp_slash( $username );
1520 $user_email = wp_slash( $email );
1521 $user_pass = $password;
1523 $userdata = compact('user_login', 'user_email', 'user_pass');
1524 return wp_insert_user($userdata);
1528 * Return a list of meta keys that wp_insert_user() is supposed to set.
1533 * @param object $user WP_User instance.
1536 function _get_additional_user_keys( $user ) {
1537 $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' );
1538 return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
1542 * Set up the user contact methods.
1544 * Default contact methods were removed in 3.6. A filter dictates contact methods.
1548 * @param WP_User $user Optional. WP_User object.
1549 * @return array Array of contact methods and their labels.
1551 function wp_get_user_contact_methods( $user = null ) {
1553 if ( get_site_option( 'initial_db_version' ) < 23588 ) {
1555 'aim' => __( 'AIM' ),
1556 'yim' => __( 'Yahoo IM' ),
1557 'jabber' => __( 'Jabber / Google Talk' )
1562 * Filter the user contact methods.
1566 * @param array $methods Array of contact methods and their labels.
1567 * @param WP_User $user WP_User object.
1569 return apply_filters( 'user_contactmethods', $methods, $user );
1573 * The old private function for setting up user contact methods.
1578 function _wp_get_user_contactmethods( $user = null ) {
1579 return wp_get_user_contact_methods( $user );
1583 * Retrieves a user row based on password reset key and login
1585 * A key is considered 'expired' if it exactly matches the value of the
1586 * user_activation_key field, rather than being matched after going through the
1587 * hashing process. This field is now hashed; old values are no longer accepted
1588 * but have a different WP_Error code so good user feedback can be provided.
1590 * @uses $wpdb WordPress Database object
1592 * @param string $key Hash to validate sending user's password.
1593 * @param string $login The user login.
1594 * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
1596 function check_password_reset_key($key, $login) {
1597 global $wpdb, $wp_hasher;
1599 $key = preg_replace('/[^a-z0-9]/i', '', $key);
1601 if ( empty( $key ) || !is_string( $key ) )
1602 return new WP_Error('invalid_key', __('Invalid key'));
1604 if ( empty($login) || !is_string($login) )
1605 return new WP_Error('invalid_key', __('Invalid key'));
1607 $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
1609 return new WP_Error('invalid_key', __('Invalid key'));
1611 if ( empty( $wp_hasher ) ) {
1612 require_once ABSPATH . 'wp-includes/class-phpass.php';
1613 $wp_hasher = new PasswordHash( 8, true );
1616 if ( $wp_hasher->CheckPassword( $key, $row->user_activation_key ) )
1617 return get_userdata( $row->ID );
1619 if ( $key === $row->user_activation_key ) {
1620 $return = new WP_Error( 'expired_key', __( 'Invalid key' ) );
1621 $user_id = $row->ID;
1624 * Filter the return value of check_password_reset_key() when an
1625 * old-style key is used (plain-text key was stored in the database).
1629 * @param WP_Error $return A WP_Error object denoting an expired key.
1630 * Return a WP_User object to validate the key.
1631 * @param int $user_id The matched user ID.
1633 return apply_filters( 'password_reset_key_expired', $return, $user_id );
1636 return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
1640 * Handles resetting the user's password.
1642 * @param object $user The user
1643 * @param string $new_pass New password for the user in plaintext
1645 function reset_password( $user, $new_pass ) {
1646 do_action( 'password_reset', $user, $new_pass );
1648 wp_set_password( $new_pass, $user->ID );
1649 update_user_option( $user->ID, 'default_password_nag', false, true );
1651 wp_password_change_notification( $user );
1655 * Handles registering a new user.
1657 * @param string $user_login User's username for logging in
1658 * @param string $user_email User's email address to send password and add
1659 * @return int|WP_Error Either user's ID or error on failure.
1661 function register_new_user( $user_login, $user_email ) {
1662 $errors = new WP_Error();
1664 $sanitized_user_login = sanitize_user( $user_login );
1665 $user_email = apply_filters( 'user_registration_email', $user_email );
1667 // Check the username
1668 if ( $sanitized_user_login == '' ) {
1669 $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
1670 } elseif ( ! validate_username( $user_login ) ) {
1671 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) );
1672 $sanitized_user_login = '';
1673 } elseif ( username_exists( $sanitized_user_login ) ) {
1674 $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) );
1677 // Check the e-mail address
1678 if ( $user_email == '' ) {
1679 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your e-mail address.' ) );
1680 } elseif ( ! is_email( $user_email ) ) {
1681 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn’t correct.' ) );
1683 } elseif ( email_exists( $user_email ) ) {
1684 $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
1687 do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
1689 $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
1691 if ( $errors->get_error_code() )
1694 $user_pass = wp_generate_password( 12, false );
1695 $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email );
1696 if ( ! $user_id || is_wp_error( $user_id ) ) {
1697 $errors->add( 'registerfail', sprintf( __( '<strong>ERROR</strong>: Couldn’t register you… please contact the <a href="mailto:%s">webmaster</a> !' ), get_option( 'admin_email' ) ) );
1701 update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
1703 wp_new_user_notification( $user_id, $user_pass );