9 * Authenticate user with remember capability.
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.
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
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.
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'];
35 if ( !empty($credentials['remember']) )
36 $credentials['remember'] = true;
38 $credentials['remember'] = false;
40 // TODO do we deprecate the wp_authentication action?
41 do_action_ref_array('wp_authenticate', array(&$credentials['user_login'], &$credentials['user_password']));
43 if ( '' === $secure_cookie )
44 $secure_cookie = is_ssl() ? true : false;
46 global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
47 $auth_secure_cookie = $secure_cookie;
49 add_filter('authenticate', 'wp_authenticate_cookie', 30, 3);
51 $user = wp_authenticate($credentials['user_login'], $credentials['user_password']);
53 if ( is_wp_error($user) ) {
54 if ( $user->get_error_codes() == array('empty_username', 'empty_password') ) {
55 $user = new WP_Error('', '');
61 wp_set_auth_cookie($user->ID, $credentials['remember'], $secure_cookie);
62 do_action('wp_login', $credentials['user_login']);
68 * Authenticate the user using the username and password.
70 add_filter('authenticate', 'wp_authenticate_username_password', 20, 3);
71 function wp_authenticate_username_password($user, $username, $password) {
72 if ( is_a($user, 'WP_User') ) { return $user; }
74 if ( empty($username) || empty($password) ) {
75 $error = new WP_Error();
77 if ( empty($username) )
78 $error->add('empty_username', __('<strong>ERROR</strong>: The username field is empty.'));
80 if ( empty($password) )
81 $error->add('empty_password', __('<strong>ERROR</strong>: The password field is empty.'));
86 $userdata = get_userdatabylogin($username);
89 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')));
92 $userdata = apply_filters('wp_authenticate_user', $userdata, $password);
93 if ( is_wp_error($userdata) ) {
97 if ( !wp_check_password($password, $userdata->user_pass, $userdata->ID) ) {
98 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')));
101 $user = new WP_User($userdata->ID);
106 * Authenticate the user using the WordPress auth cookie.
108 function wp_authenticate_cookie($user, $username, $password) {
109 if ( is_a($user, 'WP_User') ) { return $user; }
111 if ( empty($username) && empty($password) ) {
112 $user_id = wp_validate_auth_cookie();
114 return new WP_User($user_id);
116 global $auth_secure_cookie;
118 if ( $auth_secure_cookie )
119 $auth_cookie = SECURE_AUTH_COOKIE;
121 $auth_cookie = AUTH_COOKIE;
123 if ( !empty($_COOKIE[$auth_cookie]) )
124 return new WP_Error('expired_session', __('Please log in again.'));
126 // If the cookie is not set, be silent.
133 * Retrieve user data based on field.
135 * Use get_profile() will make a database query to get the value of the table
136 * column. The value might be cached using the query cache, but care should be
137 * taken when using the function to not make a lot of queries for retrieving
138 * user profile information.
140 * If the $user parameter is not used, then the user will be retrieved from a
141 * cookie of the user. Therefore, if the cookie does not exist, then no value
142 * might be returned. Sanity checking must be done to ensure that when using
143 * get_profile() that empty/null/false values are handled and that something is
144 * at least displayed.
147 * @uses $wpdb WordPress database object to create queries.
149 * @param string $field User field to retrieve.
150 * @param string $user Optional. User username.
151 * @return string The value in the field.
153 function get_profile($field, $user = false) {
156 $user = $wpdb->escape($_COOKIE[USER_COOKIE]);
157 return $wpdb->get_var( $wpdb->prepare("SELECT $field FROM $wpdb->users WHERE user_login = %s", $user) );
161 * Number of posts user has written.
164 * @uses $wpdb WordPress database object for queries.
166 * @param int $userid User ID.
167 * @return int Amount of posts user has written.
169 function get_usernumposts($userid) {
171 $userid = (int) $userid;
172 $count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(*) FROM $wpdb->posts WHERE post_author = %d AND post_type = 'post' AND ", $userid) . get_private_posts_cap_sql('post'));
173 return apply_filters('get_usernumposts', $count, $userid);
177 * Check that the user login name and password is correct.
180 * @todo xmlrpc only. Maybe move to xmlrpc.php.
182 * @param string $user_login User name.
183 * @param string $user_pass User password.
184 * @return bool False if does not authenticate, true if username and password authenticates.
186 function user_pass_ok($user_login, $user_pass) {
187 $user = wp_authenticate($user_login, $user_pass);
188 if ( is_wp_error($user) )
195 // User option functions
199 * Retrieve user option that can be either global, user, or blog.
201 * If the user ID is not given, then the current user will be used instead. If
202 * the user ID is given, then the user data will be retrieved. The filter for
203 * the result, will also pass the original option name and finally the user data
204 * object as the third parameter.
206 * The option will first check for the non-global name, then the global name,
207 * and if it still doesn't find it, it will try the blog option. The option can
208 * either be modified or set by a plugin.
211 * @uses $wpdb WordPress database object for queries.
212 * @uses apply_filters() Calls 'get_user_option_$option' hook with result,
213 * option parameter, and user data object.
215 * @param string $option User option name.
216 * @param int $user Optional. User ID.
217 * @param bool $check_blog_options Whether to check for an option in the options table if a per-user option does not exist. Default is true.
220 function get_user_option( $option, $user = 0, $check_blog_options = true ) {
223 $option = preg_replace('|[^a-z0-9_]|i', '', $option);
225 $user = wp_get_current_user();
227 $user = get_userdata($user);
229 if ( isset( $user->{$wpdb->prefix . $option} ) ) // Blog specific
230 $result = $user->{$wpdb->prefix . $option};
231 elseif ( isset( $user->{$option} ) ) // User specific and cross-blog
232 $result = $user->{$option};
233 elseif ( $check_blog_options ) // Blog global
234 $result = get_option( $option );
238 return apply_filters("get_user_option_{$option}", $result, $option, $user);
242 * Update user option with global blog capability.
244 * User options are just like user metadata except that they have support for
245 * global blog options. If the 'global' parameter is false, which it is by default
246 * it will prepend the WordPress table prefix to the option name.
249 * @uses $wpdb WordPress database object for queries
251 * @param int $user_id User ID
252 * @param string $option_name User option name.
253 * @param mixed $newvalue User option value.
254 * @param bool $global Optional. Whether option name is blog specific or not.
257 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
260 $option_name = $wpdb->prefix . $option_name;
261 return update_usermeta( $user_id, $option_name, $newvalue );
265 * Get users for the blog.
267 * For setups that use the multi-blog feature. Can be used outside of the
268 * multi-blog feature.
271 * @uses $wpdb WordPress database object for queries
272 * @uses $blog_id The Blog id of the blog for those that use more than one blog
274 * @param int $id Blog ID.
275 * @return array List of users that are part of that Blog ID
277 function get_users_of_blog( $id = '' ) {
278 global $wpdb, $blog_id;
280 $id = (int) $blog_id;
281 $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 = '{$wpdb->prefix}capabilities' ORDER BY {$wpdb->usermeta}.user_id" );
286 // User meta functions
290 * Remove user meta data.
293 * @uses $wpdb WordPress database object for queries.
295 * @param int $user_id User ID.
296 * @param string $meta_key Metadata key.
297 * @param mixed $meta_value Metadata value.
298 * @return bool True deletion completed and false if user_id is not a number.
300 function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) {
302 if ( !is_numeric( $user_id ) )
304 $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
306 if ( is_array($meta_value) || is_object($meta_value) )
307 $meta_value = serialize($meta_value);
308 $meta_value = trim( $meta_value );
310 if ( ! empty($meta_value) )
311 $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) );
313 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
315 wp_cache_delete($user_id, 'users');
321 * Retrieve user metadata.
323 * If $user_id is not a number, then the function will fail over with a 'false'
324 * boolean return value. Other returned values depend on whether there is only
325 * one item to be returned, which be that single item type. If there is more
326 * than one metadata value, then it will be list of metadata values.
329 * @uses $wpdb WordPress database object for queries.
331 * @param int $user_id User ID
332 * @param string $meta_key Optional. Metadata key.
335 function get_usermeta( $user_id, $meta_key = '') {
337 $user_id = (int) $user_id;
342 if ( !empty($meta_key) ) {
343 $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
344 $user = wp_cache_get($user_id, 'users');
345 // Check the cached user object
346 if ( false !== $user && isset($user->$meta_key) )
347 $metas = array($user->$meta_key);
349 $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
351 $metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d", $user_id) );
354 if ( empty($metas) ) {
355 if ( empty($meta_key) )
361 $metas = array_map('maybe_unserialize', $metas);
363 if ( count($metas) == 1 )
370 * Update metadata of user.
372 * There is no need to serialize values, they will be serialized if it is
373 * needed. The metadata key can only be a string with underscores. All else will
376 * Will remove the metadata, if the meta value is empty.
379 * @uses $wpdb WordPress database object for queries
381 * @param int $user_id User ID
382 * @param string $meta_key Metadata key.
383 * @param mixed $meta_value Metadata value.
384 * @return bool True on successful update, false on failure.
386 function update_usermeta( $user_id, $meta_key, $meta_value ) {
388 if ( !is_numeric( $user_id ) )
390 $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
392 /** @todo Might need fix because usermeta data is assumed to be already escaped */
393 if ( is_string($meta_value) )
394 $meta_value = stripslashes($meta_value);
395 $meta_value = maybe_serialize($meta_value);
397 if (empty($meta_value)) {
398 return delete_usermeta($user_id, $meta_key);
401 $cur = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
403 $wpdb->insert($wpdb->usermeta, compact('user_id', 'meta_key', 'meta_value') );
404 else if ( $cur->meta_value != $meta_value )
405 $wpdb->update($wpdb->usermeta, compact('meta_value'), compact('user_id', 'meta_key') );
409 wp_cache_delete($user_id, 'users');
415 // Private helper functions
419 * Setup global user vars.
421 * Used by set_current_user() for back compat. Might be deprecated in the
425 * @global string $userdata User description.
426 * @global string $user_login The user username for logging in
427 * @global int $user_level The level of the user
428 * @global int $user_ID The ID of the user
429 * @global string $user_email The email address of the user
430 * @global string $user_url The url in the user's profile
431 * @global string $user_pass_md5 MD5 of the user's password
432 * @global string $user_identity The display name of the user
434 * @param int $user_id Optional. User ID to setup global data.
436 function setup_userdata($user_id = '') {
437 global $user_login, $userdata, $user_level, $user_ID, $user_email, $user_url, $user_pass_md5, $user_identity;
439 if ( '' == $user_id )
440 $user = wp_get_current_user();
442 $user = new WP_User($user_id);
444 if ( 0 == $user->ID )
447 $userdata = $user->data;
448 $user_login = $user->user_login;
449 $user_level = (int) isset($user->user_level) ? $user->user_level : 0;
450 $user_ID = (int) $user->ID;
451 $user_email = $user->user_email;
452 $user_url = $user->user_url;
453 $user_pass_md5 = md5($user->user_pass);
454 $user_identity = $user->display_name;
458 * Create dropdown HTML content of users.
460 * The content can either be displayed, which it is by default or retrieved by
461 * setting the 'echo' argument. The 'include' and 'exclude' arguments do not
462 * need to be used; all users will be displayed in that case. Only one can be
463 * used, either 'include' or 'exclude', but not both.
465 * The available arguments are as follows:
467 * <li>show_option_all - Text to show all and whether HTML option exists.</li>
468 * <li>show_option_none - Text for show none and whether HTML option exists.
470 * <li>orderby - SQL order by clause for what order the users appear. Default is
471 * 'display_name'.</li>
472 * <li>order - Default is 'ASC'. Can also be 'DESC'.</li>
473 * <li>include - User IDs to include.</li>
474 * <li>exclude - User IDs to exclude.</li>
475 * <li>multi - Default is 'false'. Whether to skip the ID attribute on the 'select' element.</li>
476 * <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>
477 * <li>echo - Default is '1'. Whether to display or retrieve content.</li>
478 * <li>selected - Which User ID is selected.</li>
479 * <li>name - Default is 'user'. Name attribute of select element.</li>
480 * <li>class - Class attribute of select element.</li>
484 * @uses $wpdb WordPress database object for queries
486 * @param string|array $args Optional. Override defaults.
487 * @return string|null Null on display. String of HTML content on retrieve.
489 function wp_dropdown_users( $args = '' ) {
492 'show_option_all' => '', 'show_option_none' => '',
493 'orderby' => 'display_name', 'order' => 'ASC',
494 'include' => '', 'exclude' => '', 'multi' => 0,
495 'show' => 'display_name', 'echo' => 1,
496 'selected' => 0, 'name' => 'user', 'class' => ''
499 $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
501 $r = wp_parse_args( $args, $defaults );
502 extract( $r, EXTR_SKIP );
504 $query = "SELECT * FROM $wpdb->users";
506 $query_where = array();
508 if ( is_array($include) )
509 $include = join(',', $include);
510 $include = preg_replace('/[^0-9,]/', '', $include); // (int)
512 $query_where[] = "ID IN ($include)";
514 if ( is_array($exclude) )
515 $exclude = join(',', $exclude);
516 $exclude = preg_replace('/[^0-9,]/', '', $exclude); // (int)
518 $query_where[] = "ID NOT IN ($exclude)";
521 $query .= " WHERE " . join(' AND', $query_where);
523 $query .= " ORDER BY $orderby $order";
525 $users = $wpdb->get_results( $query );
528 if ( !empty($users) ) {
529 $id = $multi ? "" : "id='$name'";
531 $output = "<select name='$name' $id class='$class'>\n";
533 if ( $show_option_all )
534 $output .= "\t<option value='0'>$show_option_all</option>\n";
536 if ( $show_option_none )
537 $output .= "\t<option value='-1'>$show_option_none</option>\n";
539 foreach ( (array) $users as $user ) {
540 $user->ID = (int) $user->ID;
541 $_selected = $user->ID == $selected ? " selected='selected'" : '';
542 $display = !empty($user->$show) ? $user->$show : '('. $user->user_login . ')';
543 $output .= "\t<option value='$user->ID'$_selected>" . esc_html($display) . "</option>\n";
546 $output .= "</select>";
549 $output = apply_filters('wp_dropdown_users', $output);
558 * Add user meta data as properties to given user object.
560 * The finished user data is cached, but the cache is not used to fill in the
561 * user data for the given object. Once the function has been used, the cache
562 * should be used to retrieve user data. The purpose seems then to be to ensure
563 * that the data in the object is always fresh.
567 * @uses $wpdb WordPress database object for queries
569 * @param object $user The user data object.
571 function _fill_user( &$user ) {
574 $show = $wpdb->hide_errors();
575 $metavalues = $wpdb->get_results($wpdb->prepare("SELECT meta_key, meta_value FROM $wpdb->usermeta WHERE user_id = %d", $user->ID));
576 $wpdb->show_errors($show);
579 foreach ( (array) $metavalues as $meta ) {
580 $value = maybe_unserialize($meta->meta_value);
581 $user->{$meta->meta_key} = $value;
585 $level = $wpdb->prefix . 'user_level';
586 if ( isset( $user->{$level} ) )
587 $user->user_level = $user->{$level};
589 // For backwards compat.
590 if ( isset($user->first_name) )
591 $user->user_firstname = $user->first_name;
592 if ( isset($user->last_name) )
593 $user->user_lastname = $user->last_name;
594 if ( isset($user->description) )
595 $user->user_description = $user->description;
597 wp_cache_add($user->ID, $user, 'users');
598 wp_cache_add($user->user_login, $user->ID, 'userlogins');
599 wp_cache_add($user->user_email, $user->ID, 'useremail');
600 wp_cache_add($user->user_nicename, $user->ID, 'userslugs');