Wordpress 4.6
[autoinstalls/wordpress.git] / wp-includes / user.php
1 <?php
2 /**
3  * Core User API
4  *
5  * @package WordPress
6  * @subpackage Users
7  */
8
9 /**
10  * Authenticates and logs a user in with 'remember' capability.
11  *
12  * The credentials is an array that has 'user_login', 'user_password', and
13  * 'remember' indices. If the credentials is not given, then the log in form
14  * will be assumed and used if set.
15  *
16  * The various authentication cookies will be set by this function and will be
17  * set for a longer period depending on if the 'remember' credential is set to
18  * true.
19  *
20  * @since 2.5.0
21  *
22  * @global string $auth_secure_cookie
23  *
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.
27  */
28 function wp_signon( $credentials = array(), $secure_cookie = '' ) {
29         if ( empty($credentials) ) {
30                 $credentials = array(); // Back-compat for plugins passing an empty string.
31
32                 if ( ! empty($_POST['log']) )
33                         $credentials['user_login'] = $_POST['log'];
34                 if ( ! empty($_POST['pwd']) )
35                         $credentials['user_password'] = $_POST['pwd'];
36                 if ( ! empty($_POST['rememberme']) )
37                         $credentials['remember'] = $_POST['rememberme'];
38         }
39
40         if ( !empty($credentials['remember']) )
41                 $credentials['remember'] = true;
42         else
43                 $credentials['remember'] = false;
44
45         /**
46          * Fires before the user is authenticated.
47          *
48          * The variables passed to the callbacks are passed by reference,
49          * and can be modified by callback functions.
50          *
51          * @since 1.5.1
52          *
53          * @todo Decide whether to deprecate the wp_authenticate action.
54          *
55          * @param string $user_login    Username, passed by reference.
56          * @param string $user_password User password, passed by reference.
57          */
58         do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
59
60         if ( '' === $secure_cookie )
61                 $secure_cookie = is_ssl();
62
63         /**
64          * Filters whether to use a secure sign-on cookie.
65          *
66          * @since 3.1.0
67          *
68          * @param bool  $secure_cookie Whether to use a secure sign-on cookie.
69          * @param array $credentials {
70          *     Array of entered sign-on data.
71          *
72          *     @type string $user_login    Username.
73          *     @type string $user_password Password entered.
74          *     @type bool   $remember      Whether to 'remember' the user. Increases the time
75          *                                 that the cookie will be kept. Default false.
76          * }
77          */
78         $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );
79
80         global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
81         $auth_secure_cookie = $secure_cookie;
82
83         add_filter('authenticate', 'wp_authenticate_cookie', 30, 3);
84
85         $user = wp_authenticate($credentials['user_login'], $credentials['user_password']);
86
87         if ( is_wp_error($user) ) {
88                 if ( $user->get_error_codes() == array('empty_username', 'empty_password') ) {
89                         $user = new WP_Error('', '');
90                 }
91
92                 return $user;
93         }
94
95         wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie);
96         /**
97          * Fires after the user has successfully logged in.
98          *
99          * @since 1.5.0
100          *
101          * @param string  $user_login Username.
102          * @param WP_User $user       WP_User object of the logged-in user.
103          */
104         do_action( 'wp_login', $user->user_login, $user );
105         return $user;
106 }
107
108 /**
109  * Authenticate a user, confirming the username and password are valid.
110  *
111  * @since 2.8.0
112  *
113  * @param WP_User|WP_Error|null $user     WP_User or WP_Error object from a previous callback. Default null.
114  * @param string                $username Username for authentication.
115  * @param string                $password Password for authentication.
116  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
117  */
118 function wp_authenticate_username_password($user, $username, $password) {
119         if ( $user instanceof WP_User ) {
120                 return $user;
121         }
122
123         if ( empty($username) || empty($password) ) {
124                 if ( is_wp_error( $user ) )
125                         return $user;
126
127                 $error = new WP_Error();
128
129                 if ( empty($username) )
130                         $error->add('empty_username', __('<strong>ERROR</strong>: The username field is empty.'));
131
132                 if ( empty($password) )
133                         $error->add('empty_password', __('<strong>ERROR</strong>: The password field is empty.'));
134
135                 return $error;
136         }
137
138         $user = get_user_by('login', $username);
139
140         if ( !$user ) {
141                 return new WP_Error( 'invalid_username',
142                         __( '<strong>ERROR</strong>: Invalid username.' ) .
143                         ' <a href="' . wp_lostpassword_url() . '">' .
144                         __( 'Lost your password?' ) .
145                         '</a>'
146                 );
147         }
148
149         /**
150          * Filters whether the given user can be authenticated with the provided $password.
151          *
152          * @since 2.5.0
153          *
154          * @param WP_User|WP_Error $user     WP_User or WP_Error object if a previous
155          *                                   callback failed authentication.
156          * @param string           $password Password to check against the user.
157          */
158         $user = apply_filters( 'wp_authenticate_user', $user, $password );
159         if ( is_wp_error($user) )
160                 return $user;
161
162         if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
163                 return new WP_Error( 'incorrect_password',
164                         sprintf(
165                                 /* translators: %s: user name */
166                                 __( '<strong>ERROR</strong>: The password you entered for the username %s is incorrect.' ),
167                                 '<strong>' . $username . '</strong>'
168                         ) .
169                         ' <a href="' . wp_lostpassword_url() . '">' .
170                         __( 'Lost your password?' ) .
171                         '</a>'
172                 );
173         }
174
175         return $user;
176 }
177
178 /**
179  * Authenticates a user using the email and password.
180  *
181  * @since 4.5.0
182  *
183  * @param WP_User|WP_Error|null $user     WP_User or WP_Error object if a previous
184  *                                        callback failed authentication.
185  * @param string                $email    Email address for authentication.
186  * @param string                $password Password for authentication.
187  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
188  */
189 function wp_authenticate_email_password( $user, $email, $password ) {
190         if ( $user instanceof WP_User ) {
191                 return $user;
192         }
193
194         if ( empty( $email ) || empty( $password ) ) {
195                 if ( is_wp_error( $user ) ) {
196                         return $user;
197                 }
198
199                 $error = new WP_Error();
200
201                 if ( empty( $email ) ) {
202                         $error->add( 'empty_username', __( '<strong>ERROR</strong>: The email field is empty.' ) ); // Uses 'empty_username' for back-compat with wp_signon()
203                 }
204
205                 if ( empty( $password ) ) {
206                         $error->add( 'empty_password', __( '<strong>ERROR</strong>: The password field is empty.' ) );
207                 }
208
209                 return $error;
210         }
211
212         if ( ! is_email( $email ) ) {
213                 return $user;
214         }
215
216         $user = get_user_by( 'email', $email );
217
218         if ( ! $user ) {
219                 return new WP_Error( 'invalid_email',
220                         __( '<strong>ERROR</strong>: Invalid email address.' ) .
221                         ' <a href="' . wp_lostpassword_url() . '">' .
222                         __( 'Lost your password?' ) .
223                         '</a>'
224                 );
225         }
226
227         /** This filter is documented in wp-includes/user.php */
228         $user = apply_filters( 'wp_authenticate_user', $user, $password );
229
230         if ( is_wp_error( $user ) ) {
231                 return $user;
232         }
233
234         if ( ! wp_check_password( $password, $user->user_pass, $user->ID ) ) {
235                 return new WP_Error( 'incorrect_password',
236                         sprintf(
237                                 /* translators: %s: email address */
238                                 __( '<strong>ERROR</strong>: The password you entered for the email address %s is incorrect.' ),
239                                 '<strong>' . $email . '</strong>'
240                         ) .
241                         ' <a href="' . wp_lostpassword_url() . '">' .
242                         __( 'Lost your password?' ) .
243                         '</a>'
244                 );
245         }
246
247         return $user;
248 }
249
250 /**
251  * Authenticate the user using the WordPress auth cookie.
252  *
253  * @since 2.8.0
254  *
255  * @global string $auth_secure_cookie
256  *
257  * @param WP_User|WP_Error|null $user     WP_User or WP_Error object from a previous callback. Default null.
258  * @param string                $username Username. If not empty, cancels the cookie authentication.
259  * @param string                $password Password. If not empty, cancels the cookie authentication.
260  * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
261  */
262 function wp_authenticate_cookie($user, $username, $password) {
263         if ( $user instanceof WP_User ) {
264                 return $user;
265         }
266
267         if ( empty($username) && empty($password) ) {
268                 $user_id = wp_validate_auth_cookie();
269                 if ( $user_id )
270                         return new WP_User($user_id);
271
272                 global $auth_secure_cookie;
273
274                 if ( $auth_secure_cookie )
275                         $auth_cookie = SECURE_AUTH_COOKIE;
276                 else
277                         $auth_cookie = AUTH_COOKIE;
278
279                 if ( !empty($_COOKIE[$auth_cookie]) )
280                         return new WP_Error('expired_session', __('Please log in again.'));
281
282                 // If the cookie is not set, be silent.
283         }
284
285         return $user;
286 }
287
288 /**
289  * For Multisite blogs, check if the authenticated user has been marked as a
290  * spammer, or if the user's primary blog has been marked as spam.
291  *
292  * @since 3.7.0
293  *
294  * @param WP_User|WP_Error|null $user WP_User or WP_Error object from a previous callback. Default null.
295  * @return WP_User|WP_Error WP_User on success, WP_Error if the user is considered a spammer.
296  */
297 function wp_authenticate_spam_check( $user ) {
298         if ( $user instanceof WP_User && is_multisite() ) {
299                 /**
300                  * Filters whether the user has been marked as a spammer.
301                  *
302                  * @since 3.7.0
303                  *
304                  * @param bool    $spammed Whether the user is considered a spammer.
305                  * @param WP_User $user    User to check against.
306                  */
307                 $spammed = apply_filters( 'check_is_user_spammed', is_user_spammy( $user ), $user );
308
309                 if ( $spammed )
310                         return new WP_Error( 'spammer_account', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.' ) );
311         }
312         return $user;
313 }
314
315 /**
316  * Validates the logged-in cookie.
317  *
318  * Checks the logged-in cookie if the previous auth cookie could not be
319  * validated and parsed.
320  *
321  * This is a callback for the {@see 'determine_current_user'} filter, rather than API.
322  *
323  * @since 3.9.0
324  *
325  * @param int|bool $user_id The user ID (or false) as received from the
326  *                       determine_current_user filter.
327  * @return int|false User ID if validated, false otherwise. If a user ID from
328  *                   an earlier filter callback is received, that value is returned.
329  */
330 function wp_validate_logged_in_cookie( $user_id ) {
331         if ( $user_id ) {
332                 return $user_id;
333         }
334
335         if ( is_blog_admin() || is_network_admin() || empty( $_COOKIE[LOGGED_IN_COOKIE] ) ) {
336                 return false;
337         }
338
339         return wp_validate_auth_cookie( $_COOKIE[LOGGED_IN_COOKIE], 'logged_in' );
340 }
341
342 /**
343  * Number of posts user has written.
344  *
345  * @since 3.0.0
346  * @since 4.1.0 Added `$post_type` argument.
347  * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array
348  *              of post types to `$post_type`.
349  *
350  * @global wpdb $wpdb WordPress database abstraction object.
351  *
352  * @param int          $userid      User ID.
353  * @param array|string $post_type   Optional. Single post type or array of post types to count the number of posts for. Default 'post'.
354  * @param bool         $public_only Optional. Whether to only return counts for public posts. Default false.
355  * @return string Number of posts the user has written in this post type.
356  */
357 function count_user_posts( $userid, $post_type = 'post', $public_only = false ) {
358         global $wpdb;
359
360         $where = get_posts_by_author_sql( $post_type, true, $userid, $public_only );
361
362         $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
363
364         /**
365          * Filters the number of posts a user has written.
366          *
367          * @since 2.7.0
368          * @since 4.1.0 Added `$post_type` argument.
369          * @since 4.3.1 Added `$public_only` argument.
370          *
371          * @param int          $count       The user's post count.
372          * @param int          $userid      User ID.
373          * @param string|array $post_type   Single post type or array of post types to count the number of posts for.
374          * @param bool         $public_only Whether to limit counted posts to public posts.
375          */
376         return apply_filters( 'get_usernumposts', $count, $userid, $post_type, $public_only );
377 }
378
379 /**
380  * Number of posts written by a list of users.
381  *
382  * @since 3.0.0
383  *
384  * @global wpdb $wpdb WordPress database abstraction object.
385  *
386  * @param array        $users       Array of user IDs.
387  * @param string|array $post_type   Optional. Single post type or array of post types to check. Defaults to 'post'.
388  * @param bool         $public_only Optional. Only return counts for public posts.  Defaults to false.
389  * @return array Amount of posts each user has written.
390  */
391 function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) {
392         global $wpdb;
393
394         $count = array();
395         if ( empty( $users ) || ! is_array( $users ) )
396                 return $count;
397
398         $userlist = implode( ',', array_map( 'absint', $users ) );
399         $where = get_posts_by_author_sql( $post_type, true, null, $public_only );
400
401         $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N );
402         foreach ( $result as $row ) {
403                 $count[ $row[0] ] = $row[1];
404         }
405
406         foreach ( $users as $id ) {
407                 if ( ! isset( $count[ $id ] ) )
408                         $count[ $id ] = 0;
409         }
410
411         return $count;
412 }
413
414 //
415 // User option functions
416 //
417
418 /**
419  * Get the current user's ID
420  *
421  * @since MU
422  *
423  * @return int The current user's ID
424  */
425 function get_current_user_id() {
426         if ( ! function_exists( 'wp_get_current_user' ) )
427                 return 0;
428         $user = wp_get_current_user();
429         return ( isset( $user->ID ) ? (int) $user->ID : 0 );
430 }
431
432 /**
433  * Retrieve user option that can be either per Site or per Network.
434  *
435  * If the user ID is not given, then the current user will be used instead. If
436  * the user ID is given, then the user data will be retrieved. The filter for
437  * the result, will also pass the original option name and finally the user data
438  * object as the third parameter.
439  *
440  * The option will first check for the per site name and then the per Network name.
441  *
442  * @since 2.0.0
443  *
444  * @global wpdb $wpdb WordPress database abstraction object.
445  *
446  * @param string $option     User option name.
447  * @param int    $user       Optional. User ID.
448  * @param string $deprecated Use get_option() to check for an option in the options table.
449  * @return mixed User option value on success, false on failure.
450  */
451 function get_user_option( $option, $user = 0, $deprecated = '' ) {
452         global $wpdb;
453
454         if ( !empty( $deprecated ) )
455                 _deprecated_argument( __FUNCTION__, '3.0.0' );
456
457         if ( empty( $user ) )
458                 $user = get_current_user_id();
459
460         if ( ! $user = get_userdata( $user ) )
461                 return false;
462
463         $prefix = $wpdb->get_blog_prefix();
464         if ( $user->has_prop( $prefix . $option ) ) // Blog specific
465                 $result = $user->get( $prefix . $option );
466         elseif ( $user->has_prop( $option ) ) // User specific and cross-blog
467                 $result = $user->get( $option );
468         else
469                 $result = false;
470
471         /**
472          * Filters a specific user option value.
473          *
474          * The dynamic portion of the hook name, `$option`, refers to the user option name.
475          *
476          * @since 2.5.0
477          *
478          * @param mixed   $result Value for the user's option.
479          * @param string  $option Name of the option being retrieved.
480          * @param WP_User $user   WP_User object of the user whose option is being retrieved.
481          */
482         return apply_filters( "get_user_option_{$option}", $result, $option, $user );
483 }
484
485 /**
486  * Update user option with global blog capability.
487  *
488  * User options are just like user metadata except that they have support for
489  * global blog options. If the 'global' parameter is false, which it is by default
490  * it will prepend the WordPress table prefix to the option name.
491  *
492  * Deletes the user option if $newvalue is empty.
493  *
494  * @since 2.0.0
495  *
496  * @global wpdb $wpdb WordPress database abstraction object.
497  *
498  * @param int    $user_id     User ID.
499  * @param string $option_name User option name.
500  * @param mixed  $newvalue    User option value.
501  * @param bool   $global      Optional. Whether option name is global or blog specific.
502  *                            Default false (blog specific).
503  * @return int|bool User meta ID if the option didn't exist, true on successful update,
504  *                  false on failure.
505  */
506 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
507         global $wpdb;
508
509         if ( !$global )
510                 $option_name = $wpdb->get_blog_prefix() . $option_name;
511
512         return update_user_meta( $user_id, $option_name, $newvalue );
513 }
514
515 /**
516  * Delete user option with global blog capability.
517  *
518  * User options are just like user metadata except that they have support for
519  * global blog options. If the 'global' parameter is false, which it is by default
520  * it will prepend the WordPress table prefix to the option name.
521  *
522  * @since 3.0.0
523  *
524  * @global wpdb $wpdb WordPress database abstraction object.
525  *
526  * @param int    $user_id     User ID
527  * @param string $option_name User option name.
528  * @param bool   $global      Optional. Whether option name is global or blog specific.
529  *                            Default false (blog specific).
530  * @return bool True on success, false on failure.
531  */
532 function delete_user_option( $user_id, $option_name, $global = false ) {
533         global $wpdb;
534
535         if ( !$global )
536                 $option_name = $wpdb->get_blog_prefix() . $option_name;
537         return delete_user_meta( $user_id, $option_name );
538 }
539
540 /**
541  * Retrieve list of users matching criteria.
542  *
543  * @since 3.1.0
544  *
545  * @see WP_User_Query
546  *
547  * @param array $args Optional. Arguments to retrieve users. See WP_User_Query::prepare_query().
548  *                    for more information on accepted arguments.
549  * @return array List of users.
550  */
551 function get_users( $args = array() ) {
552
553         $args = wp_parse_args( $args );
554         $args['count_total'] = false;
555
556         $user_search = new WP_User_Query($args);
557
558         return (array) $user_search->get_results();
559 }
560
561 /**
562  * Get the blogs a user belongs to.
563  *
564  * @since 3.0.0
565  *
566  * @global wpdb $wpdb WordPress database abstraction object.
567  *
568  * @param int  $user_id User ID
569  * @param bool $all     Whether to retrieve all blogs, or only blogs that are not
570  *                      marked as deleted, archived, or spam.
571  * @return array A list of the user's blogs. An empty array if the user doesn't exist
572  *               or belongs to no blogs.
573  */
574 function get_blogs_of_user( $user_id, $all = false ) {
575         global $wpdb;
576
577         $user_id = (int) $user_id;
578
579         // Logged out users can't have blogs
580         if ( empty( $user_id ) )
581                 return array();
582
583         /**
584          * Filters the list of a user's sites before it is populated.
585          *
586          * Passing a non-null value to the filter will effectively short circuit
587          * get_blogs_of_user(), returning that value instead.
588          *
589          * @since 4.6.0
590          *
591          * @param null|array $blogs   An array of WP_Site objects of which the user is a member.
592          * @param int        $user_id User ID.
593          * @param bool       $all     Whether the returned array should contain all sites, including
594          *                            those marked 'deleted', 'archived', or 'spam'. Default false.
595          */
596         $blogs = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
597
598         if ( null !== $blogs ) {
599                 return $blogs;
600         }
601
602         $keys = get_user_meta( $user_id );
603         if ( empty( $keys ) )
604                 return array();
605
606         if ( ! is_multisite() ) {
607                 $blog_id = get_current_blog_id();
608                 $blogs = array( $blog_id => new stdClass );
609                 $blogs[ $blog_id ]->userblog_id = $blog_id;
610                 $blogs[ $blog_id ]->blogname = get_option('blogname');
611                 $blogs[ $blog_id ]->domain = '';
612                 $blogs[ $blog_id ]->path = '';
613                 $blogs[ $blog_id ]->site_id = 1;
614                 $blogs[ $blog_id ]->siteurl = get_option('siteurl');
615                 $blogs[ $blog_id ]->archived = 0;
616                 $blogs[ $blog_id ]->spam = 0;
617                 $blogs[ $blog_id ]->deleted = 0;
618                 return $blogs;
619         }
620
621         $blogs = array();
622
623         if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
624                 $blog = get_blog_details( 1 );
625                 if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
626                         $blogs[ 1 ] = (object) array(
627                                 'userblog_id' => 1,
628                                 'blogname'    => $blog->blogname,
629                                 'domain'      => $blog->domain,
630                                 'path'        => $blog->path,
631                                 'site_id'     => $blog->site_id,
632                                 'siteurl'     => $blog->siteurl,
633                                 'archived'    => $blog->archived,
634                                 'mature'      => $blog->mature,
635                                 'spam'        => $blog->spam,
636                                 'deleted'     => $blog->deleted,
637                         );
638                 }
639                 unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
640         }
641
642         $keys = array_keys( $keys );
643
644         foreach ( $keys as $key ) {
645                 if ( 'capabilities' !== substr( $key, -12 ) )
646                         continue;
647                 if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) )
648                         continue;
649                 $blog_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
650                 if ( ! is_numeric( $blog_id ) )
651                         continue;
652
653                 $blog_id = (int) $blog_id;
654                 $blog = get_blog_details( $blog_id );
655                 if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
656                         $blogs[ $blog_id ] = (object) array(
657                                 'userblog_id' => $blog_id,
658                                 'blogname'    => $blog->blogname,
659                                 'domain'      => $blog->domain,
660                                 'path'        => $blog->path,
661                                 'site_id'     => $blog->site_id,
662                                 'siteurl'     => $blog->siteurl,
663                                 'archived'    => $blog->archived,
664                                 'mature'      => $blog->mature,
665                                 'spam'        => $blog->spam,
666                                 'deleted'     => $blog->deleted,
667                         );
668                 }
669         }
670
671         /**
672          * Filters the list of blogs a user belongs to.
673          *
674          * @since MU
675          *
676          * @param array $blogs   An array of blog objects belonging to the user.
677          * @param int   $user_id User ID.
678          * @param bool  $all     Whether the returned blogs array should contain all blogs, including
679          *                       those marked 'deleted', 'archived', or 'spam'. Default false.
680          */
681         return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all );
682 }
683
684 /**
685  * Find out whether a user is a member of a given blog.
686  *
687  * @since MU 1.1
688  *
689  * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
690  * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
691  * @return bool
692  */
693 function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
694         global $wpdb;
695
696         $user_id = (int) $user_id;
697         $blog_id = (int) $blog_id;
698
699         if ( empty( $user_id ) ) {
700                 $user_id = get_current_user_id();
701         }
702
703         // Technically not needed, but does save calls to get_blog_details and get_user_meta
704         // in the event that the function is called when a user isn't logged in
705         if ( empty( $user_id ) ) {
706                 return false;
707         } else {
708                 $user = get_userdata( $user_id );
709                 if ( ! $user instanceof WP_User ) {
710                         return false;
711                 }
712         }
713
714         if ( ! is_multisite() ) {
715                 return true;
716         }
717
718         if ( empty( $blog_id ) ) {
719                 $blog_id = get_current_blog_id();
720         }
721
722         $blog = get_blog_details( $blog_id );
723
724         if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) {
725                 return false;
726         }
727
728         $keys = get_user_meta( $user_id );
729         if ( empty( $keys ) ) {
730                 return false;
731         }
732
733         // no underscore before capabilities in $base_capabilities_key
734         $base_capabilities_key = $wpdb->base_prefix . 'capabilities';
735         $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
736
737         if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) {
738                 return true;
739         }
740
741         if ( isset( $keys[ $site_capabilities_key ] ) ) {
742                 return true;
743         }
744
745         return false;
746 }
747
748 /**
749  * Add meta data field to a user.
750  *
751  * Post meta data is called "Custom Fields" on the Administration Screens.
752  *
753  * @since 3.0.0
754  * @link https://codex.wordpress.org/Function_Reference/add_user_meta
755  *
756  * @param int    $user_id    User ID.
757  * @param string $meta_key   Metadata name.
758  * @param mixed  $meta_value Metadata value.
759  * @param bool   $unique     Optional, default is false. Whether the same key should not be added.
760  * @return int|false Meta ID on success, false on failure.
761  */
762 function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
763         return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
764 }
765
766 /**
767  * Remove metadata matching criteria from a user.
768  *
769  * You can match based on the key, or key and value. Removing based on key and
770  * value, will keep from removing duplicate metadata with the same key. It also
771  * allows removing all metadata matching key, if needed.
772  *
773  * @since 3.0.0
774  * @link https://codex.wordpress.org/Function_Reference/delete_user_meta
775  *
776  * @param int    $user_id    User ID
777  * @param string $meta_key   Metadata name.
778  * @param mixed  $meta_value Optional. Metadata value.
779  * @return bool True on success, false on failure.
780  */
781 function delete_user_meta($user_id, $meta_key, $meta_value = '') {
782         return delete_metadata('user', $user_id, $meta_key, $meta_value);
783 }
784
785 /**
786  * Retrieve user meta field for a user.
787  *
788  * @since 3.0.0
789  * @link https://codex.wordpress.org/Function_Reference/get_user_meta
790  *
791  * @param int    $user_id User ID.
792  * @param string $key     Optional. The meta key to retrieve. By default, returns data for all keys.
793  * @param bool   $single  Whether to return a single value.
794  * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
795  */
796 function get_user_meta($user_id, $key = '', $single = false) {
797         return get_metadata('user', $user_id, $key, $single);
798 }
799
800 /**
801  * Update user meta field based on user ID.
802  *
803  * Use the $prev_value parameter to differentiate between meta fields with the
804  * same key and user ID.
805  *
806  * If the meta field for the user does not exist, it will be added.
807  *
808  * @since 3.0.0
809  * @link https://codex.wordpress.org/Function_Reference/update_user_meta
810  *
811  * @param int    $user_id    User ID.
812  * @param string $meta_key   Metadata key.
813  * @param mixed  $meta_value Metadata value.
814  * @param mixed  $prev_value Optional. Previous value to check before removing.
815  * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
816  */
817 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
818         return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
819 }
820
821 /**
822  * Count number of users who have each of the user roles.
823  *
824  * Assumes there are neither duplicated nor orphaned capabilities meta_values.
825  * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query()
826  * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
827  * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
828  *
829  * @since 3.0.0
830  * @since 4.4.0 The number of users with no role is now included in the `none` element.
831  *
832  * @global wpdb $wpdb WordPress database abstraction object.
833  *
834  * @param string $strategy 'time' or 'memory'
835  * @return array Includes a grand total and an array of counts indexed by role strings.
836  */
837 function count_users($strategy = 'time') {
838         global $wpdb;
839
840         // Initialize
841         $id = get_current_blog_id();
842         $blog_prefix = $wpdb->get_blog_prefix($id);
843         $result = array();
844
845         if ( 'time' == $strategy ) {
846                 $avail_roles = wp_roles()->get_names();
847
848                 // Build a CPU-intensive query that will return concise information.
849                 $select_count = array();
850                 foreach ( $avail_roles as $this_role => $name ) {
851                         $select_count[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%');
852                 }
853                 $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))";
854                 $select_count = implode(', ', $select_count);
855
856                 // Add the meta_value index to the selection list, then run the query.
857                 $row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
858
859                 // Run the previous loop again to associate results with role names.
860                 $col = 0;
861                 $role_counts = array();
862                 foreach ( $avail_roles as $this_role => $name ) {
863                         $count = (int) $row[$col++];
864                         if ($count > 0) {
865                                 $role_counts[$this_role] = $count;
866                         }
867                 }
868
869                 $role_counts['none'] = (int) $row[$col++];
870
871                 // Get the meta_value index from the end of the result set.
872                 $total_users = (int) $row[$col];
873
874                 $result['total_users'] = $total_users;
875                 $result['avail_roles'] =& $role_counts;
876         } else {
877                 $avail_roles = array(
878                         'none' => 0,
879                 );
880
881                 $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" );
882
883                 foreach ( $users_of_blog as $caps_meta ) {
884                         $b_roles = maybe_unserialize($caps_meta);
885                         if ( ! is_array( $b_roles ) )
886                                 continue;
887                         if ( empty( $b_roles ) ) {
888                                 $avail_roles['none']++;
889                         }
890                         foreach ( $b_roles as $b_role => $val ) {
891                                 if ( isset($avail_roles[$b_role]) ) {
892                                         $avail_roles[$b_role]++;
893                                 } else {
894                                         $avail_roles[$b_role] = 1;
895                                 }
896                         }
897                 }
898
899                 $result['total_users'] = count( $users_of_blog );
900                 $result['avail_roles'] =& $avail_roles;
901         }
902
903         if ( is_multisite() ) {
904                 $result['avail_roles']['none'] = 0;
905         }
906
907         return $result;
908 }
909
910 //
911 // Private helper functions
912 //
913
914 /**
915  * Set up global user vars.
916  *
917  * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
918  *
919  * @since 2.0.4
920  *
921  * @global string $user_login    The user username for logging in
922  * @global object $userdata      User data.
923  * @global int    $user_level    The level of the user
924  * @global int    $user_ID       The ID of the user
925  * @global string $user_email    The email address of the user
926  * @global string $user_url      The url in the user's profile
927  * @global string $user_identity The display name of the user
928  *
929  * @param int $for_user_id Optional. User ID to set up global data.
930  */
931 function setup_userdata($for_user_id = '') {
932         global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity;
933
934         if ( '' == $for_user_id )
935                 $for_user_id = get_current_user_id();
936         $user = get_userdata( $for_user_id );
937
938         if ( ! $user ) {
939                 $user_ID = 0;
940                 $user_level = 0;
941                 $userdata = null;
942                 $user_login = $user_email = $user_url = $user_identity = '';
943                 return;
944         }
945
946         $user_ID    = (int) $user->ID;
947         $user_level = (int) $user->user_level;
948         $userdata   = $user;
949         $user_login = $user->user_login;
950         $user_email = $user->user_email;
951         $user_url   = $user->user_url;
952         $user_identity = $user->display_name;
953 }
954
955 /**
956  * Create dropdown HTML content of users.
957  *
958  * The content can either be displayed, which it is by default or retrieved by
959  * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
960  * need to be used; all users will be displayed in that case. Only one can be
961  * used, either 'include' or 'exclude', but not both.
962  *
963  * The available arguments are as follows:
964  *
965  * @since 2.3.0
966  * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
967  *
968  * @global int  $blog_id
969  *
970  * @param array|string $args {
971  *     Optional. Array or string of arguments to generate a drop-down of users.
972  *     See WP_User_Query::prepare_query() for additional available arguments.
973  *
974  *     @type string       $show_option_all         Text to show as the drop-down default (all).
975  *                                                 Default empty.
976  *     @type string       $show_option_none        Text to show as the drop-down default when no
977  *                                                 users were found. Default empty.
978  *     @type int|string   $option_none_value       Value to use for $show_option_non when no users
979  *                                                 were found. Default -1.
980  *     @type string       $hide_if_only_one_author Whether to skip generating the drop-down
981  *                                                 if only one user was found. Default empty.
982  *     @type string       $orderby                 Field to order found users by. Accepts user fields.
983  *                                                 Default 'display_name'.
984  *     @type string       $order                   Whether to order users in ascending or descending
985  *                                                 order. Accepts 'ASC' (ascending) or 'DESC' (descending).
986  *                                                 Default 'ASC'.
987  *     @type array|string $include                 Array or comma-separated list of user IDs to include.
988  *                                                 Default empty.
989  *     @type array|string $exclude                 Array or comma-separated list of user IDs to exclude.
990  *                                                 Default empty.
991  *     @type bool|int     $multi                   Whether to skip the ID attribute on the 'select' element.
992  *                                                 Accepts 1|true or 0|false. Default 0|false.
993  *     @type string       $show                    User data to display. If the selected item is empty
994  *                                                 then the 'user_login' will be displayed in parentheses.
995  *                                                 Accepts any user field, or 'display_name_with_login' to show
996  *                                                 the display name with user_login in parentheses.
997  *                                                 Default 'display_name'.
998  *     @type int|bool     $echo                    Whether to echo or return the drop-down. Accepts 1|true (echo)
999  *                                                 or 0|false (return). Default 1|true.
1000  *     @type int          $selected                Which user ID should be selected. Default 0.
1001  *     @type bool         $include_selected        Whether to always include the selected user ID in the drop-
1002  *                                                 down. Default false.
1003  *     @type string       $name                    Name attribute of select element. Default 'user'.
1004  *     @type string       $id                      ID attribute of the select element. Default is the value of $name.
1005  *     @type string       $class                   Class attribute of the select element. Default empty.
1006  *     @type int          $blog_id                 ID of blog (Multisite only). Default is ID of the current blog.
1007  *     @type string       $who                     Which type of users to query. Accepts only an empty string or
1008  *                                                 'authors'. Default empty.
1009  * }
1010  * @return string String of HTML content.
1011  */
1012 function wp_dropdown_users( $args = '' ) {
1013         $defaults = array(
1014                 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
1015                 'orderby' => 'display_name', 'order' => 'ASC',
1016                 'include' => '', 'exclude' => '', 'multi' => 0,
1017                 'show' => 'display_name', 'echo' => 1,
1018                 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
1019                 'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false,
1020                 'option_none_value' => -1
1021         );
1022
1023         $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
1024
1025         $r = wp_parse_args( $args, $defaults );
1026
1027         $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
1028
1029         $fields = array( 'ID', 'user_login' );
1030
1031         $show = ! empty( $r['show'] ) ? $r['show'] : 'display_name';
1032         if ( 'display_name_with_login' === $show ) {
1033                 $fields[] = 'display_name';
1034         } else {
1035                 $fields[] = $show;
1036         }
1037
1038         $query_args['fields'] = $fields;
1039
1040         $show_option_all = $r['show_option_all'];
1041         $show_option_none = $r['show_option_none'];
1042         $option_none_value = $r['option_none_value'];
1043
1044         /**
1045          * Filters the query arguments for the user drop-down.
1046          *
1047          * @since 4.4.0
1048          *
1049          * @param array $query_args The query arguments for wp_dropdown_users().
1050          * @param array $r          The default arguments for wp_dropdown_users().
1051          */
1052         $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $r );
1053
1054         $users = get_users( $query_args );
1055
1056         $output = '';
1057         if ( ! empty( $users ) && ( empty( $r['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
1058                 $name = esc_attr( $r['name'] );
1059                 if ( $r['multi'] && ! $r['id'] ) {
1060                         $id = '';
1061                 } else {
1062                         $id = $r['id'] ? " id='" . esc_attr( $r['id'] ) . "'" : " id='$name'";
1063                 }
1064                 $output = "<select name='{$name}'{$id} class='" . $r['class'] . "'>\n";
1065
1066                 if ( $show_option_all ) {
1067                         $output .= "\t<option value='0'>$show_option_all</option>\n";
1068                 }
1069
1070                 if ( $show_option_none ) {
1071                         $_selected = selected( $option_none_value, $r['selected'], false );
1072                         $output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n";
1073                 }
1074
1075                 if ( $r['include_selected'] && ( $r['selected'] > 0 ) ) {
1076                         $found_selected = false;
1077                         $r['selected'] = (int) $r['selected'];
1078                         foreach ( (array) $users as $user ) {
1079                                 $user->ID = (int) $user->ID;
1080                                 if ( $user->ID === $r['selected'] ) {
1081                                         $found_selected = true;
1082                                 }
1083                         }
1084
1085                         if ( ! $found_selected ) {
1086                                 $users[] = get_userdata( $r['selected'] );
1087                         }
1088                 }
1089
1090                 foreach ( (array) $users as $user ) {
1091                         if ( 'display_name_with_login' === $show ) {
1092                                 /* translators: 1: display name, 2: user_login */
1093                                 $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login );
1094                         } elseif ( ! empty( $user->$show ) ) {
1095                                 $display = $user->$show;
1096                         } else {
1097                                 $display = '(' . $user->user_login . ')';
1098                         }
1099
1100                         $_selected = selected( $user->ID, $r['selected'], false );
1101                         $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
1102                 }
1103
1104                 $output .= "</select>";
1105         }
1106
1107         /**
1108          * Filters the wp_dropdown_users() HTML output.
1109          *
1110          * @since 2.3.0
1111          *
1112          * @param string $output HTML output generated by wp_dropdown_users().
1113          */
1114         $html = apply_filters( 'wp_dropdown_users', $output );
1115
1116         if ( $r['echo'] ) {
1117                 echo $html;
1118         }
1119         return $html;
1120 }
1121
1122 /**
1123  * Sanitize user field based on context.
1124  *
1125  * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1126  * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1127  * when calling filters.
1128  *
1129  * @since 2.3.0
1130  *
1131  * @param string $field   The user Object field name.
1132  * @param mixed  $value   The user Object value.
1133  * @param int    $user_id User ID.
1134  * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
1135  *                        'attribute' and 'js'.
1136  * @return mixed Sanitized value.
1137  */
1138 function sanitize_user_field($field, $value, $user_id, $context) {
1139         $int_fields = array('ID');
1140         if ( in_array($field, $int_fields) )
1141                 $value = (int) $value;
1142
1143         if ( 'raw' == $context )
1144                 return $value;
1145
1146         if ( !is_string($value) && !is_numeric($value) )
1147                 return $value;
1148
1149         $prefixed = false !== strpos( $field, 'user_' );
1150
1151         if ( 'edit' == $context ) {
1152                 if ( $prefixed ) {
1153
1154                         /** This filter is documented in wp-includes/post.php */
1155                         $value = apply_filters( "edit_{$field}", $value, $user_id );
1156                 } else {
1157
1158                         /**
1159                          * Filters a user field value in the 'edit' context.
1160                          *
1161                          * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1162                          * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1163                          *
1164                          * @since 2.9.0
1165                          *
1166                          * @param mixed $value   Value of the prefixed user field.
1167                          * @param int   $user_id User ID.
1168                          */
1169                         $value = apply_filters( "edit_user_{$field}", $value, $user_id );
1170                 }
1171
1172                 if ( 'description' == $field )
1173                         $value = esc_html( $value ); // textarea_escaped?
1174                 else
1175                         $value = esc_attr($value);
1176         } elseif ( 'db' == $context ) {
1177                 if ( $prefixed ) {
1178                         /** This filter is documented in wp-includes/post.php */
1179                         $value = apply_filters( "pre_{$field}", $value );
1180                 } else {
1181
1182                         /**
1183                          * Filters the value of a user field in the 'db' context.
1184                          *
1185                          * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1186                          * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1187                          *
1188                          * @since 2.9.0
1189                          *
1190                          * @param mixed $value Value of the prefixed user field.
1191                          */
1192                         $value = apply_filters( "pre_user_{$field}", $value );
1193                 }
1194         } else {
1195                 // Use display filters by default.
1196                 if ( $prefixed ) {
1197
1198                         /** This filter is documented in wp-includes/post.php */
1199                         $value = apply_filters( $field, $value, $user_id, $context );
1200                 } else {
1201
1202                         /**
1203                          * Filters the value of a user field in a standard context.
1204                          *
1205                          * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1206                          * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1207                          *
1208                          * @since 2.9.0
1209                          *
1210                          * @param mixed  $value   The user object value to sanitize.
1211                          * @param int    $user_id User ID.
1212                          * @param string $context The context to filter within.
1213                          */
1214                         $value = apply_filters( "user_{$field}", $value, $user_id, $context );
1215                 }
1216         }
1217
1218         if ( 'user_url' == $field )
1219                 $value = esc_url($value);
1220
1221         if ( 'attribute' == $context ) {
1222                 $value = esc_attr( $value );
1223         } elseif ( 'js' == $context ) {
1224                 $value = esc_js( $value );
1225         }
1226         return $value;
1227 }
1228
1229 /**
1230  * Update all user caches
1231  *
1232  * @since 3.0.0
1233  *
1234  * @param object|WP_User $user User object to be cached
1235  * @return bool|null Returns false on failure.
1236  */
1237 function update_user_caches( $user ) {
1238         if ( $user instanceof WP_User ) {
1239                 if ( ! $user->exists() ) {
1240                         return false;
1241                 }
1242
1243                 $user = $user->data;
1244         }
1245
1246         wp_cache_add($user->ID, $user, 'users');
1247         wp_cache_add($user->user_login, $user->ID, 'userlogins');
1248         wp_cache_add($user->user_email, $user->ID, 'useremail');
1249         wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
1250 }
1251
1252 /**
1253  * Clean all user caches
1254  *
1255  * @since 3.0.0
1256  * @since 4.4.0 'clean_user_cache' action was added.
1257  *
1258  * @param WP_User|int $user User object or ID to be cleaned from the cache
1259  */
1260 function clean_user_cache( $user ) {
1261         if ( is_numeric( $user ) )
1262                 $user = new WP_User( $user );
1263
1264         if ( ! $user->exists() )
1265                 return;
1266
1267         wp_cache_delete( $user->ID, 'users' );
1268         wp_cache_delete( $user->user_login, 'userlogins' );
1269         wp_cache_delete( $user->user_email, 'useremail' );
1270         wp_cache_delete( $user->user_nicename, 'userslugs' );
1271
1272         /**
1273          * Fires immediately after the given user's cache is cleaned.
1274          *
1275          * @since 4.4.0
1276          *
1277          * @param int     $user_id User ID.
1278          * @param WP_User $user    User object.
1279          */
1280         do_action( 'clean_user_cache', $user->ID, $user );
1281 }
1282
1283 /**
1284  * Checks whether the given username exists.
1285  *
1286  * @since 2.0.0
1287  *
1288  * @param string $username Username.
1289  * @return int|false The user's ID on success, and false on failure.
1290  */
1291 function username_exists( $username ) {
1292         if ( $user = get_user_by( 'login', $username ) ) {
1293                 return $user->ID;
1294         }
1295         return false;
1296 }
1297
1298 /**
1299  * Checks whether the given email exists.
1300  *
1301  * @since 2.1.0
1302  *
1303  * @param string $email Email.
1304  * @return int|false The user's ID on success, and false on failure.
1305  */
1306 function email_exists( $email ) {
1307         if ( $user = get_user_by( 'email', $email) ) {
1308                 return $user->ID;
1309         }
1310         return false;
1311 }
1312
1313 /**
1314  * Checks whether a username is valid.
1315  *
1316  * @since 2.0.1
1317  * @since 4.4.0 Empty sanitized usernames are now considered invalid
1318  *
1319  * @param string $username Username.
1320  * @return bool Whether username given is valid
1321  */
1322 function validate_username( $username ) {
1323         $sanitized = sanitize_user( $username, true );
1324         $valid = ( $sanitized == $username && ! empty( $sanitized ) );
1325
1326         /**
1327          * Filters whether the provided username is valid or not.
1328          *
1329          * @since 2.0.1
1330          *
1331          * @param bool   $valid    Whether given username is valid.
1332          * @param string $username Username to check.
1333          */
1334         return apply_filters( 'validate_username', $valid, $username );
1335 }
1336
1337 /**
1338  * Insert a user into the database.
1339  *
1340  * Most of the `$userdata` array fields have filters associated with the values. Exceptions are
1341  * 'ID', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl',
1342  * 'user_registered', and 'role'. The filters have the prefix 'pre_user_' followed by the field
1343  * name. An example using 'description' would have the filter called, 'pre_user_description' that
1344  * can be hooked into.
1345  *
1346  * @since 2.0.0
1347  * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact
1348  *              methods for new installs. See wp_get_user_contact_methods().
1349  *
1350  * @global wpdb $wpdb WordPress database abstraction object.
1351  *
1352  * @param array|object|WP_User $userdata {
1353  *     An array, object, or WP_User object of user data arguments.
1354  *
1355  *     @type int         $ID                   User ID. If supplied, the user will be updated.
1356  *     @type string      $user_pass            The plain-text user password.
1357  *     @type string      $user_login           The user's login username.
1358  *     @type string      $user_nicename        The URL-friendly user name.
1359  *     @type string      $user_url             The user URL.
1360  *     @type string      $user_email           The user email address.
1361  *     @type string      $display_name         The user's display name.
1362  *                                             Default is the user's username.
1363  *     @type string      $nickname             The user's nickname.
1364  *                                             Default is the user's username.
1365  *     @type string      $first_name           The user's first name. For new users, will be used
1366  *                                             to build the first part of the user's display name
1367  *                                             if `$display_name` is not specified.
1368  *     @type string      $last_name            The user's last name. For new users, will be used
1369  *                                             to build the second part of the user's display name
1370  *                                             if `$display_name` is not specified.
1371  *     @type string      $description          The user's biographical description.
1372  *     @type string|bool $rich_editing         Whether to enable the rich-editor for the user.
1373  *                                             False if not empty.
1374  *     @type string|bool $comment_shortcuts    Whether to enable comment moderation keyboard
1375  *                                             shortcuts for the user. Default false.
1376  *     @type string      $admin_color          Admin color scheme for the user. Default 'fresh'.
1377  *     @type bool        $use_ssl              Whether the user should always access the admin over
1378  *                                             https. Default false.
1379  *     @type string      $user_registered      Date the user registered. Format is 'Y-m-d H:i:s'.
1380  *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
1381  *                                             site's front end. Default true.
1382  *     @type string      $role                 User's role.
1383  * }
1384  * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1385  *                      be created.
1386  */
1387 function wp_insert_user( $userdata ) {
1388         global $wpdb;
1389
1390         if ( $userdata instanceof stdClass ) {
1391                 $userdata = get_object_vars( $userdata );
1392         } elseif ( $userdata instanceof WP_User ) {
1393                 $userdata = $userdata->to_array();
1394         }
1395
1396         // Are we updating or creating?
1397         if ( ! empty( $userdata['ID'] ) ) {
1398                 $ID = (int) $userdata['ID'];
1399                 $update = true;
1400                 $old_user_data = get_userdata( $ID );
1401
1402                 if ( ! $old_user_data ) {
1403                         return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1404                 }
1405
1406                 // hashed in wp_update_user(), plaintext if called directly
1407                 $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass;
1408         } else {
1409                 $update = false;
1410                 // Hash the password
1411                 $user_pass = wp_hash_password( $userdata['user_pass'] );
1412         }
1413
1414         $sanitized_user_login = sanitize_user( $userdata['user_login'], true );
1415
1416         /**
1417          * Filters a username after it has been sanitized.
1418          *
1419          * This filter is called before the user is created or updated.
1420          *
1421          * @since 2.0.3
1422          *
1423          * @param string $sanitized_user_login Username after it has been sanitized.
1424          */
1425         $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login );
1426
1427         //Remove any non-printable chars from the login string to see if we have ended up with an empty username
1428         $user_login = trim( $pre_user_login );
1429
1430         // user_login must be between 0 and 60 characters.
1431         if ( empty( $user_login ) ) {
1432                 return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
1433         } elseif ( mb_strlen( $user_login ) > 60 ) {
1434                 return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) );
1435         }
1436
1437         if ( ! $update && username_exists( $user_login ) ) {
1438                 return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
1439         }
1440
1441         /**
1442          * Filters the list of blacklisted usernames.
1443          *
1444          * @since 4.4.0
1445          *
1446          * @param array $usernames Array of blacklisted usernames.
1447          */
1448         $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
1449
1450         if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ) ) ) {
1451                 return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) );
1452         }
1453
1454         /*
1455          * If a nicename is provided, remove unsafe user characters before using it.
1456          * Otherwise build a nicename from the user_login.
1457          */
1458         if ( ! empty( $userdata['user_nicename'] ) ) {
1459                 $user_nicename = sanitize_user( $userdata['user_nicename'], true );
1460                 if ( mb_strlen( $user_nicename ) > 50 ) {
1461                         return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) );
1462                 }
1463         } else {
1464                 $user_nicename = mb_substr( $user_login, 0, 50 );
1465         }
1466
1467         $user_nicename = sanitize_title( $user_nicename );
1468
1469         // Store values to save in user meta.
1470         $meta = array();
1471
1472         /**
1473          * Filters a user's nicename before the user is created or updated.
1474          *
1475          * @since 2.0.3
1476          *
1477          * @param string $user_nicename The user's nicename.
1478          */
1479         $user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
1480
1481         $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url'];
1482
1483         /**
1484          * Filters a user's URL before the user is created or updated.
1485          *
1486          * @since 2.0.3
1487          *
1488          * @param string $raw_user_url The user's URL.
1489          */
1490         $user_url = apply_filters( 'pre_user_url', $raw_user_url );
1491
1492         $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email'];
1493
1494         /**
1495          * Filters a user's email before the user is created or updated.
1496          *
1497          * @since 2.0.3
1498          *
1499          * @param string $raw_user_email The user's email.
1500          */
1501         $user_email = apply_filters( 'pre_user_email', $raw_user_email );
1502
1503         /*
1504          * If there is no update, just check for `email_exists`. If there is an update,
1505          * check if current email and new email are the same, or not, and check `email_exists`
1506          * accordingly.
1507          */
1508         if ( ( ! $update || ( ! empty( $old_user_data ) && 0 !== strcasecmp( $user_email, $old_user_data->user_email ) ) )
1509                 && ! defined( 'WP_IMPORTING' )
1510                 && email_exists( $user_email )
1511         ) {
1512                 return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
1513         }
1514         $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname'];
1515
1516         /**
1517          * Filters a user's nickname before the user is created or updated.
1518          *
1519          * @since 2.0.3
1520          *
1521          * @param string $nickname The user's nickname.
1522          */
1523         $meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname );
1524
1525         $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name'];
1526
1527         /**
1528          * Filters a user's first name before the user is created or updated.
1529          *
1530          * @since 2.0.3
1531          *
1532          * @param string $first_name The user's first name.
1533          */
1534         $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name );
1535
1536         $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name'];
1537
1538         /**
1539          * Filters a user's last name before the user is created or updated.
1540          *
1541          * @since 2.0.3
1542          *
1543          * @param string $last_name The user's last name.
1544          */
1545         $meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name );
1546
1547         if ( empty( $userdata['display_name'] ) ) {
1548                 if ( $update ) {
1549                         $display_name = $user_login;
1550                 } elseif ( $meta['first_name'] && $meta['last_name'] ) {
1551                         /* translators: 1: first name, 2: last name */
1552                         $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $meta['first_name'], $meta['last_name'] );
1553                 } elseif ( $meta['first_name'] ) {
1554                         $display_name = $meta['first_name'];
1555                 } elseif ( $meta['last_name'] ) {
1556                         $display_name = $meta['last_name'];
1557                 } else {
1558                         $display_name = $user_login;
1559                 }
1560         } else {
1561                 $display_name = $userdata['display_name'];
1562         }
1563
1564         /**
1565          * Filters a user's display name before the user is created or updated.
1566          *
1567          * @since 2.0.3
1568          *
1569          * @param string $display_name The user's display name.
1570          */
1571         $display_name = apply_filters( 'pre_user_display_name', $display_name );
1572
1573         $description = empty( $userdata['description'] ) ? '' : $userdata['description'];
1574
1575         /**
1576          * Filters a user's description before the user is created or updated.
1577          *
1578          * @since 2.0.3
1579          *
1580          * @param string $description The user's description.
1581          */
1582         $meta['description'] = apply_filters( 'pre_user_description', $description );
1583
1584         $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing'];
1585
1586         $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true';
1587
1588         $admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color'];
1589         $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color );
1590
1591         $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : $userdata['use_ssl'];
1592
1593         $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered'];
1594
1595         $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front'];
1596
1597         $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));
1598
1599         if ( $user_nicename_check ) {
1600                 $suffix = 2;
1601                 while ($user_nicename_check) {
1602                         // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix.
1603                         $base_length = 49 - mb_strlen( $suffix );
1604                         $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix";
1605                         $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));
1606                         $suffix++;
1607                 }
1608                 $user_nicename = $alt_user_nicename;
1609         }
1610
1611         $compacted = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
1612         $data = wp_unslash( $compacted );
1613
1614         if ( $update ) {
1615                 if ( $user_email !== $old_user_data->user_email ) {
1616                         $data['user_activation_key'] = '';
1617                 }
1618                 $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
1619                 $user_id = (int) $ID;
1620         } else {
1621                 $wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) );
1622                 $user_id = (int) $wpdb->insert_id;
1623         }
1624
1625         $user = new WP_User( $user_id );
1626
1627         /**
1628          * Filters a user's meta values and keys before the user is created or updated.
1629          *
1630          * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`.
1631          *
1632          * @since 4.4.0
1633          *
1634          * @param array $meta {
1635          *     Default meta values and keys for the user.
1636          *
1637          *     @type string   $nickname             The user's nickname. Default is the user's username.
1638          *     @type string   $first_name           The user's first name.
1639          *     @type string   $last_name            The user's last name.
1640          *     @type string   $description          The user's description.
1641          *     @type bool     $rich_editing         Whether to enable the rich-editor for the user. False if not empty.
1642          *     @type bool     $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default false.
1643          *     @type string   $admin_color          The color scheme for a user's admin screen. Default 'fresh'.
1644          *     @type int|bool $use_ssl              Whether to force SSL on the user's admin area. 0|false if SSL is
1645          *                                          not forced.
1646          *     @type bool     $show_admin_bar_front Whether to show the admin bar on the front end for the user.
1647          *                                          Default true.
1648          * }
1649          * @param WP_User $user   User object.
1650          * @param bool    $update Whether the user is being updated rather than created.
1651          */
1652         $meta = apply_filters( 'insert_user_meta', $meta, $user, $update );
1653
1654         // Update user meta.
1655         foreach ( $meta as $key => $value ) {
1656                 update_user_meta( $user_id, $key, $value );
1657         }
1658
1659         foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) {
1660                 if ( isset( $userdata[ $key ] ) ) {
1661                         update_user_meta( $user_id, $key, $userdata[ $key ] );
1662                 }
1663         }
1664
1665         if ( isset( $userdata['role'] ) ) {
1666                 $user->set_role( $userdata['role'] );
1667         } elseif ( ! $update ) {
1668                 $user->set_role(get_option('default_role'));
1669         }
1670         wp_cache_delete( $user_id, 'users' );
1671         wp_cache_delete( $user_login, 'userlogins' );
1672
1673         if ( $update ) {
1674                 /**
1675                  * Fires immediately after an existing user is updated.
1676                  *
1677                  * @since 2.0.0
1678                  *
1679                  * @param int    $user_id       User ID.
1680                  * @param object $old_user_data Object containing user's data prior to update.
1681                  */
1682                 do_action( 'profile_update', $user_id, $old_user_data );
1683         } else {
1684                 /**
1685                  * Fires immediately after a new user is registered.
1686                  *
1687                  * @since 1.5.0
1688                  *
1689                  * @param int $user_id User ID.
1690                  */
1691                 do_action( 'user_register', $user_id );
1692         }
1693
1694         return $user_id;
1695 }
1696
1697 /**
1698  * Update a user in the database.
1699  *
1700  * It is possible to update a user's password by specifying the 'user_pass'
1701  * value in the $userdata parameter array.
1702  *
1703  * If current user's password is being updated, then the cookies will be
1704  * cleared.
1705  *
1706  * @since 2.0.0
1707  *
1708  * @see wp_insert_user() For what fields can be set in $userdata.
1709  *
1710  * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
1711  * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
1712  */
1713 function wp_update_user($userdata) {
1714         if ( $userdata instanceof stdClass ) {
1715                 $userdata = get_object_vars( $userdata );
1716         } elseif ( $userdata instanceof WP_User ) {
1717                 $userdata = $userdata->to_array();
1718         }
1719
1720         $ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
1721         if ( ! $ID ) {
1722                 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1723         }
1724
1725         // First, get all of the original fields
1726         $user_obj = get_userdata( $ID );
1727         if ( ! $user_obj ) {
1728                 return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1729         }
1730
1731         $user = $user_obj->to_array();
1732
1733         // Add additional custom fields
1734         foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
1735                 $user[ $key ] = get_user_meta( $ID, $key, true );
1736         }
1737
1738         // Escape data pulled from DB.
1739         $user = add_magic_quotes( $user );
1740
1741         if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) {
1742                 // If password is changing, hash it now
1743                 $plaintext_pass = $userdata['user_pass'];
1744                 $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] );
1745
1746                 /**
1747                  * Filters whether to send the password change email.
1748                  *
1749                  * @since 4.3.0
1750                  *
1751                  * @see wp_insert_user() For `$user` and `$userdata` fields.
1752                  *
1753                  * @param bool  $send     Whether to send the email.
1754                  * @param array $user     The original user array.
1755                  * @param array $userdata The updated user array.
1756                  *
1757                  */
1758                 $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata );
1759         }
1760
1761         if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) {
1762                 /**
1763                  * Filters whether to send the email change email.
1764                  *
1765                  * @since 4.3.0
1766                  *
1767                  * @see wp_insert_user() For `$user` and `$userdata` fields.
1768                  *
1769                  * @param bool  $send     Whether to send the email.
1770                  * @param array $user     The original user array.
1771                  * @param array $userdata The updated user array.
1772                  *
1773                  */
1774                 $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata );
1775         }
1776
1777         wp_cache_delete( $user['user_email'], 'useremail' );
1778         wp_cache_delete( $user['user_nicename'], 'userslugs' );
1779
1780         // Merge old and new fields with new fields overwriting old ones.
1781         $userdata = array_merge( $user, $userdata );
1782         $user_id = wp_insert_user( $userdata );
1783
1784         if ( ! is_wp_error( $user_id ) ) {
1785
1786                 $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
1787
1788                 if ( ! empty( $send_password_change_email ) ) {
1789
1790                         /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1791                         $pass_change_text = __( 'Hi ###USERNAME###,
1792
1793 This notice confirms that your password was changed on ###SITENAME###.
1794
1795 If you did not change your password, please contact the Site Administrator at
1796 ###ADMIN_EMAIL###
1797
1798 This email has been sent to ###EMAIL###
1799
1800 Regards,
1801 All at ###SITENAME###
1802 ###SITEURL###' );
1803
1804                         $pass_change_email = array(
1805                                 'to'      => $user['user_email'],
1806                                 'subject' => __( '[%s] Notice of Password Change' ),
1807                                 'message' => $pass_change_text,
1808                                 'headers' => '',
1809                         );
1810
1811                         /**
1812                          * Filters the contents of the email sent when the user's password is changed.
1813                          *
1814                          * @since 4.3.0
1815                          *
1816                          * @param array $pass_change_email {
1817                          *            Used to build wp_mail().
1818                          *            @type string $to      The intended recipients. Add emails in a comma separated string.
1819                          *            @type string $subject The subject of the email.
1820                          *            @type string $message The content of the email.
1821                          *                The following strings have a special meaning and will get replaced dynamically:
1822                          *                - ###USERNAME###    The current user's username.
1823                          *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1824                          *                - ###EMAIL###       The old email.
1825                          *                - ###SITENAME###    The name of the site.
1826                          *                - ###SITEURL###     The URL to the site.
1827                          *            @type string $headers Headers. Add headers in a newline (\r\n) separated string.
1828                          *        }
1829                          * @param array $user     The original user array.
1830                          * @param array $userdata The updated user array.
1831                          *
1832                          */
1833                         $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata );
1834
1835                         $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] );
1836                         $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] );
1837                         $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] );
1838                         $pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] );
1839                         $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] );
1840
1841                         wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] );
1842                 }
1843
1844                 if ( ! empty( $send_email_change_email ) ) {
1845                         /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1846                         $email_change_text = __( 'Hi ###USERNAME###,
1847
1848 This notice confirms that your email was changed on ###SITENAME###.
1849
1850 If you did not change your email, please contact the Site Administrator at
1851 ###ADMIN_EMAIL###
1852
1853 This email has been sent to ###EMAIL###
1854
1855 Regards,
1856 All at ###SITENAME###
1857 ###SITEURL###' );
1858
1859                         $email_change_email = array(
1860                                 'to'      => $user['user_email'],
1861                                 'subject' => __( '[%s] Notice of Email Change' ),
1862                                 'message' => $email_change_text,
1863                                 'headers' => '',
1864                         );
1865
1866                         /**
1867                          * Filters the contents of the email sent when the user's email is changed.
1868                          *
1869                          * @since 4.3.0
1870                          *
1871                          * @param array $email_change_email {
1872                          *            Used to build wp_mail().
1873                          *            @type string $to      The intended recipients.
1874                          *            @type string $subject The subject of the email.
1875                          *            @type string $message The content of the email.
1876                          *                The following strings have a special meaning and will get replaced dynamically:
1877                          *                - ###USERNAME###    The current user's username.
1878                          *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1879                          *                - ###EMAIL###       The old email.
1880                          *                - ###SITENAME###    The name of the site.
1881                          *                - ###SITEURL###     The URL to the site.
1882                          *            @type string $headers Headers.
1883                          *        }
1884                          * @param array $user The original user array.
1885                          * @param array $userdata The updated user array.
1886                          */
1887                         $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata );
1888
1889                         $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] );
1890                         $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] );
1891                         $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] );
1892                         $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] );
1893                         $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );
1894
1895                         wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] );
1896                 }
1897         }
1898
1899         // Update the cookies if the password changed.
1900         $current_user = wp_get_current_user();
1901         if ( $current_user->ID == $ID ) {
1902                 if ( isset($plaintext_pass) ) {
1903                         wp_clear_auth_cookie();
1904
1905                         // Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
1906                         // If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
1907                         $logged_in_cookie    = wp_parse_auth_cookie( '', 'logged_in' );
1908                         /** This filter is documented in wp-includes/pluggable.php */
1909                         $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false );
1910                         $remember            = ( ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life );
1911
1912                         wp_set_auth_cookie( $ID, $remember );
1913                 }
1914         }
1915
1916         return $user_id;
1917 }
1918
1919 /**
1920  * A simpler way of inserting a user into the database.
1921  *
1922  * Creates a new user with just the username, password, and email. For more
1923  * complex user creation use wp_insert_user() to specify more information.
1924  *
1925  * @since 2.0.0
1926  * @see wp_insert_user() More complete way to create a new user
1927  *
1928  * @param string $username The user's username.
1929  * @param string $password The user's password.
1930  * @param string $email    Optional. The user's email. Default empty.
1931  * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1932  *                      be created.
1933  */
1934 function wp_create_user($username, $password, $email = '') {
1935         $user_login = wp_slash( $username );
1936         $user_email = wp_slash( $email    );
1937         $user_pass = $password;
1938
1939         $userdata = compact('user_login', 'user_email', 'user_pass');
1940         return wp_insert_user($userdata);
1941 }
1942
1943 /**
1944  * Returns a list of meta keys to be (maybe) populated in wp_update_user().
1945  *
1946  * The list of keys returned via this function are dependent on the presence
1947  * of those keys in the user meta data to be set.
1948  *
1949  * @since 3.3.0
1950  * @access private
1951  *
1952  * @param WP_User $user WP_User instance.
1953  * @return array List of user keys to be populated in wp_update_user().
1954  */
1955 function _get_additional_user_keys( $user ) {
1956         $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' );
1957         return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
1958 }
1959
1960 /**
1961  * Set up the user contact methods.
1962  *
1963  * Default contact methods were removed in 3.6. A filter dictates contact methods.
1964  *
1965  * @since 3.7.0
1966  *
1967  * @param WP_User $user Optional. WP_User object.
1968  * @return array Array of contact methods and their labels.
1969  */
1970 function wp_get_user_contact_methods( $user = null ) {
1971         $methods = array();
1972         if ( get_site_option( 'initial_db_version' ) < 23588 ) {
1973                 $methods = array(
1974                         'aim'    => __( 'AIM' ),
1975                         'yim'    => __( 'Yahoo IM' ),
1976                         'jabber' => __( 'Jabber / Google Talk' )
1977                 );
1978         }
1979
1980         /**
1981          * Filters the user contact methods.
1982          *
1983          * @since 2.9.0
1984          *
1985          * @param array   $methods Array of contact methods and their labels.
1986          * @param WP_User $user    WP_User object.
1987          */
1988         return apply_filters( 'user_contactmethods', $methods, $user );
1989 }
1990
1991 /**
1992  * The old private function for setting up user contact methods.
1993  *
1994  * Use wp_get_user_contact_methods() instead.
1995  *
1996  * @since 2.9.0
1997  * @access private
1998  *
1999  * @param WP_User $user Optional. WP_User object. Default null.
2000  * @return array Array of contact methods and their labels.
2001  */
2002 function _wp_get_user_contactmethods( $user = null ) {
2003         return wp_get_user_contact_methods( $user );
2004 }
2005
2006 /**
2007  * Gets the text suggesting how to create strong passwords.
2008  *
2009  * @since 4.1.0
2010  *
2011  * @return string The password hint text.
2012  */
2013 function wp_get_password_hint() {
2014         $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 ! " ? $ % ^ &amp; ).' );
2015
2016         /**
2017          * Filters the text describing the site's password complexity policy.
2018          *
2019          * @since 4.1.0
2020          *
2021          * @param string $hint The password hint text.
2022          */
2023         return apply_filters( 'password_hint', $hint );
2024 }
2025
2026 /**
2027  * Creates, stores, then returns a password reset key for user.
2028  *
2029  * @since 4.4.0
2030  *
2031  * @global wpdb         $wpdb      WordPress database abstraction object.
2032  * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
2033  *
2034  * @param WP_User $user User to retrieve password reset key for.
2035  *
2036  * @return string|WP_Error Password reset key on success. WP_Error on error.
2037  */
2038 function get_password_reset_key( $user ) {
2039         global $wpdb, $wp_hasher;
2040
2041         /**
2042          * Fires before a new password is retrieved.
2043          *
2044          * Use the {@see 'retrieve_password'} hook instead.
2045          *
2046          * @since 1.5.0
2047          * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
2048          *
2049          * @param string $user_login The user login name.
2050          */
2051         do_action( 'retreive_password', $user->user_login );
2052
2053         /**
2054          * Fires before a new password is retrieved.
2055          *
2056          * @since 1.5.1
2057          *
2058          * @param string $user_login The user login name.
2059          */
2060         do_action( 'retrieve_password', $user->user_login );
2061
2062         $allow = true;
2063         if ( is_multisite() && is_user_spammy( $user ) ) {
2064                 $allow = false;
2065         }
2066
2067         /**
2068          * Filters whether to allow a password to be reset.
2069          *
2070          * @since 2.7.0
2071          *
2072          * @param bool $allow         Whether to allow the password to be reset. Default true.
2073          * @param int  $user_data->ID The ID of the user attempting to reset a password.
2074          */
2075         $allow = apply_filters( 'allow_password_reset', $allow, $user->ID );
2076
2077         if ( ! $allow ) {
2078                 return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );
2079         } elseif ( is_wp_error( $allow ) ) {
2080                 return $allow;
2081         }
2082
2083         // Generate something random for a password reset key.
2084         $key = wp_generate_password( 20, false );
2085
2086         /**
2087          * Fires when a password reset key is generated.
2088          *
2089          * @since 2.5.0
2090          *
2091          * @param string $user_login The username for the user.
2092          * @param string $key        The generated password reset key.
2093          */
2094         do_action( 'retrieve_password_key', $user->user_login, $key );
2095
2096         // Now insert the key, hashed, into the DB.
2097         if ( empty( $wp_hasher ) ) {
2098                 require_once ABSPATH . WPINC . '/class-phpass.php';
2099                 $wp_hasher = new PasswordHash( 8, true );
2100         }
2101         $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
2102         $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
2103         if ( false === $key_saved ) {
2104                 return new WP_Error( 'no_password_key_update', __( 'Could not save password reset key to database.' ) );
2105         }
2106
2107         return $key;
2108 }
2109
2110 /**
2111  * Retrieves a user row based on password reset key and login
2112  *
2113  * A key is considered 'expired' if it exactly matches the value of the
2114  * user_activation_key field, rather than being matched after going through the
2115  * hashing process. This field is now hashed; old values are no longer accepted
2116  * but have a different WP_Error code so good user feedback can be provided.
2117  *
2118  * @since 3.1.0
2119  *
2120  * @global wpdb         $wpdb      WordPress database object for queries.
2121  * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
2122  *
2123  * @param string $key       Hash to validate sending user's password.
2124  * @param string $login     The user login.
2125  * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
2126  */
2127 function check_password_reset_key($key, $login) {
2128         global $wpdb, $wp_hasher;
2129
2130         $key = preg_replace('/[^a-z0-9]/i', '', $key);
2131
2132         if ( empty( $key ) || !is_string( $key ) )
2133                 return new WP_Error('invalid_key', __('Invalid key'));
2134
2135         if ( empty($login) || !is_string($login) )
2136                 return new WP_Error('invalid_key', __('Invalid key'));
2137
2138         $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
2139         if ( ! $row )
2140                 return new WP_Error('invalid_key', __('Invalid key'));
2141
2142         if ( empty( $wp_hasher ) ) {
2143                 require_once ABSPATH . WPINC . '/class-phpass.php';
2144                 $wp_hasher = new PasswordHash( 8, true );
2145         }
2146
2147         /**
2148          * Filters the expiration time of password reset keys.
2149          *
2150          * @since 4.3.0
2151          *
2152          * @param int $expiration The expiration time in seconds.
2153          */
2154         $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS );
2155
2156         if ( false !== strpos( $row->user_activation_key, ':' ) ) {
2157                 list( $pass_request_time, $pass_key ) = explode( ':', $row->user_activation_key, 2 );
2158                 $expiration_time = $pass_request_time + $expiration_duration;
2159         } else {
2160                 $pass_key = $row->user_activation_key;
2161                 $expiration_time = false;
2162         }
2163
2164         if ( ! $pass_key ) {
2165                 return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2166         }
2167
2168         $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key );
2169
2170         if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) {
2171                 return get_userdata( $row->ID );
2172         } elseif ( $hash_is_correct && $expiration_time ) {
2173                 // Key has an expiration time that's passed
2174                 return new WP_Error( 'expired_key', __( 'Invalid key' ) );
2175         }
2176
2177         if ( hash_equals( $row->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) {
2178                 $return = new WP_Error( 'expired_key', __( 'Invalid key' ) );
2179                 $user_id = $row->ID;
2180
2181                 /**
2182                  * Filters the return value of check_password_reset_key() when an
2183                  * old-style key is used.
2184                  *
2185                  * @since 3.7.0 Previously plain-text keys were stored in the database.
2186                  * @since 4.3.0 Previously key hashes were stored without an expiration time.
2187                  *
2188                  * @param WP_Error $return  A WP_Error object denoting an expired key.
2189                  *                          Return a WP_User object to validate the key.
2190                  * @param int      $user_id The matched user ID.
2191                  */
2192                 return apply_filters( 'password_reset_key_expired', $return, $user_id );
2193         }
2194
2195         return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2196 }
2197
2198 /**
2199  * Handles resetting the user's password.
2200  *
2201  * @since 2.5.0
2202  *
2203  * @param object $user     The user
2204  * @param string $new_pass New password for the user in plaintext
2205  */
2206 function reset_password( $user, $new_pass ) {
2207         /**
2208          * Fires before the user's password is reset.
2209          *
2210          * @since 1.5.0
2211          *
2212          * @param object $user     The user.
2213          * @param string $new_pass New user password.
2214          */
2215         do_action( 'password_reset', $user, $new_pass );
2216
2217         wp_set_password( $new_pass, $user->ID );
2218         update_user_option( $user->ID, 'default_password_nag', false, true );
2219
2220         /**
2221          * Fires after the user's password is reset.
2222          *
2223          * @since 4.4.0
2224          *
2225          * @param object $user     The user.
2226          * @param string $new_pass New user password.
2227          */
2228         do_action( 'after_password_reset', $user, $new_pass );
2229 }
2230
2231 /**
2232  * Handles registering a new user.
2233  *
2234  * @since 2.5.0
2235  *
2236  * @param string $user_login User's username for logging in
2237  * @param string $user_email User's email address to send password and add
2238  * @return int|WP_Error Either user's ID or error on failure.
2239  */
2240 function register_new_user( $user_login, $user_email ) {
2241         $errors = new WP_Error();
2242
2243         $sanitized_user_login = sanitize_user( $user_login );
2244         /**
2245          * Filters the email address of a user being registered.
2246          *
2247          * @since 2.1.0
2248          *
2249          * @param string $user_email The email address of the new user.
2250          */
2251         $user_email = apply_filters( 'user_registration_email', $user_email );
2252
2253         // Check the username
2254         if ( $sanitized_user_login == '' ) {
2255                 $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
2256         } elseif ( ! validate_username( $user_login ) ) {
2257                 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) );
2258                 $sanitized_user_login = '';
2259         } elseif ( username_exists( $sanitized_user_login ) ) {
2260                 $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) );
2261
2262         } else {
2263                 /** This filter is documented in wp-includes/user.php */
2264                 $illegal_user_logins = array_map( 'strtolower', (array) apply_filters( 'illegal_user_logins', array() ) );
2265                 if ( in_array( strtolower( $sanitized_user_login ), $illegal_user_logins ) ) {
2266                         $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
2267                 }
2268         }
2269
2270         // Check the email address
2271         if ( $user_email == '' ) {
2272                 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) );
2273         } elseif ( ! is_email( $user_email ) ) {
2274                 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn&#8217;t correct.' ) );
2275                 $user_email = '';
2276         } elseif ( email_exists( $user_email ) ) {
2277                 $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
2278         }
2279
2280         /**
2281          * Fires when submitting registration form data, before the user is created.
2282          *
2283          * @since 2.1.0
2284          *
2285          * @param string   $sanitized_user_login The submitted username after being sanitized.
2286          * @param string   $user_email           The submitted email.
2287          * @param WP_Error $errors               Contains any errors with submitted username and email,
2288          *                                       e.g., an empty field, an invalid username or email,
2289          *                                       or an existing username or email.
2290          */
2291         do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
2292
2293         /**
2294          * Filters the errors encountered when a new user is being registered.
2295          *
2296          * The filtered WP_Error object may, for example, contain errors for an invalid
2297          * or existing username or email address. A WP_Error object should always returned,
2298          * but may or may not contain errors.
2299          *
2300          * If any errors are present in $errors, this will abort the user's registration.
2301          *
2302          * @since 2.1.0
2303          *
2304          * @param WP_Error $errors               A WP_Error object containing any errors encountered
2305          *                                       during registration.
2306          * @param string   $sanitized_user_login User's username after it has been sanitized.
2307          * @param string   $user_email           User's email.
2308          */
2309         $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
2310
2311         if ( $errors->get_error_code() )
2312                 return $errors;
2313
2314         $user_pass = wp_generate_password( 12, false );
2315         $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email );
2316         if ( ! $user_id || is_wp_error( $user_id ) ) {
2317                 $errors->add( 'registerfail', sprintf( __( '<strong>ERROR</strong>: Couldn&#8217;t register you&hellip; please contact the <a href="mailto:%s">webmaster</a> !' ), get_option( 'admin_email' ) ) );
2318                 return $errors;
2319         }
2320
2321         update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
2322
2323         /**
2324          * Fires after a new user registration has been recorded.
2325          *
2326          * @since 4.4.0
2327          *
2328          * @param int $user_id ID of the newly registered user.
2329          */
2330         do_action( 'register_new_user', $user_id );
2331
2332         return $user_id;
2333 }
2334
2335 /**
2336  * Initiates email notifications related to the creation of new users.
2337  *
2338  * Notifications are sent both to the site admin and to the newly created user.
2339  *
2340  * @since 4.4.0
2341  * @since 4.6.0 Converted the `$notify` parameter to accept 'user' for sending
2342  *              notifications only to the user created.
2343  *
2344  * @param int    $user_id ID of the newly created user.
2345  * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin'
2346  *                        or an empty string (admin only), 'user', or 'both' (admin and user).
2347  *                        Default 'both'.
2348  */
2349 function wp_send_new_user_notifications( $user_id, $notify = 'both' ) {
2350         wp_new_user_notification( $user_id, null, $notify );
2351 }
2352
2353 /**
2354  * Retrieve the current session token from the logged_in cookie.
2355  *
2356  * @since 4.0.0
2357  *
2358  * @return string Token.
2359  */
2360 function wp_get_session_token() {
2361         $cookie = wp_parse_auth_cookie( '', 'logged_in' );
2362         return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
2363 }
2364
2365 /**
2366  * Retrieve a list of sessions for the current user.
2367  *
2368  * @since 4.0.0
2369  * @return array Array of sessions.
2370  */
2371 function wp_get_all_sessions() {
2372         $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2373         return $manager->get_all();
2374 }
2375
2376 /**
2377  * Remove the current session token from the database.
2378  *
2379  * @since 4.0.0
2380  */
2381 function wp_destroy_current_session() {
2382         $token = wp_get_session_token();
2383         if ( $token ) {
2384                 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2385                 $manager->destroy( $token );
2386         }
2387 }
2388
2389 /**
2390  * Remove all but the current session token for the current user for the database.
2391  *
2392  * @since 4.0.0
2393  */
2394 function wp_destroy_other_sessions() {
2395         $token = wp_get_session_token();
2396         if ( $token ) {
2397                 $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2398                 $manager->destroy_others( $token );
2399         }
2400 }
2401
2402 /**
2403  * Remove all session tokens for the current user from the database.
2404  *
2405  * @since 4.0.0
2406  */
2407 function wp_destroy_all_sessions() {
2408         $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2409         $manager->destroy_all();
2410 }
2411
2412 /**
2413  * Get the user IDs of all users with no role on this site.
2414  *
2415  * This function returns an empty array when used on Multisite.
2416  *
2417  * @since 4.4.0
2418  *
2419  * @return array Array of user IDs.
2420  */
2421 function wp_get_users_with_no_role() {
2422         global $wpdb;
2423
2424         if ( is_multisite() ) {
2425                 return array();
2426         }
2427
2428         $prefix = $wpdb->get_blog_prefix();
2429         $regex  = implode( '|', wp_roles()->get_names() );
2430         $regex  = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex );
2431         $users  = $wpdb->get_col( $wpdb->prepare( "
2432                 SELECT user_id
2433                 FROM $wpdb->usermeta
2434                 WHERE meta_key = '{$prefix}capabilities'
2435                 AND meta_value NOT REGEXP %s
2436         ", $regex ) );
2437
2438         return $users;
2439 }
2440
2441 /**
2442  * Retrieves the current user object.
2443  *
2444  * Will set the current user, if the current user is not set. The current user
2445  * will be set to the logged-in person. If no user is logged-in, then it will
2446  * set the current user to 0, which is invalid and won't have any permissions.
2447  *
2448  * This function is used by the pluggable functions wp_get_current_user() and
2449  * get_currentuserinfo(), the latter of which is deprecated but used for backward
2450  * compatibility.
2451  *
2452  * @since 4.5.0
2453  * @access private
2454  *
2455  * @see wp_get_current_user()
2456  * @global WP_User $current_user Checks if the current user is set.
2457  *
2458  * @return WP_User Current WP_User instance.
2459  */
2460 function _wp_get_current_user() {
2461         global $current_user;
2462
2463         if ( ! empty( $current_user ) ) {
2464                 if ( $current_user instanceof WP_User ) {
2465                         return $current_user;
2466                 }
2467
2468                 // Upgrade stdClass to WP_User
2469                 if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
2470                         $cur_id = $current_user->ID;
2471                         $current_user = null;
2472                         wp_set_current_user( $cur_id );
2473                         return $current_user;
2474                 }
2475
2476                 // $current_user has a junk value. Force to WP_User with ID 0.
2477                 $current_user = null;
2478                 wp_set_current_user( 0 );
2479                 return $current_user;
2480         }
2481
2482         if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) {
2483                 wp_set_current_user( 0 );
2484                 return $current_user;
2485         }
2486
2487         /**
2488          * Filters the current user.
2489          *
2490          * The default filters use this to determine the current user from the
2491          * request's cookies, if available.
2492          *
2493          * Returning a value of false will effectively short-circuit setting
2494          * the current user.
2495          *
2496          * @since 3.9.0
2497          *
2498          * @param int|bool $user_id User ID if one has been determined, false otherwise.
2499          */
2500         $user_id = apply_filters( 'determine_current_user', false );
2501         if ( ! $user_id ) {
2502                 wp_set_current_user( 0 );
2503                 return $current_user;
2504         }
2505
2506         wp_set_current_user( $user_id );
2507
2508         return $current_user;
2509 }