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
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 != get_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 $wp_roles, $wpdb;
61 $user->ID = (int) $user_id;
62 $userdata = get_userdata( $user_id );
63 $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 != get_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( $user ) 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';
121 $user->show_admin_bar_front = isset( $_POST['admin_bar_front'] ) ? 'true' : 'false';
124 $user->comment_shortcuts = isset( $_POST['comment_shortcuts'] ) && 'true' == $_POST['comment_shortcuts'] ? 'true' : '';
127 if ( !empty($_POST['use_ssl']) )
130 $errors = new WP_Error();
132 /* checking that username has been typed */
133 if ( $user->user_login == '' )
134 $errors->add( 'user_login', __( '<strong>ERROR</strong>: Please enter a username.' ));
136 /* checking the password has been typed twice */
137 do_action_ref_array( 'check_passwords', array ( $user->user_login, & $pass1, & $pass2 ));
140 if ( empty($pass1) && !empty($pass2) )
141 $errors->add( 'pass', __( '<strong>ERROR</strong>: You entered your new password only once.' ), array( 'form-field' => 'pass1' ) );
142 elseif ( !empty($pass1) && empty($pass2) )
143 $errors->add( 'pass', __( '<strong>ERROR</strong>: You entered your new password only once.' ), array( 'form-field' => 'pass2' ) );
146 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter your password.' ), array( 'form-field' => 'pass1' ) );
147 elseif ( empty($pass2) )
148 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter your password twice.' ), array( 'form-field' => 'pass2' ) );
151 /* Check for "\" in password */
152 if ( false !== strpos( stripslashes($pass1), "\\" ) )
153 $errors->add( 'pass', __( '<strong>ERROR</strong>: Passwords may not contain the character "\\".' ), array( 'form-field' => 'pass1' ) );
155 /* checking the password has been typed twice the same */
156 if ( $pass1 != $pass2 )
157 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter the same password in the two password fields.' ), array( 'form-field' => 'pass1' ) );
159 if ( !empty( $pass1 ) )
160 $user->user_pass = $pass1;
162 if ( !$update && isset( $_POST['user_login'] ) && !validate_username( $_POST['user_login'] ) )
163 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ));
165 if ( !$update && username_exists( $user->user_login ) )
166 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ));
168 /* checking e-mail address */
169 if ( empty( $user->user_email ) ) {
170 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please enter an e-mail address.' ), array( 'form-field' => 'email' ) );
171 } elseif ( !is_email( $user->user_email ) ) {
172 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The e-mail address isn’t correct.' ), array( 'form-field' => 'email' ) );
173 } elseif ( ( $owner_id = email_exists($user->user_email) ) && ( !$update || ( $owner_id != $user->ID ) ) ) {
174 $errors->add( 'email_exists', __('<strong>ERROR</strong>: This email is already registered, please choose another one.'), array( 'form-field' => 'email' ) );
177 // Allow plugins to return their own errors.
178 do_action_ref_array('user_profile_update_errors', array ( &$errors, $update, &$user ) );
180 if ( $errors->get_error_codes() )
184 $user_id = wp_update_user( get_object_vars( $user ) );
186 $user_id = wp_insert_user( get_object_vars( $user ) );
187 wp_new_user_notification( $user_id, isset($_POST['send_password']) ? $pass1 : '' );
193 * Fetch a filtered list of user roles that the current user is
196 * Simple function who's main purpose is to allow filtering of the
197 * list of roles in the $wp_roles object so that plugins can remove
198 * inappropriate ones depending on the situation or user making edits.
199 * Specifically because without filtering anyone with the edit_users
200 * capability can edit others to be administrators, even if they are
201 * only editors or authors. This filter allows admins to delegate
208 function get_editable_roles() {
211 $all_roles = $wp_roles->roles;
212 $editable_roles = apply_filters('editable_roles', $all_roles);
214 return $editable_roles;
218 * Retrieve user data and filter it.
222 * @param int $user_id User ID.
223 * @return object WP_User object with user data.
225 function get_user_to_edit( $user_id ) {
226 $user = new WP_User( $user_id );
228 $user->filter = 'edit';
234 * Retrieve the user's drafts.
238 * @param int $user_id User ID.
241 function get_users_drafts( $user_id ) {
243 $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);
244 $query = apply_filters('get_users_drafts', $query);
245 return $wpdb->get_results( $query );
249 * Remove user and optionally reassign posts and links to another user.
251 * If the $reassign parameter is not assigned to an User ID, then all posts will
252 * be deleted of that user. The action 'delete_user' that is passed the User ID
253 * being deleted will be run after the posts are either reassigned or deleted.
254 * The user meta will also be deleted that are for that User ID.
258 * @param int $id User ID.
259 * @param int $reassign Optional. Reassign posts and links to new User ID.
260 * @return bool True when finished.
262 function wp_delete_user( $id, $reassign = 'novalue' ) {
267 // allow for transaction statement
268 do_action('delete_user', $id);
270 if ( 'novalue' === $reassign || null === $reassign ) {
271 $post_ids = $wpdb->get_col( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_author = %d", $id) );
274 foreach ( $post_ids as $post_id )
275 wp_delete_post($post_id);
279 $link_ids = $wpdb->get_col( $wpdb->prepare("SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id) );
282 foreach ( $link_ids as $link_id )
283 wp_delete_link($link_id);
286 $reassign = (int) $reassign;
287 $wpdb->update( $wpdb->posts, array('post_author' => $reassign), array('post_author' => $id) );
288 $wpdb->update( $wpdb->links, array('link_owner' => $reassign), array('link_owner' => $id) );
291 clean_user_cache($id);
293 // FINALLY, delete user
294 if ( !is_multisite() ) {
295 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d", $id) );
296 $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->users WHERE ID = %d", $id) );
298 $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
299 $wpdb->query("DELETE FROM $wpdb->usermeta WHERE user_id = $id AND meta_key = '{$level_key}'");
302 // allow for commit transaction
303 do_action('deleted_user', $id);
309 * Remove all capabilities from user.
313 * @param int $id User ID.
315 function wp_revoke_user($id) {
318 $user = new WP_User($id);
319 $user->remove_all_caps();
322 add_action('admin_init', 'default_password_nag_handler');
326 function default_password_nag_handler($errors = false) {
328 if ( ! get_user_option('default_password_nag') ) //Short circuit it.
331 //get_user_setting = JS saved UI setting. else no-js-fallback code.
332 if ( 'hide' == get_user_setting('default_password_nag') || isset($_GET['default_password_nag']) && '0' == $_GET['default_password_nag'] ) {
333 delete_user_setting('default_password_nag');
334 update_user_option($user_ID, 'default_password_nag', false, true);
338 add_action('profile_update', 'default_password_nag_edit_user', 10, 2);
342 function default_password_nag_edit_user($user_ID, $old_data) {
343 if ( ! get_user_option('default_password_nag', $user_ID) ) //Short circuit it.
346 $new_data = get_userdata($user_ID);
348 if ( $new_data->user_pass != $old_data->user_pass ) { //Remove the nag if the password has been changed.
349 delete_user_setting('default_password_nag', $user_ID);
350 update_user_option($user_ID, 'default_password_nag', false, true);
354 add_action('admin_notices', 'default_password_nag');
358 function default_password_nag() {
360 if ( 'profile.php' == $pagenow || ! get_user_option('default_password_nag') ) //Short circuit it.
363 echo '<div class="error default-password-nag">';
365 echo '<strong>' . __('Notice:') . '</strong> ';
366 _e('You’re using the auto-generated password for your account. Would you like to change it to something easier to remember?');
368 printf( '<a href="%s">' . __('Yes, take me to my profile page') . '</a> | ', admin_url('profile.php') . '#password' );
369 printf( '<a href="%s" id="default-password-nag-no">' . __('No thanks, do not remind me again') . '</a>', '?default_password_nag=0' );