3 * WordPress user administration API.
6 * @subpackage Administration
10 * Creates a new user from the "Users" form using $_POST information.
14 * @return int|WP_Error WP_Error or User ID.
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|WP_Error user id of the updated user
30 function edit_user( $user_id = 0 ) {
31 $wp_roles = wp_roles();
35 $user->ID = (int) $user_id;
36 $userdata = get_userdata( $user_id );
37 $user->user_login = wp_slash( $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( wp_unslash( $_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 $protocols = implode( '|', array_map( 'preg_quote', wp_allowed_protocols() ) );
73 $user->user_url = preg_match('/^(' . $protocols . '):/is', $user->user_url) ? $user->user_url : 'http://'.$user->user_url;
76 if ( isset( $_POST['first_name'] ) )
77 $user->first_name = sanitize_text_field( $_POST['first_name'] );
78 if ( isset( $_POST['last_name'] ) )
79 $user->last_name = sanitize_text_field( $_POST['last_name'] );
80 if ( isset( $_POST['nickname'] ) )
81 $user->nickname = sanitize_text_field( $_POST['nickname'] );
82 if ( isset( $_POST['display_name'] ) )
83 $user->display_name = sanitize_text_field( $_POST['display_name'] );
85 if ( isset( $_POST['description'] ) )
86 $user->description = trim( $_POST['description'] );
88 foreach ( wp_get_user_contact_methods( $user ) as $method => $name ) {
89 if ( isset( $_POST[$method] ))
90 $user->$method = sanitize_text_field( $_POST[$method] );
94 $user->rich_editing = isset( $_POST['rich_editing'] ) && 'false' == $_POST['rich_editing'] ? 'false' : 'true';
95 $user->admin_color = isset( $_POST['admin_color'] ) ? sanitize_text_field( $_POST['admin_color'] ) : 'fresh';
96 $user->show_admin_bar_front = isset( $_POST['admin_bar_front'] ) ? 'true' : 'false';
99 $user->comment_shortcuts = isset( $_POST['comment_shortcuts'] ) && 'true' == $_POST['comment_shortcuts'] ? 'true' : '';
102 if ( !empty($_POST['use_ssl']) )
105 $errors = new WP_Error();
107 /* checking that username has been typed */
108 if ( $user->user_login == '' )
109 $errors->add( 'user_login', __( '<strong>ERROR</strong>: Please enter a username.' ) );
111 /* checking that nickname has been typed */
112 if ( $update && empty( $user->nickname ) ) {
113 $errors->add( 'nickname', __( '<strong>ERROR</strong>: Please enter a nickname.' ) );
116 /* checking the password has been typed twice */
118 * Fires before the password and confirm password fields are checked for congruity.
122 * @param string $user_login The username.
123 * @param string &$pass1 The password, passed by reference.
124 * @param string &$pass2 The confirmed password, passed by reference.
126 do_action_ref_array( 'check_passwords', array( $user->user_login, &$pass1, &$pass2 ) );
128 /* Check for "\" in password */
129 if ( false !== strpos( wp_unslash( $pass1 ), "\\" ) )
130 $errors->add( 'pass', __( '<strong>ERROR</strong>: Passwords may not contain the character "\\".' ), array( 'form-field' => 'pass1' ) );
132 /* checking the password has been typed twice the same */
133 if ( $pass1 != $pass2 )
134 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter the same password in both password fields.' ), array( 'form-field' => 'pass1' ) );
136 if ( !empty( $pass1 ) )
137 $user->user_pass = $pass1;
139 if ( !$update && isset( $_POST['user_login'] ) && !validate_username( $_POST['user_login'] ) )
140 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ));
142 if ( !$update && username_exists( $user->user_login ) )
143 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ));
145 /** This filter is documented in wp-includes/user.php */
146 $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
148 if ( in_array( strtolower( $user->user_login ), array_map( 'strtolower', $illegal_logins ) ) ) {
149 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
152 /* checking email address */
153 if ( empty( $user->user_email ) ) {
154 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please enter an email address.' ), array( 'form-field' => 'email' ) );
155 } elseif ( !is_email( $user->user_email ) ) {
156 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn’t correct.' ), array( 'form-field' => 'email' ) );
157 } elseif ( ( $owner_id = email_exists($user->user_email) ) && ( !$update || ( $owner_id != $user->ID ) ) ) {
158 $errors->add( 'email_exists', __('<strong>ERROR</strong>: This email is already registered, please choose another one.'), array( 'form-field' => 'email' ) );
162 * Fires before user profile update errors are returned.
166 * @param WP_Error &$errors WP_Error object, passed by reference.
167 * @param bool $update Whether this is a user update.
168 * @param WP_User &$user WP_User object, passed by reference.
170 do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );
172 if ( $errors->get_error_codes() )
176 $user_id = wp_update_user( $user );
178 $user_id = wp_insert_user( $user );
179 $notify = isset( $_POST['send_user_notification'] ) ? 'both' : 'admin';
182 * Fires after a new user has been created.
186 * @param int $user_id ID of the newly created user.
187 * @param string $notify Type of notification that should happen. See {@see wp_send_new_user_notifications()}
188 * for more information on possible values.
190 do_action( 'edit_user_created_user', $user_id, $notify );
196 * Fetch a filtered list of user roles that the current user is
199 * Simple function who's main purpose is to allow filtering of the
200 * list of roles in the $wp_roles object so that plugins can remove
201 * inappropriate ones depending on the situation or user making edits.
202 * Specifically because without filtering anyone with the edit_users
203 * capability can edit others to be administrators, even if they are
204 * only editors or authors. This filter allows admins to delegate
211 function get_editable_roles() {
212 $all_roles = wp_roles()->roles;
215 * Filter the list of editable roles.
219 * @param array $all_roles List of roles.
221 $editable_roles = apply_filters( 'editable_roles', $all_roles );
223 return $editable_roles;
227 * Retrieve user data and filter it.
231 * @param int $user_id User ID.
232 * @return WP_User|bool WP_User object on success, false on failure.
234 function get_user_to_edit( $user_id ) {
235 $user = get_userdata( $user_id );
238 $user->filter = 'edit';
244 * Retrieve the user's drafts.
248 * @global wpdb $wpdb WordPress database abstraction object.
250 * @param int $user_id User ID.
253 function get_users_drafts( $user_id ) {
255 $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);
258 * Filter the user's drafts query string.
262 * @param string $query The user's drafts query string.
264 $query = apply_filters( 'get_users_drafts', $query );
265 return $wpdb->get_results( $query );
269 * Remove user and optionally reassign posts and links to another user.
271 * If the $reassign parameter is not assigned to a User ID, then all posts will
272 * be deleted of that user. The action 'delete_user' that is passed the User ID
273 * being deleted will be run after the posts are either reassigned or deleted.
274 * The user meta will also be deleted that are for that User ID.
278 * @global wpdb $wpdb WordPress database abstraction object.
280 * @param int $id User ID.
281 * @param int $reassign Optional. Reassign posts and links to new User ID.
282 * @return bool True when finished.
284 function wp_delete_user( $id, $reassign = null ) {
287 if ( ! is_numeric( $id ) ) {
292 $user = new WP_User( $id );
294 if ( !$user->exists() )
297 // Normalize $reassign to null or a user ID. 'novalue' was an older default.
298 if ( 'novalue' === $reassign ) {
300 } elseif ( null !== $reassign ) {
301 $reassign = (int) $reassign;
305 * Fires immediately before a user is deleted from the database.
309 * @param int $id ID of the user to delete.
310 * @param int|null $reassign ID of the user to reassign posts and links to.
311 * Default null, for no reassignment.
313 do_action( 'delete_user', $id, $reassign );
315 if ( null === $reassign ) {
316 $post_types_to_delete = array();
317 foreach ( get_post_types( array(), 'objects' ) as $post_type ) {
318 if ( $post_type->delete_with_user ) {
319 $post_types_to_delete[] = $post_type->name;
320 } elseif ( null === $post_type->delete_with_user && post_type_supports( $post_type->name, 'author' ) ) {
321 $post_types_to_delete[] = $post_type->name;
326 * Filter the list of post types to delete with a user.
330 * @param array $post_types_to_delete Post types to delete.
331 * @param int $id User ID.
333 $post_types_to_delete = apply_filters( 'post_types_to_delete_with_user', $post_types_to_delete, $id );
334 $post_types_to_delete = implode( "', '", $post_types_to_delete );
335 $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 ) );
337 foreach ( $post_ids as $post_id )
338 wp_delete_post( $post_id );
342 $link_ids = $wpdb->get_col( $wpdb->prepare("SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id) );
345 foreach ( $link_ids as $link_id )
346 wp_delete_link($link_id);
349 $post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d", $id ) );
350 $wpdb->update( $wpdb->posts, array('post_author' => $reassign), array('post_author' => $id) );
351 if ( ! empty( $post_ids ) ) {
352 foreach ( $post_ids as $post_id )
353 clean_post_cache( $post_id );
355 $link_ids = $wpdb->get_col( $wpdb->prepare("SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id) );
356 $wpdb->update( $wpdb->links, array('link_owner' => $reassign), array('link_owner' => $id) );
357 if ( ! empty( $link_ids ) ) {
358 foreach ( $link_ids as $link_id )
359 clean_bookmark_cache( $link_id );
363 // FINALLY, delete user
364 if ( is_multisite() ) {
365 remove_user_from_blog( $id, get_current_blog_id() );
367 $meta = $wpdb->get_col( $wpdb->prepare( "SELECT umeta_id FROM $wpdb->usermeta WHERE user_id = %d", $id ) );
368 foreach ( $meta as $mid )
369 delete_metadata_by_mid( 'user', $mid );
371 $wpdb->delete( $wpdb->users, array( 'ID' => $id ) );
374 clean_user_cache( $user );
377 * Fires immediately after a user is deleted from the database.
381 * @param int $id ID of the deleted user.
382 * @param int|null $reassign ID of the user to reassign posts and links to.
383 * Default null, for no reassignment.
385 do_action( 'deleted_user', $id, $reassign );
391 * Remove all capabilities from user.
395 * @param int $id User ID.
397 function wp_revoke_user($id) {
400 $user = new WP_User($id);
401 $user->remove_all_caps();
407 * @global int $user_ID
409 * @param false $errors Deprecated.
411 function default_password_nag_handler($errors = false) {
414 if ( ! get_user_option('default_password_nag') )
417 // get_user_setting = JS saved UI setting. else no-js-fallback code.
418 if ( 'hide' == get_user_setting('default_password_nag') || isset($_GET['default_password_nag']) && '0' == $_GET['default_password_nag'] ) {
419 delete_user_setting('default_password_nag');
420 update_user_option($user_ID, 'default_password_nag', false, true);
427 * @param int $user_ID
428 * @param object $old_data
430 function default_password_nag_edit_user($user_ID, $old_data) {
432 if ( ! get_user_option('default_password_nag', $user_ID) )
435 $new_data = get_userdata($user_ID);
437 // Remove the nag if the password has been changed.
438 if ( $new_data->user_pass != $old_data->user_pass ) {
439 delete_user_setting('default_password_nag');
440 update_user_option($user_ID, 'default_password_nag', false, true);
447 * @global string $pagenow
449 function default_password_nag() {
452 if ( 'profile.php' == $pagenow || ! get_user_option('default_password_nag') )
455 echo '<div class="error default-password-nag">';
457 echo '<strong>' . __('Notice:') . '</strong> ';
458 _e('You’re using the auto-generated password for your account. Would you like to change it?');
460 printf( '<a href="%s">' . __('Yes, take me to my profile page') . '</a> | ', get_edit_profile_url() . '#password' );
461 printf( '<a href="%s" id="default-password-nag-no">' . __('No thanks, do not remind me again') . '</a>', '?default_password_nag=0' );
469 function delete_users_add_js() { ?>
471 jQuery(document).ready( function($) {
472 var submit = $('#submit').prop('disabled', true);
473 $('input[name="delete_option"]').one('change', function() {
474 submit.prop('disabled', false);
476 $('#reassign_user').focus( function() {
477 $('#delete_option1').prop('checked', true).trigger('change');
485 * Optional SSL preference that can be turned on by hooking to the 'personal_options' action.
489 * @param object $user User data object
491 function use_ssl_preference($user) {
493 <tr class="user-use-ssl-wrap">
494 <th scope="row"><?php _e('Use https')?></th>
495 <td><label for="use_ssl"><input name="use_ssl" type="checkbox" id="use_ssl" value="1" <?php checked('1', $user->use_ssl); ?> /> <?php _e('Always use https when visiting the admin'); ?></label></td>
502 * @param string $text
505 function admin_created_user_email( $text ) {
506 $roles = get_editable_roles();
507 $role = $roles[ $_REQUEST['role'] ];
508 /* translators: 1: Site name, 2: site URL, 3: role */
509 return sprintf( __( 'Hi,
510 You\'ve been invited to join \'%1$s\' at
511 %2$s with the role of %3$s.
512 If you do not want to join this site please ignore
513 this email. This invitation will expire in a few days.
515 Please click the following link to activate your user account:
516 %%s' ), get_bloginfo( 'name' ), home_url(), wp_specialchars_decode( translate_user_role( $role['name'] ) ) );