Make WordPress Core

source: branches/4.5/src/wp-includes/user.php

Last change on this file was 47652, checked in by whyisjake, 2 years ago

User: Invalidate user_activation_key on password update.
Query: Ensure that only a single post can be returned on date/time based queries.
Cache API: Ensure proper escaping around the stats method in the cache API.
Formatting: Expand sanitize_file_name to have better support for utf8 characters.

Brings the changes in [47634], [47635], [47637], and [47638] to the 4.7 branch.

Props: batmoo, ehti, nickdaugherty, peterwilsoncc, sergeybiryukov, sstoqnov, westi, whyisjake, whyisjake, xknown.

  • Property svn:eol-style set to native
File size: 81.2 KB
Line 
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 */
28function 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         * Filter 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 */
118function 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         * Filter 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 */
189function 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 */
262function 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 */
297function wp_authenticate_spam_check( $user ) {
298        if ( $user instanceof WP_User && is_multisite() ) {
299                /**
300                 * Filter 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 );
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 * Validate 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 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 */
330function 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 */
357function 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         * Filter 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 */
391function 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 */
425function 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 */
451function get_user_option( $option, $user = 0, $deprecated = '' ) {
452        global $wpdb;
453
454        if ( !empty( $deprecated ) )
455                _deprecated_argument( __FUNCTION__, '3.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         * Filter 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 */
506function 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 */
532function 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 {@see WP_User_Query::prepare_query()}
548 *                    for more information on accepted arguments.
549 * @return array List of users.
550 */
551function 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 */
574function 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        $keys = get_user_meta( $user_id );
584        if ( empty( $keys ) )
585                return array();
586
587        if ( ! is_multisite() ) {
588                $blog_id = get_current_blog_id();
589                $blogs = array( $blog_id => new stdClass );
590                $blogs[ $blog_id ]->userblog_id = $blog_id;
591                $blogs[ $blog_id ]->blogname = get_option('blogname');
592                $blogs[ $blog_id ]->domain = '';
593                $blogs[ $blog_id ]->path = '';
594                $blogs[ $blog_id ]->site_id = 1;
595                $blogs[ $blog_id ]->siteurl = get_option('siteurl');
596                $blogs[ $blog_id ]->archived = 0;
597                $blogs[ $blog_id ]->spam = 0;
598                $blogs[ $blog_id ]->deleted = 0;
599                return $blogs;
600        }
601
602        $blogs = array();
603
604        if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
605                $blog = get_blog_details( 1 );
606                if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
607                        $blogs[ 1 ] = (object) array(
608                                'userblog_id' => 1,
609                                'blogname'    => $blog->blogname,
610                                'domain'      => $blog->domain,
611                                'path'        => $blog->path,
612                                'site_id'     => $blog->site_id,
613                                'siteurl'     => $blog->siteurl,
614                                'archived'    => $blog->archived,
615                                'mature'      => $blog->mature,
616                                'spam'        => $blog->spam,
617                                'deleted'     => $blog->deleted,
618                        );
619                }
620                unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
621        }
622
623        $keys = array_keys( $keys );
624
625        foreach ( $keys as $key ) {
626                if ( 'capabilities' !== substr( $key, -12 ) )
627                        continue;
628                if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) )
629                        continue;
630                $blog_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
631                if ( ! is_numeric( $blog_id ) )
632                        continue;
633
634                $blog_id = (int) $blog_id;
635                $blog = get_blog_details( $blog_id );
636                if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
637                        $blogs[ $blog_id ] = (object) array(
638                                'userblog_id' => $blog_id,
639                                'blogname'    => $blog->blogname,
640                                'domain'      => $blog->domain,
641                                'path'        => $blog->path,
642                                'site_id'     => $blog->site_id,
643                                'siteurl'     => $blog->siteurl,
644                                'archived'    => $blog->archived,
645                                'mature'      => $blog->mature,
646                                'spam'        => $blog->spam,
647                                'deleted'     => $blog->deleted,
648                        );
649                }
650        }
651
652        /**
653         * Filter the list of blogs a user belongs to.
654         *
655         * @since MU
656         *
657         * @param array $blogs   An array of blog objects belonging to the user.
658         * @param int   $user_id User ID.
659         * @param bool  $all     Whether the returned blogs array should contain all blogs, including
660         *                       those marked 'deleted', 'archived', or 'spam'. Default false.
661         */
662        return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all );
663}
664
665/**
666 * Find out whether a user is a member of a given blog.
667 *
668 * @since MU 1.1
669 *
670 * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
671 * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
672 * @return bool
673 */
674function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
675        global $wpdb;
676
677        $user_id = (int) $user_id;
678        $blog_id = (int) $blog_id;
679
680        if ( empty( $user_id ) ) {
681                $user_id = get_current_user_id();
682        }
683
684        // Technically not needed, but does save calls to get_blog_details and get_user_meta
685        // in the event that the function is called when a user isn't logged in
686        if ( empty( $user_id ) ) {
687                return false;
688        } else {
689                $user = get_userdata( $user_id );
690                if ( ! $user instanceof WP_User ) {
691                        return false;
692                }
693        }
694
695        if ( ! is_multisite() ) {
696                return true;
697        }
698
699        if ( empty( $blog_id ) ) {
700                $blog_id = get_current_blog_id();
701        }
702
703        $blog = get_blog_details( $blog_id );
704
705        if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) {
706                return false;
707        }
708
709        $keys = get_user_meta( $user_id );
710        if ( empty( $keys ) ) {
711                return false;
712        }
713
714        // no underscore before capabilities in $base_capabilities_key
715        $base_capabilities_key = $wpdb->base_prefix . 'capabilities';
716        $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
717
718        if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) {
719                return true;
720        }
721
722        if ( isset( $keys[ $site_capabilities_key ] ) ) {
723                return true;
724        }
725
726        return false;
727}
728
729/**
730 * Add meta data field to a user.
731 *
732 * Post meta data is called "Custom Fields" on the Administration Screens.
733 *
734 * @since 3.0.0
735 * @link https://codex.wordpress.org/Function_Reference/add_user_meta
736 *
737 * @param int    $user_id    User ID.
738 * @param string $meta_key   Metadata name.
739 * @param mixed  $meta_value Metadata value.
740 * @param bool   $unique     Optional, default is false. Whether the same key should not be added.
741 * @return int|false Meta ID on success, false on failure.
742 */
743function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
744        return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
745}
746
747/**
748 * Remove metadata matching criteria from a user.
749 *
750 * You can match based on the key, or key and value. Removing based on key and
751 * value, will keep from removing duplicate metadata with the same key. It also
752 * allows removing all metadata matching key, if needed.
753 *
754 * @since 3.0.0
755 * @link https://codex.wordpress.org/Function_Reference/delete_user_meta
756 *
757 * @param int    $user_id    User ID
758 * @param string $meta_key   Metadata name.
759 * @param mixed  $meta_value Optional. Metadata value.
760 * @return bool True on success, false on failure.
761 */
762function delete_user_meta($user_id, $meta_key, $meta_value = '') {
763        return delete_metadata('user', $user_id, $meta_key, $meta_value);
764}
765
766/**
767 * Retrieve user meta field for a user.
768 *
769 * @since 3.0.0
770 * @link https://codex.wordpress.org/Function_Reference/get_user_meta
771 *
772 * @param int    $user_id User ID.
773 * @param string $key     Optional. The meta key to retrieve. By default, returns data for all keys.
774 * @param bool   $single  Whether to return a single value.
775 * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
776 */
777function get_user_meta($user_id, $key = '', $single = false) {
778        return get_metadata('user', $user_id, $key, $single);
779}
780
781/**
782 * Update user meta field based on user ID.
783 *
784 * Use the $prev_value parameter to differentiate between meta fields with the
785 * same key and user ID.
786 *
787 * If the meta field for the user does not exist, it will be added.
788 *
789 * @since 3.0.0
790 * @link https://codex.wordpress.org/Function_Reference/update_user_meta
791 *
792 * @param int    $user_id    User ID.
793 * @param string $meta_key   Metadata key.
794 * @param mixed  $meta_value Metadata value.
795 * @param mixed  $prev_value Optional. Previous value to check before removing.
796 * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
797 */
798function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
799        return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
800}
801
802/**
803 * Count number of users who have each of the user roles.
804 *
805 * Assumes there are neither duplicated nor orphaned capabilities meta_values.
806 * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query()
807 * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
808 * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
809 *
810 * @since 3.0.0
811 * @since 4.4.0 The number of users with no role is now included in the `none` element.
812 *
813 * @global wpdb $wpdb WordPress database abstraction object.
814 *
815 * @param string $strategy 'time' or 'memory'
816 * @return array Includes a grand total and an array of counts indexed by role strings.
817 */
818function count_users($strategy = 'time') {
819        global $wpdb;
820
821        // Initialize
822        $id = get_current_blog_id();
823        $blog_prefix = $wpdb->get_blog_prefix($id);
824        $result = array();
825
826        if ( 'time' == $strategy ) {
827                $avail_roles = wp_roles()->get_names();
828
829                // Build a CPU-intensive query that will return concise information.
830                $select_count = array();
831                foreach ( $avail_roles as $this_role => $name ) {
832                        $select_count[] = $wpdb->prepare( "COUNT(NULLIF(`meta_value` LIKE %s, false))", '%' . $wpdb->esc_like( '"' . $this_role . '"' ) . '%');
833                }
834                $select_count[] = "COUNT(NULLIF(`meta_value` = 'a:0:{}', false))";
835                $select_count = implode(', ', $select_count);
836
837                // Add the meta_value index to the selection list, then run the query.
838                $row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
839
840                // Run the previous loop again to associate results with role names.
841                $col = 0;
842                $role_counts = array();
843                foreach ( $avail_roles as $this_role => $name ) {
844                        $count = (int) $row[$col++];
845                        if ($count > 0) {
846                                $role_counts[$this_role] = $count;
847                        }
848                }
849
850                $role_counts['none'] = (int) $row[$col++];
851
852                // Get the meta_value index from the end of the result set.
853                $total_users = (int) $row[$col];
854
855                $result['total_users'] = $total_users;
856                $result['avail_roles'] =& $role_counts;
857        } else {
858                $avail_roles = array(
859                        'none' => 0,
860                );
861
862                $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" );
863
864                foreach ( $users_of_blog as $caps_meta ) {
865                        $b_roles = maybe_unserialize($caps_meta);
866                        if ( ! is_array( $b_roles ) )
867                                continue;
868                        if ( empty( $b_roles ) ) {
869                                $avail_roles['none']++;
870                        }
871                        foreach ( $b_roles as $b_role => $val ) {
872                                if ( isset($avail_roles[$b_role]) ) {
873                                        $avail_roles[$b_role]++;
874                                } else {
875                                        $avail_roles[$b_role] = 1;
876                                }
877                        }
878                }
879
880                $result['total_users'] = count( $users_of_blog );
881                $result['avail_roles'] =& $avail_roles;
882        }
883
884        if ( is_multisite() ) {
885                $result['avail_roles']['none'] = 0;
886        }
887
888        return $result;
889}
890
891//
892// Private helper functions
893//
894
895/**
896 * Set up global user vars.
897 *
898 * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
899 *
900 * @since 2.0.4
901 *
902 * @global string $user_login    The user username for logging in
903 * @global object $userdata      User data.
904 * @global int    $user_level    The level of the user
905 * @global int    $user_ID       The ID of the user
906 * @global string $user_email    The email address of the user
907 * @global string $user_url      The url in the user's profile
908 * @global string $user_identity The display name of the user
909 *
910 * @param int $for_user_id Optional. User ID to set up global data.
911 */
912function setup_userdata($for_user_id = '') {
913        global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity;
914
915        if ( '' == $for_user_id )
916                $for_user_id = get_current_user_id();
917        $user = get_userdata( $for_user_id );
918
919        if ( ! $user ) {
920                $user_ID = 0;
921                $user_level = 0;
922                $userdata = null;
923                $user_login = $user_email = $user_url = $user_identity = '';
924                return;
925        }
926
927        $user_ID    = (int) $user->ID;
928        $user_level = (int) $user->user_level;
929        $userdata   = $user;
930        $user_login = $user->user_login;
931        $user_email = $user->user_email;
932        $user_url   = $user->user_url;
933        $user_identity = $user->display_name;
934}
935
936/**
937 * Create dropdown HTML content of users.
938 *
939 * The content can either be displayed, which it is by default or retrieved by
940 * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
941 * need to be used; all users will be displayed in that case. Only one can be
942 * used, either 'include' or 'exclude', but not both.
943 *
944 * The available arguments are as follows:
945 *
946 * @since 2.3.0
947 * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
948 *
949 * @global int  $blog_id
950 *
951 * @param array|string $args {
952 *     Optional. Array or string of arguments to generate a drop-down of users.
953 *     {@see WP_User_Query::prepare_query() for additional available arguments.
954 *
955 *     @type string       $show_option_all         Text to show as the drop-down default (all).
956 *                                                 Default empty.
957 *     @type string       $show_option_none        Text to show as the drop-down default when no
958 *                                                 users were found. Default empty.
959 *     @type int|string   $option_none_value       Value to use for $show_option_non when no users
960 *                                                 were found. Default -1.
961 *     @type string       $hide_if_only_one_author Whether to skip generating the drop-down
962 *                                                 if only one user was found. Default empty.
963 *     @type string       $orderby                 Field to order found users by. Accepts user fields.
964 *                                                 Default 'display_name'.
965 *     @type string       $order                   Whether to order users in ascending or descending
966 *                                                 order. Accepts 'ASC' (ascending) or 'DESC' (descending).
967 *                                                 Default 'ASC'.
968 *     @type array|string $include                 Array or comma-separated list of user IDs to include.
969 *                                                 Default empty.
970 *     @type array|string $exclude                 Array or comma-separated list of user IDs to exclude.
971 *                                                 Default empty.
972 *     @type bool|int     $multi                   Whether to skip the ID attribute on the 'select' element.
973 *                                                 Accepts 1|true or 0|false. Default 0|false.
974 *     @type string       $show                    User data to display. If the selected item is empty
975 *                                                 then the 'user_login' will be displayed in parentheses.
976 *                                                 Accepts any user field, or 'display_name_with_login' to show
977 *                                                 the display name with user_login in parentheses.
978 *                                                 Default 'display_name'.
979 *     @type int|bool     $echo                    Whether to echo or return the drop-down. Accepts 1|true (echo)
980 *                                                 or 0|false (return). Default 1|true.
981 *     @type int          $selected                Which user ID should be selected. Default 0.
982 *     @type bool         $include_selected        Whether to always include the selected user ID in the drop-
983 *                                                 down. Default false.
984 *     @type string       $name                    Name attribute of select element. Default 'user'.
985 *     @type string       $id                      ID attribute of the select element. Default is the value of $name.
986 *     @type string       $class                   Class attribute of the select element. Default empty.
987 *     @type int          $blog_id                 ID of blog (Multisite only). Default is ID of the current blog.
988 *     @type string       $who                     Which type of users to query. Accepts only an empty string or
989 *                                                 'authors'. Default empty.
990 * }
991 * @return string String of HTML content.
992 */
993function wp_dropdown_users( $args = '' ) {
994        $defaults = array(
995                'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
996                'orderby' => 'display_name', 'order' => 'ASC',
997                'include' => '', 'exclude' => '', 'multi' => 0,
998                'show' => 'display_name', 'echo' => 1,
999                'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
1000                'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false,
1001                'option_none_value' => -1
1002        );
1003
1004        $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
1005
1006        $r = wp_parse_args( $args, $defaults );
1007
1008        $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
1009
1010        $fields = array( 'ID', 'user_login' );
1011
1012        $show = ! empty( $r['show'] ) ? $r['show'] : 'display_name';
1013        if ( 'display_name_with_login' === $show ) {
1014                $fields[] = 'display_name';
1015        } else {
1016                $fields[] = $show;
1017        }
1018
1019        $query_args['fields'] = $fields;
1020
1021        $show_option_all = $r['show_option_all'];
1022        $show_option_none = $r['show_option_none'];
1023        $option_none_value = $r['option_none_value'];
1024
1025        /**
1026         * Filter the query arguments for the user drop-down.
1027         *
1028         * @since 4.4.0
1029         *
1030         * @param array $query_args The query arguments for wp_dropdown_users().
1031         * @param array $r          The default arguments for wp_dropdown_users().
1032         */
1033        $query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $r );
1034
1035        $users = get_users( $query_args );
1036
1037        $output = '';
1038        if ( ! empty( $users ) && ( empty( $r['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
1039                $name = esc_attr( $r['name'] );
1040                if ( $r['multi'] && ! $r['id'] ) {
1041                        $id = '';
1042                } else {
1043                        $id = $r['id'] ? " id='" . esc_attr( $r['id'] ) . "'" : " id='$name'";
1044                }
1045                $output = "<select name='{$name}'{$id} class='" . $r['class'] . "'>\n";
1046
1047                if ( $show_option_all ) {
1048                        $output .= "\t<option value='0'>$show_option_all</option>\n";
1049                }
1050
1051                if ( $show_option_none ) {
1052                        $_selected = selected( $option_none_value, $r['selected'], false );
1053                        $output .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n";
1054                }
1055
1056                if ( $r['include_selected'] && ( $r['selected'] > 0 ) ) {
1057                        $found_selected = false;
1058                        $r['selected'] = (int) $r['selected'];
1059                        foreach ( (array) $users as $user ) {
1060                                $user->ID = (int) $user->ID;
1061                                if ( $user->ID === $r['selected'] ) {
1062                                        $found_selected = true;
1063                                }
1064                        }
1065
1066                        if ( ! $found_selected ) {
1067                                $users[] = get_userdata( $r['selected'] );
1068                        }
1069                }
1070
1071                foreach ( (array) $users as $user ) {
1072                        if ( 'display_name_with_login' === $show ) {
1073                                /* translators: 1: display name, 2: user_login */
1074                                $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login );
1075                        } elseif ( ! empty( $user->$show ) ) {
1076                                $display = $user->$show;
1077                        } else {
1078                                $display = '(' . $user->user_login . ')';
1079                        }
1080
1081                        $_selected = selected( $user->ID, $r['selected'], false );
1082                        $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
1083                }
1084
1085                $output .= "</select>";
1086        }
1087
1088        /**
1089         * Filter the wp_dropdown_users() HTML output.
1090         *
1091         * @since 2.3.0
1092         *
1093         * @param string $output HTML output generated by wp_dropdown_users().
1094         */
1095        $html = apply_filters( 'wp_dropdown_users', $output );
1096
1097        if ( $r['echo'] ) {
1098                echo $html;
1099        }
1100        return $html;
1101}
1102
1103/**
1104 * Sanitize user field based on context.
1105 *
1106 * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1107 * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1108 * when calling filters.
1109 *
1110 * @since 2.3.0
1111 *
1112 * @param string $field   The user Object field name.
1113 * @param mixed  $value   The user Object value.
1114 * @param int    $user_id User ID.
1115 * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
1116 *                        'attribute' and 'js'.
1117 * @return mixed Sanitized value.
1118 */
1119function sanitize_user_field($field, $value, $user_id, $context) {
1120        $int_fields = array('ID');
1121        if ( in_array($field, $int_fields) )
1122                $value = (int) $value;
1123
1124        if ( 'raw' == $context )
1125                return $value;
1126
1127        if ( !is_string($value) && !is_numeric($value) )
1128                return $value;
1129
1130        $prefixed = false !== strpos( $field, 'user_' );
1131
1132        if ( 'edit' == $context ) {
1133                if ( $prefixed ) {
1134
1135                        /** This filter is documented in wp-includes/post.php */
1136                        $value = apply_filters( "edit_{$field}", $value, $user_id );
1137                } else {
1138
1139                        /**
1140                         * Filter a user field value in the 'edit' context.
1141                         *
1142                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1143                         * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1144                         *
1145                         * @since 2.9.0
1146                         *
1147                         * @param mixed $value   Value of the prefixed user field.
1148                         * @param int   $user_id User ID.
1149                         */
1150                        $value = apply_filters( "edit_user_{$field}", $value, $user_id );
1151                }
1152
1153                if ( 'description' == $field )
1154                        $value = esc_html( $value ); // textarea_escaped?
1155                else
1156                        $value = esc_attr($value);
1157        } elseif ( 'db' == $context ) {
1158                if ( $prefixed ) {
1159                        /** This filter is documented in wp-includes/post.php */
1160                        $value = apply_filters( "pre_{$field}", $value );
1161                } else {
1162
1163                        /**
1164                         * Filter the value of a user field in the 'db' context.
1165                         *
1166                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1167                         * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1168                         *
1169                         * @since 2.9.0
1170                         *
1171                         * @param mixed $value Value of the prefixed user field.
1172                         */
1173                        $value = apply_filters( "pre_user_{$field}", $value );
1174                }
1175        } else {
1176                // Use display filters by default.
1177                if ( $prefixed ) {
1178
1179                        /** This filter is documented in wp-includes/post.php */
1180                        $value = apply_filters( $field, $value, $user_id, $context );
1181                } else {
1182
1183                        /**
1184                         * Filter the value of a user field in a standard context.
1185                         *
1186                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
1187                         * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
1188                         *
1189                         * @since 2.9.0
1190                         *
1191                         * @param mixed  $value   The user object value to sanitize.
1192                         * @param int    $user_id User ID.
1193                         * @param string $context The context to filter within.
1194                         */
1195                        $value = apply_filters( "user_{$field}", $value, $user_id, $context );
1196                }
1197        }
1198
1199        if ( 'user_url' == $field )
1200                $value = esc_url($value);
1201
1202        if ( 'attribute' == $context ) {
1203                $value = esc_attr( $value );
1204        } elseif ( 'js' == $context ) {
1205                $value = esc_js( $value );
1206        }
1207        return $value;
1208}
1209
1210/**
1211 * Update all user caches
1212 *
1213 * @since 3.0.0
1214 *
1215 * @param object|WP_User $user User object to be cached
1216 * @return bool|null Returns false on failure.
1217 */
1218function update_user_caches( $user ) {
1219        if ( $user instanceof WP_User ) {
1220                if ( ! $user->exists() ) {
1221                        return false;
1222                }
1223
1224                $user = $user->data;
1225        }
1226
1227        wp_cache_add($user->ID, $user, 'users');
1228        wp_cache_add($user->user_login, $user->ID, 'userlogins');
1229        wp_cache_add($user->user_email, $user->ID, 'useremail');
1230        wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
1231}
1232
1233/**
1234 * Clean all user caches
1235 *
1236 * @since 3.0.0
1237 * @since 4.4.0 'clean_user_cache' action was added.
1238 *
1239 * @param WP_User|int $user User object or ID to be cleaned from the cache
1240 */
1241function clean_user_cache( $user ) {
1242        if ( is_numeric( $user ) )
1243                $user = new WP_User( $user );
1244
1245        if ( ! $user->exists() )
1246                return;
1247
1248        wp_cache_delete( $user->ID, 'users' );
1249        wp_cache_delete( $user->user_login, 'userlogins' );
1250        wp_cache_delete( $user->user_email, 'useremail' );
1251        wp_cache_delete( $user->user_nicename, 'userslugs' );
1252
1253        /**
1254         * Fires immediately after the given user's cache is cleaned.
1255         *
1256         * @since 4.4.0
1257         *
1258         * @param int     $user_id User ID.
1259         * @param WP_User $user    User object.
1260         */
1261        do_action( 'clean_user_cache', $user->ID, $user );
1262}
1263
1264/**
1265 * Checks whether the given username exists.
1266 *
1267 * @since 2.0.0
1268 *
1269 * @param string $username Username.
1270 * @return int|false The user's ID on success, and false on failure.
1271 */
1272function username_exists( $username ) {
1273        if ( $user = get_user_by( 'login', $username ) ) {
1274                return $user->ID;
1275        }
1276        return false;
1277}
1278
1279/**
1280 * Checks whether the given email exists.
1281 *
1282 * @since 2.1.0
1283 *
1284 * @param string $email Email.
1285 * @return int|false The user's ID on success, and false on failure.
1286 */
1287function email_exists( $email ) {
1288        if ( $user = get_user_by( 'email', $email) ) {
1289                return $user->ID;
1290        }
1291        return false;
1292}
1293
1294/**
1295 * Checks whether a username is valid.
1296 *
1297 * @since 2.0.1
1298 * @since 4.4.0 Empty sanitized usernames are now considered invalid
1299 *
1300 * @param string $username Username.
1301 * @return bool Whether username given is valid
1302 */
1303function validate_username( $username ) {
1304        $sanitized = sanitize_user( $username, true );
1305        $valid = ( $sanitized == $username && ! empty( $sanitized ) );
1306
1307        /**
1308         * Filter whether the provided username is valid or not.
1309         *
1310         * @since 2.0.1
1311         *
1312         * @param bool   $valid    Whether given username is valid.
1313         * @param string $username Username to check.
1314         */
1315        return apply_filters( 'validate_username', $valid, $username );
1316}
1317
1318/**
1319 * Insert a user into the database.
1320 *
1321 * Most of the `$userdata` array fields have filters associated with the values. Exceptions are
1322 * 'ID', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl',
1323 * 'user_registered', and 'role'. The filters have the prefix 'pre_user_' followed by the field
1324 * name. An example using 'description' would have the filter called, 'pre_user_description' that
1325 * can be hooked into.
1326 *
1327 * @since 2.0.0
1328 * @since 3.6.0 The `aim`, `jabber`, and `yim` fields were removed as default user contact
1329 *              methods for new installs. See wp_get_user_contact_methods().
1330 *
1331 * @global wpdb $wpdb WordPress database abstraction object.
1332 *
1333 * @param array|object|WP_User $userdata {
1334 *     An array, object, or WP_User object of user data arguments.
1335 *
1336 *     @type int         $ID                   User ID. If supplied, the user will be updated.
1337 *     @type string      $user_pass            The plain-text user password.
1338 *     @type string      $user_login           The user's login username.
1339 *     @type string      $user_nicename        The URL-friendly user name.
1340 *     @type string      $user_url             The user URL.
1341 *     @type string      $user_email           The user email address.
1342 *     @type string      $display_name         The user's display name.
1343 *                                             Default is the user's username.
1344 *     @type string      $nickname             The user's nickname.
1345 *                                             Default is the user's username.
1346 *     @type string      $first_name           The user's first name. For new users, will be used
1347 *                                             to build the first part of the user's display name
1348 *                                             if `$display_name` is not specified.
1349 *     @type string      $last_name            The user's last name. For new users, will be used
1350 *                                             to build the second part of the user's display name
1351 *                                             if `$display_name` is not specified.
1352 *     @type string      $description          The user's biographical description.
1353 *     @type string|bool $rich_editing         Whether to enable the rich-editor for the user.
1354 *                                             False if not empty.
1355 *     @type string|bool $comment_shortcuts    Whether to enable comment moderation keyboard
1356 *                                             shortcuts for the user. Default false.
1357 *     @type string      $admin_color          Admin color scheme for the user. Default 'fresh'.
1358 *     @type bool        $use_ssl              Whether the user should always access the admin over
1359 *                                             https. Default false.
1360 *     @type string      $user_registered      Date the user registered. Format is 'Y-m-d H:i:s'.
1361 *     @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user on the
1362 *                                             site's front end. Default true.
1363 *     @type string      $role                 User's role.
1364 * }
1365 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1366 *                      be created.
1367 */
1368function wp_insert_user( $userdata ) {
1369        global $wpdb;
1370
1371        if ( $userdata instanceof stdClass ) {
1372                $userdata = get_object_vars( $userdata );
1373        } elseif ( $userdata instanceof WP_User ) {
1374                $userdata = $userdata->to_array();
1375        }
1376
1377        // Are we updating or creating?
1378        if ( ! empty( $userdata['ID'] ) ) {
1379                $ID = (int) $userdata['ID'];
1380                $update = true;
1381                $old_user_data = get_userdata( $ID );
1382
1383                if ( ! $old_user_data ) {
1384                        return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1385                }
1386
1387                // hashed in wp_update_user(), plaintext if called directly
1388                $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass;
1389        } else {
1390                $update = false;
1391                // Hash the password
1392                $user_pass = wp_hash_password( $userdata['user_pass'] );
1393        }
1394
1395        $sanitized_user_login = sanitize_user( $userdata['user_login'], true );
1396
1397        /**
1398         * Filter a username after it has been sanitized.
1399         *
1400         * This filter is called before the user is created or updated.
1401         *
1402         * @since 2.0.3
1403         *
1404         * @param string $sanitized_user_login Username after it has been sanitized.
1405         */
1406        $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login );
1407
1408        //Remove any non-printable chars from the login string to see if we have ended up with an empty username
1409        $user_login = trim( $pre_user_login );
1410
1411        // user_login must be between 0 and 60 characters.
1412        if ( empty( $user_login ) ) {
1413                return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
1414        } elseif ( mb_strlen( $user_login ) > 60 ) {
1415                return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) );
1416        }
1417
1418        if ( ! $update && username_exists( $user_login ) ) {
1419                return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
1420        }
1421
1422        /**
1423         * Filter the list of blacklisted usernames.
1424         *
1425         * @since 4.4.0
1426         *
1427         * @param array $usernames Array of blacklisted usernames.
1428         */
1429        $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
1430
1431        if ( in_array( strtolower( $user_login ), array_map( 'strtolower', $illegal_logins ) ) ) {
1432                return new WP_Error( 'invalid_username', __( 'Sorry, that username is not allowed.' ) );
1433        }
1434
1435        /*
1436         * If a nicename is provided, remove unsafe user characters before using it.
1437         * Otherwise build a nicename from the user_login.
1438         */
1439        if ( ! empty( $userdata['user_nicename'] ) ) {
1440                $user_nicename = sanitize_user( $userdata['user_nicename'], true );
1441                if ( mb_strlen( $user_nicename ) > 50 ) {
1442                        return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) );
1443                }
1444        } else {
1445                $user_nicename = mb_substr( $user_login, 0, 50 );
1446        }
1447
1448        $user_nicename = sanitize_title( $user_nicename );
1449
1450        // Store values to save in user meta.
1451        $meta = array();
1452
1453        /**
1454         * Filter a user's nicename before the user is created or updated.
1455         *
1456         * @since 2.0.3
1457         *
1458         * @param string $user_nicename The user's nicename.
1459         */
1460        $user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
1461
1462        $raw_user_url = empty( $userdata['user_url'] ) ? '' : $userdata['user_url'];
1463
1464        /**
1465         * Filter a user's URL before the user is created or updated.
1466         *
1467         * @since 2.0.3
1468         *
1469         * @param string $raw_user_url The user's URL.
1470         */
1471        $user_url = apply_filters( 'pre_user_url', $raw_user_url );
1472
1473        $raw_user_email = empty( $userdata['user_email'] ) ? '' : $userdata['user_email'];
1474
1475        /**
1476         * Filter a user's email before the user is created or updated.
1477         *
1478         * @since 2.0.3
1479         *
1480         * @param string $raw_user_email The user's email.
1481         */
1482        $user_email = apply_filters( 'pre_user_email', $raw_user_email );
1483
1484        /*
1485         * If there is no update, just check for `email_exists`. If there is an update,
1486         * check if current email and new email are the same, or not, and check `email_exists`
1487         * accordingly.
1488         */
1489        if ( ( ! $update || ( ! empty( $old_user_data ) && 0 !== strcasecmp( $user_email, $old_user_data->user_email ) ) )
1490                && ! defined( 'WP_IMPORTING' )
1491                && email_exists( $user_email )
1492        ) {
1493                return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) );
1494        }
1495        $nickname = empty( $userdata['nickname'] ) ? $user_login : $userdata['nickname'];
1496
1497        /**
1498         * Filter a user's nickname before the user is created or updated.
1499         *
1500         * @since 2.0.3
1501         *
1502         * @param string $nickname The user's nickname.
1503         */
1504        $meta['nickname'] = apply_filters( 'pre_user_nickname', $nickname );
1505
1506        $first_name = empty( $userdata['first_name'] ) ? '' : $userdata['first_name'];
1507
1508        /**
1509         * Filter a user's first name before the user is created or updated.
1510         *
1511         * @since 2.0.3
1512         *
1513         * @param string $first_name The user's first name.
1514         */
1515        $meta['first_name'] = apply_filters( 'pre_user_first_name', $first_name );
1516
1517        $last_name = empty( $userdata['last_name'] ) ? '' : $userdata['last_name'];
1518
1519        /**
1520         * Filter a user's last name before the user is created or updated.
1521         *
1522         * @since 2.0.3
1523         *
1524         * @param string $last_name The user's last name.
1525         */
1526        $meta['last_name'] = apply_filters( 'pre_user_last_name', $last_name );
1527
1528        if ( empty( $userdata['display_name'] ) ) {
1529                if ( $update ) {
1530                        $display_name = $user_login;
1531                } elseif ( $meta['first_name'] && $meta['last_name'] ) {
1532                        /* translators: 1: first name, 2: last name */
1533                        $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $meta['first_name'], $meta['last_name'] );
1534                } elseif ( $meta['first_name'] ) {
1535                        $display_name = $meta['first_name'];
1536                } elseif ( $meta['last_name'] ) {
1537                        $display_name = $meta['last_name'];
1538                } else {
1539                        $display_name = $user_login;
1540                }
1541        } else {
1542                $display_name = $userdata['display_name'];
1543        }
1544
1545        /**
1546         * Filter a user's display name before the user is created or updated.
1547         *
1548         * @since 2.0.3
1549         *
1550         * @param string $display_name The user's display name.
1551         */
1552        $display_name = apply_filters( 'pre_user_display_name', $display_name );
1553
1554        $description = empty( $userdata['description'] ) ? '' : $userdata['description'];
1555
1556        /**
1557         * Filter a user's description before the user is created or updated.
1558         *
1559         * @since 2.0.3
1560         *
1561         * @param string $description The user's description.
1562         */
1563        $meta['description'] = apply_filters( 'pre_user_description', $description );
1564
1565        $meta['rich_editing'] = empty( $userdata['rich_editing'] ) ? 'true' : $userdata['rich_editing'];
1566
1567        $meta['comment_shortcuts'] = empty( $userdata['comment_shortcuts'] ) || 'false' === $userdata['comment_shortcuts'] ? 'false' : 'true';
1568
1569        $admin_color = empty( $userdata['admin_color'] ) ? 'fresh' : $userdata['admin_color'];
1570        $meta['admin_color'] = preg_replace( '|[^a-z0-9 _.\-@]|i', '', $admin_color );
1571
1572        $meta['use_ssl'] = empty( $userdata['use_ssl'] ) ? 0 : $userdata['use_ssl'];
1573
1574        $user_registered = empty( $userdata['user_registered'] ) ? gmdate( 'Y-m-d H:i:s' ) : $userdata['user_registered'];
1575
1576        $meta['show_admin_bar_front'] = empty( $userdata['show_admin_bar_front'] ) ? 'true' : $userdata['show_admin_bar_front'];
1577
1578        $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));
1579
1580        if ( $user_nicename_check ) {
1581                $suffix = 2;
1582                while ($user_nicename_check) {
1583                        // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix.
1584                        $base_length = 49 - mb_strlen( $suffix );
1585                        $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix";
1586                        $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));
1587                        $suffix++;
1588                }
1589                $user_nicename = $alt_user_nicename;
1590        }
1591
1592        $compacted = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
1593        $data = wp_unslash( $compacted );
1594
1595        if ( $update ) {
1596                if ( $user_email !== $old_user_data->user_email || $user_pass !== $old_user_data->user_pass ) {
1597                        $data['user_activation_key'] = '';
1598                }
1599                $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
1600                $user_id = (int) $ID;
1601        } else {
1602                $wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) );
1603                $user_id = (int) $wpdb->insert_id;
1604        }
1605
1606        $user = new WP_User( $user_id );
1607
1608        /**
1609         * Filter a user's meta values and keys before the user is created or updated.
1610         *
1611         * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`.
1612         *
1613         * @since 4.4.0
1614         *
1615         * @param array $meta {
1616         *     Default meta values and keys for the user.
1617         *
1618         *     @type string   $nickname             The user's nickname. Default is the user's username.
1619         *     @type string   $first_name           The user's first name.
1620         *     @type string   $last_name            The user's last name.
1621         *     @type string   $description          The user's description.
1622         *     @type bool     $rich_editing         Whether to enable the rich-editor for the user. False if not empty.
1623         *     @type bool     $comment_shortcuts    Whether to enable keyboard shortcuts for the user. Default false.
1624         *     @type string   $admin_color          The color scheme for a user's admin screen. Default 'fresh'.
1625         *     @type int|bool $use_ssl              Whether to force SSL on the user's admin area. 0|false if SSL is
1626         *                                          not forced.
1627         *     @type bool     $show_admin_bar_front Whether to show the admin bar on the front end for the user.
1628         *                                          Default true.
1629         * }
1630         * @param WP_User $user   User object.
1631         * @param bool    $update Whether the user is being updated rather than created.
1632         */
1633        $meta = apply_filters( 'insert_user_meta', $meta, $user, $update );
1634
1635        // Update user meta.
1636        foreach ( $meta as $key => $value ) {
1637                update_user_meta( $user_id, $key, $value );
1638        }
1639
1640        foreach ( wp_get_user_contact_methods( $user ) as $key => $value ) {
1641                if ( isset( $userdata[ $key ] ) ) {
1642                        update_user_meta( $user_id, $key, $userdata[ $key ] );
1643                }
1644        }
1645
1646        if ( isset( $userdata['role'] ) ) {
1647                $user->set_role( $userdata['role'] );
1648        } elseif ( ! $update ) {
1649                $user->set_role(get_option('default_role'));
1650        }
1651        wp_cache_delete( $user_id, 'users' );
1652        wp_cache_delete( $user_login, 'userlogins' );
1653
1654        if ( $update ) {
1655                /**
1656                 * Fires immediately after an existing user is updated.
1657                 *
1658                 * @since 2.0.0
1659                 *
1660                 * @param int    $user_id       User ID.
1661                 * @param object $old_user_data Object containing user's data prior to update.
1662                 */
1663                do_action( 'profile_update', $user_id, $old_user_data );
1664        } else {
1665                /**
1666                 * Fires immediately after a new user is registered.
1667                 *
1668                 * @since 1.5.0
1669                 *
1670                 * @param int $user_id User ID.
1671                 */
1672                do_action( 'user_register', $user_id );
1673        }
1674
1675        return $user_id;
1676}
1677
1678/**
1679 * Update a user in the database.
1680 *
1681 * It is possible to update a user's password by specifying the 'user_pass'
1682 * value in the $userdata parameter array.
1683 *
1684 * If current user's password is being updated, then the cookies will be
1685 * cleared.
1686 *
1687 * @since 2.0.0
1688 *
1689 * @see wp_insert_user() For what fields can be set in $userdata.
1690 *
1691 * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User.
1692 * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated.
1693 */
1694function wp_update_user($userdata) {
1695        if ( $userdata instanceof stdClass ) {
1696                $userdata = get_object_vars( $userdata );
1697        } elseif ( $userdata instanceof WP_User ) {
1698                $userdata = $userdata->to_array();
1699        }
1700
1701        $ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
1702        if ( ! $ID ) {
1703                return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1704        }
1705
1706        // First, get all of the original fields
1707        $user_obj = get_userdata( $ID );
1708        if ( ! $user_obj ) {
1709                return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
1710        }
1711
1712        $user = $user_obj->to_array();
1713
1714        // Add additional custom fields
1715        foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
1716                $user[ $key ] = get_user_meta( $ID, $key, true );
1717        }
1718
1719        // Escape data pulled from DB.
1720        $user = add_magic_quotes( $user );
1721
1722        if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) {
1723                // If password is changing, hash it now
1724                $plaintext_pass = $userdata['user_pass'];
1725                $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] );
1726
1727                /**
1728                 * Filter whether to send the password change email.
1729                 *
1730                 * @since 4.3.0
1731                 *
1732                 * @see wp_insert_user() For `$user` and `$userdata` fields.
1733                 *
1734                 * @param bool  $send     Whether to send the email.
1735                 * @param array $user     The original user array.
1736                 * @param array $userdata The updated user array.
1737                 *
1738                 */
1739                $send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata );
1740        }
1741
1742        if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) {
1743                /**
1744                 * Filter whether to send the email change email.
1745                 *
1746                 * @since 4.3.0
1747                 *
1748                 * @see wp_insert_user() For `$user` and `$userdata` fields.
1749                 *
1750                 * @param bool  $send     Whether to send the email.
1751                 * @param array $user     The original user array.
1752                 * @param array $userdata The updated user array.
1753                 *
1754                 */
1755                $send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata );
1756        }
1757
1758        wp_cache_delete( $user['user_email'], 'useremail' );
1759        wp_cache_delete( $user['user_nicename'], 'userslugs' );
1760
1761        // Merge old and new fields with new fields overwriting old ones.
1762        $userdata = array_merge( $user, $userdata );
1763        $user_id = wp_insert_user( $userdata );
1764
1765        if ( ! is_wp_error( $user_id ) ) {
1766
1767                $blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
1768
1769                if ( ! empty( $send_password_change_email ) ) {
1770
1771                        /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1772                        $pass_change_text = __( 'Hi ###USERNAME###,
1773
1774This notice confirms that your password was changed on ###SITENAME###.
1775
1776If you did not change your password, please contact the Site Administrator at
1777###ADMIN_EMAIL###
1778
1779This email has been sent to ###EMAIL###
1780
1781Regards,
1782All at ###SITENAME###
1783###SITEURL###' );
1784
1785                        $pass_change_email = array(
1786                                'to'      => $user['user_email'],
1787                                'subject' => __( '[%s] Notice of Password Change' ),
1788                                'message' => $pass_change_text,
1789                                'headers' => '',
1790                        );
1791
1792                        /**
1793                         * Filter the contents of the email sent when the user's password is changed.
1794                         *
1795                         * @since 4.3.0
1796                         *
1797                         * @param array $pass_change_email {
1798                         *            Used to build wp_mail().
1799                         *            @type string $to      The intended recipients. Add emails in a comma separated string.
1800                         *            @type string $subject The subject of the email.
1801                         *            @type string $message The content of the email.
1802                         *                The following strings have a special meaning and will get replaced dynamically:
1803                         *                - ###USERNAME###    The current user's username.
1804                         *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1805                         *                - ###EMAIL###       The old email.
1806                         *                - ###SITENAME###    The name of the site.
1807                         *                - ###SITEURL###     The URL to the site.
1808                         *            @type string $headers Headers. Add headers in a newline (\r\n) separated string.
1809                         *        }
1810                         * @param array $user     The original user array.
1811                         * @param array $userdata The updated user array.
1812                         *
1813                         */
1814                        $pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata );
1815
1816                        $pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] );
1817                        $pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] );
1818                        $pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] );
1819                        $pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] );
1820                        $pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] );
1821
1822                        wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] );
1823                }
1824
1825                if ( ! empty( $send_email_change_email ) ) {
1826                        /* translators: Do not translate USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: those are placeholders. */
1827                        $email_change_text = __( 'Hi ###USERNAME###,
1828
1829This notice confirms that your email was changed on ###SITENAME###.
1830
1831If you did not change your email, please contact the Site Administrator at
1832###ADMIN_EMAIL###
1833
1834This email has been sent to ###EMAIL###
1835
1836Regards,
1837All at ###SITENAME###
1838###SITEURL###' );
1839
1840                        $email_change_email = array(
1841                                'to'      => $user['user_email'],
1842                                'subject' => __( '[%s] Notice of Email Change' ),
1843                                'message' => $email_change_text,
1844                                'headers' => '',
1845                        );
1846
1847                        /**
1848                         * Filter the contents of the email sent when the user's email is changed.
1849                         *
1850                         * @since 4.3.0
1851                         *
1852                         * @param array $email_change_email {
1853                         *            Used to build wp_mail().
1854                         *            @type string $to      The intended recipients.
1855                         *            @type string $subject The subject of the email.
1856                         *            @type string $message The content of the email.
1857                         *                The following strings have a special meaning and will get replaced dynamically:
1858                         *                - ###USERNAME###    The current user's username.
1859                         *                - ###ADMIN_EMAIL### The admin email in case this was unexpected.
1860                         *                - ###EMAIL###       The old email.
1861                         *                - ###SITENAME###    The name of the site.
1862                         *                - ###SITEURL###     The URL to the site.
1863                         *            @type string $headers Headers.
1864                         *        }
1865                         * @param array $user The original user array.
1866                         * @param array $userdata The updated user array.
1867                         */
1868                        $email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata );
1869
1870                        $email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] );
1871                        $email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] );
1872                        $email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] );
1873                        $email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] );
1874                        $email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );
1875
1876                        wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] );
1877                }
1878        }
1879
1880        // Update the cookies if the password changed.
1881        $current_user = wp_get_current_user();
1882        if ( $current_user->ID == $ID ) {
1883                if ( isset($plaintext_pass) ) {
1884                        wp_clear_auth_cookie();
1885
1886                        // Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
1887                        // If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
1888                        $logged_in_cookie    = wp_parse_auth_cookie( '', 'logged_in' );
1889                        /** This filter is documented in wp-includes/pluggable.php */
1890                        $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false );
1891                        $remember            = ( ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life );
1892
1893                        wp_set_auth_cookie( $ID, $remember );
1894                }
1895        }
1896
1897        return $user_id;
1898}
1899
1900/**
1901 * A simpler way of inserting a user into the database.
1902 *
1903 * Creates a new user with just the username, password, and email. For more
1904 * complex user creation use {@see wp_insert_user()} to specify more information.
1905 *
1906 * @since 2.0.0
1907 * @see wp_insert_user() More complete way to create a new user
1908 *
1909 * @param string $username The user's username.
1910 * @param string $password The user's password.
1911 * @param string $email    Optional. The user's email. Default empty.
1912 * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
1913 *                      be created.
1914 */
1915function wp_create_user($username, $password, $email = '') {
1916        $user_login = wp_slash( $username );
1917        $user_email = wp_slash( $email    );
1918        $user_pass = $password;
1919
1920        $userdata = compact('user_login', 'user_email', 'user_pass');
1921        return wp_insert_user($userdata);
1922}
1923
1924/**
1925 * Returns a list of meta keys to be (maybe) populated in wp_update_user().
1926 *
1927 * The list of keys returned via this function are dependent on the presence
1928 * of those keys in the user meta data to be set.
1929 *
1930 * @since 3.3.0
1931 * @access private
1932 *
1933 * @param WP_User $user WP_User instance.
1934 * @return array List of user keys to be populated in wp_update_user().
1935 */
1936function _get_additional_user_keys( $user ) {
1937        $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' );
1938        return array_merge( $keys, array_keys( wp_get_user_contact_methods( $user ) ) );
1939}
1940
1941/**
1942 * Set up the user contact methods.
1943 *
1944 * Default contact methods were removed in 3.6. A filter dictates contact methods.
1945 *
1946 * @since 3.7.0
1947 *
1948 * @param WP_User $user Optional. WP_User object.
1949 * @return array Array of contact methods and their labels.
1950 */
1951function wp_get_user_contact_methods( $user = null ) {
1952        $methods = array();
1953        if ( get_site_option( 'initial_db_version' ) < 23588 ) {
1954                $methods = array(
1955                        'aim'    => __( 'AIM' ),
1956                        'yim'    => __( 'Yahoo IM' ),
1957                        'jabber' => __( 'Jabber / Google Talk' )
1958                );
1959        }
1960
1961        /**
1962         * Filter the user contact methods.
1963         *
1964         * @since 2.9.0
1965         *
1966         * @param array   $methods Array of contact methods and their labels.
1967         * @param WP_User $user    WP_User object.
1968         */
1969        return apply_filters( 'user_contactmethods', $methods, $user );
1970}
1971
1972/**
1973 * The old private function for setting up user contact methods.
1974 *
1975 * Use wp_get_user_contact_methods() instead.
1976 *
1977 * @since 2.9.0
1978 * @access private
1979 *
1980 * @param WP_User $user Optional. WP_User object. Default null.
1981 * @return array Array of contact methods and their labels.
1982 */
1983function _wp_get_user_contactmethods( $user = null ) {
1984        return wp_get_user_contact_methods( $user );
1985}
1986
1987/**
1988 * Gets the text suggesting how to create strong passwords.
1989 *
1990 * @since 4.1.0
1991 *
1992 * @return string The password hint text.
1993 */
1994function wp_get_password_hint() {
1995        $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; ).' );
1996
1997        /**
1998         * Filter the text describing the site's password complexity policy.
1999         *
2000         * @since 4.1.0
2001         *
2002         * @param string $hint The password hint text.
2003         */
2004        return apply_filters( 'password_hint', $hint );
2005}
2006
2007/**
2008 * Creates, stores, then returns a password reset key for user.
2009 *
2010 * @since 4.4.0
2011 *
2012 * @global wpdb         $wpdb      WordPress database abstraction object.
2013 * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
2014 *
2015 * @param WP_User $user User to retrieve password reset key for.
2016 *
2017 * @return string|WP_Error Password reset key on success. WP_Error on error.
2018 */
2019function get_password_reset_key( $user ) {
2020        global $wpdb, $wp_hasher;
2021
2022        /**
2023         * Fires before a new password is retrieved.
2024         *
2025         * @since 1.5.0
2026         * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
2027         *
2028         * @param string $user_login The user login name.
2029         */
2030        do_action( 'retreive_password', $user->user_login );
2031
2032        /**
2033         * Fires before a new password is retrieved.
2034         *
2035         * @since 1.5.1
2036         *
2037         * @param string $user_login The user login name.
2038         */
2039        do_action( 'retrieve_password', $user->user_login );
2040
2041        /**
2042         * Filter whether to allow a password to be reset.
2043         *
2044         * @since 2.7.0
2045         *
2046         * @param bool $allow         Whether to allow the password to be reset. Default true.
2047         * @param int  $user_data->ID The ID of the user attempting to reset a password.
2048         */
2049        $allow = apply_filters( 'allow_password_reset', true, $user->ID );
2050
2051        if ( ! $allow ) {
2052                return new WP_Error( 'no_password_reset', __( 'Password reset is not allowed for this user' ) );
2053        } elseif ( is_wp_error( $allow ) ) {
2054                return $allow;
2055        }
2056
2057        // Generate something random for a password reset key.
2058        $key = wp_generate_password( 20, false );
2059
2060        /**
2061         * Fires when a password reset key is generated.
2062         *
2063         * @since 2.5.0
2064         *
2065         * @param string $user_login The username for the user.
2066         * @param string $key        The generated password reset key.
2067         */
2068        do_action( 'retrieve_password_key', $user->user_login, $key );
2069
2070        // Now insert the key, hashed, into the DB.
2071        if ( empty( $wp_hasher ) ) {
2072                require_once ABSPATH . WPINC . '/class-phpass.php';
2073                $wp_hasher = new PasswordHash( 8, true );
2074        }
2075        $hashed = time() . ':' . $wp_hasher->HashPassword( $key );
2076        $key_saved = $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user->user_login ) );
2077        if ( false === $key_saved ) {
2078                return new WP_Error( 'no_password_key_update', __( 'Could not save password reset key to database.' ) );
2079        }
2080
2081        return $key;
2082}
2083
2084/**
2085 * Retrieves a user row based on password reset key and login
2086 *
2087 * A key is considered 'expired' if it exactly matches the value of the
2088 * user_activation_key field, rather than being matched after going through the
2089 * hashing process. This field is now hashed; old values are no longer accepted
2090 * but have a different WP_Error code so good user feedback can be provided.
2091 *
2092 * @since 3.1.0
2093 *
2094 * @global wpdb         $wpdb      WordPress database object for queries.
2095 * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance.
2096 *
2097 * @param string $key       Hash to validate sending user's password.
2098 * @param string $login     The user login.
2099 * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
2100 */
2101function check_password_reset_key($key, $login) {
2102        global $wpdb, $wp_hasher;
2103
2104        $key = preg_replace('/[^a-z0-9]/i', '', $key);
2105
2106        if ( empty( $key ) || !is_string( $key ) )
2107                return new WP_Error('invalid_key', __('Invalid key'));
2108
2109        if ( empty($login) || !is_string($login) )
2110                return new WP_Error('invalid_key', __('Invalid key'));
2111
2112        $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
2113        if ( ! $row )
2114                return new WP_Error('invalid_key', __('Invalid key'));
2115
2116        if ( empty( $wp_hasher ) ) {
2117                require_once ABSPATH . WPINC . '/class-phpass.php';
2118                $wp_hasher = new PasswordHash( 8, true );
2119        }
2120
2121        /**
2122         * Filter the expiration time of password reset keys.
2123         *
2124         * @since 4.3.0
2125         *
2126         * @param int $expiration The expiration time in seconds.
2127         */
2128        $expiration_duration = apply_filters( 'password_reset_expiration', DAY_IN_SECONDS );
2129
2130        if ( false !== strpos( $row->user_activation_key, ':' ) ) {
2131                list( $pass_request_time, $pass_key ) = explode( ':', $row->user_activation_key, 2 );
2132                $expiration_time = $pass_request_time + $expiration_duration;
2133        } else {
2134                $pass_key = $row->user_activation_key;
2135                $expiration_time = false;
2136        }
2137
2138        if ( ! $pass_key ) {
2139                return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2140        }
2141
2142        $hash_is_correct = $wp_hasher->CheckPassword( $key, $pass_key );
2143
2144        if ( $hash_is_correct && $expiration_time && time() < $expiration_time ) {
2145                return get_userdata( $row->ID );
2146        } elseif ( $hash_is_correct && $expiration_time ) {
2147                // Key has an expiration time that's passed
2148                return new WP_Error( 'expired_key', __( 'Invalid key' ) );
2149        }
2150
2151        if ( hash_equals( $row->user_activation_key, $key ) || ( $hash_is_correct && ! $expiration_time ) ) {
2152                $return = new WP_Error( 'expired_key', __( 'Invalid key' ) );
2153                $user_id = $row->ID;
2154
2155                /**
2156                 * Filter the return value of check_password_reset_key() when an
2157                 * old-style key is used.
2158                 *
2159                 * @since 3.7.0 Previously plain-text keys were stored in the database.
2160                 * @since 4.3.0 Previously key hashes were stored without an expiration time.
2161                 *
2162                 * @param WP_Error $return  A WP_Error object denoting an expired key.
2163                 *                          Return a WP_User object to validate the key.
2164                 * @param int      $user_id The matched user ID.
2165                 */
2166                return apply_filters( 'password_reset_key_expired', $return, $user_id );
2167        }
2168
2169        return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
2170}
2171
2172/**
2173 * Handles resetting the user's password.
2174 *
2175 * @since 2.5.0
2176 *
2177 * @param object $user     The user
2178 * @param string $new_pass New password for the user in plaintext
2179 */
2180function reset_password( $user, $new_pass ) {
2181        /**
2182         * Fires before the user's password is reset.
2183         *
2184         * @since 1.5.0
2185         *
2186         * @param object $user     The user.
2187         * @param string $new_pass New user password.
2188         */
2189        do_action( 'password_reset', $user, $new_pass );
2190
2191        wp_set_password( $new_pass, $user->ID );
2192        update_user_option( $user->ID, 'default_password_nag', false, true );
2193
2194        /**
2195         * Fires after the user's password is reset.
2196         *
2197         * @since 4.4.0
2198         *
2199         * @param object $user     The user.
2200         * @param string $new_pass New user password.
2201         */
2202        do_action( 'after_password_reset', $user, $new_pass );
2203}
2204
2205/**
2206 * Handles registering a new user.
2207 *
2208 * @since 2.5.0
2209 *
2210 * @param string $user_login User's username for logging in
2211 * @param string $user_email User's email address to send password and add
2212 * @return int|WP_Error Either user's ID or error on failure.
2213 */
2214function register_new_user( $user_login, $user_email ) {
2215        $errors = new WP_Error();
2216
2217        $sanitized_user_login = sanitize_user( $user_login );
2218        /**
2219         * Filter the email address of a user being registered.
2220         *
2221         * @since 2.1.0
2222         *
2223         * @param string $user_email The email address of the new user.
2224         */
2225        $user_email = apply_filters( 'user_registration_email', $user_email );
2226
2227        // Check the username
2228        if ( $sanitized_user_login == '' ) {
2229                $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
2230        } elseif ( ! validate_username( $user_login ) ) {
2231                $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ) );
2232                $sanitized_user_login = '';
2233        } elseif ( username_exists( $sanitized_user_login ) ) {
2234                $errors->add( 'username_exists', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ) );
2235
2236        } else {
2237                /** This filter is documented in wp-includes/user.php */
2238                $illegal_user_logins = array_map( 'strtolower', (array) apply_filters( 'illegal_user_logins', array() ) );
2239                if ( in_array( strtolower( $sanitized_user_login ), $illegal_user_logins ) ) {
2240                        $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
2241                }
2242        }
2243
2244        // Check the email address
2245        if ( $user_email == '' ) {
2246                $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) );
2247        } elseif ( ! is_email( $user_email ) ) {
2248                $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn&#8217;t correct.' ) );
2249                $user_email = '';
2250        } elseif ( email_exists( $user_email ) ) {
2251                $errors->add( 'email_exists', __( '<strong>ERROR</strong>: This email is already registered, please choose another one.' ) );
2252        }
2253
2254        /**
2255         * Fires when submitting registration form data, before the user is created.
2256         *
2257         * @since 2.1.0
2258         *
2259         * @param string   $sanitized_user_login The submitted username after being sanitized.
2260         * @param string   $user_email           The submitted email.
2261         * @param WP_Error $errors               Contains any errors with submitted username and email,
2262         *                                       e.g., an empty field, an invalid username or email,
2263         *                                       or an existing username or email.
2264         */
2265        do_action( 'register_post', $sanitized_user_login, $user_email, $errors );
2266
2267        /**
2268         * Filter the errors encountered when a new user is being registered.
2269         *
2270         * The filtered WP_Error object may, for example, contain errors for an invalid
2271         * or existing username or email address. A WP_Error object should always returned,
2272         * but may or may not contain errors.
2273         *
2274         * If any errors are present in $errors, this will abort the user's registration.
2275         *
2276         * @since 2.1.0
2277         *
2278         * @param WP_Error $errors               A WP_Error object containing any errors encountered
2279         *                                       during registration.
2280         * @param string   $sanitized_user_login User's username after it has been sanitized.
2281         * @param string   $user_email           User's email.
2282         */
2283        $errors = apply_filters( 'registration_errors', $errors, $sanitized_user_login, $user_email );
2284
2285        if ( $errors->get_error_code() )
2286                return $errors;
2287
2288        $user_pass = wp_generate_password( 12, false );
2289        $user_id = wp_create_user( $sanitized_user_login, $user_pass, $user_email );
2290        if ( ! $user_id || is_wp_error( $user_id ) ) {
2291                $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' ) ) );
2292                return $errors;
2293        }
2294
2295        update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
2296
2297        /**
2298         * Fires after a new user registration has been recorded.
2299         *
2300         * @since 4.4.0
2301         *
2302         * @param int $user_id ID of the newly registered user.
2303         */
2304        do_action( 'register_new_user', $user_id );
2305
2306        return $user_id;
2307}
2308
2309/**
2310 * Initiate email notifications related to the creation of new users.
2311 *
2312 * Notifications are sent both to the site admin and to the newly created user.
2313 *
2314 * @since 4.4.0
2315 *
2316 * @param int    $user_id ID of the newly created user.
2317 * @param string $notify  Optional. Type of notification that should happen. Accepts 'admin' or an empty string
2318 *                        (admin only), or 'both' (admin and user). Default 'both'.
2319 */
2320function wp_send_new_user_notifications( $user_id, $notify = 'both' ) {
2321        wp_new_user_notification( $user_id, null, $notify );
2322}
2323
2324/**
2325 * Retrieve the current session token from the logged_in cookie.
2326 *
2327 * @since 4.0.0
2328 *
2329 * @return string Token.
2330 */
2331function wp_get_session_token() {
2332        $cookie = wp_parse_auth_cookie( '', 'logged_in' );
2333        return ! empty( $cookie['token'] ) ? $cookie['token'] : '';
2334}
2335
2336/**
2337 * Retrieve a list of sessions for the current user.
2338 *
2339 * @since 4.0.0
2340 * @return array Array of sessions.
2341 */
2342function wp_get_all_sessions() {
2343        $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2344        return $manager->get_all();
2345}
2346
2347/**
2348 * Remove the current session token from the database.
2349 *
2350 * @since 4.0.0
2351 */
2352function wp_destroy_current_session() {
2353        $token = wp_get_session_token();
2354        if ( $token ) {
2355                $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2356                $manager->destroy( $token );
2357        }
2358}
2359
2360/**
2361 * Remove all but the current session token for the current user for the database.
2362 *
2363 * @since 4.0.0
2364 */
2365function wp_destroy_other_sessions() {
2366        $token = wp_get_session_token();
2367        if ( $token ) {
2368                $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2369                $manager->destroy_others( $token );
2370        }
2371}
2372
2373/**
2374 * Remove all session tokens for the current user from the database.
2375 *
2376 * @since 4.0.0
2377 */
2378function wp_destroy_all_sessions() {
2379        $manager = WP_Session_Tokens::get_instance( get_current_user_id() );
2380        $manager->destroy_all();
2381}
2382
2383/**
2384 * Get the user IDs of all users with no role on this site.
2385 *
2386 * This function returns an empty array when used on Multisite.
2387 *
2388 * @since 4.4.0
2389 *
2390 * @return array Array of user IDs.
2391 */
2392function wp_get_users_with_no_role() {
2393        global $wpdb;
2394
2395        if ( is_multisite() ) {
2396                return array();
2397        }
2398
2399        $prefix = $wpdb->get_blog_prefix();
2400        $regex  = implode( '|', wp_roles()->get_names() );
2401        $regex  = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex );
2402        $users  = $wpdb->get_col( $wpdb->prepare( "
2403                SELECT user_id
2404                FROM $wpdb->usermeta
2405                WHERE meta_key = '{$prefix}capabilities'
2406                AND meta_value NOT REGEXP %s
2407        ", $regex ) );
2408
2409        return $users;
2410}
2411
2412/**
2413 * Retrieves the current user object.
2414 *
2415 * Will set the current user, if the current user is not set. The current user
2416 * will be set to the logged-in person. If no user is logged-in, then it will
2417 * set the current user to 0, which is invalid and won't have any permissions.
2418 *
2419 * This function is used by the pluggable functions wp_get_current_user() and
2420 * get_currentuserinfo(), the latter of which is deprecated but used for backward
2421 * compatibility.
2422 *
2423 * @since 4.5.0
2424 * @access private
2425 *
2426 * @see wp_get_current_user()
2427 * @global WP_User $current_user Checks if the current user is set.
2428 *
2429 * @return WP_User Current WP_User instance.
2430 */
2431function _wp_get_current_user() {
2432        global $current_user;
2433
2434        if ( ! empty( $current_user ) ) {
2435                if ( $current_user instanceof WP_User ) {
2436                        return $current_user;
2437                }
2438
2439                // Upgrade stdClass to WP_User
2440                if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
2441                        $cur_id = $current_user->ID;
2442                        $current_user = null;
2443                        wp_set_current_user( $cur_id );
2444                        return $current_user;
2445                }
2446
2447                // $current_user has a junk value. Force to WP_User with ID 0.
2448                $current_user = null;
2449                wp_set_current_user( 0 );
2450                return $current_user;
2451        }
2452
2453        if ( defined('XMLRPC_REQUEST') && XMLRPC_REQUEST ) {
2454                wp_set_current_user( 0 );
2455                return $current_user;
2456        }
2457
2458        /**
2459         * Filter the current user.
2460         *
2461         * The default filters use this to determine the current user from the
2462         * request's cookies, if available.
2463         *
2464         * Returning a value of false will effectively short-circuit setting
2465         * the current user.
2466         *
2467         * @since 3.9.0
2468         *
2469         * @param int|bool $user_id User ID if one has been determined, false otherwise.
2470         */
2471        $user_id = apply_filters( 'determine_current_user', false );
2472        if ( ! $user_id ) {
2473                wp_set_current_user( 0 );
2474                return $current_user;
2475        }
2476
2477        wp_set_current_user( $user_id );
2478
2479        return $current_user;
2480}
Note: See TracBrowser for help on using the repository browser.