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