3 * WordPress user administration API.
6 * @subpackage Administration
10 * Creates a new user from the "Users" form using $_POST information.
12 * It seems that the first half is for backwards compatibility, but only
13 * has the ability to alter the user's role. WordPress core seems to
14 * use this function only in the second way, running edit_user() with
15 * no id so as to create a new user.
19 * @param int $user_id Optional. User ID.
20 * @return null|WP_Error|int Null when adding user, WP_Error or User ID integer when no parameters.
23 if ( func_num_args() ) { // The hackiest hack that ever did hack
24 global $current_user, $wp_roles;
25 $user_id = (int) func_get_arg( 0 );
27 if ( isset( $_POST['role'] ) ) {
28 $new_role = sanitize_text_field( $_POST['role'] );
29 // Don't let anyone with 'edit_users' (admins) edit their own role to something without it.
30 if ( $user_id != $current_user->id || $wp_roles->role_objects[$new_role]->has_cap( 'edit_users' ) ) {
31 // If the new role isn't editable by the logged-in user die with error
32 $editable_roles = get_editable_roles();
33 if ( empty( $editable_roles[$new_role] ) )
34 wp_die(__('You can’t give users that role.'));
36 $user = new WP_User( $user_id );
37 $user->set_role( $new_role );
41 add_action( 'user_register', 'add_user' ); // See above
47 * Edit user settings based on contents of $_POST
49 * Used on user-edit.php and profile.php to manage and process user options, passwords etc.
53 * @param int $user_id Optional. User ID.
54 * @return int user id of the updated user
56 function edit_user( $user_id = 0 ) {
57 global $current_user, $wp_roles, $wpdb;
58 if ( $user_id != 0 ) {
60 $user->ID = (int) $user_id;
61 $userdata = get_userdata( $user_id );
62 $user->user_login = $wpdb->escape( $userdata->user_login );
68 if ( !$update && isset( $_POST['user_login'] ) )
69 $user->user_login = sanitize_user($_POST['user_login'], true);
72 if ( isset( $_POST['pass1'] ))
73 $pass1 = $_POST['pass1'];
74 if ( isset( $_POST['pass2'] ))
75 $pass2 = $_POST['pass2'];
77 if ( isset( $_POST['role'] ) && current_user_can( 'edit_users' ) ) {
78 $new_role = sanitize_text_field( $_POST['role'] );
79 $potential_role = isset($wp_roles->role_objects[$new_role]) ? $wp_roles->role_objects[$new_role] : false;
80 // Don't let anyone with 'edit_users' (admins) edit their own role to something without it.
81 // Multisite super admins can freely edit their blog roles -- they possess all caps.
82 if ( ( is_multisite() && current_user_can( 'manage_sites' ) ) || $user_id != $current_user->id || ($potential_role && $potential_role->has_cap( 'edit_users' ) ) )
83 $user->role = $new_role;
85 // If the new role isn't editable by the logged-in user die with error
86 $editable_roles = get_editable_roles();
87 if ( ! empty( $new_role ) && empty( $editable_roles[$new_role] ) )
88 wp_die(__('You can’t give users that role.'));
91 if ( isset( $_POST['email'] ))
92 $user->user_email = sanitize_text_field( $_POST['email'] );
93 if ( isset( $_POST['url'] ) ) {
94 if ( empty ( $_POST['url'] ) || $_POST['url'] == 'http://' ) {
97 $user->user_url = esc_url_raw( $_POST['url'] );
98 $user->user_url = preg_match('/^(https?|ftps?|mailto|news|irc|gopher|nntp|feed|telnet):/is', $user->user_url) ? $user->user_url : 'http://'.$user->user_url;
101 if ( isset( $_POST['first_name'] ) )
102 $user->first_name = sanitize_text_field( $_POST['first_name'] );
103 if ( isset( $_POST['last_name'] ) )
104 $user->last_name = sanitize_text_field( $_POST['last_name'] );
105 if ( isset( $_POST['nickname'] ) )
106 $user->nickname = sanitize_text_field( $_POST['nickname'] );
107 if ( isset( $_POST['display_name'] ) )
108 $user->display_name = sanitize_text_field( $_POST['display_name'] );
110 if ( isset( $_POST['description'] ) )
111 $user->description = trim( $_POST['description'] );
113 foreach ( _wp_get_user_contactmethods() as $method => $name ) {
114 if ( isset( $_POST[$method] ))
115 $user->$method = sanitize_text_field( $_POST[$method] );
119 $user->rich_editing = isset( $_POST['rich_editing'] ) && 'false' == $_POST['rich_editing'] ? 'false' : 'true';
120 $user->admin_color = isset( $_POST['admin_color'] ) ? sanitize_text_field( $_POST['admin_color'] ) : 'fresh';
123 $user->comment_shortcuts = isset( $_POST['comment_shortcuts'] ) && 'true' == $_POST['comment_shortcuts'] ? 'true' : '';
126 if ( !empty($_POST['use_ssl']) )
129 $errors = new WP_Error();
131 /* checking that username has been typed */
132 if ( $user->user_login == '' )
133 $errors->add( 'user_login', __( '<strong>ERROR</strong>: Please enter a username.' ));
135 /* checking the password has been typed twice */
136 do_action_ref_array( 'check_passwords', array ( $user->user_login, & $pass1, & $pass2 ));
139 if ( empty($pass1) && !empty($pass2) )
140 $errors->add( 'pass', __( '<strong>ERROR</strong>: You entered your new password only once.' ), array( 'form-field' => 'pass1' ) );
141 elseif ( !empty($pass1) && empty($pass2) )
142 $errors->add( 'pass', __( '<strong>ERROR</strong>: You entered your new password only once.' ), array( 'form-field' => 'pass2' ) );
145 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter your password.' ), array( 'form-field' => 'pass1' ) );
146 elseif ( empty($pass2) )
147 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter your password twice.' ), array( 'form-field' => 'pass2' ) );
150 /* Check for "\" in password */
151 if ( false !== strpos( stripslashes($pass1), "\\" ) )
152 $errors->add( 'pass', __( '<strong>ERROR</strong>: Passwords may not contain the character "\\".' ), array( 'form-field' => 'pass1' ) );
154 /* checking the password has been typed twice the same */
155 if ( $pass1 != $pass2 )
156 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter the same password in the two password fields.' ), array( 'form-field' => 'pass1' ) );
158 if ( !empty( $pass1 ) )
159 $user->user_pass = $pass1;
161 if ( !$update && isset( $_POST['user_login'] ) && !validate_username( $_POST['user_login'] ) )
162 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ));
164 if ( !$update && username_exists( $user->user_login ) )
165 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ));
167 /* checking e-mail address */
168 if ( empty( $user->user_email ) ) {
169 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please enter an e-mail address.' ), array( 'form-field' => 'email' ) );
170 } elseif ( !is_email( $user->user_email ) ) {
171 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The e-mail address isn’t correct.' ), array( 'form-field' => 'email' ) );
172 } elseif ( ( $owner_id = email_exists($user->user_email) ) && $owner_id != $user->ID ) {
173 $errors->add( 'email_exists', __('<strong>ERROR</strong>: This email is already registered, please choose another one.'), array( 'form-field' => 'email' ) );
176 // Allow plugins to return their own errors.
177 do_action_ref_array('user_profile_update_errors', array ( &$errors, $update, &$user ) );
179 if ( $errors->get_error_codes() )
183 $user_id = wp_update_user( get_object_vars( $user ) );
185 $user_id = wp_insert_user( get_object_vars( $user ) );
186 wp_new_user_notification( $user_id, isset($_POST['send_password']) ? $pass1 : '' );
192 * {@internal Missing Short Description}}
194 * {@internal Missing Long Description}}
198 * @return array List of user IDs.
200 function get_author_user_ids() {
202 if ( !is_multisite() )
203 $level_key = $wpdb->get_blog_prefix() . 'user_level';
205 $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
207 return $wpdb->get_col( $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s AND meta_value != '0'", $level_key) );
211 * {@internal Missing Short Description}}
213 * {@internal Missing Long Description}}
217 * @param int $user_id User ID.
218 * @return array|bool List of editable authors. False if no editable users.
220 function get_editable_authors( $user_id ) {
223 $editable = get_editable_user_ids( $user_id );
228 $editable = join(',', $editable);
229 $authors = $wpdb->get_results( "SELECT * FROM $wpdb->users WHERE ID IN ($editable) ORDER BY display_name" );
232 return apply_filters('get_editable_authors', $authors);
236 * {@internal Missing Short Description}}
238 * {@internal Missing Long Description}}
242 * @param int $user_id User ID.
243 * @param bool $exclude_zeros Optional, default is true. Whether to exclude zeros.
246 function get_editable_user_ids( $user_id, $exclude_zeros = true, $post_type = 'post' ) {
249 $user = new WP_User( $user_id );
250 $post_type_obj = get_post_type_object($post_type);
252 if ( ! $user->has_cap($post_type_obj->cap->edit_others_posts) ) {
253 if ( $user->has_cap($post_type_obj->cap->edit_posts) || ! $exclude_zeros )
254 return array($user->id);
259 if ( !is_multisite() )
260 $level_key = $wpdb->get_blog_prefix() . 'user_level';
262 $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
264 $query = $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s", $level_key);
265 if ( $exclude_zeros )
266 $query .= " AND meta_value != '0'";
268 return $wpdb->get_col( $query );
272 * Fetch a filtered list of user roles that the current user is
275 * Simple function who's main purpose is to allow filtering of the
276 * list of roles in the $wp_roles object so that plugins can remove
277 * innappropriate ones depending on the situation or user making edits.
278 * Specifically because without filtering anyone with the edit_users
279 * capability can edit others to be administrators, even if they are
280 * only editors or authors. This filter allows admins to delegate
287 function get_editable_roles() {
290 $all_roles = $wp_roles->roles;
291 $editable_roles = apply_filters('editable_roles', $all_roles);
293 return $editable_roles;
297 * {@internal Missing Short Description}}
299 * {@internal Missing Long Description}}
305 function get_nonauthor_user_ids() {
308 if ( !is_multisite() )
309 $level_key = $wpdb->get_blog_prefix() . 'user_level';
311 $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
313 return $wpdb->get_col( $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s AND meta_value = '0'", $level_key) );
317 * Retrieve editable posts from other users.
321 * @param int $user_id User ID to not retrieve posts from.
322 * @param string $type Optional, defaults to 'any'. Post type to retrieve, can be 'draft' or 'pending'.
323 * @return array List of posts from others.
325 function get_others_unpublished_posts($user_id, $type='any') {
328 $editable = get_editable_user_ids( $user_id );
330 if ( in_array($type, array('draft', 'pending')) )
331 $type_sql = " post_status = '$type' ";
333 $type_sql = " ( post_status = 'draft' OR post_status = 'pending' ) ";
335 $dir = ( 'pending' == $type ) ? 'ASC' : 'DESC';
340 $editable = join(',', $editable);
341 $other_unpubs = $wpdb->get_results( $wpdb->prepare("SELECT ID, post_title, post_author FROM $wpdb->posts WHERE post_type = 'post' AND $type_sql AND post_author IN ($editable) AND post_author != %d ORDER BY post_modified $dir", $user_id) );
344 return apply_filters('get_others_drafts', $other_unpubs);
348 * Retrieve drafts from other users.
352 * @param int $user_id User ID.
353 * @return array List of drafts from other users.
355 function get_others_drafts($user_id) {
356 return get_others_unpublished_posts($user_id, 'draft');
360 * Retrieve pending review posts from other users.
364 * @param int $user_id User ID.
365 * @return array List of posts with pending review post type from other users.
367 function get_others_pending($user_id) {
368 return get_others_unpublished_posts($user_id, 'pending');
372 * Retrieve user data and filter it.
376 * @param int $user_id User ID.
377 * @return object WP_User object with user data.
379 function get_user_to_edit( $user_id ) {
380 $user = new WP_User( $user_id );
382 $user_contactmethods = _wp_get_user_contactmethods();
383 foreach ($user_contactmethods as $method => $name) {
384 if ( empty( $user->{$method} ) )
385 $user->{$method} = '';
388 if ( empty($user->description) )
389 $user->description = '';
391 $user = sanitize_user_object($user, 'edit');
397 * Retrieve the user's drafts.
401 * @param int $user_id User ID.
404 function get_users_drafts( $user_id ) {
406 $query = $wpdb->prepare("SELECT ID, post_title FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'draft' AND post_author = %d ORDER BY post_modified DESC", $user_id);
407 $query = apply_filters('get_users_drafts', $query);
408 return $wpdb->get_results( $query );
412 * Remove user and optionally reassign posts and links to another user.
414 * If the $reassign parameter is not assigned to an User ID, then all posts will
415 * be deleted of that user. The action 'delete_user' that is passed the User ID
416 * being deleted will be run after the posts are either reassigned or deleted.
417 * The user meta will also be deleted that are for that User ID.
421 * @param int $id User ID.
422 * @param int $reassign Optional. Reassign posts and links to new User ID.
423 * @return bool True when finished.
425 function wp_delete_user( $id, $reassign = 'novalue' ) {
430 // allow for transaction statement
431 do_action('delete_user', $id);
433 if ( 'novalue' === $reassign || null === $reassign ) {
434 $post_ids = $wpdb->get_col( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_author = %d", $id) );
437 foreach ( $post_ids as $post_id )
438 wp_delete_post($post_id);
442 $link_ids = $wpdb->get_col( $wpdb->prepare("SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id) );
445 foreach ( $link_ids as $link_id )
446 wp_delete_link($link_id);
449 $reassign = (int) $reassign;
450 $wpdb->update( $wpdb->posts, array('post_author' => $reassign), array('post_author' => $id) );
451 $wpdb->update( $wpdb->links, array('link_owner' => $reassign), array('link_owner' => $id) );
454 clean_user_cache($id);
456 // FINALLY, delete user
457 if ( !is_multisite() ) {
458 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d", $id) );
459 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->users WHERE ID = %d", $id) );
461 $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
462 $wpdb->query("DELETE FROM $wpdb->usermeta WHERE user_id = $id AND meta_key = '{$level_key}'");
465 // allow for commit transaction
466 do_action('deleted_user', $id);
472 * Remove all capabilities from user.
476 * @param int $id User ID.
478 function wp_revoke_user($id) {
481 $user = new WP_User($id);
482 $user->remove_all_caps();
485 if ( !class_exists('WP_User_Search') ) :
487 * WordPress User Search class.
491 class WP_User_Search {
494 * {@internal Missing Description}}
503 * {@internal Missing Description}}
521 * Role name that users have.
539 * Amount of users to display per page.
545 var $users_per_page = 50;
548 * {@internal Missing Description}}
557 * {@internal Missing Description}}
566 * {@internal Missing Description}}
575 * {@internal Missing Description}}
584 * {@internal Missing Description}}
593 * {@internal Missing Description}}
602 * {@internal Missing Description}}
608 var $total_users_for_query = 0;
611 * {@internal Missing Description}}
617 var $too_many_total_users = false;
620 * {@internal Missing Description}}
629 * {@internal Missing Description}}
638 * PHP4 Constructor - Sets up the object properties.
642 * @param string $search_term Search terms string.
643 * @param int $page Optional. Page ID.
644 * @param string $role Role name.
645 * @return WP_User_Search
647 function WP_User_Search ($search_term = '', $page = '', $role = '') {
648 $this->search_term = $search_term;
649 $this->raw_page = ( '' == $page ) ? false : (int) $page;
650 $this->page = (int) ( '' == $page ) ? 1 : $page;
653 $this->prepare_query();
655 $this->prepare_vars_for_template_usage();
660 * {@internal Missing Short Description}}
662 * {@internal Missing Long Description}}
667 function prepare_query() {
669 $this->first_user = ($this->page - 1) * $this->users_per_page;
671 $this->query_limit = $wpdb->prepare(" LIMIT %d, %d", $this->first_user, $this->users_per_page);
672 $this->query_orderby = ' ORDER BY user_login';
675 if ( $this->search_term ) {
677 $search_sql = 'AND (';
678 foreach ( array('user_login', 'user_nicename', 'user_email', 'user_url', 'display_name') as $col )
679 $searches[] = $col . " LIKE '%$this->search_term%'";
680 $search_sql .= implode(' OR ', $searches);
684 $this->query_from = " FROM $wpdb->users";
685 $this->query_where = " WHERE 1=1 $search_sql";
688 $this->query_from .= " INNER JOIN $wpdb->usermeta ON $wpdb->users.ID = $wpdb->usermeta.user_id";
689 $this->query_where .= $wpdb->prepare(" AND $wpdb->usermeta.meta_key = '{$wpdb->prefix}capabilities' AND $wpdb->usermeta.meta_value LIKE %s", '%' . $this->role . '%');
690 } elseif ( is_multisite() ) {
691 $level_key = $wpdb->prefix . 'capabilities'; // wpmu site admins don't have user_levels
692 $this->query_from .= ", $wpdb->usermeta";
693 $this->query_where .= " AND $wpdb->users.ID = $wpdb->usermeta.user_id AND meta_key = '{$level_key}'";
696 do_action_ref_array( 'pre_user_search', array( &$this ) );
700 * {@internal Missing Short Description}}
702 * {@internal Missing Long Description}}
710 $this->results = $wpdb->get_col("SELECT DISTINCT($wpdb->users.ID)" . $this->query_from . $this->query_where . $this->query_orderby . $this->query_limit);
712 if ( $this->results )
713 $this->total_users_for_query = $wpdb->get_var("SELECT COUNT(DISTINCT($wpdb->users.ID))" . $this->query_from . $this->query_where); // no limit
715 $this->search_errors = new WP_Error('no_matching_users_found', __('No matching users were found!'));
719 * {@internal Missing Short Description}}
721 * {@internal Missing Long Description}}
726 function prepare_vars_for_template_usage() {
727 $this->search_term = stripslashes($this->search_term); // done with DB, from now on we want slashes gone
731 * {@internal Missing Short Description}}
733 * {@internal Missing Long Description}}
738 function do_paging() {
739 if ( $this->total_users_for_query > $this->users_per_page ) { // have to page the results
741 if( ! empty($this->search_term) )
742 $args['usersearch'] = urlencode($this->search_term);
743 if( ! empty($this->role) )
744 $args['role'] = urlencode($this->role);
746 $this->paging_text = paginate_links( array(
747 'total' => ceil($this->total_users_for_query / $this->users_per_page),
748 'current' => $this->page,
749 'base' => 'users.php?%_%',
750 'format' => 'userspage=%#%',
753 if ( $this->paging_text ) {
754 $this->paging_text = sprintf( '<span class="displaying-num">' . __( 'Displaying %s–%s of %s' ) . '</span>%s',
755 number_format_i18n( ( $this->page - 1 ) * $this->users_per_page + 1 ),
756 number_format_i18n( min( $this->page * $this->users_per_page, $this->total_users_for_query ) ),
757 number_format_i18n( $this->total_users_for_query ),
765 * {@internal Missing Short Description}}
767 * {@internal Missing Long Description}}
774 function get_results() {
775 return (array) $this->results;
779 * Displaying paging text.
781 * @see do_paging() Builds paging text.
786 function page_links() {
787 echo $this->paging_text;
791 * Whether paging is enabled.
793 * @see do_paging() Builds paging text.
800 function results_are_paged() {
801 if ( $this->paging_text )
807 * Whether there are search terms.
814 function is_search() {
815 if ( $this->search_term )
822 add_action('admin_init', 'default_password_nag_handler');
823 function default_password_nag_handler($errors = false) {
825 if ( ! get_user_option('default_password_nag') ) //Short circuit it.
828 //get_user_setting = JS saved UI setting. else no-js-falback code.
829 if ( 'hide' == get_user_setting('default_password_nag') || isset($_GET['default_password_nag']) && '0' == $_GET['default_password_nag'] ) {
830 delete_user_setting('default_password_nag');
831 update_user_option($user_ID, 'default_password_nag', false, true);
835 add_action('profile_update', 'default_password_nag_edit_user', 10, 2);
836 function default_password_nag_edit_user($user_ID, $old_data) {
837 if ( ! get_user_option('default_password_nag', $user_ID) ) //Short circuit it.
840 $new_data = get_userdata($user_ID);
842 if ( $new_data->user_pass != $old_data->user_pass ) { //Remove the nag if the password has been changed.
843 delete_user_setting('default_password_nag', $user_ID);
844 update_user_option($user_ID, 'default_password_nag', false, true);
848 add_action('admin_notices', 'default_password_nag');
849 function default_password_nag() {
850 if ( ! get_user_option('default_password_nag') ) //Short circuit it.
853 echo '<div class="error default-password-nag">';
855 echo '<strong>' . __('Notice:') . '</strong> ';
856 _e('You’re using the auto-generated password for your account. Would you like to change it to something you’ll remember easier?');
858 printf( '<a href="%s">' . __('Yes, take me to my profile page') . '</a> | ', admin_url('profile.php') . '#password' );
859 printf( '<a href="%s" id="default-password-nag-no">' . __('No thanks, do not remind me again') . '</a>', '?default_password_nag=0' );