3 * WordPress user administration API.
6 * @subpackage Administration
10 * Creates a new user from the "Users" form using $_POST information.
14 * @return null|WP_Error|int Null when adding user, WP_Error or User ID integer when no parameters.
21 * Edit user settings based on contents of $_POST
23 * Used on user-edit.php and profile.php to manage and process user options, passwords etc.
27 * @param int $user_id Optional. User ID.
28 * @return int user id of the updated user
30 function edit_user( $user_id = 0 ) {
31 global $wp_roles, $wpdb;
35 $user->ID = (int) $user_id;
36 $userdata = get_userdata( $user_id );
37 $user->user_login = $wpdb->escape( $userdata->user_login );
42 if ( !$update && isset( $_POST['user_login'] ) )
43 $user->user_login = sanitize_user($_POST['user_login'], true);
46 if ( isset( $_POST['pass1'] ))
47 $pass1 = $_POST['pass1'];
48 if ( isset( $_POST['pass2'] ))
49 $pass2 = $_POST['pass2'];
51 if ( isset( $_POST['role'] ) && current_user_can( 'edit_users' ) ) {
52 $new_role = sanitize_text_field( $_POST['role'] );
53 $potential_role = isset($wp_roles->role_objects[$new_role]) ? $wp_roles->role_objects[$new_role] : false;
54 // Don't let anyone with 'edit_users' (admins) edit their own role to something without it.
55 // Multisite super admins can freely edit their blog roles -- they possess all caps.
56 if ( ( is_multisite() && current_user_can( 'manage_sites' ) ) || $user_id != get_current_user_id() || ($potential_role && $potential_role->has_cap( 'edit_users' ) ) )
57 $user->role = $new_role;
59 // If the new role isn't editable by the logged-in user die with error
60 $editable_roles = get_editable_roles();
61 if ( ! empty( $new_role ) && empty( $editable_roles[$new_role] ) )
62 wp_die(__('You can’t give users that role.'));
65 if ( isset( $_POST['email'] ))
66 $user->user_email = sanitize_text_field( $_POST['email'] );
67 if ( isset( $_POST['url'] ) ) {
68 if ( empty ( $_POST['url'] ) || $_POST['url'] == 'http://' ) {
71 $user->user_url = esc_url_raw( $_POST['url'] );
72 $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;
75 if ( isset( $_POST['first_name'] ) )
76 $user->first_name = sanitize_text_field( $_POST['first_name'] );
77 if ( isset( $_POST['last_name'] ) )
78 $user->last_name = sanitize_text_field( $_POST['last_name'] );
79 if ( isset( $_POST['nickname'] ) )
80 $user->nickname = sanitize_text_field( $_POST['nickname'] );
81 if ( isset( $_POST['display_name'] ) )
82 $user->display_name = sanitize_text_field( $_POST['display_name'] );
84 if ( isset( $_POST['description'] ) )
85 $user->description = trim( $_POST['description'] );
87 foreach ( _wp_get_user_contactmethods( $user ) as $method => $name ) {
88 if ( isset( $_POST[$method] ))
89 $user->$method = sanitize_text_field( $_POST[$method] );
93 $user->rich_editing = isset( $_POST['rich_editing'] ) && 'false' == $_POST['rich_editing'] ? 'false' : 'true';
94 $user->admin_color = isset( $_POST['admin_color'] ) ? sanitize_text_field( $_POST['admin_color'] ) : 'fresh';
95 $user->show_admin_bar_front = isset( $_POST['admin_bar_front'] ) ? 'true' : 'false';
98 $user->comment_shortcuts = isset( $_POST['comment_shortcuts'] ) && 'true' == $_POST['comment_shortcuts'] ? 'true' : '';
101 if ( !empty($_POST['use_ssl']) )
104 $errors = new WP_Error();
106 /* checking that username has been typed */
107 if ( $user->user_login == '' )
108 $errors->add( 'user_login', __( '<strong>ERROR</strong>: Please enter a username.' ));
110 /* checking the password has been typed twice */
111 do_action_ref_array( 'check_passwords', array ( $user->user_login, & $pass1, & $pass2 ));
114 if ( empty($pass1) && !empty($pass2) )
115 $errors->add( 'pass', __( '<strong>ERROR</strong>: You entered your new password only once.' ), array( 'form-field' => 'pass1' ) );
116 elseif ( !empty($pass1) && empty($pass2) )
117 $errors->add( 'pass', __( '<strong>ERROR</strong>: You entered your new password only once.' ), array( 'form-field' => 'pass2' ) );
120 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter your password.' ), array( 'form-field' => 'pass1' ) );
121 elseif ( empty($pass2) )
122 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter your password twice.' ), array( 'form-field' => 'pass2' ) );
125 /* Check for "\" in password */
126 if ( false !== strpos( stripslashes($pass1), "\\" ) )
127 $errors->add( 'pass', __( '<strong>ERROR</strong>: Passwords may not contain the character "\\".' ), array( 'form-field' => 'pass1' ) );
129 /* checking the password has been typed twice the same */
130 if ( $pass1 != $pass2 )
131 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter the same password in the two password fields.' ), array( 'form-field' => 'pass1' ) );
133 if ( !empty( $pass1 ) )
134 $user->user_pass = $pass1;
136 if ( !$update && isset( $_POST['user_login'] ) && !validate_username( $_POST['user_login'] ) )
137 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ));
139 if ( !$update && username_exists( $user->user_login ) )
140 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ));
142 /* checking e-mail address */
143 if ( empty( $user->user_email ) ) {
144 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please enter an e-mail address.' ), array( 'form-field' => 'email' ) );
145 } elseif ( !is_email( $user->user_email ) ) {
146 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The e-mail address isn’t correct.' ), array( 'form-field' => 'email' ) );
147 } elseif ( ( $owner_id = email_exists($user->user_email) ) && ( !$update || ( $owner_id != $user->ID ) ) ) {
148 $errors->add( 'email_exists', __('<strong>ERROR</strong>: This email is already registered, please choose another one.'), array( 'form-field' => 'email' ) );
151 // Allow plugins to return their own errors.
152 do_action_ref_array('user_profile_update_errors', array ( &$errors, $update, &$user ) );
154 if ( $errors->get_error_codes() )
158 $user_id = wp_update_user( get_object_vars( $user ) );
160 $user_id = wp_insert_user( get_object_vars( $user ) );
161 wp_new_user_notification( $user_id, isset($_POST['send_password']) ? $pass1 : '' );
167 * Fetch a filtered list of user roles that the current user is
170 * Simple function who's main purpose is to allow filtering of the
171 * list of roles in the $wp_roles object so that plugins can remove
172 * inappropriate ones depending on the situation or user making edits.
173 * Specifically because without filtering anyone with the edit_users
174 * capability can edit others to be administrators, even if they are
175 * only editors or authors. This filter allows admins to delegate
182 function get_editable_roles() {
185 $all_roles = $wp_roles->roles;
186 $editable_roles = apply_filters('editable_roles', $all_roles);
188 return $editable_roles;
192 * Retrieve user data and filter it.
196 * @param int $user_id User ID.
197 * @return object WP_User object with user data.
199 function get_user_to_edit( $user_id ) {
200 $user = new WP_User( $user_id );
202 $user->filter = 'edit';
208 * Retrieve the user's drafts.
212 * @param int $user_id User ID.
215 function get_users_drafts( $user_id ) {
217 $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);
218 $query = apply_filters('get_users_drafts', $query);
219 return $wpdb->get_results( $query );
223 * Remove user and optionally reassign posts and links to another user.
225 * If the $reassign parameter is not assigned to an User ID, then all posts will
226 * be deleted of that user. The action 'delete_user' that is passed the User ID
227 * being deleted will be run after the posts are either reassigned or deleted.
228 * The user meta will also be deleted that are for that User ID.
232 * @param int $id User ID.
233 * @param int $reassign Optional. Reassign posts and links to new User ID.
234 * @return bool True when finished.
236 function wp_delete_user( $id, $reassign = 'novalue' ) {
240 $user = new WP_User( $id );
242 // allow for transaction statement
243 do_action('delete_user', $id);
245 if ( 'novalue' === $reassign || null === $reassign ) {
246 $post_types_to_delete = array();
247 foreach ( get_post_types( array(), 'objects' ) as $post_type ) {
248 if ( $post_type->delete_with_user ) {
249 $post_types_to_delete[] = $post_type->name;
250 } elseif ( null === $post_type->delete_with_user && post_type_supports( $post_type->name, 'author' ) ) {
251 $post_types_to_delete[] = $post_type->name;
255 $post_types_to_delete = apply_filters( 'post_types_to_delete_with_user', $post_types_to_delete, $id );
256 $post_types_to_delete = implode( "', '", $post_types_to_delete );
257 $post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d AND post_type IN ('$post_types_to_delete')", $id ) );
259 foreach ( $post_ids as $post_id )
260 wp_delete_post( $post_id );
264 $link_ids = $wpdb->get_col( $wpdb->prepare("SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id) );
267 foreach ( $link_ids as $link_id )
268 wp_delete_link($link_id);
271 $reassign = (int) $reassign;
272 $wpdb->update( $wpdb->posts, array('post_author' => $reassign), array('post_author' => $id) );
273 $wpdb->update( $wpdb->links, array('link_owner' => $reassign), array('link_owner' => $id) );
276 // FINALLY, delete user
277 if ( is_multisite() ) {
278 remove_user_from_blog( $id, get_current_blog_id() );
280 $meta = $wpdb->get_col( $wpdb->prepare( "SELECT umeta_id FROM $wpdb->usermeta WHERE user_id = %d", $id ) );
281 foreach ( $meta as $mid )
282 delete_metadata_by_mid( 'user', $mid );
284 $wpdb->delete( $wpdb->users, array( 'ID' => $id ) );
287 clean_user_cache( $user );
289 // allow for commit transaction
290 do_action('deleted_user', $id);
296 * Remove all capabilities from user.
300 * @param int $id User ID.
302 function wp_revoke_user($id) {
305 $user = new WP_User($id);
306 $user->remove_all_caps();
309 add_action('admin_init', 'default_password_nag_handler');
313 function default_password_nag_handler($errors = false) {
315 if ( ! get_user_option('default_password_nag') ) //Short circuit it.
318 //get_user_setting = JS saved UI setting. else no-js-fallback code.
319 if ( 'hide' == get_user_setting('default_password_nag') || isset($_GET['default_password_nag']) && '0' == $_GET['default_password_nag'] ) {
320 delete_user_setting('default_password_nag');
321 update_user_option($user_ID, 'default_password_nag', false, true);
325 add_action('profile_update', 'default_password_nag_edit_user', 10, 2);
329 function default_password_nag_edit_user($user_ID, $old_data) {
330 if ( ! get_user_option('default_password_nag', $user_ID) ) //Short circuit it.
333 $new_data = get_userdata($user_ID);
335 if ( $new_data->user_pass != $old_data->user_pass ) { //Remove the nag if the password has been changed.
336 delete_user_setting('default_password_nag', $user_ID);
337 update_user_option($user_ID, 'default_password_nag', false, true);
341 add_action('admin_notices', 'default_password_nag');
345 function default_password_nag() {
347 if ( 'profile.php' == $pagenow || ! get_user_option('default_password_nag') ) //Short circuit it.
350 echo '<div class="error default-password-nag">';
352 echo '<strong>' . __('Notice:') . '</strong> ';
353 _e('You’re using the auto-generated password for your account. Would you like to change it to something easier to remember?');
355 printf( '<a href="%s">' . __('Yes, take me to my profile page') . '</a> | ', admin_url('profile.php') . '#password' );
356 printf( '<a href="%s" id="default-password-nag-no">' . __('No thanks, do not remind me again') . '</a>', '?default_password_nag=0' );