2006-06-07 22:22:16 -04:00
< ? php
2008-09-12 00:29:09 -04:00
/**
* WordPress User API
*
* @ package WordPress
*/
/**
* Authenticate user with remember capability .
*
* The credentials is an array that has 'user_login' , 'user_password' , and
* 'remember' indices . If the credentials is not given , then the log in form
* will be assumed and used if set .
*
* The various authentication cookies will be set by this function and will be
* set for a longer period depending on if the 'remember' credential is set to
* true .
*
* @ since 2.5 . 0
*
* @ param array $credentials Optional . User info in order to sign on .
* @ param bool $secure_cookie Optional . Whether to use secure cookie .
* @ return object Either WP_Error on failure , or WP_User on success .
*/
2008-06-11 13:25:55 -04:00
function wp_signon ( $credentials = '' , $secure_cookie = '' ) {
2008-01-22 14:35:19 -05:00
if ( empty ( $credentials ) ) {
if ( ! empty ( $_POST [ 'log' ]) )
$credentials [ 'user_login' ] = $_POST [ 'log' ];
if ( ! empty ( $_POST [ 'pwd' ]) )
$credentials [ 'user_password' ] = $_POST [ 'pwd' ];
if ( ! empty ( $_POST [ 'rememberme' ]) )
$credentials [ 'remember' ] = $_POST [ 'rememberme' ];
}
if ( ! empty ( $credentials [ 'remember' ]) )
$credentials [ 'remember' ] = true ;
else
$credentials [ 'remember' ] = false ;
2009-01-24 17:38:19 -05:00
// TODO do we deprecate the wp_authentication action?
2008-04-16 00:49:19 -04:00
do_action_ref_array ( 'wp_authenticate' , array ( & $credentials [ 'user_login' ], & $credentials [ 'user_password' ]));
2008-06-11 13:25:55 -04:00
if ( '' === $secure_cookie )
2010-03-19 17:15:00 -04:00
$secure_cookie = is_ssl ();
2008-08-09 01:36:14 -04:00
2009-01-24 17:38:19 -05:00
global $auth_secure_cookie ; // XXX ugly hack to pass this to wp_authenticate_cookie
$auth_secure_cookie = $secure_cookie ;
2008-01-22 14:35:19 -05:00
2009-01-24 17:38:19 -05:00
add_filter ( 'authenticate' , 'wp_authenticate_cookie' , 30 , 3 );
2008-06-11 13:25:55 -04:00
2009-01-24 17:38:19 -05:00
$user = wp_authenticate ( $credentials [ 'user_login' ], $credentials [ 'user_password' ]);
2008-01-22 14:35:19 -05:00
2009-01-29 16:30:16 -05:00
if ( is_wp_error ( $user ) ) {
if ( $user -> get_error_codes () == array ( 'empty_username' , 'empty_password' ) ) {
$user = new WP_Error ( '' , '' );
}
2009-01-24 17:38:19 -05:00
return $user ;
2009-01-29 16:30:16 -05:00
}
2009-01-24 17:38:19 -05:00
wp_set_auth_cookie ( $user -> ID , $credentials [ 'remember' ], $secure_cookie );
do_action ( 'wp_login' , $credentials [ 'user_login' ]);
return $user ;
}
/**
* Authenticate the user using the username and password .
*/
add_filter ( 'authenticate' , 'wp_authenticate_username_password' , 20 , 3 );
function wp_authenticate_username_password ( $user , $username , $password ) {
if ( is_a ( $user , 'WP_User' ) ) { return $user ; }
if ( empty ( $username ) || empty ( $password ) ) {
2008-01-22 14:35:19 -05:00
$error = new WP_Error ();
2009-01-24 17:38:19 -05:00
if ( empty ( $username ) )
2008-01-22 14:35:19 -05:00
$error -> add ( 'empty_username' , __ ( '<strong>ERROR</strong>: The username field is empty.' ));
2009-01-24 17:38:19 -05:00
if ( empty ( $password ) )
2008-01-22 14:35:19 -05:00
$error -> add ( 'empty_password' , __ ( '<strong>ERROR</strong>: The password field is empty.' ));
2009-01-24 17:38:19 -05:00
2008-01-22 14:35:19 -05:00
return $error ;
}
2010-01-26 15:25:34 -05:00
$userdata = get_user_by ( 'login' , $username );
2009-01-24 17:38:19 -05:00
2010-01-26 15:25:34 -05:00
if ( ! $userdata )
2009-04-16 18:07:25 -04:00
return new WP_Error ( 'invalid_username' , sprintf ( __ ( '<strong>ERROR</strong>: Invalid username. <a href="%s" title="Password Lost and Found">Lost your password</a>?' ), site_url ( 'wp-login.php?action=lostpassword' , 'login' )));
2010-01-26 15:25:34 -05:00
2010-01-27 13:11:17 -05:00
if ( is_multisite () ) {
// Is user marked as spam?
if ( 1 == $userdata -> spam )
return new WP_Error ( 'invalid_username' , __ ( '<strong>ERROR</strong>: 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_object ( $details ) && $details -> spam == 1 )
return new WP_Error ( 'blog_suspended' , __ ( 'Blog Suspended.' ));
}
}
2009-01-24 17:38:19 -05:00
2009-03-02 17:25:55 -05:00
$userdata = apply_filters ( 'wp_authenticate_user' , $userdata , $password );
2010-01-26 15:25:34 -05:00
if ( is_wp_error ( $userdata ) )
2009-03-02 17:25:55 -05:00
return $userdata ;
2009-01-24 17:38:19 -05:00
2010-01-26 15:25:34 -05:00
if ( ! wp_check_password ( $password , $userdata -> user_pass , $userdata -> ID ) )
2009-04-16 18:07:25 -04:00
return new WP_Error ( 'incorrect_password' , sprintf ( __ ( '<strong>ERROR</strong>: Incorrect password. <a href="%s" title="Password Lost and Found">Lost your password</a>?' ), site_url ( 'wp-login.php?action=lostpassword' , 'login' )));
2009-01-24 17:38:19 -05:00
$user = new WP_User ( $userdata -> ID );
return $user ;
}
/**
* Authenticate the user using the WordPress auth cookie .
*/
function wp_authenticate_cookie ( $user , $username , $password ) {
if ( is_a ( $user , 'WP_User' ) ) { return $user ; }
if ( empty ( $username ) && empty ( $password ) ) {
$user_id = wp_validate_auth_cookie ();
if ( $user_id )
return new WP_User ( $user_id );
global $auth_secure_cookie ;
if ( $auth_secure_cookie )
$auth_cookie = SECURE_AUTH_COOKIE ;
else
$auth_cookie = AUTH_COOKIE ;
if ( ! empty ( $_COOKIE [ $auth_cookie ]) )
return new WP_Error ( 'expired_session' , __ ( 'Please log in again.' ));
// If the cookie is not set, be silent.
}
2008-01-22 14:35:19 -05:00
return $user ;
}
2008-09-12 00:29:09 -04:00
/**
* Number of posts user has written .
*
2010-03-18 21:11:21 -04:00
* @ since 3.0 . 0
2008-09-12 00:29:09 -04:00
* @ uses $wpdb WordPress database object for queries .
*
* @ param int $userid User ID .
* @ return int Amount of posts user has written .
*/
2010-03-03 14:08:30 -05:00
function count_user_posts ( $userid ) {
2006-06-07 22:22:16 -04:00
global $wpdb ;
2010-03-03 14:08:30 -05:00
$where = get_posts_by_author_sql ( 'post' , TRUE , $userid );
$count = $wpdb -> get_var ( " SELECT COUNT(*) FROM $wpdb->posts $where " );
2008-09-27 17:26:57 -04:00
return apply_filters ( 'get_usernumposts' , $count , $userid );
2006-06-07 22:22:16 -04:00
}
2010-03-03 14:08:30 -05:00
/**
* Number of posts written by a list of users .
*
* @ since 3.0 . 0
* @ param array $userid User ID number list .
* @ return array Amount of posts each user has written .
*/
function count_many_users_posts ( $users ) {
global $wpdb ;
2010-03-08 09:30:17 -05:00
$count = array ();
2010-03-11 19:03:44 -05:00
if ( ! is_array ( $users ) || empty ( $users ) )
2010-03-08 09:30:17 -05:00
return $count ;
$userlist = implode ( ',' , $users );
$where = get_posts_by_author_sql ( 'post' );
2010-03-03 14:08:30 -05:00
$result = $wpdb -> get_results ( " SELECT post_author, COUNT(*) FROM $wpdb->posts $where AND post_author IN ( $userlist ) GROUP BY post_author " , ARRAY_N );
2010-03-08 09:30:17 -05:00
foreach ( $result as $row ) {
$count [ $row [ 0 ] ] = $row [ 1 ];
2010-03-03 14:08:30 -05:00
}
2010-03-08 09:30:17 -05:00
foreach ( $users as $id ) {
if ( ! isset ( $count [ $id ] ) )
$count [ $id ] = 0 ;
2010-03-03 14:08:30 -05:00
}
return $count ;
}
2008-09-12 00:29:09 -04:00
/**
* 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 ) {
2008-01-22 14:35:19 -05:00
$user = wp_authenticate ( $user_login , $user_pass );
if ( is_wp_error ( $user ) )
return false ;
return true ;
2006-06-07 22:22:16 -04:00
}
//
// User option functions
//
2008-09-12 00:29:09 -04:00
/**
2010-02-19 05:49:07 -05:00
* Retrieve user option that can be either per Site or per Network .
2008-09-12 00:29:09 -04:00
*
* If the user ID is not given , then the current user will be used instead . If
* the user ID is given , then the user data will be retrieved . The filter for
* the result , will also pass the original option name and finally the user data
* object as the third parameter .
*
2010-02-19 05:49:07 -05:00
* The option will first check for the per site name and then the per Network name .
2008-09-12 00:29:09 -04:00
*
* @ since 2.0 . 0
* @ uses $wpdb WordPress database object for queries .
* @ uses apply_filters () Calls 'get_user_option_$option' hook with result ,
* option parameter , and user data object .
*
* @ param string $option User option name .
* @ param int $user Optional . User ID .
2010-01-06 19:01:52 -05:00
* @ param bool $deprecated Use get_option () to check for an option in the options table .
2008-09-12 00:29:09 -04:00
* @ return mixed
*/
2010-01-06 19:01:52 -05:00
function get_user_option ( $option , $user = 0 , $deprecated = '' ) {
2006-06-07 22:22:16 -04:00
global $wpdb ;
2010-01-06 19:01:52 -05:00
if ( ! empty ( $deprecated ) )
_deprecated_argument ( __FUNCTION__ , '3.0' );
2006-06-07 22:22:16 -04:00
if ( empty ( $user ) )
$user = wp_get_current_user ();
else
$user = get_userdata ( $user );
if ( isset ( $user -> { $wpdb -> prefix . $option } ) ) // Blog specific
2008-03-11 17:37:23 -04:00
$result = $user -> { $wpdb -> prefix . $option };
2006-06-07 22:22:16 -04:00
elseif ( isset ( $user -> { $option } ) ) // User specific and cross-blog
2008-03-11 17:37:23 -04:00
$result = $user -> { $option };
2008-11-25 13:33:04 -05:00
else
$result = false ;
2008-08-09 01:36:14 -04:00
2008-03-11 17:37:23 -04:00
return apply_filters ( " get_user_option_ { $option } " , $result , $option , $user );
2006-06-07 22:22:16 -04:00
}
2008-09-12 00:29:09 -04:00
/**
* Update user option with global blog capability .
*
* User options are just like user metadata except that they have support for
2009-04-08 14:24:49 -04:00
* global blog options . If the 'global' parameter is false , which it is by default
2008-09-12 00:29:09 -04:00
* it will prepend the WordPress table prefix to the option name .
*
2010-04-23 10:25:05 -04:00
* Deletes the user option if $newvalue is empty .
*
2008-09-12 00:29:09 -04:00
* @ since 2.0 . 0
* @ uses $wpdb WordPress database object for queries
*
* @ param int $user_id User ID
* @ param string $option_name User option name .
* @ param mixed $newvalue User option value .
2010-03-11 13:28:31 -05:00
* @ param bool $global Optional . Whether option name is global or blog specific . Default false ( blog specific ) .
2008-09-12 00:29:09 -04:00
* @ return unknown
*/
2006-06-07 22:22:16 -04:00
function update_user_option ( $user_id , $option_name , $newvalue , $global = false ) {
global $wpdb ;
2010-03-02 13:06:14 -05:00
2006-06-07 22:22:16 -04:00
if ( ! $global )
$option_name = $wpdb -> prefix . $option_name ;
2010-04-23 10:25:05 -04:00
// For backward compatibility. See differences between update_user_meta() and deprecated update_user_meta().
// http://core.trac.wordpress.org/ticket/13088
if ( is_null ( $newvalue ) || is_scalar ( $newvalue ) && empty ( $newvalue ) )
return delete_user_meta ( $user_id , $option_name );
2010-02-22 16:25:32 -05:00
return update_user_meta ( $user_id , $option_name , $newvalue );
2006-06-07 22:22:16 -04:00
}
2010-03-11 13:28:31 -05:00
/**
* Delete user option with global blog capability .
*
* User options are just like user metadata except that they have support for
* global blog options . If the 'global' parameter is false , which it is by default
* it will prepend the WordPress table prefix to the option name .
*
* @ since 3.0 . 0
* @ uses $wpdb WordPress database object for queries
*
* @ param int $user_id User ID
* @ param string $option_name User option name .
* @ param bool $global Optional . Whether option name is global or blog specific . Default false ( blog specific ) .
* @ return unknown
*/
function delete_user_option ( $user_id , $option_name , $global = false ) {
global $wpdb ;
if ( ! $global )
$option_name = $wpdb -> prefix . $option_name ;
return delete_user_meta ( $user_id , $option_name );
}
2008-09-12 00:29:09 -04:00
/**
* Get users for the blog .
*
* For setups that use the multi - blog feature . Can be used outside of the
* multi - blog feature .
*
* @ since 2.2 . 0
* @ uses $wpdb WordPress database object for queries
* @ uses $blog_id The Blog id of the blog for those that use more than one blog
*
* @ param int $id Blog ID .
* @ return array List of users that are part of that Blog ID
*/
2007-01-31 20:19:36 -05:00
function get_users_of_blog ( $id = '' ) {
global $wpdb , $blog_id ;
if ( empty ( $id ) )
2007-03-22 20:59:21 -04:00
$id = ( int ) $blog_id ;
2010-01-11 17:23:58 -05:00
$blog_prefix = $wpdb -> get_blog_prefix ( $id );
2010-01-11 16:49:40 -05:00
$users = $wpdb -> get_results ( " SELECT user_id, user_id AS ID, user_login, display_name, user_email, meta_value FROM $wpdb->users , $wpdb->usermeta WHERE { $wpdb -> users } .ID = { $wpdb -> usermeta } .user_id AND meta_key = ' { $blog_prefix } capabilities' ORDER BY { $wpdb -> usermeta } .user_id " );
2007-01-31 20:19:36 -05:00
return $users ;
}
2008-09-12 00:29:09 -04:00
/**
2010-02-22 13:35:35 -05:00
* Add meta data field to a user .
2008-09-12 00:29:09 -04:00
*
2010-02-22 13:35:35 -05:00
* Post meta data is called " Custom Fields " on the Administration Panels .
*
* @ since 3.0 . 0
* @ uses add_metadata ()
* @ link http :// codex . wordpress . org / Function_Reference / add_user_meta
2008-09-12 00:29:09 -04:00
*
2010-02-22 13:35:35 -05:00
* @ 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 .
2008-09-12 00:29:09 -04:00
*/
2010-02-22 13:35:35 -05:00
function add_user_meta ( $user_id , $meta_key , $meta_value , $unique = false ) {
return add_metadata ( 'user' , $user_id , $meta_key , $meta_value , $unique );
2006-06-07 22:22:16 -04:00
}
2008-09-12 00:29:09 -04:00
/**
2010-02-22 13:35:35 -05:00
* Remove metadata matching criteria from a user .
2008-09-12 00:29:09 -04:00
*
2010-02-22 13:35:35 -05:00
* You can match based on the key , or key and value . Removing based on key and
* value , will keep from removing duplicate metadata with the same key . It also
* allows removing all metadata matching key , if needed .
2008-09-12 00:29:09 -04:00
*
2010-02-22 13:35:35 -05:00
* @ since 3.0 . 0
* @ uses delete_metadata ()
* @ link http :// codex . wordpress . org / Function_Reference / delete_user_meta
2008-09-12 00:29:09 -04:00
*
2010-02-22 13:35:35 -05:00
* @ param int $user_id user ID
* @ param string $meta_key Metadata name .
* @ param mixed $meta_value Optional . Metadata value .
* @ return bool False for failure . True for success .
2008-09-12 00:29:09 -04:00
*/
2010-02-22 13:35:35 -05:00
function delete_user_meta ( $user_id , $meta_key , $meta_value = '' ) {
return delete_metadata ( 'user' , $user_id , $meta_key , $meta_value );
}
2006-06-07 22:22:16 -04:00
2010-02-22 13:35:35 -05:00
/**
* Retrieve user meta field for a user .
*
* @ since 3.0 . 0
* @ uses get_metadata ()
* @ 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 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 ) {
return get_metadata ( 'user' , $user_id , $key , $single );
2006-06-07 22:22:16 -04:00
}
2008-09-12 00:29:09 -04:00
/**
2010-02-22 13:35:35 -05:00
* Update user meta field based on user ID .
2008-09-12 00:29:09 -04:00
*
2010-02-22 13:35:35 -05:00
* Use the $prev_value parameter to differentiate between meta fields with the
* same key and user ID .
2008-09-12 00:29:09 -04:00
*
2010-02-22 13:35:35 -05:00
* If the meta field for the user does not exist , it will be added .
2008-09-12 00:29:09 -04:00
*
2010-03-26 15:13:36 -04:00
* @ since 3.0 . 0
2010-02-22 13:35:35 -05:00
* @ uses update_metadata
* @ link http :// codex . wordpress . org / Function_Reference / update_user_meta
2008-09-12 00:29:09 -04:00
*
2010-02-22 13:35:35 -05:00
* @ param int $user_id Post ID .
* @ param string $key Metadata key .
* @ param mixed $value Metadata value .
* @ param mixed $prev_value Optional . Previous value to check before removing .
* @ return bool False on failure , true if success .
2008-09-12 00:29:09 -04:00
*/
2010-02-22 13:35:35 -05:00
function update_user_meta ( $user_id , $meta_key , $meta_value , $prev_value = '' ) {
return update_metadata ( 'user' , $user_id , $meta_key , $meta_value , $prev_value );
2006-06-07 22:22:16 -04:00
}
2010-03-03 14:08:30 -05:00
/**
* 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_Search :: 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.
*
* @ since 3.0 . 0
* @ param string $strategy 'time' or 'memory'
* @ return array Includes a grand total and an array of counts indexed by role strings .
*/
function count_users ( $strategy = 'time' ) {
global $wpdb , $blog_id , $wp_roles ;
// Initialize
$id = ( int ) $blog_id ;
$blog_prefix = $wpdb -> get_blog_prefix ( $id );
$result = array ();
2010-04-15 17:24:52 -04:00
if ( 'time' == $strategy ) {
global $wp_roles ;
if ( ! isset ( $wp_roles ) )
$wp_roles = new WP_Roles ();
2010-03-03 14:08:30 -05:00
$avail_roles = $wp_roles -> get_names ();
// 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 = implode ( ', ' , $select_count );
// Add the meta_value index to the selection list, then run the query.
$row = $wpdb -> get_row ( " SELECT $select_count , COUNT(*) FROM $wpdb->usermeta WHERE meta_key = ' { $blog_prefix } capabilities' " , ARRAY_N );
// Run the previous loop again to associate results with role names.
$col = 0 ;
$role_counts = array ();
foreach ( $avail_roles as $this_role => $name ) {
$count = ( int ) $row [ $col ++ ];
if ( $count > 0 ) {
$role_counts [ $this_role ] = $count ;
}
}
// Get the meta_value index from the end of the result set.
$total_users = ( int ) $row [ $col ];
$result [ 'total_users' ] = $total_users ;
$result [ 'avail_roles' ] =& $role_counts ;
} else {
$avail_roles = array ();
$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 ;
}
}
}
}
$result [ 'total_users' ] = count ( $users_of_blog );
$result [ 'avail_roles' ] =& $avail_roles ;
}
return $result ;
}
2006-06-07 22:22:16 -04:00
//
// Private helper functions
//
2008-09-12 00:29:09 -04:00
/**
2010-03-17 00:39:50 -04:00
* Set up global user vars .
2008-09-12 00:29:09 -04:00
*
2010-04-14 18:06:03 -04:00
* Used by wp_set_current_user () for back compat . Might be deprecated in the future .
2008-09-12 00:29:09 -04:00
*
* @ since 2.0 . 4
* @ global string $userdata User description .
* @ global string $user_login The user username for logging in
* @ global int $user_level The level of the user
* @ 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
*
2010-03-17 00:39:50 -04:00
* @ param int $for_user_id Optional . User ID to set up global data .
2008-09-12 00:29:09 -04:00
*/
2009-11-27 13:17:44 -05:00
function setup_userdata ( $for_user_id = '' ) {
2009-11-30 21:06:02 -05:00
global $user_login , $userdata , $user_level , $user_ID , $user_email , $user_url , $user_pass_md5 , $user_identity ;
2006-06-07 22:22:16 -04:00
2009-11-27 13:17:44 -05:00
if ( '' == $for_user_id )
2006-06-07 22:22:16 -04:00
$user = wp_get_current_user ();
2006-11-19 02:56:05 -05:00
else
2009-11-27 13:17:44 -05:00
$user = new WP_User ( $for_user_id );
2006-06-07 22:22:16 -04:00
if ( 0 == $user -> ID )
return ;
$userdata = $user -> data ;
$user_login = $user -> user_login ;
2008-02-02 13:42:09 -05:00
$user_level = ( int ) isset ( $user -> user_level ) ? $user -> user_level : 0 ;
2009-11-30 21:06:02 -05:00
$user_ID = ( int ) $user -> ID ;
2006-06-07 22:22:16 -04:00
$user_email = $user -> user_email ;
$user_url = $user -> user_url ;
$user_pass_md5 = md5 ( $user -> user_pass );
$user_identity = $user -> display_name ;
}
2008-09-12 00:29:09 -04:00
/**
* Create dropdown HTML content of users .
*
* The content can either be displayed , which it is by default or retrieved by
* setting the 'echo' argument . The 'include' and 'exclude' arguments do not
* need to be used ; all users will be displayed in that case . Only one can be
* used , either 'include' or 'exclude' , but not both .
*
* The available arguments are as follows :
* < ol >
* < li > show_option_all - Text to show all and whether HTML option exists .</ li >
* < li > show_option_none - Text for show none and whether HTML option exists .
* </ li >
* < li > orderby - SQL order by clause for what order the users appear . Default is
* 'display_name' .</ li >
* < li > order - Default is 'ASC' . Can also be 'DESC' .</ li >
* < li > include - User IDs to include .</ li >
* < li > exclude - User IDs to exclude .</ li >
2010-03-02 13:36:49 -05:00
* < 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 >
2008-10-25 16:40:58 -04:00
* < 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 parentesis </ li >
2008-09-12 00:29:09 -04:00
* < li > echo - Default is '1' . Whether to display or retrieve content .</ li >
* < li > selected - Which User ID is selected .</ li >
* < li > name - Default is 'user' . Name attribute of select element .</ li >
2010-03-02 13:36:49 -05:00
* < li > id - Default is the value of the 'name' parameter . ID attribute of select element .</ li >
2008-09-12 00:29:09 -04:00
* < li > class - Class attribute of select element .</ li >
2010-02-13 15:17:15 -05:00
* < li > blog_id - ID of blog ( Multisite only ) . Defaults to ID of current blog .</ li >
2008-09-12 00:29:09 -04:00
* </ ol >
*
* @ since 2.3 . 0
* @ uses $wpdb WordPress database object for queries
*
* @ param string | array $args Optional . Override defaults .
* @ return string | null Null on display . String of HTML content on retrieve .
*/
2007-05-29 00:28:10 -04:00
function wp_dropdown_users ( $args = '' ) {
2010-02-13 15:17:15 -05:00
global $wpdb ;
2007-05-29 00:28:10 -04:00
$defaults = array (
'show_option_all' => '' , 'show_option_none' => '' ,
'orderby' => 'display_name' , 'order' => 'ASC' ,
2008-09-30 06:30:56 -04:00
'include' => '' , 'exclude' => '' , 'multi' => 0 ,
2007-05-29 00:28:10 -04:00
'show' => 'display_name' , 'echo' => 1 ,
2010-02-13 15:17:15 -05:00
'selected' => 0 , 'name' => 'user' , 'class' => '' , 'blog_id' => $GLOBALS [ 'blog_id' ],
2010-03-02 13:36:49 -05:00
'id' => '' ,
2007-05-29 00:28:10 -04:00
);
2007-06-13 22:25:30 -04:00
2007-05-29 00:28:10 -04:00
$defaults [ 'selected' ] = is_author () ? get_query_var ( 'author' ) : 0 ;
2007-06-13 22:25:30 -04:00
2007-05-29 00:28:10 -04:00
$r = wp_parse_args ( $args , $defaults );
2007-06-14 18:45:40 -04:00
extract ( $r , EXTR_SKIP );
2007-05-29 00:28:10 -04:00
2010-02-13 15:17:15 -05:00
$blog_prefix = $wpdb -> get_blog_prefix ( $blog_id );
2010-02-13 15:12:08 -05:00
$query = " SELECT { $wpdb -> users } .* FROM $wpdb->users , $wpdb->usermeta WHERE { $wpdb -> users } .ID = { $wpdb -> usermeta } .user_id AND meta_key = ' { $blog_prefix } capabilities' " ;
2007-05-29 00:28:10 -04:00
$query_where = array ();
if ( is_array ( $include ) )
$include = join ( ',' , $include );
$include = preg_replace ( '/[^0-9,]/' , '' , $include ); // (int)
if ( $include )
$query_where [] = " ID IN ( $include ) " ;
if ( is_array ( $exclude ) )
$exclude = join ( ',' , $exclude );
$exclude = preg_replace ( '/[^0-9,]/' , '' , $exclude ); // (int)
if ( $exclude )
$query_where [] = " ID NOT IN ( $exclude ) " ;
if ( $query_where )
2010-02-13 15:12:08 -05:00
$query .= " AND " . join ( ' AND' , $query_where );
2007-05-29 00:28:10 -04:00
$query .= " ORDER BY $orderby $order " ;
$users = $wpdb -> get_results ( $query );
$output = '' ;
if ( ! empty ( $users ) ) {
2010-03-02 13:36:49 -05:00
$name = esc_attr ( $name );
if ( $multi && ! $id )
$id = '' ;
else
$id = $id ? " id=' " . esc_attr ( $id ) . " ' " : " id=' $name ' " ;
2008-09-30 06:30:56 -04:00
2010-03-02 13:36:49 -05:00
$output = " <select name=' { $name } ' { $id } class=' $class '> \n " ;
2007-05-29 00:28:10 -04:00
if ( $show_option_all )
$output .= " \t <option value='0'> $show_option_all </option> \n " ;
if ( $show_option_none )
$output .= " \t <option value='-1'> $show_option_none </option> \n " ;
2008-08-06 16:31:54 -04:00
foreach ( ( array ) $users as $user ) {
2007-05-29 00:28:10 -04:00
$user -> ID = ( int ) $user -> ID ;
$_selected = $user -> ID == $selected ? " selected='selected' " : '' ;
2008-10-25 16:40:58 -04:00
$display = ! empty ( $user -> $show ) ? $user -> $show : '(' . $user -> user_login . ')' ;
2009-05-18 11:11:07 -04:00
$output .= " \t <option value=' $user->ID ' $_selected > " . esc_html ( $display ) . " </option> \n " ;
2007-05-29 00:28:10 -04:00
}
$output .= " </select> " ;
}
$output = apply_filters ( 'wp_dropdown_users' , $output );
if ( $echo )
echo $output ;
return $output ;
}
2008-09-12 00:29:09 -04:00
/**
* 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
2010-03-03 14:08:30 -05:00
* 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 .
2008-09-12 00:29:09 -04:00
*
* @ access private
* @ since 2.5 . 0
* @ uses $wpdb WordPress database object for queries
*
* @ param object $user The user data object .
*/
2007-11-27 17:14:53 -05:00
function _fill_user ( & $user ) {
2010-03-03 14:08:30 -05:00
$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 ) {
2007-11-27 17:14:53 -05:00
global $wpdb ;
2010-03-03 14:08:30 -05:00
$clean = array_map ( 'intval' , $ids );
if ( 0 == count ( $clean ) )
return $objects ;
$list = implode ( ',' , $clean );
2007-12-16 16:38:24 -05:00
$show = $wpdb -> hide_errors ();
2010-03-03 14:08:30 -05:00
$metavalues = $wpdb -> get_results ( " SELECT user_id, meta_key, meta_value FROM $wpdb->usermeta WHERE user_id IN ( $list ) " );
2007-12-16 16:38:24 -05:00
$wpdb -> show_errors ( $show );
2007-11-27 17:14:53 -05:00
2010-03-03 14:08:30 -05:00
$objects = array ();
foreach ( $clean as $id ) {
$objects [ $id ] = array ();
}
foreach ( $metavalues as $meta_object ) {
$objects [ $meta_object -> user_id ][] = $meta_object ;
}
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 );
$user -> { $meta -> meta_key } = $value ;
2007-11-27 17:14:53 -05:00
}
$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 ;
2010-03-03 14:08:30 -05:00
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
* @ param array $metas User metavalues 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 ]);
}
}
2007-11-27 17:14:53 -05:00
}
2009-09-14 09:57:48 -04:00
/**
* 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 ) {
2010-01-15 17:11:12 -05:00
if ( is_string ( $user -> $field ) || is_numeric ( $user -> $field ) )
2009-12-23 10:02:06 -05:00
$user -> $field = sanitize_user_field ( $field , $user -> $field , $user -> ID , $context );
2009-09-14 09:57:48 -04:00
}
$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 .
*
* Possible context values are : 'raw' , 'edit' , 'db' , 'display' , 'attribute' and 'js' . The
* 'display' context is used by default . 'attribute' and 'js' contexts are treated like '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 '$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_' .
*
* @ param string $field The user Object field name .
* @ param mixed $value The user Object value .
* @ param int $user_id user ID .
* @ param string $context How to sanitize user fields . Looks for 'raw' , 'edit' , 'db' , 'display' ,
* 'attribute' and 'js' .
* @ return mixed Sanitized value .
*/
function sanitize_user_field ( $field , $value , $user_id , $context ) {
$int_fields = array ( 'ID' );
if ( in_array ( $field , $int_fields ) )
$value = ( int ) $value ;
if ( 'raw' == $context )
return $value ;
2009-12-23 10:02:06 -05:00
if ( ! is_string ( $value ) && ! is_numeric ( $value ) )
2009-09-14 09:57:48 -04:00
return $value ;
$prefixed = false ;
if ( false !== strpos ( $field , 'user_' ) ) {
$prefixed = true ;
$field_no_prefix = str_replace ( 'user_' , '' , $field );
}
if ( 'edit' == $context ) {
if ( $prefixed ) {
$value = apply_filters ( " edit_ $field " , $value , $user_id );
} else {
$value = apply_filters ( " edit_user_ $field " , $value , $user_id );
}
if ( 'description' == $field )
$value = esc_html ( $value );
else
$value = esc_attr ( $value );
} else if ( 'db' == $context ) {
if ( $prefixed ) {
$value = apply_filters ( " pre_ $field " , $value );
} else {
$value = apply_filters ( " pre_user_ $field " , $value );
}
} else {
// Use display filters by default.
if ( $prefixed )
$value = apply_filters ( $field , $value , $user_id , $context );
else
$value = apply_filters ( " user_ $field " , $value , $user_id , $context );
}
if ( 'user_url' == $field )
$value = esc_url ( $value );
if ( 'attribute' == $context )
$value = esc_attr ( $value );
else if ( 'js' == $context )
$value = esc_js ( $value );
return $value ;
}
2010-03-03 14:08:30 -05:00
/**
* Update all user caches
*
* @ since 3.0 . 0
*
* @ param object $user User object to be cached
*/
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' );
wp_cache_add ( $user -> user_nicename , $user -> ID , 'userslugs' );
}
2010-01-19 14:23:11 -05:00
/**
* Clean all user caches
*
2010-03-03 14:08:30 -05:00
* @ since 3.0 . 0
2010-01-19 14:23:11 -05:00
*
* @ param int $id User ID
*/
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' );
}
2010-03-02 13:06:14 -05:00
?>