X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f9001779751f83dc8a10e478bfecb4d8dd5f964c..6c8f14c09105d0afa4c1574215c59b5021040e76:/wp-includes/user.php diff --git a/wp-includes/user.php b/wp-includes/user.php index cd4b01d9..7bdc37cc 100644 --- a/wp-includes/user.php +++ b/wp-includes/user.php @@ -61,11 +61,10 @@ function wp_signon( $credentials = '', $secure_cookie = '' ) { } wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie); - do_action('wp_login', $credentials['user_login']); + do_action('wp_login', $user->user_login, $user); return $user; } - /** * Authenticate the user using the username and password. */ @@ -85,33 +84,32 @@ function wp_authenticate_username_password($user, $username, $password) { return $error; } - $userdata = get_user_by('login', $username); + $user = get_user_by('login', $username); - if ( !$userdata ) - return new WP_Error('invalid_username', sprintf(__('ERROR: Invalid username. Lost your password?'), site_url('wp-login.php?action=lostpassword', 'login'))); + if ( !$user ) + return new WP_Error('invalid_username', sprintf(__('ERROR: Invalid username. Lost your password?'), wp_lostpassword_url())); if ( is_multisite() ) { // Is user marked as spam? - if ( 1 == $userdata->spam) + if ( 1 == $user->spam) return new WP_Error('invalid_username', __('ERROR: Your account has been marked as a spammer.')); // Is a user's blog marked as spam? - if ( !is_super_admin( $userdata->ID ) && isset($userdata->primary_blog) ) { - $details = get_blog_details( $userdata->primary_blog ); + if ( !is_super_admin( $user->ID ) && isset($user->primary_blog) ) { + $details = get_blog_details( $user->primary_blog ); if ( is_object( $details ) && $details->spam == 1 ) return new WP_Error('blog_suspended', __('Site Suspended.')); } } - $userdata = apply_filters('wp_authenticate_user', $userdata, $password); - if ( is_wp_error($userdata) ) - return $userdata; + $user = apply_filters('wp_authenticate_user', $user, $password); + if ( is_wp_error($user) ) + return $user; - if ( !wp_check_password($password, $userdata->user_pass, $userdata->ID) ) + if ( !wp_check_password($password, $user->user_pass, $user->ID) ) return new WP_Error( 'incorrect_password', sprintf( __( 'ERROR: The password you entered for the username %1$s is incorrect. Lost your password?' ), - $username, site_url( 'wp-login.php?action=lostpassword', 'login' ) ) ); + $username, wp_lostpassword_url() ) ); - $user = new WP_User($userdata->ID); return $user; } @@ -154,7 +152,7 @@ function wp_authenticate_cookie($user, $username, $password) { function count_user_posts($userid) { global $wpdb; - $where = get_posts_by_author_sql('post', TRUE, $userid); + $where = get_posts_by_author_sql('post', true, $userid); $count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->posts $where" ); @@ -165,18 +163,21 @@ function count_user_posts($userid) { * Number of posts written by a list of users. * * @since 3.0.0 - * @param array $users User ID number list. + * + * @param array $users Array of user IDs. + * @param string $post_type Optional. Post type to check. Defaults to post. + * @param bool $public_only Optional. Only return counts for public posts. Defaults to false. * @return array Amount of posts each user has written. */ -function count_many_users_posts($users) { +function count_many_users_posts( $users, $post_type = 'post', $public_only = false ) { global $wpdb; $count = array(); - if ( ! is_array($users) || empty( $users ) ) + if ( empty( $users ) || ! is_array( $users ) ) return $count; - $userlist = implode( ',', $users ); - $where = get_posts_by_author_sql( 'post' ); + $userlist = implode( ',', array_map( 'absint', $users ) ); + $where = get_posts_by_author_sql( $post_type, true, null, $public_only ); $result = $wpdb->get_results( "SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ($userlist) GROUP BY post_author", ARRAY_N ); foreach ( $result as $row ) { @@ -191,24 +192,6 @@ function count_many_users_posts($users) { return $count; } -/** - * Check that the user login name and password is correct. - * - * @since 0.71 - * @todo xmlrpc only. Maybe move to xmlrpc.php. - * - * @param string $user_login User name. - * @param string $user_pass User password. - * @return bool False if does not authenticate, true if username and password authenticates. - */ -function user_pass_ok($user_login, $user_pass) { - $user = wp_authenticate($user_login, $user_pass); - if ( is_wp_error($user) ) - return false; - - return true; -} - // // User option functions // @@ -253,20 +236,16 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) { if ( !empty( $deprecated ) ) _deprecated_argument( __FUNCTION__, '3.0' ); - if ( empty($user) ) { - $user = wp_get_current_user(); - $user = $user->ID; - } - - $user = get_userdata($user); + if ( empty( $user ) ) + $user = get_current_user_id(); - // Keys used as object vars cannot have dashes. - $key = str_replace('-', '', $option); + if ( ! $user = get_userdata( $user ) ) + return false; - if ( isset( $user->{$wpdb->prefix . $key} ) ) // Blog specific - $result = $user->{$wpdb->prefix . $key}; - elseif ( isset( $user->{$key} ) ) // User specific and cross-blog - $result = $user->{$key}; + if ( $user->has_prop( $wpdb->prefix . $option ) ) // Blog specific + $result = $user->get( $wpdb->prefix . $option ); + elseif ( $user->has_prop( $option ) ) // User specific and cross-blog + $result = $user->get( $option ); else $result = false; @@ -335,6 +314,15 @@ function delete_user_option( $user_id, $option_name, $global = false ) { */ class WP_User_Query { + /** + * Query vars, after parsing + * + * @since 3.5.0 + * @access public + * @var array + */ + var $query_vars = array(); + /** * List of found user ids * @@ -360,13 +348,6 @@ class WP_User_Query { var $query_orderby; var $query_limit; - /** - * PHP4 constructor - */ - function WP_User_Query( $query = null ) { - $this->__construct( $query ); - } - /** * PHP5 constructor * @@ -386,9 +367,11 @@ class WP_User_Query { 'include' => array(), 'exclude' => array(), 'search' => '', + 'search_columns' => array(), 'orderby' => 'login', 'order' => 'ASC', - 'offset' => '', 'number' => '', + 'offset' => '', + 'number' => '', 'count_total' => true, 'fields' => 'all', 'who' => '' @@ -408,7 +391,7 @@ class WP_User_Query { function prepare_query() { global $wpdb; - $qv = &$this->query_vars; + $qv =& $this->query_vars; if ( is_array( $qv['fields'] ) ) { $qv['fields'] = array_unique( $qv['fields'] ); @@ -423,6 +406,9 @@ class WP_User_Query { $this->query_fields = "$wpdb->users.ID"; } + if ( $qv['count_total'] ) + $this->query_fields = 'SQL_CALC_FOUND_ROWS ' . $this->query_fields; + $this->query_from = "FROM $wpdb->users"; $this->query_where = "WHERE 1=1"; @@ -438,7 +424,7 @@ class WP_User_Query { $where = get_posts_by_author_sql('post'); $this->query_from .= " LEFT OUTER JOIN ( SELECT post_author, COUNT(*) as post_count - FROM wp_posts + FROM $wpdb->posts $where GROUP BY post_author ) p ON ({$wpdb->users}.ID = p.post_author) @@ -480,14 +466,19 @@ class WP_User_Query { if ( $wild ) $search = trim($search, '*'); - if ( false !== strpos( $search, '@') ) - $search_columns = array('user_email'); - elseif ( is_numeric($search) ) - $search_columns = array('user_login', 'ID'); - elseif ( preg_match('|^https?://|', $search) ) - $search_columns = array('user_url'); - else - $search_columns = array('user_login', 'user_nicename'); + $search_columns = array(); + if ( $qv['search_columns'] ) + $search_columns = array_intersect( $qv['search_columns'], array( 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename' ) ); + if ( ! $search_columns ) { + if ( false !== strpos( $search, '@') ) + $search_columns = array('user_email'); + elseif ( is_numeric($search) ) + $search_columns = array('user_login', 'ID'); + elseif ( preg_match('|^https?://|', $search) && ! wp_is_large_network( 'users' ) ) + $search_columns = array('user_url'); + else + $search_columns = array('user_login', 'user_nicename'); + } $this->query_where .= $this->get_search_sql( $search, $search_columns, $wild ); } @@ -496,13 +487,11 @@ class WP_User_Query { if ( 'authors' == $qv['who'] && $blog_id ) { $qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level'; - $qv['meta_value'] = '_wp_zero_value'; // Hack to pass '0' + $qv['meta_value'] = 0; $qv['meta_compare'] = '!='; $qv['blog_id'] = $blog_id = 0; // Prevent extra meta query } - _parse_meta_query( $qv ); - $role = trim( $qv['role'] ); if ( $blog_id && ( $role || is_multisite() ) ) { @@ -517,10 +506,16 @@ class WP_User_Query { $qv['meta_query'][] = $cap_meta_query; } - if ( !empty( $qv['meta_query'] ) ) { - $clauses = call_user_func_array( '_get_meta_sql', array( $qv['meta_query'], 'user', $wpdb->users, 'ID', &$this ) ); + $meta_query = new WP_Meta_Query(); + $meta_query->parse_query_vars( $qv ); + + if ( !empty( $meta_query->queries ) ) { + $clauses = $meta_query->get_sql( 'user', $wpdb->users, 'ID', $this ); $this->query_from .= $clauses['join']; $this->query_where .= $clauses['where']; + + if ( 'OR' == $meta_query->relation ) + $this->query_fields = 'DISTINCT ' . $this->query_fields; } if ( !empty( $qv['include'] ) ) { @@ -543,29 +538,64 @@ class WP_User_Query { function query() { global $wpdb; - if ( is_array( $this->query_vars['fields'] ) || 'all' == $this->query_vars['fields'] ) { + $qv =& $this->query_vars; + + if ( is_array( $qv['fields'] ) || 'all' == $qv['fields'] ) { $this->results = $wpdb->get_results("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit"); } else { $this->results = $wpdb->get_col("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit"); } - if ( $this->query_vars['count_total'] ) - $this->total_users = $wpdb->get_var("SELECT COUNT(*) $this->query_from $this->query_where"); + if ( $qv['count_total'] ) + $this->total_users = $wpdb->get_var( apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()' ) ); if ( !$this->results ) return; - if ( 'all_with_meta' == $this->query_vars['fields'] ) { + if ( 'all_with_meta' == $qv['fields'] ) { cache_users( $this->results ); $r = array(); foreach ( $this->results as $userid ) - $r[ $userid ] = new WP_User( $userid, '', $this->query_vars['blog_id'] ); + $r[ $userid ] = new WP_User( $userid, '', $qv['blog_id'] ); $this->results = $r; + } elseif ( 'all' == $qv['fields'] ) { + foreach ( $this->results as $key => $user ) { + $this->results[ $key ] = new WP_User( $user ); + } } } + /** + * Retrieve query variable. + * + * @since 3.5.0 + * @access public + * + * @param string $query_var Query variable key. + * @return mixed + */ + function get( $query_var ) { + if ( isset( $this->query_vars[$query_var] ) ) + return $this->query_vars[$query_var]; + + return null; + } + + /** + * Set query variable. + * + * @since 3.5.0 + * @access public + * + * @param string $query_var Query variable key. + * @param mixed $value Query variable value. + */ + function set( $query_var, $value ) { + $this->query_vars[$query_var] = $value; + } + /* * Used internally to generate an SQL string for searching across multiple columns * @@ -644,103 +674,117 @@ function get_users( $args = array() ) { * * @since 3.0.0 * - * @param int $id User Id - * @param bool $all Whether to retrieve all blogs or only blogs that are not marked as deleted, archived, or spam. - * @return array A list of the user's blogs. False if the user was not found or an empty array if the user has no blogs. + * @param int $user_id User ID + * @param bool $all Whether to retrieve all blogs, or only blogs that are not marked as deleted, archived, or spam. + * @return array A list of the user's blogs. An empty array if the user doesn't exist or belongs to no blogs. */ -function get_blogs_of_user( $id, $all = false ) { +function get_blogs_of_user( $user_id, $all = false ) { global $wpdb; - if ( !is_multisite() ) { + $user_id = (int) $user_id; + + // Logged out users can't have blogs + if ( empty( $user_id ) ) + return array(); + + $keys = get_user_meta( $user_id ); + if ( empty( $keys ) ) + return array(); + + if ( ! is_multisite() ) { $blog_id = get_current_blog_id(); - $blogs = array(); + $blogs = array( $blog_id => new stdClass ); $blogs[ $blog_id ]->userblog_id = $blog_id; $blogs[ $blog_id ]->blogname = get_option('blogname'); $blogs[ $blog_id ]->domain = ''; $blogs[ $blog_id ]->path = ''; $blogs[ $blog_id ]->site_id = 1; $blogs[ $blog_id ]->siteurl = get_option('siteurl'); + $blogs[ $blog_id ]->archived = 0; + $blogs[ $blog_id ]->spam = 0; + $blogs[ $blog_id ]->deleted = 0; return $blogs; } - $blogs = wp_cache_get( 'blogs_of_user-' . $id, 'users' ); - - // Try priming the new cache from the old cache - if ( false === $blogs ) { - $cache_suffix = $all ? '_all' : '_short'; - $blogs = wp_cache_get( 'blogs_of_user_' . $id . $cache_suffix, 'users' ); - if ( is_array( $blogs ) ) { - $blogs = array_keys( $blogs ); - if ( $all ) - wp_cache_set( 'blogs_of_user-' . $id, $blogs, 'users' ); + $blogs = array(); + + if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) { + $blog = get_blog_details( 1 ); + if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) { + $blogs[ 1 ] = (object) array( + 'userblog_id' => 1, + 'blogname' => $blog->blogname, + 'domain' => $blog->domain, + 'path' => $blog->path, + 'site_id' => $blog->site_id, + 'siteurl' => $blog->siteurl, + 'archived' => 0, + 'spam' => 0, + 'deleted' => 0 + ); } + unset( $keys[ $wpdb->base_prefix . 'capabilities' ] ); } - if ( false === $blogs ) { - $user = get_userdata( (int) $id ); - if ( !$user ) - return false; + $keys = array_keys( $keys ); - $blogs = $match = array(); - $prefix_length = strlen($wpdb->base_prefix); - foreach ( (array) $user as $key => $value ) { - if ( $prefix_length && substr($key, 0, $prefix_length) != $wpdb->base_prefix ) - continue; - if ( substr($key, -12, 12) != 'capabilities' ) - continue; - if ( preg_match( '/^' . $wpdb->base_prefix . '((\d+)_)?capabilities$/', $key, $match ) ) { - if ( count( $match ) > 2 ) - $blogs[] = (int) $match[ 2 ]; - else - $blogs[] = 1; - } - } - wp_cache_set( 'blogs_of_user-' . $id, $blogs, 'users' ); - } + foreach ( $keys as $key ) { + if ( 'capabilities' !== substr( $key, -12 ) ) + continue; + if ( $wpdb->base_prefix && 0 !== strpos( $key, $wpdb->base_prefix ) ) + continue; + $blog_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key ); + if ( ! is_numeric( $blog_id ) ) + continue; - $blog_deets = array(); - foreach ( (array) $blogs as $blog_id ) { + $blog_id = (int) $blog_id; $blog = get_blog_details( $blog_id ); - if ( $blog && isset( $blog->domain ) && ( $all == true || $all == false && ( $blog->archived == 0 && $blog->spam == 0 && $blog->deleted == 0 ) ) ) { - $blog_deets[ $blog_id ]->userblog_id = $blog_id; - $blog_deets[ $blog_id ]->blogname = $blog->blogname; - $blog_deets[ $blog_id ]->domain = $blog->domain; - $blog_deets[ $blog_id ]->path = $blog->path; - $blog_deets[ $blog_id ]->site_id = $blog->site_id; - $blog_deets[ $blog_id ]->siteurl = $blog->siteurl; + if ( $blog && isset( $blog->domain ) && ( $all || ( ! $blog->archived && ! $blog->spam && ! $blog->deleted ) ) ) { + $blogs[ $blog_id ] = (object) array( + 'userblog_id' => $blog_id, + 'blogname' => $blog->blogname, + 'domain' => $blog->domain, + 'path' => $blog->path, + 'site_id' => $blog->site_id, + 'siteurl' => $blog->siteurl, + 'archived' => 0, + 'spam' => 0, + 'deleted' => 0 + ); } } - return apply_filters( 'get_blogs_of_user', $blog_deets, $id, $all ); + return apply_filters( 'get_blogs_of_user', $blogs, $user_id, $all ); } /** - * Checks if the current user belong to a given blog. + * Find out whether a user is a member of a given blog. * - * @since 3.0.0 + * @since MU 1.1 + * @uses get_blogs_of_user() * - * @param int $blog_id Blog ID - * @return bool True if the current users belong to $blog_id, false if not. + * @param int $user_id Optional. The unique ID of the user. Defaults to the current user. + * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site. + * @return bool */ -function is_blog_user( $blog_id = 0 ) { - global $wpdb; +function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) { + $user_id = (int) $user_id; + $blog_id = (int) $blog_id; - $current_user = wp_get_current_user(); - if ( !$blog_id ) - $blog_id = $wpdb->blogid; - - $cap_key = $wpdb->base_prefix . $blog_id . '_capabilities'; + if ( empty( $user_id ) ) + $user_id = get_current_user_id(); - if ( is_array($current_user->$cap_key) && in_array(1, $current_user->$cap_key) ) - return true; + if ( empty( $blog_id ) ) + $blog_id = get_current_blog_id(); - return false; + $blogs = get_blogs_of_user( $user_id ); + return array_key_exists( $blog_id, $blogs ); } /** * Add meta data field to a user. * - * Post meta data is called "Custom Fields" on the Administration Panels. + * Post meta data is called "Custom Fields" on the Administration Screens. * * @since 3.0.0 * @uses add_metadata() @@ -784,12 +828,12 @@ function delete_user_meta($user_id, $meta_key, $meta_value = '') { * @link http://codex.wordpress.org/Function_Reference/get_user_meta * * @param int $user_id Post ID. - * @param string $key The meta key to retrieve. + * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys. * @param bool $single Whether to return a single value. * @return mixed Will be an array if $single is false. Will be value of meta data field if $single * is true. */ -function get_user_meta($user_id, $key, $single = false) { +function get_user_meta($user_id, $key = '', $single = false) { return get_metadata('user', $user_id, $key, $single); } @@ -819,7 +863,7 @@ function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') { * Count number of users who have each of the user roles. * * Assumes there are neither duplicated nor orphaned capabilities meta_values. - * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query() + * Assumes role names are unique phrases. Same assumption made by WP_User_Query::prepare_query() * Using $strategy = 'time' this is CPU-intensive and should handle around 10^7 users. * Using $strategy = 'memory' this is memory-intensive and should handle around 10^5 users, but see WP Bug #12257. * @@ -846,7 +890,7 @@ function count_users($strategy = 'time') { // Build a CPU-intensive query that will return concise information. $select_count = array(); foreach ( $avail_roles as $this_role => $name ) { - $select_count[] = "COUNT(NULLIF(`meta_value` LIKE '%" . like_escape($this_role) . "%', FALSE))"; + $select_count[] = "COUNT(NULLIF(`meta_value` LIKE '%\"" . like_escape( $this_role ) . "\"%', false))"; } $select_count = implode(', ', $select_count); @@ -874,14 +918,14 @@ function count_users($strategy = 'time') { $users_of_blog = $wpdb->get_col( "SELECT meta_value FROM $wpdb->usermeta WHERE meta_key = '{$blog_prefix}capabilities'" ); foreach ( $users_of_blog as $caps_meta ) { - $b_roles = unserialize($caps_meta); - if ( is_array($b_roles) ) { - foreach ( $b_roles as $b_role => $val ) { - if ( isset($avail_roles[$b_role]) ) { - $avail_roles[$b_role]++; - } else { - $avail_roles[$b_role] = 1; - } + $b_roles = maybe_unserialize($caps_meta); + if ( ! is_array( $b_roles ) ) + continue; + foreach ( $b_roles as $b_role => $val ) { + if ( isset($avail_roles[$b_role]) ) { + $avail_roles[$b_role]++; + } else { + $avail_roles[$b_role] = 1; } } } @@ -909,33 +953,32 @@ function count_users($strategy = 'time') { * @global int $user_ID The ID of the user * @global string $user_email The email address of the user * @global string $user_url The url in the user's profile - * @global string $user_pass_md5 MD5 of the user's password * @global string $user_identity The display name of the user * * @param int $for_user_id Optional. User ID to set up global data. */ function setup_userdata($for_user_id = '') { - global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_pass_md5, $user_identity; + global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_identity; if ( '' == $for_user_id ) - $user = wp_get_current_user(); - else - $user = new WP_User($for_user_id); - - $userdata = $user->data; - $user_ID = (int) $user->ID; - $user_level = (int) isset($user->user_level) ? $user->user_level : 0; - - if ( 0 == $user->ID ) { - $user_login = $user_email = $user_url = $user_pass_md5 = $user_identity = ''; + $for_user_id = get_current_user_id(); + $user = get_userdata( $for_user_id ); + + if ( ! $user ) { + $user_ID = 0; + $user_level = 0; + $userdata = null; + $user_login = $user_email = $user_url = $user_identity = ''; return; } - $user_login = $user->user_login; - $user_email = $user->user_email; - $user_url = $user->user_url; - $user_pass_md5 = md5($user->user_pass); - $user_identity = $user->display_name; + $user_ID = (int) $user->ID; + $user_level = (int) $user->user_level; + $userdata = $user; + $user_login = $user->user_login; + $user_email = $user->user_email; + $user_url = $user->user_url; + $user_identity = $user->display_name; } /** @@ -964,7 +1007,7 @@ function setup_userdata($for_user_id = '') { *
  • id - Default is the value of the 'name' parameter. ID attribute of select element.
    • *
  • class - Class attribute of select element.
    • *
  • blog_id - ID of blog (Multisite only). Defaults to ID of current blog.
    • - *
  • who - Which users to query. Currently only 'authors' is supported. Default is all users.
    • + *
  • who - Which users to query. Currently only 'authors' is supported. Default is all users.
    • * * * @since 2.3.0 @@ -1038,141 +1081,6 @@ function wp_dropdown_users( $args = '' ) { return $output; } -/** - * Add user meta data as properties to given user object. - * - * The finished user data is cached, but the cache is not used to fill in the - * user data for the given object. Once the function has been used, the cache - * should be used to retrieve user data. The intention is if the current data - * had been cached already, there would be no need to call this function. - * - * @access private - * @since 2.5.0 - * @uses $wpdb WordPress database object for queries - * - * @param object $user The user data object. - */ -function _fill_user( &$user ) { - $metavalues = get_user_metavalues(array($user->ID)); - _fill_single_user($user, $metavalues[$user->ID]); -} - -/** - * Perform the query to get the $metavalues array(s) needed by _fill_user and _fill_many_users - * - * @since 3.0.0 - * @param array $ids User ID numbers list. - * @return array of arrays. The array is indexed by user_id, containing $metavalues object arrays. - */ -function get_user_metavalues($ids) { - $objects = array(); - - $ids = array_map('intval', $ids); - foreach ( $ids as $id ) - $objects[$id] = array(); - - $metas = update_meta_cache('user', $ids); - - foreach ( $metas as $id => $meta ) { - foreach ( $meta as $key => $metavalues ) { - foreach ( $metavalues as $value ) { - $objects[$id][] = (object)array( 'user_id' => $id, 'meta_key' => $key, 'meta_value' => $value); - } - } - } - - return $objects; -} - -/** - * Unserialize user metadata, fill $user object, then cache everything. - * - * @since 3.0.0 - * @param object $user The User object. - * @param array $metavalues An array of objects provided by get_user_metavalues() - */ -function _fill_single_user( &$user, &$metavalues ) { - global $wpdb; - - foreach ( $metavalues as $meta ) { - $value = maybe_unserialize($meta->meta_value); - // Keys used as object vars cannot have dashes. - $key = str_replace('-', '', $meta->meta_key); - $user->{$key} = $value; - } - - $level = $wpdb->prefix . 'user_level'; - if ( isset( $user->{$level} ) ) - $user->user_level = $user->{$level}; - - // For backwards compat. - if ( isset($user->first_name) ) - $user->user_firstname = $user->first_name; - if ( isset($user->last_name) ) - $user->user_lastname = $user->last_name; - if ( isset($user->description) ) - $user->user_description = $user->description; - - update_user_caches($user); -} - -/** - * Take an array of user objects, fill them with metas, and cache them. - * - * @since 3.0.0 - * @param array $users User objects - */ -function _fill_many_users( &$users ) { - $ids = array(); - foreach( $users as $user_object ) { - $ids[] = $user_object->ID; - } - - $metas = get_user_metavalues($ids); - - foreach ( $users as $user_object ) { - if ( isset($metas[$user_object->ID]) ) { - _fill_single_user($user_object, $metas[$user_object->ID]); - } - } -} - -/** - * Sanitize every user field. - * - * If the context is 'raw', then the user object or array will get minimal santization of the int fields. - * - * @since 2.3.0 - * @uses sanitize_user_field() Used to sanitize the fields. - * - * @param object|array $user The User Object or Array - * @param string $context Optional, default is 'display'. How to sanitize user fields. - * @return object|array The now sanitized User Object or Array (will be the same type as $user) - */ -function sanitize_user_object($user, $context = 'display') { - if ( is_object($user) ) { - if ( !isset($user->ID) ) - $user->ID = 0; - if ( isset($user->data) ) - $vars = get_object_vars( $user->data ); - else - $vars = get_object_vars($user); - foreach ( array_keys($vars) as $field ) { - if ( is_string($user->$field) || is_numeric($user->$field) ) - $user->$field = sanitize_user_field($field, $user->$field, $user->ID, $context); - } - $user->filter = $context; - } else { - if ( !isset($user['ID']) ) - $user['ID'] = 0; - foreach ( array_keys($user) as $field ) - $user[$field] = sanitize_user_field($field, $user[$field], $user['ID'], $context); - $user['filter'] = $context; - } - - return $user; -} - /** * Sanitize user field based on context. * @@ -1181,17 +1089,12 @@ function sanitize_user_object($user, $context = 'display') { * when calling filters. * * @since 2.3.0 - * @uses apply_filters() Calls 'edit_$field' and '{$field_no_prefix}_edit_pre' passing $value and - * $user_id if $context == 'edit' and field name prefix == 'user_'. - * - * @uses apply_filters() Calls 'edit_user_$field' passing $value and $user_id if $context == 'db'. - * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db' and field name prefix == 'user_'. - * @uses apply_filters() Calls '{$field}_pre' passing $value if $context == 'db' and field name prefix != 'user_'. - * + * @uses apply_filters() Calls 'edit_$field' passing $value and $user_id if $context == 'edit'. + * $field is prefixed with 'user_' if it isn't already. + * @uses apply_filters() Calls 'pre_$field' passing $value if $context == 'db'. $field is prefixed with + * 'user_' if it isn't already. * @uses apply_filters() Calls '$field' passing $value, $user_id and $context if $context == anything - * other than 'raw', 'edit' and 'db' and field name prefix == 'user_'. - * @uses apply_filters() Calls 'user_$field' passing $value if $context == anything other than 'raw', - * 'edit' and 'db' and field name prefix != 'user_'. + * other than 'raw', 'edit' and 'db'. $field is prefixed with 'user_' if it isn't already. * * @param string $field The user Object field name. * @param mixed $value The user Object value. @@ -1211,11 +1114,7 @@ function sanitize_user_field($field, $value, $user_id, $context) { if ( !is_string($value) && !is_numeric($value) ) return $value; - $prefixed = false; - if ( false !== strpos($field, 'user_') ) { - $prefixed = true; - $field_no_prefix = str_replace('user_', '', $field); - } + $prefixed = false !== strpos( $field, 'user_' ); if ( 'edit' == $context ) { if ( $prefixed ) { @@ -1260,7 +1159,7 @@ function sanitize_user_field($field, $value, $user_id, $context) { * * @param object $user User object to be cached */ -function update_user_caches(&$user) { +function update_user_caches($user) { wp_cache_add($user->ID, $user, 'users'); wp_cache_add($user->user_login, $user->ID, 'userlogins'); wp_cache_add($user->user_email, $user->ID, 'useremail'); @@ -1272,16 +1171,19 @@ function update_user_caches(&$user) { * * @since 3.0.0 * - * @param int $id User ID + * @param WP_User|int $user User object or ID to be cleaned from the cache */ -function clean_user_cache($id) { - $user = new WP_User($id); - - wp_cache_delete($id, 'users'); - wp_cache_delete($user->user_login, 'userlogins'); - wp_cache_delete($user->user_email, 'useremail'); - wp_cache_delete($user->user_nicename, 'userslugs'); - wp_cache_delete('blogs_of_user-' . $id, 'users'); +function clean_user_cache( $user ) { + if ( is_numeric( $user ) ) + $user = new WP_User( $user ); + + if ( ! $user->exists() ) + return; + + wp_cache_delete( $user->ID, 'users' ); + wp_cache_delete( $user->user_login, 'userlogins' ); + wp_cache_delete( $user->user_email, 'useremail' ); + wp_cache_delete( $user->user_nicename, 'userslugs' ); } /** @@ -1293,7 +1195,7 @@ function clean_user_cache($id) { * @return null|int The user's ID on success, and null on failure. */ function username_exists( $username ) { - if ( $user = get_userdatabylogin( $username ) ) { + if ( $user = get_user_by('login', $username ) ) { return $user->ID; } else { return null; @@ -1310,7 +1212,7 @@ function username_exists( $username ) { * @return bool|int The user's ID on success, and false on failure. */ function email_exists( $email ) { - if ( $user = get_user_by_email($email) ) + if ( $user = get_user_by('email', $email) ) return $user->ID; return false; @@ -1350,14 +1252,12 @@ function validate_username( $username ) { * 'ID' - An integer that will be used for updating an existing user. * 'user_pass' - A string that contains the plain text password for the user. * 'user_login' - A string that contains the user's username for logging in. - * 'user_nicename' - A string that contains a nicer looking name for the user. + * 'user_nicename' - A string that contains a URL-friendly name for the user. * The default is the user's username. * 'user_url' - A string containing the user's URL for the user's web site. * 'user_email' - A string containing the user's email address. * 'display_name' - A string that will be shown on the site. Defaults to user's - * username. It is likely that you will want to change this, for both - * appearance and security through obscurity (that is if you don't use and - * delete the default 'admin' user). + * username. It is likely that you will want to change this, for appearance. * 'nickname' - The user's nickname, defaults to the user's username. * 'first_name' - The user's first name. * 'last_name' - The user's last name. @@ -1376,19 +1276,24 @@ function validate_username( $username ) { * @uses do_action() Calls 'profile_update' hook when updating giving the user's ID * @uses do_action() Calls 'user_register' hook when creating a new user giving the user's ID * - * @param array $userdata An array of user data. + * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User. * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not be created. */ -function wp_insert_user($userdata) { +function wp_insert_user( $userdata ) { global $wpdb; - extract($userdata, EXTR_SKIP); + if ( is_a( $userdata, 'stdClass' ) ) + $userdata = get_object_vars( $userdata ); + elseif ( is_a( $userdata, 'WP_User' ) ) + $userdata = $userdata->to_array(); + + extract( $userdata, EXTR_SKIP ); // Are we updating or creating? if ( !empty($ID) ) { $ID = (int) $ID; $update = true; - $old_user_data = get_userdata($ID); + $old_user_data = WP_User::get_data_by( 'id', $ID ); } else { $update = false; // Hash the password @@ -1405,7 +1310,7 @@ function wp_insert_user($userdata) { return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') ); if ( !$update && username_exists( $user_login ) ) - return new WP_Error('existing_user_login', __('This username is already registered.') ); + return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) ); if ( empty($user_nicename) ) $user_nicename = sanitize_title( $user_login ); @@ -1420,11 +1325,7 @@ function wp_insert_user($userdata) { $user_email = apply_filters('pre_user_email', $user_email); if ( !$update && ! defined( 'WP_IMPORTING' ) && email_exists($user_email) ) - return new WP_Error('existing_user_email', __('This email address is already registered.') ); - - if ( empty($display_name) ) - $display_name = $user_login; - $display_name = apply_filters('pre_user_display_name', $display_name); + return new WP_Error( 'existing_user_email', __( 'Sorry, that email address is already used!' ) ); if ( empty($nickname) ) $nickname = $user_login; @@ -1438,6 +1339,21 @@ function wp_insert_user($userdata) { $last_name = ''; $last_name = apply_filters('pre_user_last_name', $last_name); + if ( empty( $display_name ) ) { + if ( $update ) + $display_name = $user_login; + elseif ( $first_name && $last_name ) + /* translators: 1: first name, 2: last name */ + $display_name = sprintf( _x( '%1$s %2$s', 'Display name based on first name and last name' ), $first_name, $last_name ); + elseif ( $first_name ) + $display_name = $first_name; + elseif ( $last_name ) + $display_name = $last_name; + else + $display_name = $user_login; + } + $display_name = apply_filters( 'pre_user_display_name', $display_name ); + if ( empty($description) ) $description = ''; $description = apply_filters('pre_user_description', $description); @@ -1461,9 +1377,6 @@ function wp_insert_user($userdata) { if ( empty($show_admin_bar_front) ) $show_admin_bar_front = 'true'; - if ( empty($show_admin_bar_admin) ) - $show_admin_bar_admin = is_multisite() ? 'true' : 'false'; - $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)); if ( $user_nicename_check ) { @@ -1487,24 +1400,11 @@ function wp_insert_user($userdata) { $user_id = (int) $wpdb->insert_id; } - update_user_meta( $user_id, 'first_name', $first_name ); - update_user_meta( $user_id, 'last_name', $last_name ); - update_user_meta( $user_id, 'nickname', $nickname ); - update_user_meta( $user_id, 'description', $description ); - update_user_meta( $user_id, 'rich_editing', $rich_editing ); - update_user_meta( $user_id, 'comment_shortcuts', $comment_shortcuts ); - update_user_meta( $user_id, 'admin_color', $admin_color ); - update_user_meta( $user_id, 'use_ssl', $use_ssl ); - update_user_meta( $user_id, 'show_admin_bar_front', $show_admin_bar_front ); - update_user_meta( $user_id, 'show_admin_bar_admin', $show_admin_bar_admin ); - - $user = new WP_User($user_id); + $user = new WP_User( $user_id ); - foreach ( _wp_get_user_contactmethods( $user ) as $method => $name ) { - if ( empty($$method) ) - $$method = ''; - - update_user_meta( $user_id, $method, $$method ); + foreach ( _get_additional_user_keys( $user ) as $key ) { + if ( isset( $$key ) ) + update_user_meta( $user_id, $key, $$key ); } if ( isset($role) ) @@ -1539,17 +1439,29 @@ function wp_insert_user($userdata) { * @see wp_insert_user() For what fields can be set in $userdata * @uses wp_insert_user() Used to update existing user or add new one if user doesn't exist already * - * @param array $userdata An array of user data. - * @return int The updated user's ID. + * @param mixed $userdata An array of user data or a user object of type stdClass or WP_User. + * @return int|WP_Error The updated user's ID or a WP_Error object if the user could not be updated. */ function wp_update_user($userdata) { + if ( is_a( $userdata, 'stdClass' ) ) + $userdata = get_object_vars( $userdata ); + elseif ( is_a( $userdata, 'WP_User' ) ) + $userdata = $userdata->to_array(); + $ID = (int) $userdata['ID']; // First, get all of the original fields - $user = get_userdata($ID); + $user_obj = get_userdata( $ID ); + + $user = $user_obj->to_array(); + + // Add additional custom fields + foreach ( _get_additional_user_keys( $user_obj ) as $key ) { + $user[ $key ] = get_user_meta( $ID, $key, true ); + } // Escape data pulled from DB. - $user = add_magic_quotes(get_object_vars($user)); + $user = add_magic_quotes( $user ); // If password is changing, hash it now. if ( ! empty($userdata['user_pass']) ) { @@ -1565,7 +1477,7 @@ function wp_update_user($userdata) { // Update the cookies if the password changed. $current_user = wp_get_current_user(); - if ( $current_user->id == $ID ) { + if ( $current_user->ID == $ID ) { if ( isset($plaintext_pass) ) { wp_clear_auth_cookie(); wp_set_auth_cookie($ID); @@ -1578,8 +1490,8 @@ function wp_update_user($userdata) { /** * A simpler way of inserting an user into the database. * - * Creates a new user with just the username, password, and email. For a more - * detail creation of a user, use wp_insert_user() to specify more infomation. + * Creates a new user with just the username, password, and email. For more + * complex user creation use wp_insert_user() to specify more information. * * @since 2.0.0 * @see wp_insert_user() More complete way to create a new user @@ -1598,14 +1510,27 @@ function wp_create_user($username, $password, $email = '') { return wp_insert_user($userdata); } +/** + * Return a list of meta keys that wp_insert_user() is supposed to set. + * + * @since 3.3.0 + * @access private + * + * @param object $user WP_User instance. + * @return array + */ +function _get_additional_user_keys( $user ) { + $keys = array( 'first_name', 'last_name', 'nickname', 'description', 'rich_editing', 'comment_shortcuts', 'admin_color', 'use_ssl', 'show_admin_bar_front' ); + return array_merge( $keys, array_keys( _wp_get_user_contactmethods( $user ) ) ); +} /** - * Set up the default contact methods + * Set up the default contact methods. * + * @since 2.9.0 * @access private - * @since * - * @param object $user User data object (optional) + * @param object $user User data object (optional). * @return array $user_contactmethods Array of contact methods and their labels. */ function _wp_get_user_contactmethods( $user = null ) { @@ -1616,5 +1541,3 @@ function _wp_get_user_contactmethods( $user = null ) { ); return apply_filters( 'user_contactmethods', $user_contactmethods, $user ); } - -?>