WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Introduce *_user_meta() functions, deprecate *_usermeta() family. Fixes #10837 props scribu, technosailor. 

git-svn-id: http://svn.automattic.com/wordpress/trunk@13300 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
nacin 2010-02-22 18:35:35 +00:00
parent cd767cd7a8
commit 10ee577b12
2 changed files with 121 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
wp-includes/deprecated.php
View File

@ -2266,4 +2266,66 @@ function unregister_widget_control($id) {
return wp_unregister_widget_control($id); return wp_unregister_widget_control($id);
} }
?> /**
* Remove user meta data.
*
* @since 2.0.0
* @deprecated 3.0.0
* @deprecated Use delete_user_meta()
* @see delete_user_meta()
*
* @param int $user_id User ID.
* @param string $meta_key Metadata key.
* @param mixed $meta_value Metadata value.
* @return bool True deletion completed and false if user_id is not a number.
*/
function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) {
_deprecated_function( __FUNCTION__, '3.0', 'delete_user_meta()' );
return delete_user_meta( $user_id, $meta_key, $meta_value );
}
/**
* Retrieve user metadata.
*
* If $user_id is not a number, then the function will fail over with a 'false'
* boolean return value. Other returned values depend on whether there is only
* one item to be returned, which be that single item type. If there is more
* than one metadata value, then it will be list of metadata values.
*
* @since 2.0.0
* @deprecated 3.0.0
* @deprecated Use get_user_meta()
* @see get_user_meta()
*
* @param int $user_id User ID
* @param string $meta_key Optional. Metadata key.
* @return mixed
*/
function get_usermeta( $user_id, $meta_key = '') {
_deprecated_function( __FUNCTION__, '3.0', 'get_user_meta()' );
return get_user_meta( $user_id, $meta_key, false );
}
/**
* Update metadata of user.
*
* There is no need to serialize values, they will be serialized if it is
* needed. The metadata key can only be a string with underscores. All else will
* be removed.
*
* Will remove the metadata, if the meta value is empty.
*
* @since 2.0.0
* @deprecated 3.0.0
* @deprecated Use update_user_meta()
* @see update_user_meta()
*
* @param int $user_id User ID
* @param string $meta_key Metadata key.
* @param mixed $meta_value Metadata value.
* @return bool True on successful update, false on failure.
*/
function update_usermeta( $user_id, $meta_key, $meta_value ) {
_deprecated_function( __FUNCTION__, '3.0', 'update_user_meta()' );
return update_user_meta( $user_id, $meta_key, $meta_value );
}

184
wp-includes/user.php
View File

@ -292,150 +292,82 @@ function get_users_of_blog( $id = '' ) {
return $users; return $users;
} }
//
// User meta functions
//
/** /**
* Remove user meta data. * Add meta data field to a user.
* *
* @since 2.0.0 * Post meta data is called "Custom Fields" on the Administration Panels.
* @uses $wpdb WordPress database object for queries.
* *
* @param int $user_id User ID. * @since 3.0.0
* @param string $meta_key Metadata key. * @uses add_metadata()
* @param mixed $meta_value Metadata value. * @link http://codex.wordpress.org/Function_Reference/add_user_meta
* @return bool True deletion completed and false if user_id is not a number. *
* @param int $user_id Post ID.
* @param string $key Metadata name.
* @param mixed $value Metadata value.
* @param bool $unique Optional, default is false. Whether the same key should not be added.
* @return bool False for failure. True for success.
*/ */
function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) { function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
global $wpdb; return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
if ( !is_numeric( $user_id ) )
return false;
$meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
if ( is_array($meta_value) || is_object($meta_value) )
$meta_value = serialize($meta_value);
$meta_value = trim( $meta_value );
$cur = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
if ( $cur && $cur->umeta_id )
do_action( 'delete_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
if ( ! empty($meta_value) )
$wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s AND meta_value = %s", $user_id, $meta_key, $meta_value) );
else
$wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
wp_cache_delete($user_id, 'users');
if ( $cur && $cur->umeta_id )
do_action( 'deleted_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
return true;
} }
/** /**
* Retrieve user metadata. * Remove metadata matching criteria from a user.
* *
* If $user_id is not a number, then the function will fail over with a 'false' * You can match based on the key, or key and value. Removing based on key and
* boolean return value. Other returned values depend on whether there is only * value, will keep from removing duplicate metadata with the same key. It also
* one item to be returned, which be that single item type. If there is more * allows removing all metadata matching key, if needed.
* than one metadata value, then it will be list of metadata values.
* *
* @since 2.0.0 * @since 3.0.0
* @uses $wpdb WordPress database object for queries. * @uses delete_metadata()
* @link http://codex.wordpress.org/Function_Reference/delete_user_meta
* *
* @param int $user_id User ID * @param int $user_id user ID
* @param string $meta_key Optional. Metadata key. * @param string $meta_key Metadata name.
* @return mixed * @param mixed $meta_value Optional. Metadata value.
* @return bool False for failure. True for success.
*/ */
function get_usermeta( $user_id, $meta_key = '') { function delete_user_meta($user_id, $meta_key, $meta_value = '') {
global $wpdb; return delete_metadata('user', $user_id, $meta_key, $meta_value);
$user_id = (int) $user_id;
if ( !$user_id )
return false;
if ( !empty($meta_key) ) {
$meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
$user = wp_cache_get($user_id, 'users');
// Check the cached user object
if ( false !== $user && isset($user->$meta_key) )
$metas = array($user->$meta_key);
else
$metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
} else {
$metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d", $user_id) );
}
if ( empty($metas) ) {
if ( empty($meta_key) )
return array();
else
return '';
}
$metas = array_map('maybe_unserialize', $metas);
if ( count($metas) == 1 )
return $metas[0];
else
return $metas;
} }
/** /**
* Update metadata of user. * Retrieve user meta field for a user.
* *
* There is no need to serialize values, they will be serialized if it is * @since 3.0.0
* needed. The metadata key can only be a string with underscores. All else will * @uses get_metadata()
* be removed. * @link http://codex.wordpress.org/Function_Reference/get_user_meta
* *
* Will remove the metadata, if the meta value is empty. * @param int $user_id Post ID.
* * @param string $key The meta key to retrieve.
* @since 2.0.0 * @param bool $single Whether to return a single value.
* @uses $wpdb WordPress database object for queries * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
* * is true.
* @param int $user_id User ID
* @param string $meta_key Metadata key.
* @param mixed $meta_value Metadata value.
* @return bool True on successful update, false on failure.
*/ */
function update_usermeta( $user_id, $meta_key, $meta_value ) { function get_user_meta($user_id, $key, $single = false) {
global $wpdb; return get_metadata('user', $user_id, $key, $single);
if ( !is_numeric( $user_id ) ) }
return false;
$meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
/** @todo Might need fix because usermeta data is assumed to be already escaped */ /**
if ( is_string($meta_value) ) * Update user meta field based on user ID.
$meta_value = stripslashes($meta_value); *
$meta_value = maybe_serialize($meta_value); * Use the $prev_value parameter to differentiate between meta fields with the
* same key and user ID.
if (empty($meta_value)) { *
return delete_usermeta($user_id, $meta_key); * If the meta field for the user does not exist, it will be added.
} *
* @since 3.0
$cur = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) ); * @uses update_metadata
* @link http://codex.wordpress.org/Function_Reference/update_user_meta
if ( $cur ) *
do_action( 'update_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value ); * @param int $user_id Post ID.
* @param string $key Metadata key.
if ( !$cur ) * @param mixed $value Metadata value.
$wpdb->insert($wpdb->usermeta, compact('user_id', 'meta_key', 'meta_value') ); * @param mixed $prev_value Optional. Previous value to check before removing.
else if ( $cur->meta_value != $meta_value ) * @return bool False on failure, true if success.
$wpdb->update($wpdb->usermeta, compact('meta_value'), compact('user_id', 'meta_key') ); */
else function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {
return false; return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);
wp_cache_delete($user_id, 'users');
if ( !$cur )
do_action( 'added_usermeta', $wpdb->insert_id, $user_id, $meta_key, $meta_value );
else
do_action( 'updated_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value );
return true;
} }
// //