WordPress 4.5
[autoinstalls/wordpress.git] / wp-includes / capabilities.php
1 <?php
2 /**
3  * Core User Role & Capabilities API
4  *
5  * @package WordPress
6  * @subpackage Users
7  */
8
9 /**
10  * Map meta capabilities to primitive capabilities.
11  *
12  * This does not actually compare whether the user ID has the actual capability,
13  * just what the capability or capabilities are. Meta capability list value can
14  * be 'delete_user', 'edit_user', 'remove_user', 'promote_user', 'delete_post',
15  * 'delete_page', 'edit_post', 'edit_page', 'read_post', or 'read_page'.
16  *
17  * @since 2.0.0
18  *
19  * @global array $post_type_meta_caps Used to get post type meta capabilities.
20  *
21  * @param string $cap       Capability name.
22  * @param int    $user_id   User ID.
23  * @param int    $object_id Optional. ID of the specific object to check against if `$cap` is a "meta" cap.
24  *                          "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used
25  *                          by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts',
26  *                          'edit_others_posts', etc. The parameter is accessed via func_get_args().
27  * @return array Actual capabilities for meta capability.
28  */
29 function map_meta_cap( $cap, $user_id ) {
30         $args = array_slice( func_get_args(), 2 );
31         $caps = array();
32
33         switch ( $cap ) {
34         case 'remove_user':
35                 $caps[] = 'remove_users';
36                 break;
37         case 'promote_user':
38         case 'add_users':
39                 $caps[] = 'promote_users';
40                 break;
41         case 'edit_user':
42         case 'edit_users':
43                 // Allow user to edit itself
44                 if ( 'edit_user' == $cap && isset( $args[0] ) && $user_id == $args[0] )
45                         break;
46
47                 // In multisite the user must have manage_network_users caps. If editing a super admin, the user must be a super admin.
48                 if ( is_multisite() && ( ( ! is_super_admin( $user_id ) && 'edit_user' === $cap && is_super_admin( $args[0] ) ) || ! user_can( $user_id, 'manage_network_users' ) ) ) {
49                         $caps[] = 'do_not_allow';
50                 } else {
51                         $caps[] = 'edit_users'; // edit_user maps to edit_users.
52                 }
53                 break;
54         case 'delete_post':
55         case 'delete_page':
56                 $post = get_post( $args[0] );
57                 if ( ! $post ) {
58                         $caps[] = 'do_not_allow';
59                         break;
60                 }
61
62                 if ( 'revision' == $post->post_type ) {
63                         $post = get_post( $post->post_parent );
64                         if ( ! $post ) {
65                                 $caps[] = 'do_not_allow';
66                                 break;
67                         }
68                 }
69
70                 $post_type = get_post_type_object( $post->post_type );
71                 if ( ! $post_type ) {
72                         /* translators: 1: post type, 2: capability name */
73                         _doing_it_wrong( __FUNCTION__, sprintf( __( 'The post type %1$s is not registered, so it may not be reliable to check the capability "%2$s" against a post of that type.' ), $post->post_type, $cap ), '4.4.0' );
74                         $caps[] = 'edit_others_posts';
75                         break;
76                 }
77
78                 if ( ! $post_type->map_meta_cap ) {
79                         $caps[] = $post_type->cap->$cap;
80                         // Prior to 3.1 we would re-call map_meta_cap here.
81                         if ( 'delete_post' == $cap )
82                                 $cap = $post_type->cap->$cap;
83                         break;
84                 }
85
86                 // If the post author is set and the user is the author...
87                 if ( $post->post_author && $user_id == $post->post_author ) {
88                         // If the post is published or scheduled...
89                         if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) {
90                                 $caps[] = $post_type->cap->delete_published_posts;
91                         } elseif ( 'trash' == $post->post_status ) {
92                                 $status = get_post_meta( $post->ID, '_wp_trash_meta_status', true );
93                                 if ( in_array( $status, array( 'publish', 'future' ), true ) ) {
94                                         $caps[] = $post_type->cap->delete_published_posts;
95                                 } else {
96                                         $caps[] = $post_type->cap->delete_posts;
97                                 }
98                         } else {
99                                 // If the post is draft...
100                                 $caps[] = $post_type->cap->delete_posts;
101                         }
102                 } else {
103                         // The user is trying to edit someone else's post.
104                         $caps[] = $post_type->cap->delete_others_posts;
105                         // The post is published or scheduled, extra cap required.
106                         if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) {
107                                 $caps[] = $post_type->cap->delete_published_posts;
108                         } elseif ( 'private' == $post->post_status ) {
109                                 $caps[] = $post_type->cap->delete_private_posts;
110                         }
111                 }
112                 break;
113                 // edit_post breaks down to edit_posts, edit_published_posts, or
114                 // edit_others_posts
115         case 'edit_post':
116         case 'edit_page':
117                 $post = get_post( $args[0] );
118                 if ( ! $post ) {
119                         $caps[] = 'do_not_allow';
120                         break;
121                 }
122
123                 if ( 'revision' == $post->post_type ) {
124                         $post = get_post( $post->post_parent );
125                         if ( ! $post ) {
126                                 $caps[] = 'do_not_allow';
127                                 break;
128                         }
129                 }
130
131                 $post_type = get_post_type_object( $post->post_type );
132                 if ( ! $post_type ) {
133                         /* translators: 1: post type, 2: capability name */
134                         _doing_it_wrong( __FUNCTION__, sprintf( __( 'The post type %1$s is not registered, so it may not be reliable to check the capability "%2$s" against a post of that type.' ), $post->post_type, $cap ), '4.4.0' );
135                         $caps[] = 'edit_others_posts';
136                         break;
137                 }
138
139                 if ( ! $post_type->map_meta_cap ) {
140                         $caps[] = $post_type->cap->$cap;
141                         // Prior to 3.1 we would re-call map_meta_cap here.
142                         if ( 'edit_post' == $cap )
143                                 $cap = $post_type->cap->$cap;
144                         break;
145                 }
146
147                 // If the post author is set and the user is the author...
148                 if ( $post->post_author && $user_id == $post->post_author ) {
149                         // If the post is published or scheduled...
150                         if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) {
151                                 $caps[] = $post_type->cap->edit_published_posts;
152                         } elseif ( 'trash' == $post->post_status ) {
153                                 $status = get_post_meta( $post->ID, '_wp_trash_meta_status', true );
154                                 if ( in_array( $status, array( 'publish', 'future' ), true ) ) {
155                                         $caps[] = $post_type->cap->edit_published_posts;
156                                 } else {
157                                         $caps[] = $post_type->cap->edit_posts;
158                                 }
159                         } else {
160                                 // If the post is draft...
161                                 $caps[] = $post_type->cap->edit_posts;
162                         }
163                 } else {
164                         // The user is trying to edit someone else's post.
165                         $caps[] = $post_type->cap->edit_others_posts;
166                         // The post is published or scheduled, extra cap required.
167                         if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) {
168                                 $caps[] = $post_type->cap->edit_published_posts;
169                         } elseif ( 'private' == $post->post_status ) {
170                                 $caps[] = $post_type->cap->edit_private_posts;
171                         }
172                 }
173                 break;
174         case 'read_post':
175         case 'read_page':
176                 $post = get_post( $args[0] );
177                 if ( ! $post ) {
178                         $caps[] = 'do_not_allow';
179                         break;
180                 }
181
182                 if ( 'revision' == $post->post_type ) {
183                         $post = get_post( $post->post_parent );
184                         if ( ! $post ) {
185                                 $caps[] = 'do_not_allow';
186                                 break;
187                         }
188                 }
189
190                 $post_type = get_post_type_object( $post->post_type );
191                 if ( ! $post_type ) {
192                         /* translators: 1: post type, 2: capability name */
193                         _doing_it_wrong( __FUNCTION__, sprintf( __( 'The post type %1$s is not registered, so it may not be reliable to check the capability "%2$s" against a post of that type.' ), $post->post_type, $cap ), '4.4.0' );
194                         $caps[] = 'edit_others_posts';
195                         break;
196                 }
197
198                 if ( ! $post_type->map_meta_cap ) {
199                         $caps[] = $post_type->cap->$cap;
200                         // Prior to 3.1 we would re-call map_meta_cap here.
201                         if ( 'read_post' == $cap )
202                                 $cap = $post_type->cap->$cap;
203                         break;
204                 }
205
206                 $status_obj = get_post_status_object( $post->post_status );
207                 if ( $status_obj->public ) {
208                         $caps[] = $post_type->cap->read;
209                         break;
210                 }
211
212                 if ( $post->post_author && $user_id == $post->post_author ) {
213                         $caps[] = $post_type->cap->read;
214                 } elseif ( $status_obj->private ) {
215                         $caps[] = $post_type->cap->read_private_posts;
216                 } else {
217                         $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
218                 }
219                 break;
220         case 'publish_post':
221                 $post = get_post( $args[0] );
222                 if ( ! $post ) {
223                         $caps[] = 'do_not_allow';
224                         break;
225                 }
226
227                 $post_type = get_post_type_object( $post->post_type );
228                 if ( ! $post_type ) {
229                         /* translators: 1: post type, 2: capability name */
230                         _doing_it_wrong( __FUNCTION__, sprintf( __( 'The post type %1$s is not registered, so it may not be reliable to check the capability "%2$s" against a post of that type.' ), $post->post_type, $cap ), '4.4.0' );
231                         $caps[] = 'edit_others_posts';
232                         break;
233                 }
234
235                 $caps[] = $post_type->cap->publish_posts;
236                 break;
237         case 'edit_post_meta':
238         case 'delete_post_meta':
239         case 'add_post_meta':
240                 $post = get_post( $args[0] );
241                 if ( ! $post ) {
242                         $caps[] = 'do_not_allow';
243                         break;
244                 }
245
246                 $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
247
248                 $meta_key = isset( $args[ 1 ] ) ? $args[ 1 ] : false;
249
250                 if ( $meta_key && has_filter( "auth_post_meta_{$meta_key}" ) ) {
251                         /**
252                          * Filter whether the user is allowed to add post meta to a post.
253                          *
254                          * The dynamic portion of the hook name, `$meta_key`, refers to the
255                          * meta key passed to {@see map_meta_cap()}.
256                          *
257                          * @since 3.3.0
258                          *
259                          * @param bool   $allowed  Whether the user can add the post meta. Default false.
260                          * @param string $meta_key The meta key.
261                          * @param int    $post_id  Post ID.
262                          * @param int    $user_id  User ID.
263                          * @param string $cap      Capability name.
264                          * @param array  $caps     User capabilities.
265                          */
266                         $allowed = apply_filters( "auth_post_meta_{$meta_key}", false, $meta_key, $post->ID, $user_id, $cap, $caps );
267                         if ( ! $allowed )
268                                 $caps[] = $cap;
269                 } elseif ( $meta_key && is_protected_meta( $meta_key, 'post' ) ) {
270                         $caps[] = $cap;
271                 }
272                 break;
273         case 'edit_comment':
274                 $comment = get_comment( $args[0] );
275                 if ( ! $comment ) {
276                         $caps[] = 'do_not_allow';
277                         break;
278                 }
279
280                 $post = get_post( $comment->comment_post_ID );
281
282                 /*
283                  * If the post doesn't exist, we have an orphaned comment.
284                  * Fall back to the edit_posts capability, instead.
285                  */
286                 if ( $post ) {
287                         $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
288                 } else {
289                         $caps = map_meta_cap( 'edit_posts', $user_id );
290                 }
291                 break;
292         case 'unfiltered_upload':
293                 if ( defined('ALLOW_UNFILTERED_UPLOADS') && ALLOW_UNFILTERED_UPLOADS && ( !is_multisite() || is_super_admin( $user_id ) )  )
294                         $caps[] = $cap;
295                 else
296                         $caps[] = 'do_not_allow';
297                 break;
298         case 'unfiltered_html' :
299                 // Disallow unfiltered_html for all users, even admins and super admins.
300                 if ( defined( 'DISALLOW_UNFILTERED_HTML' ) && DISALLOW_UNFILTERED_HTML )
301                         $caps[] = 'do_not_allow';
302                 elseif ( is_multisite() && ! is_super_admin( $user_id ) )
303                         $caps[] = 'do_not_allow';
304                 else
305                         $caps[] = $cap;
306                 break;
307         case 'edit_files':
308         case 'edit_plugins':
309         case 'edit_themes':
310                 // Disallow the file editors.
311                 if ( defined( 'DISALLOW_FILE_EDIT' ) && DISALLOW_FILE_EDIT )
312                         $caps[] = 'do_not_allow';
313                 elseif ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS )
314                         $caps[] = 'do_not_allow';
315                 elseif ( is_multisite() && ! is_super_admin( $user_id ) )
316                         $caps[] = 'do_not_allow';
317                 else
318                         $caps[] = $cap;
319                 break;
320         case 'update_plugins':
321         case 'delete_plugins':
322         case 'install_plugins':
323         case 'upload_plugins':
324         case 'update_themes':
325         case 'delete_themes':
326         case 'install_themes':
327         case 'upload_themes':
328         case 'update_core':
329                 // Disallow anything that creates, deletes, or updates core, plugin, or theme files.
330                 // Files in uploads are excepted.
331                 if ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS ) {
332                         $caps[] = 'do_not_allow';
333                 } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) {
334                         $caps[] = 'do_not_allow';
335                 } elseif ( 'upload_themes' === $cap ) {
336                         $caps[] = 'install_themes';
337                 } elseif ( 'upload_plugins' === $cap ) {
338                         $caps[] = 'install_plugins';
339                 } else {
340                         $caps[] = $cap;
341                 }
342                 break;
343         case 'activate_plugins':
344                 $caps[] = $cap;
345                 if ( is_multisite() ) {
346                         // update_, install_, and delete_ are handled above with is_super_admin().
347                         $menu_perms = get_site_option( 'menu_items', array() );
348                         if ( empty( $menu_perms['plugins'] ) )
349                                 $caps[] = 'manage_network_plugins';
350                 }
351                 break;
352         case 'delete_user':
353         case 'delete_users':
354                 // If multisite only super admins can delete users.
355                 if ( is_multisite() && ! is_super_admin( $user_id ) )
356                         $caps[] = 'do_not_allow';
357                 else
358                         $caps[] = 'delete_users'; // delete_user maps to delete_users.
359                 break;
360         case 'create_users':
361                 if ( !is_multisite() )
362                         $caps[] = $cap;
363                 elseif ( is_super_admin( $user_id ) || get_site_option( 'add_new_users' ) )
364                         $caps[] = $cap;
365                 else
366                         $caps[] = 'do_not_allow';
367                 break;
368         case 'manage_links' :
369                 if ( get_option( 'link_manager_enabled' ) )
370                         $caps[] = $cap;
371                 else
372                         $caps[] = 'do_not_allow';
373                 break;
374         case 'customize' :
375                 $caps[] = 'edit_theme_options';
376                 break;
377         case 'delete_site':
378                 $caps[] = 'manage_options';
379                 break;
380         default:
381                 // Handle meta capabilities for custom post types.
382                 global $post_type_meta_caps;
383                 if ( isset( $post_type_meta_caps[ $cap ] ) ) {
384                         $args = array_merge( array( $post_type_meta_caps[ $cap ], $user_id ), $args );
385                         return call_user_func_array( 'map_meta_cap', $args );
386                 }
387
388                 // If no meta caps match, return the original cap.
389                 $caps[] = $cap;
390         }
391
392         /**
393          * Filter a user's capabilities depending on specific context and/or privilege.
394          *
395          * @since 2.8.0
396          *
397          * @param array  $caps    Returns the user's actual capabilities.
398          * @param string $cap     Capability name.
399          * @param int    $user_id The user ID.
400          * @param array  $args    Adds the context to the cap. Typically the object ID.
401          */
402         return apply_filters( 'map_meta_cap', $caps, $cap, $user_id, $args );
403 }
404
405 /**
406  * Whether the current user has a specific capability.
407  *
408  * While checking against particular roles in place of a capability is supported
409  * in part, this practice is discouraged as it may produce unreliable results.
410  *
411  * Note: Will always return true if the current user is a super admin, unless specifically denied.
412  *
413  * @since 2.0.0
414  *
415  * @see WP_User::has_cap()
416  * @see map_meta_cap()
417  *
418  * @param string $capability Capability name.
419  * @param int    $object_id  Optional. ID of the specific object to check against if `$capability` is a "meta" cap.
420  *                           "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used
421  *                           by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts',
422  *                           'edit_others_posts', etc. Accessed via func_get_args() and passed to WP_User::has_cap(),
423  *                           then map_meta_cap().
424  * @return bool Whether the current user has the given capability. If `$capability` is a meta cap and `$object_id` is
425  *              passed, whether the current user has the given meta capability for the given object.
426  */
427 function current_user_can( $capability ) {
428         $current_user = wp_get_current_user();
429
430         if ( empty( $current_user ) )
431                 return false;
432
433         $args = array_slice( func_get_args(), 1 );
434         $args = array_merge( array( $capability ), $args );
435
436         return call_user_func_array( array( $current_user, 'has_cap' ), $args );
437 }
438
439 /**
440  * Whether current user has a capability or role for a given site.
441  *
442  * @since 3.0.0
443  *
444  * @param int    $blog_id    Site ID.
445  * @param string $capability Capability or role name.
446  * @return bool
447  */
448 function current_user_can_for_blog( $blog_id, $capability ) {
449         $switched = is_multisite() ? switch_to_blog( $blog_id ) : false;
450
451         $current_user = wp_get_current_user();
452
453         if ( empty( $current_user ) ) {
454                 if ( $switched ) {
455                         restore_current_blog();
456                 }
457                 return false;
458         }
459
460         $args = array_slice( func_get_args(), 2 );
461         $args = array_merge( array( $capability ), $args );
462
463         $can = call_user_func_array( array( $current_user, 'has_cap' ), $args );
464
465         if ( $switched ) {
466                 restore_current_blog();
467         }
468
469         return $can;
470 }
471
472 /**
473  * Whether author of supplied post has capability or role.
474  *
475  * @since 2.9.0
476  *
477  * @param int|object $post Post ID or post object.
478  * @param string $capability Capability or role name.
479  * @return bool
480  */
481 function author_can( $post, $capability ) {
482         if ( !$post = get_post($post) )
483                 return false;
484
485         $author = get_userdata( $post->post_author );
486
487         if ( ! $author )
488                 return false;
489
490         $args = array_slice( func_get_args(), 2 );
491         $args = array_merge( array( $capability ), $args );
492
493         return call_user_func_array( array( $author, 'has_cap' ), $args );
494 }
495
496 /**
497  * Whether a particular user has capability or role.
498  *
499  * @since 3.1.0
500  *
501  * @param int|object $user User ID or object.
502  * @param string $capability Capability or role name.
503  * @return bool
504  */
505 function user_can( $user, $capability ) {
506         if ( ! is_object( $user ) )
507                 $user = get_userdata( $user );
508
509         if ( ! $user || ! $user->exists() )
510                 return false;
511
512         $args = array_slice( func_get_args(), 2 );
513         $args = array_merge( array( $capability ), $args );
514
515         return call_user_func_array( array( $user, 'has_cap' ), $args );
516 }
517
518 /**
519  * Retrieves the global WP_Roles instance and instantiates it if necessary.
520  *
521  * @since 4.3.0
522  *
523  * @global WP_Roles $wp_roles WP_Roles global instance.
524  *
525  * @return WP_Roles WP_Roles global instance if not already instantiated.
526  */
527 function wp_roles() {
528         global $wp_roles;
529
530         if ( ! isset( $wp_roles ) ) {
531                 $wp_roles = new WP_Roles();
532         }
533         return $wp_roles;
534 }
535
536 /**
537  * Retrieve role object.
538  *
539  * @since 2.0.0
540  *
541  * @param string $role Role name.
542  * @return WP_Role|null WP_Role object if found, null if the role does not exist.
543  */
544 function get_role( $role ) {
545         return wp_roles()->get_role( $role );
546 }
547
548 /**
549  * Add role, if it does not exist.
550  *
551  * @since 2.0.0
552  *
553  * @param string $role Role name.
554  * @param string $display_name Display name for role.
555  * @param array $capabilities List of capabilities, e.g. array( 'edit_posts' => true, 'delete_posts' => false );
556  * @return WP_Role|null WP_Role object if role is added, null if already exists.
557  */
558 function add_role( $role, $display_name, $capabilities = array() ) {
559         if ( empty( $role ) ) {
560                 return;
561         }
562         return wp_roles()->add_role( $role, $display_name, $capabilities );
563 }
564
565 /**
566  * Remove role, if it exists.
567  *
568  * @since 2.0.0
569  *
570  * @param string $role Role name.
571  */
572 function remove_role( $role ) {
573         wp_roles()->remove_role( $role );
574 }
575
576 /**
577  * Retrieve a list of super admins.
578  *
579  * @since 3.0.0
580  *
581  * @global array $super_admins
582  *
583  * @return array List of super admin logins
584  */
585 function get_super_admins() {
586         global $super_admins;
587
588         if ( isset($super_admins) )
589                 return $super_admins;
590         else
591                 return get_site_option( 'site_admins', array('admin') );
592 }
593
594 /**
595  * Determine if user is a site admin.
596  *
597  * @since 3.0.0
598  *
599  * @param int $user_id (Optional) The ID of a user. Defaults to the current user.
600  * @return bool True if the user is a site admin.
601  */
602 function is_super_admin( $user_id = false ) {
603         if ( ! $user_id || $user_id == get_current_user_id() )
604                 $user = wp_get_current_user();
605         else
606                 $user = get_userdata( $user_id );
607
608         if ( ! $user || ! $user->exists() )
609                 return false;
610
611         if ( is_multisite() ) {
612                 $super_admins = get_super_admins();
613                 if ( is_array( $super_admins ) && in_array( $user->user_login, $super_admins ) )
614                         return true;
615         } else {
616                 if ( $user->has_cap('delete_users') )
617                         return true;
618         }
619
620         return false;
621 }