wp-includes/user.php

   1 <?php
   2 /**
   3  * WordPress User API
   4  *
   5  * @package WordPress
   6  */
   7
   8 /**
   9  * Authenticate user with remember capability.
  10  *
  11  * The credentials is an array that has 'user_login', 'user_password', and
  12  * 'remember' indices. If the credentials is not given, then the log in form
  13  * will be assumed and used if set.
  14  *
  15  * The various authentication cookies will be set by this function and will be
  16  * set for a longer period depending on if the 'remember' credential is set to
  17  * true.
  18  *
  19  * @since 2.5.0
  20  *
  21  * @param array $credentials Optional. User info in order to sign on.
  22  * @param bool $secure_cookie Optional. Whether to use secure cookie.
  23  * @return object Either WP_Error on failure, or WP_User on success.
  24  */
  25 function wp_signon( $credentials = '', $secure_cookie = '' ) {
  26         if ( empty($credentials) ) {
  27                 if ( ! empty($_POST['log']) )
  28                         $credentials['user_login'] = $_POST['log'];
  29                 if ( ! empty($_POST['pwd']) )
  30                         $credentials['user_password'] = $_POST['pwd'];
  31                 if ( ! empty($_POST['rememberme']) )
  32                         $credentials['remember'] = $_POST['rememberme'];
  33         }
  34
  35         if ( !empty($credentials['remember']) )
  36                 $credentials['remember'] = true;
  37         else
  38                 $credentials['remember'] = false;
  39
  40         // TODO do we deprecate the wp_authentication action?
  41         do_action_ref_array('wp_authenticate', array(&$credentials['user_login'], &$credentials['user_password']));
  42
  43         if ( '' === $secure_cookie )
  44                 $secure_cookie = is_ssl();
  45
  46         $secure_cookie = apply_filters('secure_signon_cookie', $secure_cookie, $credentials);
  47
  48         global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
  49         $auth_secure_cookie = $secure_cookie;
  50
  51         add_filter('authenticate', 'wp_authenticate_cookie', 30, 3);
  52
  53         $user = wp_authenticate($credentials['user_login'], $credentials['user_password']);
  54
  55         if ( is_wp_error($user) ) {
  56                 if ( $user->get_error_codes() == array('empty_username', 'empty_password') ) {
  57                         $user = new WP_Error('', '');
  58                 }
  59
  60                 return $user;
  61         }
  62
  63         wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie);
  64         do_action('wp_login', $user->user_login, $user);
  65         return $user;
  66 }
  67
  68 /**
  69  * Authenticate the user using the username and password.
  70  */
  71 add_filter('authenticate', 'wp_authenticate_username_password', 20, 3);
  72 function wp_authenticate_username_password($user, $username, $password) {
  73         if ( is_a($user, 'WP_User') ) { return $user; }
  74
  75         if ( empty($username) || empty($password) ) {
  76                 $error = new WP_Error();
  77
  78                 if ( empty($username) )
  79                         $error->add('empty_username', __('<strong>ERROR</strong>: The username field is empty.'));
  80
  81                 if ( empty($password) )
  82                         $error->add('empty_password', __('<strong>ERROR</strong>: The password field is empty.'));
  83
  84                 return $error;
  85         }
  86
  87         $userdata = get_user_by('login', $username);
  88
  89         if ( !$userdata )
  90                 return new WP_Error('invalid_username', sprintf(__('<strong>ERROR</strong>: Invalid username. <a href="%s" title="Password Lost and Found">Lost your password</a>?'), wp_lostpassword_url()));
  91
  92         if ( is_multisite() ) {
  93                 // Is user marked as spam?
  94                 if ( 1 == $userdata->spam)
  95                         return new WP_Error('invalid_username', __('<strong>ERROR</strong>: Your account has been marked as a spammer.'));
  96
  97                 // Is a user's blog marked as spam?
  98                 if ( !is_super_admin( $userdata->ID ) && isset($userdata->primary_blog) ) {
  99                         $details = get_blog_details( $userdata->primary_blog );
 100                         if ( is_object( $details ) && $details->spam == 1 )
 101                                 return new WP_Error('blog_suspended', __('Site Suspended.'));
 102                 }
 103         }
 104
 105         $userdata = apply_filters('wp_authenticate_user', $userdata, $password);
 106         if ( is_wp_error($userdata) )
 107                 return $userdata;
 108
 109         if ( !wp_check_password($password, $userdata->user_pass, $userdata->ID) )
 110                 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" title="Password Lost and Found">Lost your password</a>?' ),
 111                 $username, wp_lostpassword_url() ) );
 112
 113         $user =  new WP_User($userdata->ID);
 114         return $user;
 115 }
 116
 117 /**
 118  * Authenticate the user using the WordPress auth cookie.
 119  */
 120 function wp_authenticate_cookie($user, $username, $password) {
 121         if ( is_a($user, 'WP_User') ) { return $user; }
 122
 123         if ( empty($username) && empty($password) ) {
 124                 $user_id = wp_validate_auth_cookie();
 125                 if ( $user_id )
 126                         return new WP_User($user_id);
 127
 128                 global $auth_secure_cookie;
 129
 130                 if ( $auth_secure_cookie )
 131                         $auth_cookie = SECURE_AUTH_COOKIE;
 132                 else
 133                         $auth_cookie = AUTH_COOKIE;
 134
 135                 if ( !empty($_COOKIE[$auth_cookie]) )
 136                         return new WP_Error('expired_session', __('Please log in again.'));
 137
 138                 // If the cookie is not set, be silent.
 139         }
 140
 141         return $user;
 142 }
 143
 144 /**
 145  * Number of posts user has written.
 146  *
 147  * @since 3.0.0
 148  * @uses $wpdb WordPress database object for queries.
 149  *
 150  * @param int $userid User ID.
 151  * @return int Amount of posts user has written.
 152  */
 153 function count_user_posts($userid) {
 154         global $wpdb;
 155
 156         $where = get_posts_by_author_sql('post', true, $userid);
 157
 158         $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" );
 159
 160         return apply_filters('get_usernumposts', $count, $userid);
 161 }
 162
 163 /**
 164  * Number of posts written by a list of users.
 165  *
 166  * @since 3.0.0
 167  *
 168  * @param array $users Array of user IDs.
 169  * @param string|array $post_type Optional. Post type to check. Defaults to post.
 170  * @return array Amount of posts each user has written.
 171  */
 172 function count_many_users_posts( $users, $post_type = 'post' ) {
 173         global $wpdb;
 174
 175         $count = array();
 176         if ( empty( $users ) || ! is_array( $users ) )
 177                 return $count;
 178
 179         $userlist = implode( ',', array_map( 'absint', $users ) );
 180         $where = get_posts_by_author_sql( $post_type );
 181
 182         $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N );
 183         foreach ( $result as $row ) {
 184                 $count[ $row[0] ] = $row[1];
 185         }
 186
 187         foreach ( $users as $id ) {
 188                 if ( ! isset( $count[ $id ] ) )
 189                         $count[ $id ] = 0;
 190         }
 191
 192         return $count;
 193 }
 194
 195 /**
 196  * Check that the user login name and password is correct.
 197  *
 198  * @since 0.71
 199  * @todo xmlrpc only. Maybe move to xmlrpc.php.
 200  *
 201  * @param string $user_login User name.
 202  * @param string $user_pass User password.
 203  * @return bool False if does not authenticate, true if username and password authenticates.
 204  */
 205 function user_pass_ok($user_login, $user_pass) {
 206         $user = wp_authenticate($user_login, $user_pass);
 207         if ( is_wp_error($user) )
 208                 return false;
 209
 210         return true;
 211 }
 212
 213 //
 214 // User option functions
 215 //
 216
 217 /**
 218  * Get the current user's ID
 219  *
 220  * @since MU
 221  *
 222  * @uses wp_get_current_user
 223  *
 224  * @return int The current user's ID
 225  */
 226 function get_current_user_id() {
 227         $user = wp_get_current_user();
 228         return ( isset( $user->ID ) ? (int) $user->ID : 0 );
 229 }
 230
 231 /**
 232  * Retrieve user option that can be either per Site or per Network.
 233  *
 234  * If the user ID is not given, then the current user will be used instead. If
 235  * the user ID is given, then the user data will be retrieved. The filter for
 236  * the result, will also pass the original option name and finally the user data
 237  * object as the third parameter.
 238  *
 239  * The option will first check for the per site name and then the per Network name.
 240  *
 241  * @since 2.0.0
 242  * @uses $wpdb WordPress database object for queries.
 243  * @uses apply_filters() Calls 'get_user_option_$option' hook with result,
 244  *              option parameter, and user data object.
 245  *
 246  * @param string $option User option name.
 247  * @param int $user Optional. User ID.
 248  * @param bool $deprecated Use get_option() to check for an option in the options table.
 249  * @return mixed
 250  */
 251 function get_user_option( $option, $user = 0, $deprecated = '' ) {
 252         global $wpdb;
 253
 254         if ( !empty( $deprecated ) )
 255                 _deprecated_argument( __FUNCTION__, '3.0' );
 256
 257         if ( empty( $user ) )
 258                 $user = wp_get_current_user();
 259         else
 260                 $user = new WP_User( $user );
 261
 262         if ( ! $user->exists() )
 263                 return false;
 264
 265         if ( $user->has_prop( $wpdb->prefix . $option ) ) // Blog specific
 266                 $result = $user->get( $wpdb->prefix . $option );
 267         elseif ( $user->has_prop( $option ) ) // User specific and cross-blog
 268                 $result = $user->get( $option );
 269         else
 270                 $result = false;
 271
 272         return apply_filters("get_user_option_{$option}", $result, $option, $user);
 273 }
 274
 275 /**
 276  * Update user option with global blog capability.
 277  *
 278  * User options are just like user metadata except that they have support for
 279  * global blog options. If the 'global' parameter is false, which it is by default
 280  * it will prepend the WordPress table prefix to the option name.
 281  *
 282  * Deletes the user option if $newvalue is empty.
 283  *
 284  * @since 2.0.0
 285  * @uses $wpdb WordPress database object for queries
 286  *
 287  * @param int $user_id User ID
 288  * @param string $option_name User option name.
 289  * @param mixed $newvalue User option value.
 290  * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
 291  * @return unknown
 292  */
 293 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
 294         global $wpdb;
 295
 296         if ( !$global )
 297                 $option_name = $wpdb->prefix . $option_name;
 298
 299         // For backward compatibility. See differences between update_user_meta() and deprecated update_usermeta().
 300         // http://core.trac.wordpress.org/ticket/13088
 301         if ( is_null( $newvalue ) || is_scalar( $newvalue ) && empty( $newvalue ) )
 302                 return delete_user_meta( $user_id, $option_name );
 303
 304         return update_user_meta( $user_id, $option_name, $newvalue );
 305 }
 306
 307 /**
 308  * Delete user option with global blog capability.
 309  *
 310  * User options are just like user metadata except that they have support for
 311  * global blog options. If the 'global' parameter is false, which it is by default
 312  * it will prepend the WordPress table prefix to the option name.
 313  *
 314  * @since 3.0.0
 315  * @uses $wpdb WordPress database object for queries
 316  *
 317  * @param int $user_id User ID
 318  * @param string $option_name User option name.
 319  * @param bool $global Optional. Whether option name is global or blog specific. Default false (blog specific).
 320  * @return unknown
 321  */
 322 function delete_user_option( $user_id, $option_name, $global = false ) {
 323         global $wpdb;
 324
 325         if ( !$global )
 326                 $option_name = $wpdb->prefix . $option_name;
 327         return delete_user_meta( $user_id, $option_name );
 328 }
 329
 330 /**
 331  * WordPress User Query class.
 332  *
 333  * @since 3.1.0
 334  */
 335 class WP_User_Query {
 336
 337         /**
 338          * List of found user ids
 339          *
 340          * @since 3.1.0
 341          * @access private
 342          * @var array
 343          */
 344         var $results;
 345
 346         /**
 347          * Total number of found users for the current query
 348          *
 349          * @since 3.1.0
 350          * @access private
 351          * @var int
 352          */
 353         var $total_users = 0;
 354
 355         // SQL clauses
 356         var $query_fields;
 357         var $query_from;
 358         var $query_where;
 359         var $query_orderby;
 360         var $query_limit;
 361
 362         /**
 363          * PHP5 constructor
 364          *
 365          * @since 3.1.0
 366          *
 367          * @param string|array $args The query variables
 368          * @return WP_User_Query
 369          */
 370         function __construct( $query = null ) {
 371                 if ( !empty( $query ) ) {
 372                         $this->query_vars = wp_parse_args( $query, array(
 373                                 'blog_id' => $GLOBALS['blog_id'],
 374                                 'role' => '',
 375                                 'meta_key' => '',
 376                                 'meta_value' => '',
 377                                 'meta_compare' => '',
 378                                 'include' => array(),
 379                                 'exclude' => array(),
 380                                 'search' => '',
 381                                 'search_columns' => array(),
 382                                 'orderby' => 'login',
 383                                 'order' => 'ASC',
 384                                 'offset' => '',
 385                                 'number' => '',
 386                                 'count_total' => true,
 387                                 'fields' => 'all',
 388                                 'who' => ''
 389                         ) );
 390
 391                         $this->prepare_query();
 392                         $this->query();
 393                 }
 394         }
 395
 396         /**
 397          * Prepare the query variables
 398          *
 399          * @since 3.1.0
 400          * @access private
 401          */
 402         function prepare_query() {
 403                 global $wpdb;
 404
 405                 $qv = &$this->query_vars;
 406
 407                 if ( is_array( $qv['fields'] ) ) {
 408                         $qv['fields'] = array_unique( $qv['fields'] );
 409
 410                         $this->query_fields = array();
 411                         foreach ( $qv['fields'] as $field )
 412                                 $this->query_fields[] = $wpdb->users . '.' . esc_sql( $field );
 413                         $this->query_fields = implode( ',', $this->query_fields );
 414                 } elseif ( 'all' == $qv['fields'] ) {
 415                         $this->query_fields = "$wpdb->users.*";
 416                 } else {
 417                         $this->query_fields = "$wpdb->users.ID";
 418                 }
 419
 420                 if ( $this->query_vars['count_total'] )
 421                         $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields;
 422
 423                 $this->query_from = "FROM $wpdb->users";
 424                 $this->query_where = "WHERE 1=1";
 425
 426                 // sorting
 427                 if ( in_array( $qv['orderby'], array('nicename', 'email', 'url', 'registered') ) ) {
 428                         $orderby = 'user_' . $qv['orderby'];
 429                 } elseif ( in_array( $qv['orderby'], array('user_nicename', 'user_email', 'user_url', 'user_registered') ) ) {
 430                         $orderby = $qv['orderby'];
 431                 } elseif ( 'name' == $qv['orderby'] || 'display_name' == $qv['orderby'] ) {
 432                         $orderby = 'display_name';
 433                 } elseif ( 'post_count' == $qv['orderby'] ) {
 434                         // todo: avoid the JOIN
 435                         $where = get_posts_by_author_sql('post');
 436                         $this->query_from .= " LEFT OUTER JOIN (
 437                                 SELECT post_author, COUNT(*) as post_count
 438                                 FROM $wpdb->posts
 439                                 $where
 440                                 GROUP BY post_author
 441                         ) p ON ({$wpdb->users}.ID = p.post_author)
 442                         ";
 443                         $orderby = 'post_count';
 444                 } elseif ( 'ID' == $qv['orderby'] || 'id' == $qv['orderby'] ) {
 445                         $orderby = 'ID';
 446                 } else {
 447                         $orderby = 'user_login';
 448                 }
 449
 450                 $qv['order'] = strtoupper( $qv['order'] );
 451                 if ( 'ASC' == $qv['order'] )
 452                         $order = 'ASC';
 453                 else
 454                         $order = 'DESC';
 455                 $this->query_orderby = "ORDER BY $orderby $order";
 456
 457                 // limit
 458                 if ( $qv['number'] ) {
 459                         if ( $qv['offset'] )
 460                                 $this->query_limit = $wpdb->prepare("LIMIT %d, %d", $qv['offset'], $qv['number']);
 461                         else
 462                                 $this->query_limit = $wpdb->prepare("LIMIT %d", $qv['number']);
 463                 }
 464
 465                 $search = trim( $qv['search'] );
 466                 if ( $search ) {
 467                         $leading_wild = ( ltrim($search, '*') != $search );
 468                         $trailing_wild = ( rtrim($search, '*') != $search );
 469                         if ( $leading_wild && $trailing_wild )
 470                                 $wild = 'both';
 471                         elseif ( $leading_wild )
 472                                 $wild = 'leading';
 473                         elseif ( $trailing_wild )
 474                                 $wild = 'trailing';
 475                         else
 476                                 $wild = false;
 477                         if ( $wild )
 478                                 $search = trim($search, '*');
 479
 480                         $search_columns = array();
 481                         if ( $qv['search_columns'] )
 482                                 $search_columns = array_intersect( $qv['search_columns'], array( 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename' ) );
 483                         if ( ! $search_columns ) {
 484                                 if ( false !== strpos( $search, '@') )
 485                                         $search_columns = array('user_email');
 486                                 elseif ( is_numeric($search) )
 487                                         $search_columns = array('user_login', 'ID');
 488                                 elseif ( preg_match('|^https?://|', $search) && ! wp_is_large_network( 'users' ) )
 489                                         $search_columns = array('user_url');
 490                                 else
 491                                         $search_columns = array('user_login', 'user_nicename');
 492                         }
 493
 494                         $this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
 495                 }
 496
 497                 $blog_id = absint( $qv['blog_id'] );
 498
 499                 if ( 'authors' == $qv['who'] && $blog_id ) {
 500                         $qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
 501                         $qv['meta_value'] = 0;
 502                         $qv['meta_compare'] = '!=';
 503                         $qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
 504                 }
 505
 506                 $role = trim( $qv['role'] );
 507
 508                 if ( $blog_id && ( $role || is_multisite() ) ) {
 509                         $cap_meta_query = array();
 510                         $cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
 511
 512                         if ( $role ) {
 513                                 $cap_meta_query['value'] = '"' . $role . '"';
 514                                 $cap_meta_query['compare'] = 'like';
 515                         }
 516
 517                         $qv['meta_query'][] = $cap_meta_query;
 518                 }
 519
 520                 $meta_query = new WP_Meta_Query();
 521                 $meta_query->parse_query_vars( $qv );
 522
 523                 if ( !empty( $meta_query->queries ) ) {
 524                         $clauses = $meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
 525                         $this->query_from .= $clauses['join'];
 526                         $this->query_where .= $clauses['where'];
 527
 528                         if ( 'OR' == $meta_query->relation )
 529                                 $this->query_fields = 'DISTINCT ' . $this->query_fields;
 530                 }
 531
 532                 if ( !empty( $qv['include'] ) ) {
 533                         $ids = implode( ',', wp_parse_id_list( $qv['include'] ) );
 534                         $this->query_where .= " AND $wpdb->users.ID IN ($ids)";
 535                 } elseif ( !empty($qv['exclude']) ) {
 536                         $ids = implode( ',', wp_parse_id_list( $qv['exclude'] ) );
 537                         $this->query_where .= " AND $wpdb->users.ID NOT IN ($ids)";
 538                 }
 539
 540                 do_action_ref_array( 'pre_user_query', array( &$this ) );
 541         }
 542
 543         /**
 544          * Execute the query, with the current variables
 545          *
 546          * @since 3.1.0
 547          * @access private
 548          */
 549         function query() {
 550                 global $wpdb;
 551
 552                 if ( is_array( $this->query_vars['fields'] ) || 'all' == $this->query_vars['fields'] ) {
 553                         $this->results = $wpdb->get_results("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
 554                 } else {
 555                         $this->results = $wpdb->get_col("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
 556                 }
 557
 558                 if ( $this->query_vars['count_total'] )
 559                         $this->total_users = $wpdb->get_var( apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()' ) );
 560
 561                 if ( !$this->results )
 562                         return;
 563
 564                 if ( 'all_with_meta' == $this->query_vars['fields'] ) {
 565                         cache_users( $this->results );
 566
 567                         $r = array();
 568                         foreach ( $this->results as $userid )
 569                                 $r[ $userid ] = new WP_User( $userid, '', $this->query_vars['blog_id'] );
 570
 571                         $this->results = $r;
 572                 }
 573         }
 574
 575         /*
 576          * Used internally to generate an SQL string for searching across multiple columns
 577          *
 578          * @access protected
 579          * @since 3.1.0
 580          *
 581          * @param string $string
 582          * @param array $cols
 583          * @param bool $wild Whether to allow wildcard searches. Default is false for Network Admin, true for
 584          *  single site. Single site allows leading and trailing wildcards, Network Admin only trailing.
 585          * @return string
 586          */
 587         function get_search_sql( $string, $cols, $wild = false ) {
 588                 $string = esc_sql( $string );
 589
 590                 $searches = array();
 591                 $leading_wild = ( 'leading' == $wild || 'both' == $wild ) ? '%' : '';
 592                 $trailing_wild = ( 'trailing' == $wild || 'both' == $wild ) ? '%' : '';
 593                 foreach ( $cols as $col ) {
 594                         if ( 'ID' == $col )
 595                                 $searches[] = "$col = '$string'";
 596                         else
 597                                 $searches[] = "$col LIKE '$leading_wild" . like_escape($string) . "$trailing_wild'";
 598                 }
 599
 600                 return ' AND (' . implode(' OR ', $searches) . ')';
 601         }
 602
 603         /**
 604          * Return the list of users
 605          *
 606          * @since 3.1.0
 607          * @access public
 608          *
 609          * @return array
 610          */
 611         function get_results() {
 612                 return $this->results;
 613         }
 614
 615         /**
 616          * Return the total number of users for the current query
 617          *
 618          * @since 3.1.0
 619          * @access public
 620          *
 621          * @return array
 622          */
 623         function get_total() {
 624                 return $this->total_users;
 625         }
 626 }
 627
 628 /**
 629  * Retrieve list of users matching criteria.
 630  *
 631  * @since 3.1.0
 632  * @uses $wpdb
 633  * @uses WP_User_Query See for default arguments and information.
 634  *
 635  * @param array $args Optional.
 636  * @return array List of users.
 637  */
 638 function get_users( $args = array() ) {
 639
 640         $args = wp_parse_args( $args );
 641         $args['count_total'] = false;
 642
 643         $user_search = new WP_User_Query($args);
 644
 645         return (array) $user_search->get_results();
 646 }
 647
 648 /**
 649  * Get the blogs a user belongs to.
 650  *
 651  * @since 3.0.0
 652  *
 653  * @param int $user_id User ID
 654  * @param bool $all Whether to retrieve all blogs, or only blogs that are not marked as deleted, archived, or spam.
 655  * @return array A list of the user's blogs. An empty array if the user doesn't exist or belongs to no blogs.
 656  */
 657 function get_blogs_of_user( $user_id, $all = false ) {
 658         global $wpdb;
 659
 660         $user_id = (int) $user_id;
 661
 662         // Logged out users can't have blogs
 663         if ( empty( $user_id ) )
 664                 return array();
 665
 666         $keys = get_user_meta( $user_id );
 667         if ( empty( $keys ) )
 668                 return array();
 669
 670         if ( ! is_multisite() ) {
 671                 $blog_id = get_current_blog_id();
 672                 $blogs = array( $blog_id => new stdClass );
 673                 $blogs[ $blog_id ]->userblog_id = $blog_id;
 674                 $blogs[ $blog_id ]->blogname = get_option('blogname');
 675                 $blogs[ $blog_id ]->domain = '';
 676                 $blogs[ $blog_id ]->path = '';
 677                 $blogs[ $blog_id ]->site_id = 1;
 678                 $blogs[ $blog_id ]->siteurl = get_option('siteurl');
 679                 return $blogs;
 680         }
 681
 682         $blogs = array();
 683
 684         if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {
 685                 $blog = get_blog_details( 1 );
 686                 if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
 687                         $blogs[ 1 ] = (object) array(
 688                                 'userblog_id' => 1,
 689                                 'blogname'    => $blog->blogname,
 690                                 'domain'      => $blog->domain,
 691                                 'path'        => $blog->path,
 692                                 'site_id'     => $blog->site_id,
 693                                 'siteurl'     => $blog->siteurl,
 694                         );
 695                 }
 696                 unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );
 697         }
 698
 699         $keys = array_keys( $keys );
 700
 701         foreach ( $keys as $key ) {
 702                 if ( 'capabilities' !== substr( $key, -12 ) )
 703                         continue;
 704                 if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) )
 705                         continue;
 706                 $blog_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );
 707                 if ( ! is_numeric( $blog_id ) )
 708                         continue;
 709
 710                 $blog_id = (int) $blog_id;
 711                 $blog = get_blog_details( $blog_id );
 712                 if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) {
 713                         $blogs[ $blog_id ] = (object) array(
 714                                 'userblog_id' => $blog_id,
 715                                 'blogname'    => $blog->blogname,
 716                                 'domain'      => $blog->domain,
 717                                 'path'        => $blog->path,
 718                                 'site_id'     => $blog->site_id,
 719                                 'siteurl'     => $blog->siteurl,
 720                         );
 721                 }
 722         }
 723
 724         return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all );
 725 }
 726
 727 /**
 728  * Find out whether a user is a member of a given blog.
 729  *
 730  * @since MU 1.1
 731  * @uses get_blogs_of_user()
 732  *
 733  * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
 734  * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
 735  * @return bool
 736  */
 737 function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
 738         $user_id = (int) $user_id;
 739         $blog_id = (int) $blog_id;
 740
 741         if ( empty( $user_id ) )
 742                 $user_id = get_current_user_id();
 743
 744         if ( empty( $blog_id ) )
 745                 $blog_id = get_current_blog_id();
 746
 747         $blogs = get_blogs_of_user( $user_id );
 748         return array_key_exists( $blog_id, $blogs );
 749 }
 750
 751 /**
 752  * Add meta data field to a user.
 753  *
 754  * Post meta data is called "Custom Fields" on the Administration Screens.
 755  *
 756  * @since 3.0.0
 757  * @uses add_metadata()
 758  * @link http://codex.wordpress.org/Function_Reference/add_user_meta
 759  *
 760  * @param int $user_id Post ID.
 761  * @param string $meta_key Metadata name.
 762  * @param mixed $meta_value Metadata value.
 763  * @param bool $unique Optional, default is false. Whether the same key should not be added.
 764  * @return bool False for failure. True for success.
 765  */
 766 function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
 767         return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
 768 }
 769
 770 /**
 771  * Remove metadata matching criteria from a user.
 772  *
 773  * You can match based on the key, or key and value. Removing based on key and
 774  * value, will keep from removing duplicate metadata with the same key. It also
 775  * allows removing all metadata matching key, if needed.
 776  *
 777  * @since 3.0.0
 778  * @uses delete_metadata()
 779  * @link http://codex.wordpress.org/Function_Reference/delete_user_meta
 780  *
 781  * @param int $user_id user ID
 782  * @param string $meta_key Metadata name.
 783  * @param mixed $meta_value Optional. Metadata value.
 784  * @return bool False for failure. True for success.
 785  */
 786 function delete_user_meta($user_id, $meta_key, $meta_value = '') {
 787         return delete_metadata('user', $user_id, $meta_key, $meta_value);
 788 }
 789
 790 /**
 791  * Retrieve user meta field for a user.
 792  *
 793  * @since 3.0.0
 794  * @uses get_metadata()
 795  * @link http://codex.wordpress.org/Function_Reference/get_user_meta
 796  *
 797  * @param int $user_id Post ID.
 798  * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
 799  * @param bool $single Whether to return a single value.
 800  * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
 801  *  is true.
 802  */
 803 function get_user_meta($user_id, $key = '', $single = false) {
 804         return get_metadata('user', $user_id, $key, $single);
 805 }
 806
 807 /**
 808  * Update user meta field based on user ID.
 809  *
 810  * Use the $prev_value parameter to differentiate between meta fields with the
 811  * same key and user ID.
 812  *
 813  * If the meta field for the user does not exist, it will be added.
 814  *
 815  * @since 3.0.0
 816  * @uses update_metadata
 817  * @link http://codex.wordpress.org/Function_Reference/update_user_meta
 818  *
 819  * @param int $user_id Post ID.
 820  * @param string $meta_key Metadata key.
 821  * @param mixed $meta_value Metadata value.
 822  * @param mixed $prev_value Optional. Previous value to check before removing.
 823  * @return bool False on failure, true if success.
 824  */
 825 function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
 826         return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
 827 }
 828
 829 /**
 830  * Count number of users who have each of the user roles.
 831  *
 832  * Assumes there are neither duplicated nor orphaned capabilities meta_values.
 833  * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query()
 834  * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users.
 835  * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257.
 836  *
 837  * @since 3.0.0
 838  * @param string $strategy 'time' or 'memory'
 839  * @return array Includes a grand total and an array of counts indexed by role strings.
 840  */
 841 function count_users($strategy = 'time') {
 842         global $wpdb, $wp_roles;
 843
 844         // Initialize
 845         $id = get_current_blog_id();
 846         $blog_prefix = $wpdb->get_blog_prefix($id);
 847         $result = array();
 848
 849         if ( 'time' == $strategy ) {
 850                 global $wp_roles;
 851
 852                 if ( ! isset( $wp_roles ) )
 853                         $wp_roles = new WP_Roles();
 854
 855                 $avail_roles = $wp_roles->get_names();
 856
 857                 // Build a CPU-intensive query that will return concise information.
 858                 $select_count = array();
 859                 foreach ( $avail_roles as $this_role => $name ) {
 860                         $select_count[] = "COUNT(NULLIF(`meta_value` LIKE '%\"" . like_escape( $this_role ) . "\"%', false))";
 861                 }
 862                 $select_count = implode(', ', $select_count);
 863
 864                 // Add the meta_value index to the selection list, then run the query.
 865                 $row = $wpdb->get_row( "SELECT $select_count, COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'", ARRAY_N );
 866
 867                 // Run the previous loop again to associate results with role names.
 868                 $col = 0;
 869                 $role_counts = array();
 870                 foreach ( $avail_roles as $this_role => $name ) {
 871                         $count = (int) $row[$col++];
 872                         if ($count > 0) {
 873                                 $role_counts[$this_role] = $count;
 874                         }
 875                 }
 876
 877                 // Get the meta_value index from the end of the result set.
 878                 $total_users = (int) $row[$col];
 879
 880                 $result['total_users'] = $total_users;
 881                 $result['avail_roles'] =& $role_counts;
 882         } else {
 883                 $avail_roles = array();
 884
 885                 $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" );
 886
 887                 foreach ( $users_of_blog as $caps_meta ) {
 888                         $b_roles = maybe_unserialize($caps_meta);
 889                         if ( ! is_array( $b_roles ) )
 890                                 continue;
 891                         foreach ( $b_roles as $b_role => $val ) {
 892                                 if ( isset($avail_roles[$b_role]) ) {
 893                                         $avail_roles[$b_role]++;
 894                                 } else {
 895                                         $avail_roles[$b_role] = 1;
 896                                 }
 897                         }
 898                 }
 899
 900                 $result['total_users'] = count( $users_of_blog );
 901                 $result['avail_roles'] =& $avail_roles;
 902         }
 903
 904         return $result;
 905 }
 906
 907 //
 908 // Private helper functions
 909 //
 910
 911 /**
 912  * Set up global user vars.
 913  *
 914  * Used by wp_set_current_user() for back compat. Might be deprecated in the future.
 915  *
 916  * @since 2.0.4
 917  * @global string $userdata User description.
 918  * @global string $user_login The user username for logging in
 919  * @global int $user_level The level of the user
 920  * @global int $user_ID The ID of the user
 921  * @global string $user_email The email address of the user
 922  * @global string $user_url The url in the user's profile
 923  * @global string $user_pass_md5 MD5 of the user's password
 924  * @global string $user_identity The display name of the user
 925  *
 926  * @param int $for_user_id Optional. User ID to set up global data.
 927  */
 928 function setup_userdata($for_user_id = '') {
 929         global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_pass_md5, $user_identity;
 930
 931         if ( '' == $for_user_id )
 932                 $user = wp_get_current_user();
 933         else
 934                 $user = new WP_User($for_user_id);
 935
 936         $userdata   = null;
 937         $user_ID    = (int) $user->ID;
 938         $user_level = (int) isset($user->user_level) ? $user->user_level : 0;
 939
 940         if ( ! $user->exists() ) {
 941                 $user_login = $user_email = $user_url = $user_pass_md5 = $user_identity = '';
 942                 return;
 943         }
 944
 945         $userdata   = $user;
 946         $user_login = $user->user_login;
 947         $user_email = $user->user_email;
 948         $user_url   = $user->user_url;
 949         $user_pass_md5 = md5( $user->user_pass );
 950         $user_identity = $user->display_name;
 951 }
 952
 953 /**
 954  * Create dropdown HTML content of users.
 955  *
 956  * The content can either be displayed, which it is by default or retrieved by
 957  * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
 958  * need to be used; all users will be displayed in that case. Only one can be
 959  * used, either 'include' or 'exclude', but not both.
 960  *
 961  * The available arguments are as follows:
 962  * <ol>
 963  * <li>show_option_all - Text to show all and whether HTML option exists.</li>
 964  * <li>show_option_none - Text for show none and whether HTML option exists.</li>
 965  * <li>hide_if_only_one_author - Don't create the dropdown if there is only one user.</li>
 966  * <li>orderby - SQL order by clause for what order the users appear. Default is 'display_name'.</li>
 967  * <li>order - Default is 'ASC'. Can also be 'DESC'.</li>
 968  * <li>include - User IDs to include.</li>
 969  * <li>exclude - User IDs to exclude.</li>
 970  * <li>multi - Default is 'false'. Whether to skip the ID attribute on the 'select' element. A 'true' value is overridden when id argument is set.</li>
 971  * <li>show - Default is 'display_name'. User table column to display. If the selected item is empty then the user_login will be displayed in parentheses</li>
 972  * <li>echo - Default is '1'. Whether to display or retrieve content.</li>
 973  * <li>selected - Which User ID is selected.</li>
 974  * <li>include_selected - Always include the selected user ID in the dropdown. Default is false.</li>
 975  * <li>name - Default is 'user'. Name attribute of select element.</li>
 976  * <li>id - Default is the value of the 'name' parameter. ID attribute of select element.</li>
 977  * <li>class - Class attribute of select element.</li>
 978  * <li>blog_id - ID of blog (Multisite only). Defaults to ID of current blog.</li>
 979  * <li>who - Which users to query. Currently only 'authors' is supported. Default is all users.</li>
 980  * </ol>
 981  *
 982  * @since 2.3.0
 983  * @uses $wpdb WordPress database object for queries
 984  *
 985  * @param string|array $args Optional. Override defaults.
 986  * @return string|null Null on display. String of HTML content on retrieve.
 987  */
 988 function wp_dropdown_users( $args = '' ) {
 989         $defaults = array(
 990                 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
 991                 'orderby' => 'display_name', 'order' => 'ASC',
 992                 'include' => '', 'exclude' => '', 'multi' => 0,
 993                 'show' => 'display_name', 'echo' => 1,
 994                 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
 995                 'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false
 996         );
 997
 998         $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
 999
1000         $r = wp_parse_args( $args, $defaults );
1001         extract( $r, EXTR_SKIP );
1002
1003         $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
1004         $query_args['fields'] = array( 'ID', $show );
1005         $users = get_users( $query_args );
1006
1007         $output = '';
1008         if ( !empty($users) && ( empty($hide_if_only_one_author) || count($users) > 1 ) ) {
1009                 $name = esc_attr( $name );
1010                 if ( $multi && ! $id )
1011                         $id = '';
1012                 else
1013                         $id = $id ? " id='" . esc_attr( $id ) . "'" : " id='$name'";
1014
1015                 $output = "<select name='{$name}'{$id} class='$class'>\n";
1016
1017                 if ( $show_option_all )
1018                         $output .= "\t<option value='0'>$show_option_all</option>\n";
1019
1020                 if ( $show_option_none ) {
1021                         $_selected = selected( -1, $selected, false );
1022                         $output .= "\t<option value='-1'$_selected>$show_option_none</option>\n";
1023                 }
1024
1025                 $found_selected = false;
1026                 foreach ( (array) $users as $user ) {
1027                         $user->ID = (int) $user->ID;
1028                         $_selected = selected( $user->ID, $selected, false );
1029                         if ( $_selected )
1030                                 $found_selected = true;
1031                         $display = !empty($user->$show) ? $user->$show : '('. $user->user_login . ')';
1032                         $output .= "\t<option value='$user->ID'$_selected>" . esc_html($display) . "</option>\n";
1033                 }
1034
1035                 if ( $include_selected && ! $found_selected && ( $selected > 0 ) ) {
1036                         $user = get_userdata( $selected );
1037                         $_selected = selected( $user->ID, $selected, false );
1038                         $display = !empty($user->$show) ? $user->$show : '('. $user->user_login . ')';
1039                         $output .= "\t<option value='$user->ID'$_selected>" . esc_html($display) . "</option>\n";
1040                 }
1041
1042                 $output .= "</select>";
1043         }
1044
1045         $output = apply_filters('wp_dropdown_users', $output);
1046
1047         if ( $echo )
1048                 echo $output;
1049
1050         return $output;
1051 }
1052
1053 /**
1054  * Sanitize user field based on context.
1055  *
1056  * Possible context values are:  'raw', 'edit', 'db', 'display', 'attribute' and 'js'. The
1057  * 'display' context is used by default. 'attribute' and 'js' contexts are treated like 'display'
1058  * when calling filters.
1059  *
1060  * @since 2.3.0
1061  * @uses apply_filters() Calls 'edit_$field' passing $value and $user_id if $context == 'edit'.
1062  *  $field is prefixed with 'user_' if it isn't already.
1063  * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db'. $field is prefixed with
1064  *  'user_' if it isn't already.
1065  * @uses apply_filters() Calls '$field' passing $value, $user_id and $context if $context == anything
1066  *  other than 'raw', 'edit' and 'db'. $field is prefixed with 'user_' if it isn't already.
1067  *
1068  * @param string $field The user Object field name.
1069  * @param mixed $value The user Object value.
1070  * @param int $user_id user ID.
1071  * @param string $context How to sanitize user fields. Looks for 'raw', 'edit', 'db', 'display',
1072  *               'attribute' and 'js'.
1073  * @return mixed Sanitized value.
1074  */
1075 function sanitize_user_field($field, $value, $user_id, $context) {
1076         $int_fields = array('ID');
1077         if ( in_array($field, $int_fields) )
1078                 $value = (int) $value;
1079
1080         if ( 'raw' == $context )
1081                 return $value;
1082
1083         if ( !is_string($value) && !is_numeric($value) )
1084                 return $value;
1085
1086         $prefixed = false !== strpos( $field, 'user_' );
1087
1088         if ( 'edit' == $context ) {
1089                 if ( $prefixed ) {
1090                         $value = apply_filters("edit_{$field}", $value, $user_id);
1091                 } else {
1092                         $value = apply_filters("edit_user_{$field}", $value, $user_id);
1093                 }
1094
1095                 if ( 'description' == $field )
1096                         $value = esc_html( $value ); // textarea_escaped?
1097                 else
1098                         $value = esc_attr($value);
1099         } else if ( 'db' == $context ) {
1100                 if ( $prefixed ) {
1101                         $value = apply_filters("pre_{$field}", $value);
1102                 } else {
1103                         $value = apply_filters("pre_user_{$field}", $value);
1104                 }
1105         } else {
1106                 // Use display filters by default.
1107                 if ( $prefixed )
1108                         $value = apply_filters($field, $value, $user_id, $context);
1109                 else
1110                         $value = apply_filters("user_{$field}", $value, $user_id, $context);
1111         }
1112
1113         if ( 'user_url' == $field )
1114                 $value = esc_url($value);
1115
1116         if ( 'attribute' == $context )
1117                 $value = esc_attr($value);
1118         else if ( 'js' == $context )
1119                 $value = esc_js($value);
1120
1121         return $value;
1122 }
1123
1124 /**
1125  * Update all user caches
1126  *
1127  * @since 3.0.0
1128  *
1129  * @param object $user User object to be cached
1130  */
1131 function update_user_caches($user) {
1132         wp_cache_add($user->ID, $user, 'users');
1133         wp_cache_add($user->user_login, $user->ID, 'userlogins');
1134         wp_cache_add($user->user_email, $user->ID, 'useremail');
1135         wp_cache_add($user->user_nicename, $user->ID, 'userslugs');
1136 }
1137
1138 /**
1139  * Clean all user caches
1140  *
1141  * @since 3.0.0
1142  *
1143  * @param WP_User|int $user User object or ID to be cleaned from the cache
1144  */
1145 function clean_user_cache( $user ) {
1146         if ( is_numeric( $user ) )
1147                 $user = new WP_User( $user );
1148
1149         if ( ! $user->exists() )
1150                 return;
1151
1152         wp_cache_delete( $user->ID, 'users' );
1153         wp_cache_delete( $user->user_login, 'userlogins' );
1154         wp_cache_delete( $user->user_email, 'useremail' );
1155         wp_cache_delete( $user->user_nicename, 'userslugs' );
1156 }
1157
1158 /**
1159  * Checks whether the given username exists.
1160  *
1161  * @since 2.0.0
1162  *
1163  * @param string $username Username.
1164  * @return null|int The user's ID on success, and null on failure.
1165  */
1166 function username_exists( $username ) {
1167         if ( $user = get_user_by('login', $username ) ) {
1168                 return $user->ID;
1169         } else {
1170                 return null;
1171         }
1172 }
1173
1174 /**
1175  * Checks whether the given email exists.
1176  *
1177  * @since 2.1.0
1178  * @uses $wpdb
1179  *
1180  * @param string $email Email.
1181  * @return bool|int The user's ID on success, and false on failure.
1182  */
1183 function email_exists( $email ) {
1184         if ( $user = get_user_by('email', $email) )
1185                 return $user->ID;
1186
1187         return false;
1188 }
1189
1190 /**
1191  * Checks whether an username is valid.
1192  *
1193  * @since 2.0.1
1194  * @uses apply_filters() Calls 'validate_username' hook on $valid check and $username as parameters
1195  *
1196  * @param string $username Username.
1197  * @return bool Whether username given is valid
1198  */
1199 function validate_username( $username ) {
1200         $sanitized = sanitize_user( $username, true );
1201         $valid = ( $sanitized == $username );
1202         return apply_filters( 'validate_username', $valid, $username );
1203 }
1204
1205 /**
1206  * Insert an user into the database.
1207  *
1208  * Can update a current user or insert a new user based on whether the user's ID
1209  * is present.
1210  *
1211  * Can be used to update the user's info (see below), set the user's role, and
1212  * set the user's preference on whether they want the rich editor on.
1213  *
1214  * Most of the $userdata array fields have filters associated with the values.
1215  * The exceptions are 'rich_editing', 'role', 'jabber', 'aim', 'yim',
1216  * 'user_registered', and 'ID'. The filters have the prefix 'pre_user_' followed
1217  * by the field name. An example using 'description' would have the filter
1218  * called, 'pre_user_description' that can be hooked into.
1219  *
1220  * The $userdata array can contain the following fields:
1221  * 'ID' - An integer that will be used for updating an existing user.
1222  * 'user_pass' - A string that contains the plain text password for the user.
1223  * 'user_login' - A string that contains the user's username for logging in.
1224  * 'user_nicename' - A string that contains a nicer looking name for the user.
1225  *              The default is the user's username.
1226  * 'user_url' - A string containing the user's URL for the user's web site.
1227  * 'user_email' - A string containing the user's email address.
1228  * 'display_name' - A string that will be shown on the site. Defaults to user's
1229  *              username. It is likely that you will want to change this, for appearance.
1230  * 'nickname' - The user's nickname, defaults to the user's username.
1231  * 'first_name' - The user's first name.
1232  * 'last_name' - The user's last name.
1233  * 'description' - A string containing content about the user.
1234  * 'rich_editing' - A string for whether to enable the rich editor. False
1235  *              if not empty.
1236  * 'user_registered' - The date the user registered. Format is 'Y-m-d H:i:s'.
1237  * 'role' - A string used to set the user's role.
1238  * 'jabber' - User's Jabber account.
1239  * 'aim' - User's AOL IM account.
1240  * 'yim' - User's Yahoo IM account.
1241  *
1242  * @since 2.0.0
1243  * @uses $wpdb WordPress database layer.
1244  * @uses apply_filters() Calls filters for most of the $userdata fields with the prefix 'pre_user'. See note above.
1245  * @uses do_action() Calls 'profile_update' hook when updating giving the user's ID
1246  * @uses do_action() Calls 'user_register' hook when creating a new user giving the user's ID
1247  *
1248  * @param array $userdata An array of user data.
1249  * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not be created.
1250  */
1251 function wp_insert_user($userdata) {
1252         global $wpdb;
1253
1254         extract($userdata, EXTR_SKIP);
1255
1256         // Are we updating or creating?
1257         if ( !empty($ID) ) {
1258                 $ID = (int) $ID;
1259                 $update = true;
1260                 $old_user_data = WP_User::get_data_by( 'id', $ID );
1261         } else {
1262                 $update = false;
1263                 // Hash the password
1264                 $user_pass = wp_hash_password($user_pass);
1265         }
1266
1267         $user_login = sanitize_user($user_login, true);
1268         $user_login = apply_filters('pre_user_login', $user_login);
1269
1270         //Remove any non-printable chars from the login string to see if we have ended up with an empty username
1271         $user_login = trim($user_login);
1272
1273         if ( empty($user_login) )
1274                 return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
1275
1276         if ( !$update && username_exists( $user_login ) )
1277                 return new WP_Error('existing_user_login', __('This username is already registered.') );
1278
1279         if ( empty($user_nicename) )
1280                 $user_nicename = sanitize_title( $user_login );
1281         $user_nicename = apply_filters('pre_user_nicename', $user_nicename);
1282
1283         if ( empty($user_url) )
1284                 $user_url = '';
1285         $user_url = apply_filters('pre_user_url', $user_url);
1286
1287         if ( empty($user_email) )
1288                 $user_email = '';
1289         $user_email = apply_filters('pre_user_email', $user_email);
1290
1291         if ( !$update && ! defined( 'WP_IMPORTING' ) && email_exists($user_email) )
1292                 return new WP_Error('existing_user_email', __('This email address is already registered.') );
1293
1294         if ( empty($display_name) )
1295                 $display_name = $user_login;
1296         $display_name = apply_filters('pre_user_display_name', $display_name);
1297
1298         if ( empty($nickname) )
1299                 $nickname = $user_login;
1300         $nickname = apply_filters('pre_user_nickname', $nickname);
1301
1302         if ( empty($first_name) )
1303                 $first_name = '';
1304         $first_name = apply_filters('pre_user_first_name', $first_name);
1305
1306         if ( empty($last_name) )
1307                 $last_name = '';
1308         $last_name = apply_filters('pre_user_last_name', $last_name);
1309
1310         if ( empty($description) )
1311                 $description = '';
1312         $description = apply_filters('pre_user_description', $description);
1313
1314         if ( empty($rich_editing) )
1315                 $rich_editing = 'true';
1316
1317         if ( empty($comment_shortcuts) )
1318                 $comment_shortcuts = 'false';
1319
1320         if ( empty($admin_color) )
1321                 $admin_color = 'fresh';
1322         $admin_color = preg_replace('|[^a-z0-9 _.\-@]|i', '', $admin_color);
1323
1324         if ( empty($use_ssl) )
1325                 $use_ssl = 0;
1326
1327         if ( empty($user_registered) )
1328                 $user_registered = gmdate('Y-m-d H:i:s');
1329
1330         if ( empty($show_admin_bar_front) )
1331                 $show_admin_bar_front = 'true';
1332
1333         $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));
1334
1335         if ( $user_nicename_check ) {
1336                 $suffix = 2;
1337                 while ($user_nicename_check) {
1338                         $alt_user_nicename = $user_nicename . "-$suffix";
1339                         $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));
1340                         $suffix++;
1341                 }
1342                 $user_nicename = $alt_user_nicename;
1343         }
1344
1345         $data = compact( 'user_pass', 'user_email', 'user_url', 'user_nicename', 'display_name', 'user_registered' );
1346         $data = stripslashes_deep( $data );
1347
1348         if ( $update ) {
1349                 $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
1350                 $user_id = (int) $ID;
1351         } else {
1352                 $wpdb->insert( $wpdb->users, $data + compact( 'user_login' ) );
1353                 $user_id = (int) $wpdb->insert_id;
1354         }
1355
1356         $user = new WP_User( $user_id );
1357
1358         foreach ( _get_additional_user_keys( $user ) as $key ) {
1359                 if ( isset( $$key ) )
1360                         update_user_meta( $user_id, $key, $$key );
1361         }
1362
1363         if ( isset($role) )
1364                 $user->set_role($role);
1365         elseif ( !$update )
1366                 $user->set_role(get_option('default_role'));
1367
1368         wp_cache_delete($user_id, 'users');
1369         wp_cache_delete($user_login, 'userlogins');
1370
1371         if ( $update )
1372                 do_action('profile_update', $user_id, $old_user_data);
1373         else
1374                 do_action('user_register', $user_id);
1375
1376         return $user_id;
1377 }
1378
1379 /**
1380  * Update an user in the database.
1381  *
1382  * It is possible to update a user's password by specifying the 'user_pass'
1383  * value in the $userdata parameter array.
1384  *
1385  * If $userdata does not contain an 'ID' key, then a new user will be created
1386  * and the new user's ID will be returned.
1387  *
1388  * If current user's password is being updated, then the cookies will be
1389  * cleared.
1390  *
1391  * @since 2.0.0
1392  * @see wp_insert_user() For what fields can be set in $userdata
1393  * @uses wp_insert_user() Used to update existing user or add new one if user doesn't exist already
1394  *
1395  * @param array $userdata An array of user data.
1396  * @return int The updated user's ID.
1397  */
1398 function wp_update_user($userdata) {
1399         $ID = (int) $userdata['ID'];
1400
1401         // First, get all of the original fields
1402         $user_obj = get_userdata( $ID );
1403
1404         $user = get_object_vars( $user_obj->data );
1405
1406         // Add additional custom fields
1407         foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
1408                 $user[ $key ] = get_user_meta( $ID, $key, true );
1409         }
1410
1411         // Escape data pulled from DB.
1412         $user = add_magic_quotes( $user );
1413
1414         // If password is changing, hash it now.
1415         if ( ! empty($userdata['user_pass']) ) {
1416                 $plaintext_pass = $userdata['user_pass'];
1417                 $userdata['user_pass'] = wp_hash_password($userdata['user_pass']);
1418         }
1419
1420         wp_cache_delete($user[ 'user_email' ], 'useremail');
1421
1422         // Merge old and new fields with new fields overwriting old ones.
1423         $userdata = array_merge($user, $userdata);
1424         $user_id = wp_insert_user($userdata);
1425
1426         // Update the cookies if the password changed.
1427         $current_user = wp_get_current_user();
1428         if ( $current_user->ID == $ID ) {
1429                 if ( isset($plaintext_pass) ) {
1430                         wp_clear_auth_cookie();
1431                         wp_set_auth_cookie($ID);
1432                 }
1433         }
1434
1435         return $user_id;
1436 }
1437
1438 /**
1439  * A simpler way of inserting an user into the database.
1440  *
1441  * Creates a new user with just the username, password, and email. For more
1442  * complex user creation use wp_insert_user() to specify more information.
1443  *
1444  * @since 2.0.0
1445  * @see wp_insert_user() More complete way to create a new user
1446  *
1447  * @param string $username The user's username.
1448  * @param string $password The user's password.
1449  * @param string $email The user's email (optional).
1450  * @return int The new user's ID.
1451  */
1452 function wp_create_user($username, $password, $email = '') {
1453         $user_login = esc_sql( $username );
1454         $user_email = esc_sql( $email    );
1455         $user_pass = $password;
1456
1457         $userdata = compact('user_login', 'user_email', 'user_pass');
1458         return wp_insert_user($userdata);
1459 }
1460
1461 /**
1462  * Return a list of meta keys that wp_insert_user() is supposed to set.
1463  *
1464  * @access private
1465  * @since 3.3.0
1466  *
1467  * @param object $user WP_User instance
1468  * @return array
1469  */
1470 function _get_additional_user_keys( $user ) {
1471         $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' );
1472         return array_merge( $keys, array_keys( _wp_get_user_contactmethods( $user ) ) );
1473 }
1474
1475 /**
1476  * Set up the default contact methods
1477  *
1478  * @access private
1479  * @since
1480  *
1481  * @param object $user User data object (optional)
1482  * @return array $user_contactmethods Array of contact methods and their labels.
1483  */
1484 function _wp_get_user_contactmethods( $user = null ) {
1485         $user_contactmethods = array(
1486                 'aim' => __('AIM'),
1487                 'yim' => __('Yahoo IM'),
1488                 'jabber' => __('Jabber / Google Talk')
1489         );
1490         return apply_filters( 'user_contactmethods', $user_contactmethods, $user );
1491 }