WordPress.org

Make WordPress Core

Ticket #35411: user.php

File user.php, 76.5 KB (added by michaelshulman, 4 years ago)

Fix for 35411

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