WordPress 4.5
[autoinstalls/wordpress.git] / wp-admin / includes / user.php
1 <?php
2 /**
3  * WordPress user administration API.
4  *
5  * @package WordPress
6  * @subpackage Administration
7  */
8
9 /**
10  * Creates a new user from the "Users" form using $_POST information.
11  *
12  * @since 2.0.0
13  *
14  * @return int|WP_Error WP_Error or User ID.
15  */
16 function add_user() {
17         return edit_user();
18 }
19
20 /**
21  * Edit user settings based on contents of $_POST
22  *
23  * Used on user-edit.php and profile.php to manage and process user options, passwords etc.
24  *
25  * @since 2.0.0
26  *
27  * @param int $user_id Optional. User ID.
28  * @return int|WP_Error user id of the updated user
29  */
30 function edit_user( $user_id = 0 ) {
31         $wp_roles = wp_roles();
32         $user = new stdClass;
33         if ( $user_id ) {
34                 $update = true;
35                 $user->ID = (int) $user_id;
36                 $userdata = get_userdata( $user_id );
37                 $user->user_login = wp_slash( $userdata->user_login );
38         } else {
39                 $update = false;
40         }
41
42         if ( !$update && isset( $_POST['user_login'] ) )
43                 $user->user_login = sanitize_user($_POST['user_login'], true);
44
45         $pass1 = $pass2 = '';
46         if ( isset( $_POST['pass1'] ) )
47                 $pass1 = $_POST['pass1'];
48         if ( isset( $_POST['pass2'] ) )
49                 $pass2 = $_POST['pass2'];
50
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;
58
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&#8217;t give users that role.'));
63         }
64
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://' ) {
69                         $user->user_url = '';
70                 } else {
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;
74                 }
75         }
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'] );
84
85         if ( isset( $_POST['description'] ) )
86                 $user->description = trim( $_POST['description'] );
87
88         foreach ( wp_get_user_contact_methods( $user ) as $method => $name ) {
89                 if ( isset( $_POST[$method] ))
90                         $user->$method = sanitize_text_field( $_POST[$method] );
91         }
92
93         if ( $update ) {
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';
97         }
98
99         $user->comment_shortcuts = isset( $_POST['comment_shortcuts'] ) && 'true' == $_POST['comment_shortcuts'] ? 'true' : '';
100
101         $user->use_ssl = 0;
102         if ( !empty($_POST['use_ssl']) )
103                 $user->use_ssl = 1;
104
105         $errors = new WP_Error();
106
107         /* checking that username has been typed */
108         if ( $user->user_login == '' )
109                 $errors->add( 'user_login', __( '<strong>ERROR</strong>: Please enter a username.' ) );
110
111         /* checking that nickname has been typed */
112         if ( $update && empty( $user->nickname ) ) {
113                 $errors->add( 'nickname', __( '<strong>ERROR</strong>: Please enter a nickname.' ) );
114         }
115
116         /**
117          * Fires before the password and confirm password fields are checked for congruity.
118          *
119          * @since 1.5.1
120          *
121          * @param string $user_login The username.
122          * @param string &$pass1     The password, passed by reference.
123          * @param string &$pass2     The confirmed password, passed by reference.
124          */
125         do_action_ref_array( 'check_passwords', array( $user->user_login, &$pass1, &$pass2 ) );
126
127         // Check for blank password when adding a user.
128         if ( ! $update && empty( $pass1 ) ) {
129                 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter a password.' ), array( 'form-field' => 'pass1' ) );
130         }
131
132         // Check for "\" in password.
133         if ( false !== strpos( wp_unslash( $pass1 ), "\\" ) ) {
134                 $errors->add( 'pass', __( '<strong>ERROR</strong>: Passwords may not contain the character "\\".' ), array( 'form-field' => 'pass1' ) );
135         }
136
137         // Checking the password has been typed twice the same.
138         if ( ( $update || ! empty( $pass1 ) ) && $pass1 != $pass2 ) {
139                 $errors->add( 'pass', __( '<strong>ERROR</strong>: Please enter the same password in both password fields.' ), array( 'form-field' => 'pass1' ) );
140         }
141
142         if ( !empty( $pass1 ) )
143                 $user->user_pass = $pass1;
144
145         if ( !$update && isset( $_POST['user_login'] ) && !validate_username( $_POST['user_login'] ) )
146                 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is invalid because it uses illegal characters. Please enter a valid username.' ));
147
148         if ( !$update && username_exists( $user->user_login ) )
149                 $errors->add( 'user_login', __( '<strong>ERROR</strong>: This username is already registered. Please choose another one.' ));
150
151         /** This filter is documented in wp-includes/user.php */
152         $illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );
153
154         if ( in_array( strtolower( $user->user_login ), array_map( 'strtolower', $illegal_logins ) ) ) {
155                 $errors->add( 'invalid_username', __( '<strong>ERROR</strong>: Sorry, that username is not allowed.' ) );
156         }
157
158         /* checking email address */
159         if ( empty( $user->user_email ) ) {
160                 $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please enter an email address.' ), array( 'form-field' => 'email' ) );
161         } elseif ( !is_email( $user->user_email ) ) {
162                 $errors->add( 'invalid_email', __( '<strong>ERROR</strong>: The email address isn&#8217;t correct.' ), array( 'form-field' => 'email' ) );
163         } elseif ( ( $owner_id = email_exists($user->user_email) ) && ( !$update || ( $owner_id != $user->ID ) ) ) {
164                 $errors->add( 'email_exists', __('<strong>ERROR</strong>: This email is already registered, please choose another one.'), array( 'form-field' => 'email' ) );
165         }
166
167         /**
168          * Fires before user profile update errors are returned.
169          *
170          * @since 2.8.0
171          *
172          * @param WP_Error &$errors WP_Error object, passed by reference.
173          * @param bool     $update  Whether this is a user update.
174          * @param WP_User  &$user   WP_User object, passed by reference.
175          */
176         do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );
177
178         if ( $errors->get_error_codes() )
179                 return $errors;
180
181         if ( $update ) {
182                 $user_id = wp_update_user( $user );
183         } else {
184                 $user_id = wp_insert_user( $user );
185                 $notify  = isset( $_POST['send_user_notification'] ) ? 'both' : 'admin';
186
187                 /**
188                   * Fires after a new user has been created.
189                   *
190                   * @since 4.4.0
191                   *
192                   * @param int    $user_id ID of the newly created user.
193                   * @param string $notify  Type of notification that should happen. See {@see wp_send_new_user_notifications()}
194                   *                        for more information on possible values.
195                   */
196                 do_action( 'edit_user_created_user', $user_id, $notify );
197         }
198         return $user_id;
199 }
200
201 /**
202  * Fetch a filtered list of user roles that the current user is
203  * allowed to edit.
204  *
205  * Simple function who's main purpose is to allow filtering of the
206  * list of roles in the $wp_roles object so that plugins can remove
207  * inappropriate ones depending on the situation or user making edits.
208  * Specifically because without filtering anyone with the edit_users
209  * capability can edit others to be administrators, even if they are
210  * only editors or authors. This filter allows admins to delegate
211  * user management.
212  *
213  * @since 2.8.0
214  *
215  * @return array
216  */
217 function get_editable_roles() {
218         $all_roles = wp_roles()->roles;
219
220         /**
221          * Filter the list of editable roles.
222          *
223          * @since 2.8.0
224          *
225          * @param array $all_roles List of roles.
226          */
227         $editable_roles = apply_filters( 'editable_roles', $all_roles );
228
229         return $editable_roles;
230 }
231
232 /**
233  * Retrieve user data and filter it.
234  *
235  * @since 2.0.5
236  *
237  * @param int $user_id User ID.
238  * @return WP_User|bool WP_User object on success, false on failure.
239  */
240 function get_user_to_edit( $user_id ) {
241         $user = get_userdata( $user_id );
242
243         if ( $user )
244                 $user->filter = 'edit';
245
246         return $user;
247 }
248
249 /**
250  * Retrieve the user's drafts.
251  *
252  * @since 2.0.0
253  *
254  * @global wpdb $wpdb WordPress database abstraction object.
255  *
256  * @param int $user_id User ID.
257  * @return array
258  */
259 function get_users_drafts( $user_id ) {
260         global $wpdb;
261         $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);
262
263         /**
264          * Filter the user's drafts query string.
265          *
266          * @since 2.0.0
267          *
268          * @param string $query The user's drafts query string.
269          */
270         $query = apply_filters( 'get_users_drafts', $query );
271         return $wpdb->get_results( $query );
272 }
273
274 /**
275  * Remove user and optionally reassign posts and links to another user.
276  *
277  * If the $reassign parameter is not assigned to a User ID, then all posts will
278  * be deleted of that user. The action 'delete_user' that is passed the User ID
279  * being deleted will be run after the posts are either reassigned or deleted.
280  * The user meta will also be deleted that are for that User ID.
281  *
282  * @since 2.0.0
283  *
284  * @global wpdb $wpdb WordPress database abstraction object.
285  *
286  * @param int $id User ID.
287  * @param int $reassign Optional. Reassign posts and links to new User ID.
288  * @return bool True when finished.
289  */
290 function wp_delete_user( $id, $reassign = null ) {
291         global $wpdb;
292
293         if ( ! is_numeric( $id ) ) {
294                 return false;
295         }
296
297         $id = (int) $id;
298         $user = new WP_User( $id );
299
300         if ( !$user->exists() )
301                 return false;
302
303         // Normalize $reassign to null or a user ID. 'novalue' was an older default.
304         if ( 'novalue' === $reassign ) {
305                 $reassign = null;
306         } elseif ( null !== $reassign ) {
307                 $reassign = (int) $reassign;
308         }
309
310         /**
311          * Fires immediately before a user is deleted from the database.
312          *
313          * @since 2.0.0
314          *
315          * @param int      $id       ID of the user to delete.
316          * @param int|null $reassign ID of the user to reassign posts and links to.
317          *                           Default null, for no reassignment.
318          */
319         do_action( 'delete_user', $id, $reassign );
320
321         if ( null === $reassign ) {
322                 $post_types_to_delete = array();
323                 foreach ( get_post_types( array(), 'objects' ) as $post_type ) {
324                         if ( $post_type->delete_with_user ) {
325                                 $post_types_to_delete[] = $post_type->name;
326                         } elseif ( null === $post_type->delete_with_user && post_type_supports( $post_type->name, 'author' ) ) {
327                                 $post_types_to_delete[] = $post_type->name;
328                         }
329                 }
330
331                 /**
332                  * Filter the list of post types to delete with a user.
333                  *
334                  * @since 3.4.0
335                  *
336                  * @param array $post_types_to_delete Post types to delete.
337                  * @param int   $id                   User ID.
338                  */
339                 $post_types_to_delete = apply_filters( 'post_types_to_delete_with_user', $post_types_to_delete, $id );
340                 $post_types_to_delete = implode( "', '", $post_types_to_delete );
341                 $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 ) );
342                 if ( $post_ids ) {
343                         foreach ( $post_ids as $post_id )
344                                 wp_delete_post( $post_id );
345                 }
346
347                 // Clean links
348                 $link_ids = $wpdb->get_col( $wpdb->prepare("SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id) );
349
350                 if ( $link_ids ) {
351                         foreach ( $link_ids as $link_id )
352                                 wp_delete_link($link_id);
353                 }
354         } else {
355                 $post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d", $id ) );
356                 $wpdb->update( $wpdb->posts, array('post_author' => $reassign), array('post_author' => $id) );
357                 if ( ! empty( $post_ids ) ) {
358                         foreach ( $post_ids as $post_id )
359                                 clean_post_cache( $post_id );
360                 }
361                 $link_ids = $wpdb->get_col( $wpdb->prepare("SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id) );
362                 $wpdb->update( $wpdb->links, array('link_owner' => $reassign), array('link_owner' => $id) );
363                 if ( ! empty( $link_ids ) ) {
364                         foreach ( $link_ids as $link_id )
365                                 clean_bookmark_cache( $link_id );
366                 }
367         }
368
369         // FINALLY, delete user
370         if ( is_multisite() ) {
371                 remove_user_from_blog( $id, get_current_blog_id() );
372         } else {
373                 $meta = $wpdb->get_col( $wpdb->prepare( "SELECT umeta_id FROM $wpdb->usermeta WHERE user_id = %d", $id ) );
374                 foreach ( $meta as $mid )
375                         delete_metadata_by_mid( 'user', $mid );
376
377                 $wpdb->delete( $wpdb->users, array( 'ID' => $id ) );
378         }
379
380         clean_user_cache( $user );
381
382         /**
383          * Fires immediately after a user is deleted from the database.
384          *
385          * @since 2.9.0
386          *
387          * @param int      $id       ID of the deleted user.
388          * @param int|null $reassign ID of the user to reassign posts and links to.
389          *                           Default null, for no reassignment.
390          */
391         do_action( 'deleted_user', $id, $reassign );
392
393         return true;
394 }
395
396 /**
397  * Remove all capabilities from user.
398  *
399  * @since 2.1.0
400  *
401  * @param int $id User ID.
402  */
403 function wp_revoke_user($id) {
404         $id = (int) $id;
405
406         $user = new WP_User($id);
407         $user->remove_all_caps();
408 }
409
410 /**
411  * @since 2.8.0
412  *
413  * @global int $user_ID
414  *
415  * @param false $errors Deprecated.
416  */
417 function default_password_nag_handler($errors = false) {
418         global $user_ID;
419         // Short-circuit it.
420         if ( ! get_user_option('default_password_nag') )
421                 return;
422
423         // get_user_setting = JS saved UI setting. else no-js-fallback code.
424         if ( 'hide' == get_user_setting('default_password_nag') || isset($_GET['default_password_nag']) && '0' == $_GET['default_password_nag'] ) {
425                 delete_user_setting('default_password_nag');
426                 update_user_option($user_ID, 'default_password_nag', false, true);
427         }
428 }
429
430 /**
431  * @since 2.8.0
432  *
433  * @param int    $user_ID
434  * @param object $old_data
435  */
436 function default_password_nag_edit_user($user_ID, $old_data) {
437         // Short-circuit it.
438         if ( ! get_user_option('default_password_nag', $user_ID) )
439                 return;
440
441         $new_data = get_userdata($user_ID);
442
443         // Remove the nag if the password has been changed.
444         if ( $new_data->user_pass != $old_data->user_pass ) {
445                 delete_user_setting('default_password_nag');
446                 update_user_option($user_ID, 'default_password_nag', false, true);
447         }
448 }
449
450 /**
451  * @since 2.8.0
452  *
453  * @global string $pagenow
454  */
455 function default_password_nag() {
456         global $pagenow;
457         // Short-circuit it.
458         if ( 'profile.php' == $pagenow || ! get_user_option('default_password_nag') )
459                 return;
460
461         echo '<div class="error default-password-nag">';
462         echo '<p>';
463         echo '<strong>' . __('Notice:') . '</strong> ';
464         _e('You&rsquo;re using the auto-generated password for your account. Would you like to change it?');
465         echo '</p><p>';
466         printf( '<a href="%s">' . __('Yes, take me to my profile page') . '</a> | ', get_edit_profile_url() . '#password' );
467         printf( '<a href="%s" id="default-password-nag-no">' . __('No thanks, do not remind me again') . '</a>', '?default_password_nag=0' );
468         echo '</p></div>';
469 }
470
471 /**
472  * @since 3.5.0
473  * @access private
474  */
475 function delete_users_add_js() { ?>
476 <script>
477 jQuery(document).ready( function($) {
478         var submit = $('#submit').prop('disabled', true);
479         $('input[name="delete_option"]').one('change', function() {
480                 submit.prop('disabled', false);
481         });
482         $('#reassign_user').focus( function() {
483                 $('#delete_option1').prop('checked', true).trigger('change');
484         });
485 });
486 </script>
487 <?php
488 }
489
490 /**
491  * Optional SSL preference that can be turned on by hooking to the 'personal_options' action.
492  *
493  * @since 2.7.0
494  *
495  * @param object $user User data object
496  */
497 function use_ssl_preference($user) {
498 ?>
499         <tr class="user-use-ssl-wrap">
500                 <th scope="row"><?php _e('Use https')?></th>
501                 <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         </tr>
503 <?php
504 }
505
506 /**
507  *
508  * @param string $text
509  * @return string
510  */
511 function admin_created_user_email( $text ) {
512         $roles = get_editable_roles();
513         $role = $roles[ $_REQUEST['role'] ];
514         /* translators: 1: Site name, 2: site URL, 3: role */
515         return sprintf( __( 'Hi,
516 You\'ve been invited to join \'%1$s\' at
517 %2$s with the role of %3$s.
518 If you do not want to join this site please ignore
519 this email. This invitation will expire in a few days.
520
521 Please click the following link to activate your user account:
522 %%s' ), get_bloginfo( 'name' ), home_url(), wp_specialchars_decode( translate_user_role( $role['name'] ) ) );
523 }