Changeset 18597 for trunk/wp-includes/user.php

Timestamp:

08/24/2011 07:32:59 PM (12 years ago)

Author:

ryan

Message:

Introduce metadata_exists(), WP_User::get_data_by(), WP_User::get(), WP_User::has_prop(). Don't fill user objects with meta. Eliminate data duplication in cache and memory. Props scribu. see #15458

File:

• trunk/wp-includes/user.php (modified) (8 diffs)

trunk/wp-includes/user.php

@@ -255 +255 @@
         _deprecated_argument( __FUNCTION__, '3.0' );
 
-    if ( empty($user) ) {
+    if ( empty( $user ) )
         $user = wp_get_current_user();
-        $user = $user->ID;
-    }
-
-    $user = get_userdata($user);
-
-    // Keys used as object vars cannot have dashes.
-    $key = str_replace('-', '', $option);
-
-    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};
+    else
+        $user = new WP_User( $user );
+
+    if ( ! isset( $user->ID ) )
+        return false;
+
+    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;
@@ -681 +679 @@
 
     if ( false === $blogs ) {
-        $user = get_userdata( (int) $id );
-        if ( !$user )
+        $userkeys = array_keys( get_user_meta( (int) $id ) );
+        if ( empty( $userkeys ) )
             return false;
 
         $blogs = $match = array();
-        $prefix_length = strlen($wpdb->base_prefix);
-        foreach ( (array) $user as $key => $value ) {
+        $prefix_length = strlen( $wpdb->base_prefix );
+        foreach ( $userkeys as $key ) {
             if ( $prefix_length && substr($key, 0, $prefix_length) != $wpdb->base_prefix )
                 continue;
@@ -794 +792 @@
  *  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);
 }
@@ -1044 +1042 @@
 
 /**
- * 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.
  *
@@ -1265 +1128 @@
  * @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');
@@ -1280 +1143 @@
  */
 function clean_user_cache($id) {
-    $user = new WP_User($id);
+    $user = WP_User::get_data_by( 'id', $id );
 
     wp_cache_delete($id, 'users');
@@ -1391 +1254 @@
         $ID = (int) $ID;
         $update = true;
-        $old_user_data = get_userdata($ID);
+        $old_user_data = WP_User::get_data_by( 'id', $ID );
     } else {
         $update = false;
@@ -1549 +1412 @@
 
     // First, get all of the original fields
-    $user = get_userdata($ID);
+    $user = WP_User::get_data_by('id', $ID);
 
     // Escape data pulled from DB.