<?php
+/**
+ * Core User Role & Capabilities API
+ *
+ * @package WordPress
+ * @subpackage Users
+ */
+
+/**
+ * Map meta capabilities to primitive capabilities.
+ *
+ * This does not actually compare whether the user ID has the actual capability,
+ * just what the capability or capabilities are. Meta capability list value can
+ * be 'delete_user', 'edit_user', 'remove_user', 'promote_user', 'delete_post',
+ * 'delete_page', 'edit_post', 'edit_page', 'read_post', or 'read_page'.
+ *
+ * @since 2.0.0
+ *
+ * @global array $post_type_meta_caps Used to get post type meta capabilities.
+ *
+ * @param string $cap Capability name.
+ * @param int $user_id User ID.
+ * @param int $object_id Optional. ID of the specific object to check against if `$cap` is a "meta" cap.
+ * "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used
+ * by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts',
+ * 'edit_others_posts', etc. The parameter is accessed via func_get_args().
+ * @return array Actual capabilities for meta capability.
+ */
+function map_meta_cap( $cap, $user_id ) {
+ $args = array_slice( func_get_args(), 2 );
+ $caps = array();
-class WP_Roles {
- var $roles;
-
- var $role_objects = array();
- var $role_names = array();
- var $role_key;
- var $use_db = true;
-
- function WP_Roles() {
- $this->_init();
- }
+ switch ( $cap ) {
+ case 'remove_user':
+ $caps[] = 'remove_users';
+ break;
+ case 'promote_user':
+ case 'add_users':
+ $caps[] = 'promote_users';
+ break;
+ case 'edit_user':
+ case 'edit_users':
+ // Allow user to edit itself
+ if ( 'edit_user' == $cap && isset( $args[0] ) && $user_id == $args[0] )
+ break;
- function _init () {
- global $wpdb;
- global $wp_user_roles;
- $this->role_key = $wpdb->prefix . 'user_roles';
- if ( ! empty($wp_user_roles) ) {
- $this->roles = $wp_user_roles;
- $this->use_db = false;
+ // In multisite the user must have manage_network_users caps. If editing a super admin, the user must be a super admin.
+ if ( is_multisite() && ( ( ! is_super_admin( $user_id ) && 'edit_user' === $cap && is_super_admin( $args[0] ) ) || ! user_can( $user_id, 'manage_network_users' ) ) ) {
+ $caps[] = 'do_not_allow';
} else {
- $this->roles = get_option($this->role_key);
+ $caps[] = 'edit_users'; // edit_user maps to edit_users.
}
-
- if ( empty($this->roles) )
- return;
-
- $this->role_objects = array();
- $this->role_names = array();
- foreach ($this->roles as $role => $data) {
- $this->role_objects[$role] = new WP_Role($role, $this->roles[$role]['capabilities']);
- $this->role_names[$role] = $this->roles[$role]['name'];
+ break;
+ case 'delete_post':
+ case 'delete_page':
+ $post = get_post( $args[0] );
+ if ( ! $post ) {
+ $caps[] = 'do_not_allow';
+ break;
}
- }
-
- function add_role($role, $display_name, $capabilities = '') {
- if ( isset($this->roles[$role]) )
- return;
-
- $this->roles[$role] = array(
- 'name' => $display_name,
- 'capabilities' => $capabilities);
- if ( $this->use_db )
- update_option($this->role_key, $this->roles);
- $this->role_objects[$role] = new WP_Role($role, $capabilities);
- $this->role_names[$role] = $display_name;
- return $this->role_objects[$role];
- }
-
- function remove_role($role) {
- if ( ! isset($this->role_objects[$role]) )
- return;
-
- unset($this->role_objects[$role]);
- unset($this->role_names[$role]);
- unset($this->roles[$role]);
-
- if ( $this->use_db )
- update_option($this->role_key, $this->roles);
- }
-
- function add_cap($role, $cap, $grant = true) {
- $this->roles[$role]['capabilities'][$cap] = $grant;
- if ( $this->use_db )
- update_option($this->role_key, $this->roles);
- }
-
- function remove_cap($role, $cap) {
- unset($this->roles[$role]['capabilities'][$cap]);
- if ( $this->use_db )
- update_option($this->role_key, $this->roles);
- }
-
- function &get_role($role) {
- if ( isset($this->role_objects[$role]) )
- return $this->role_objects[$role];
- else
- return null;
- }
- function get_names() {
- return $this->role_names;
- }
-
- function is_role($role)
- {
- return isset($this->role_names[$role]);
- }
-}
-
-class WP_Role {
- var $name;
- var $capabilities;
-
- function WP_Role($role, $capabilities) {
- $this->name = $role;
- $this->capabilities = $capabilities;
- }
-
- function add_cap($cap, $grant = true) {
- global $wp_roles;
-
- if ( ! isset($wp_roles) )
- $wp_roles = new WP_Roles();
-
- $this->capabilities[$cap] = $grant;
- $wp_roles->add_cap($this->name, $cap, $grant);
- }
-
- function remove_cap($cap) {
- global $wp_roles;
-
- if ( ! isset($wp_roles) )
- $wp_roles = new WP_Roles();
-
- unset($this->capabilities[$cap]);
- $wp_roles->remove_cap($this->name, $cap);
- }
-
- function has_cap($cap) {
- $capabilities = apply_filters('role_has_cap', $this->capabilities, $cap, $this->name);
- if ( !empty($capabilities[$cap]) )
- return $capabilities[$cap];
- else
- return false;
- }
-
-}
-
-class WP_User {
- var $data;
- var $ID = 0;
- var $id = 0; // Deprecated, use $ID instead.
- var $caps = array();
- var $cap_key;
- var $roles = array();
- var $allcaps = array();
-
- function WP_User($id, $name = '') {
-
- if ( empty($id) && empty($name) )
- return;
-
- if ( ! is_numeric($id) ) {
- $name = $id;
- $id = 0;
+ if ( 'revision' == $post->post_type ) {
+ $post = get_post( $post->post_parent );
+ if ( ! $post ) {
+ $caps[] = 'do_not_allow';
+ break;
+ }
}
- if ( ! empty($id) )
- $this->data = get_userdata($id);
- else
- $this->data = get_userdatabylogin($name);
-
- if ( empty($this->data->ID) )
- return;
-
- foreach (get_object_vars($this->data) as $key => $value) {
- $this->{$key} = $value;
+ $post_type = get_post_type_object( $post->post_type );
+ if ( ! $post_type ) {
+ /* translators: 1: post type, 2: capability name */
+ _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' );
+ $caps[] = 'edit_others_posts';
+ break;
}
- $this->id = $this->ID;
- $this->_init_caps();
- }
-
- function _init_caps() {
- global $wpdb;
- $this->cap_key = $wpdb->prefix . 'capabilities';
- $this->caps = &$this->{$this->cap_key};
- if ( ! is_array($this->caps) )
- $this->caps = array();
- $this->get_role_caps();
- }
-
- function get_role_caps() {
- global $wp_roles;
-
- if ( ! isset($wp_roles) )
- $wp_roles = new WP_Roles();
-
- //Filter out caps that are not role names and assign to $this->roles
- if(is_array($this->caps))
- $this->roles = array_filter(array_keys($this->caps), array(&$wp_roles, 'is_role'));
-
- //Build $allcaps from role caps, overlay user's $caps
- $this->allcaps = array();
- foreach( (array) $this->roles as $role) {
- $role = $wp_roles->get_role($role);
- $this->allcaps = array_merge($this->allcaps, $role->capabilities);
+ if ( ! $post_type->map_meta_cap ) {
+ $caps[] = $post_type->cap->$cap;
+ // Prior to 3.1 we would re-call map_meta_cap here.
+ if ( 'delete_post' == $cap )
+ $cap = $post_type->cap->$cap;
+ break;
}
- $this->allcaps = array_merge($this->allcaps, $this->caps);
- }
- function add_role($role) {
- $this->caps[$role] = true;
- update_usermeta($this->ID, $this->cap_key, $this->caps);
- $this->get_role_caps();
- $this->update_user_level_from_caps();
- }
-
- function remove_role($role) {
- if ( empty($this->roles[$role]) || (count($this->roles) <= 1) )
- return;
- unset($this->caps[$role]);
- update_usermeta($this->ID, $this->cap_key, $this->caps);
- $this->get_role_caps();
- }
-
- function set_role($role) {
- foreach($this->roles as $oldrole)
- unset($this->caps[$oldrole]);
- if ( !empty($role) ) {
- $this->caps[$role] = true;
- $this->roles = array($role => true);
+ // If the post author is set and the user is the author...
+ if ( $post->post_author && $user_id == $post->post_author ) {
+ // If the post is published or scheduled...
+ if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) {
+ $caps[] = $post_type->cap->delete_published_posts;
+ } elseif ( 'trash' == $post->post_status ) {
+ $status = get_post_meta( $post->ID, '_wp_trash_meta_status', true );
+ if ( in_array( $status, array( 'publish', 'future' ), true ) ) {
+ $caps[] = $post_type->cap->delete_published_posts;
+ } else {
+ $caps[] = $post_type->cap->delete_posts;
+ }
+ } else {
+ // If the post is draft...
+ $caps[] = $post_type->cap->delete_posts;
+ }
} else {
- $this->roles = false;
+ // The user is trying to edit someone else's post.
+ $caps[] = $post_type->cap->delete_others_posts;
+ // The post is published or scheduled, extra cap required.
+ if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) {
+ $caps[] = $post_type->cap->delete_published_posts;
+ } elseif ( 'private' == $post->post_status ) {
+ $caps[] = $post_type->cap->delete_private_posts;
+ }
}
- update_usermeta($this->ID, $this->cap_key, $this->caps);
- $this->get_role_caps();
- $this->update_user_level_from_caps();
- }
-
- function level_reduction($max, $item) {
- if(preg_match('/^level_(10|[0-9])$/i', $item, $matches)) {
- $level = intval($matches[1]);
- return max($max, $level);
- } else {
- return $max;
+ break;
+ // edit_post breaks down to edit_posts, edit_published_posts, or
+ // edit_others_posts
+ case 'edit_post':
+ case 'edit_page':
+ $post = get_post( $args[0] );
+ if ( ! $post ) {
+ $caps[] = 'do_not_allow';
+ break;
}
- }
- function update_user_level_from_caps() {
- global $wpdb;
- $this->user_level = array_reduce(array_keys($this->allcaps), array(&$this, 'level_reduction'), 0);
- update_usermeta($this->ID, $wpdb->prefix.'user_level', $this->user_level);
- }
-
- function add_cap($cap, $grant = true) {
- $this->caps[$cap] = $grant;
- update_usermeta($this->ID, $this->cap_key, $this->caps);
- }
-
- function remove_cap($cap) {
- if ( empty($this->caps[$cap]) ) return;
- unset($this->caps[$cap]);
- update_usermeta($this->ID, $this->cap_key, $this->caps);
- }
-
- function remove_all_caps() {
- global $wpdb;
- $this->caps = array();
- update_usermeta($this->ID, $this->cap_key, '');
- update_usermeta($this->ID, $wpdb->prefix.'user_level', '');
- $this->get_role_caps();
- }
-
- //has_cap(capability_or_role_name) or
- //has_cap('edit_post', post_id)
- function has_cap($cap) {
- if ( is_numeric($cap) )
- $cap = $this->translate_level_to_cap($cap);
-
- $args = array_slice(func_get_args(), 1);
- $args = array_merge(array($cap, $this->ID), $args);
- $caps = call_user_func_array('map_meta_cap', $args);
- // Must have ALL requested caps
- $capabilities = apply_filters('user_has_cap', $this->allcaps, $caps, $args);
- foreach ($caps as $cap) {
- //echo "Checking cap $cap<br />";
- if(empty($capabilities[$cap]) || !$capabilities[$cap])
- return false;
+ if ( 'revision' == $post->post_type ) {
+ $post = get_post( $post->post_parent );
+ if ( ! $post ) {
+ $caps[] = 'do_not_allow';
+ break;
+ }
}
- return true;
- }
-
- function translate_level_to_cap($level) {
- return 'level_' . $level;
- }
-
-}
-
-// Map meta capabilities to primitive capabilities.
-function map_meta_cap($cap, $user_id) {
- $args = array_slice(func_get_args(), 2);
- $caps = array();
-
- switch ($cap) {
- case 'delete_user':
- $caps[] = 'delete_users';
- break;
- case 'edit_user':
- if ( !isset($args[0]) || $user_id != $args[0] ) {
- $caps[] = 'edit_users';
+ $post_type = get_post_type_object( $post->post_type );
+ if ( ! $post_type ) {
+ /* translators: 1: post type, 2: capability name */
+ _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' );
+ $caps[] = 'edit_others_posts';
+ break;
}
- break;
- case 'delete_post':
- $author_data = get_userdata($user_id);
- //echo "post ID: {$args[0]}<br />";
- $post = get_post($args[0]);
- if ( 'page' == $post->post_type ) {
- $args = array_merge(array('delete_page', $user_id), $args);
- return call_user_func_array('map_meta_cap', $args);
+
+ if ( ! $post_type->map_meta_cap ) {
+ $caps[] = $post_type->cap->$cap;
+ // Prior to 3.1 we would re-call map_meta_cap here.
+ if ( 'edit_post' == $cap )
+ $cap = $post_type->cap->$cap;
+ break;
}
- $post_author_data = get_userdata($post->post_author);
- //echo "current user id : $user_id, post author id: " . $post_author_data->ID . "<br />";
- // If the user is the author...
- if ($user_id == $post_author_data->ID) {
- // If the post is published...
- if ($post->post_status == 'publish')
- $caps[] = 'delete_published_posts';
- else
+
+ // If the post author is set and the user is the author...
+ if ( $post->post_author && $user_id == $post->post_author ) {
+ // If the post is published or scheduled...
+ if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) {
+ $caps[] = $post_type->cap->edit_published_posts;
+ } elseif ( 'trash' == $post->post_status ) {
+ $status = get_post_meta( $post->ID, '_wp_trash_meta_status', true );
+ if ( in_array( $status, array( 'publish', 'future' ), true ) ) {
+ $caps[] = $post_type->cap->edit_published_posts;
+ } else {
+ $caps[] = $post_type->cap->edit_posts;
+ }
+ } else {
// If the post is draft...
- $caps[] = 'delete_posts';
+ $caps[] = $post_type->cap->edit_posts;
+ }
} else {
// The user is trying to edit someone else's post.
- $caps[] = 'delete_others_posts';
- // The post is published, extra cap required.
- if ($post->post_status == 'publish')
- $caps[] = 'delete_published_posts';
- else if ($post->post_status == 'private')
- $caps[] = 'delete_private_posts';
+ $caps[] = $post_type->cap->edit_others_posts;
+ // The post is published or scheduled, extra cap required.
+ if ( in_array( $post->post_status, array( 'publish', 'future' ), true ) ) {
+ $caps[] = $post_type->cap->edit_published_posts;
+ } elseif ( 'private' == $post->post_status ) {
+ $caps[] = $post_type->cap->edit_private_posts;
+ }
}
break;
- case 'delete_page':
- $author_data = get_userdata($user_id);
- //echo "post ID: {$args[0]}<br />";
- $page = get_page($args[0]);
- $page_author_data = get_userdata($page->post_author);
- //echo "current user id : $user_id, page author id: " . $page_author_data->ID . "<br />";
- // If the user is the author...
- if ($user_id == $page_author_data->ID) {
- // If the page is published...
- if ($page->post_status == 'publish')
- $caps[] = 'delete_published_pages';
- else
- // If the page is draft...
- $caps[] = 'delete_pages';
- } else {
- // The user is trying to edit someone else's page.
- $caps[] = 'delete_others_pages';
- // The page is published, extra cap required.
- if ($page->post_status == 'publish')
- $caps[] = 'delete_published_pages';
- else if ($page->post_status == 'private')
- $caps[] = 'delete_private_pages';
+ case 'read_post':
+ case 'read_page':
+ $post = get_post( $args[0] );
+ if ( ! $post ) {
+ $caps[] = 'do_not_allow';
+ break;
}
- break;
- // edit_post breaks down to edit_posts, edit_published_posts, or
- // edit_others_posts
- case 'edit_post':
- $author_data = get_userdata($user_id);
- //echo "post ID: {$args[0]}<br />";
- $post = get_post($args[0]);
- if ( 'page' == $post->post_type ) {
- $args = array_merge(array('edit_page', $user_id), $args);
- return call_user_func_array('map_meta_cap', $args);
+
+ if ( 'revision' == $post->post_type ) {
+ $post = get_post( $post->post_parent );
+ if ( ! $post ) {
+ $caps[] = 'do_not_allow';
+ break;
+ }
}
- $post_author_data = get_userdata($post->post_author);
- //echo "current user id : $user_id, post author id: " . $post_author_data->ID . "<br />";
- // If the user is the author...
- if ($user_id == $post_author_data->ID) {
- // If the post is published...
- if ($post->post_status == 'publish')
- $caps[] = 'edit_published_posts';
- else
- // If the post is draft...
- $caps[] = 'edit_posts';
- } else {
- // The user is trying to edit someone else's post.
+
+ $post_type = get_post_type_object( $post->post_type );
+ if ( ! $post_type ) {
+ /* translators: 1: post type, 2: capability name */
+ _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' );
$caps[] = 'edit_others_posts';
- // The post is published, extra cap required.
- if ($post->post_status == 'publish')
- $caps[] = 'edit_published_posts';
- else if ($post->post_status == 'private')
- $caps[] = 'edit_private_posts';
+ break;
}
- break;
- case 'edit_page':
- $author_data = get_userdata($user_id);
- //echo "post ID: {$args[0]}<br />";
- $page = get_page($args[0]);
- $page_author_data = get_userdata($page->post_author);
- //echo "current user id : $user_id, page author id: " . $page_author_data->ID . "<br />";
- // If the user is the author...
- if ($user_id == $page_author_data->ID) {
- // If the page is published...
- if ($page->post_status == 'publish')
- $caps[] = 'edit_published_pages';
- else
- // If the page is draft...
- $caps[] = 'edit_pages';
+
+ if ( ! $post_type->map_meta_cap ) {
+ $caps[] = $post_type->cap->$cap;
+ // Prior to 3.1 we would re-call map_meta_cap here.
+ if ( 'read_post' == $cap )
+ $cap = $post_type->cap->$cap;
+ break;
+ }
+
+ $status_obj = get_post_status_object( $post->post_status );
+ if ( $status_obj->public ) {
+ $caps[] = $post_type->cap->read;
+ break;
+ }
+
+ if ( $post->post_author && $user_id == $post->post_author ) {
+ $caps[] = $post_type->cap->read;
+ } elseif ( $status_obj->private ) {
+ $caps[] = $post_type->cap->read_private_posts;
} else {
- // The user is trying to edit someone else's page.
- $caps[] = 'edit_others_pages';
- // The page is published, extra cap required.
- if ($page->post_status == 'publish')
- $caps[] = 'edit_published_pages';
- else if ($page->post_status == 'private')
- $caps[] = 'edit_private_pages';
+ $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
}
break;
- case 'read_post':
- $post = get_post($args[0]);
- if ( 'page' == $post->post_type ) {
- $args = array_merge(array('read_page', $user_id), $args);
- return call_user_func_array('map_meta_cap', $args);
+ case 'publish_post':
+ $post = get_post( $args[0] );
+ if ( ! $post ) {
+ $caps[] = 'do_not_allow';
+ break;
}
- if ( 'private' != $post->post_status ) {
- $caps[] = 'read';
+ $post_type = get_post_type_object( $post->post_type );
+ if ( ! $post_type ) {
+ /* translators: 1: post type, 2: capability name */
+ _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' );
+ $caps[] = 'edit_others_posts';
break;
}
- $author_data = get_userdata($user_id);
- $post_author_data = get_userdata($post->post_author);
- if ($user_id == $post_author_data->ID)
- $caps[] = 'read';
- else
- $caps[] = 'read_private_posts';
+ $caps[] = $post_type->cap->publish_posts;
break;
- case 'read_page':
- $page = get_page($args[0]);
+ case 'edit_post_meta':
+ case 'delete_post_meta':
+ case 'add_post_meta':
+ $post = get_post( $args[0] );
+ if ( ! $post ) {
+ $caps[] = 'do_not_allow';
+ break;
+ }
- if ( 'private' != $page->post_status ) {
- $caps[] = 'read';
+ $post_type = get_post_type( $post );
+
+ $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
+
+ $meta_key = isset( $args[ 1 ] ) ? $args[ 1 ] : false;
+
+ if ( $meta_key && ( has_filter( "auth_post_meta_{$meta_key}" ) || has_filter( "auth_post_{$post_type}_meta_{$meta_key}" ) ) ) {
+ /**
+ * Filters whether the user is allowed to add post meta to a post.
+ *
+ * The dynamic portion of the hook name, `$meta_key`, refers to the
+ * meta key passed to map_meta_cap().
+ *
+ * @since 3.3.0
+ *
+ * @param bool $allowed Whether the user can add the post meta. Default false.
+ * @param string $meta_key The meta key.
+ * @param int $post_id Post ID.
+ * @param int $user_id User ID.
+ * @param string $cap Capability name.
+ * @param array $caps User capabilities.
+ */
+ $allowed = apply_filters( "auth_post_meta_{$meta_key}", false, $meta_key, $post->ID, $user_id, $cap, $caps );
+
+ /**
+ * Filters whether the user is allowed to add post meta to a post of a given type.
+ *
+ * The dynamic portions of the hook name, `$meta_key` and `$post_type`,
+ * refer to the meta key passed to map_meta_cap() and the post type, respectively.
+ *
+ * @since 4.6.0
+ *
+ * @param bool $allowed Whether the user can add the post meta. Default false.
+ * @param string $meta_key The meta key.
+ * @param int $post_id Post ID.
+ * @param int $user_id User ID.
+ * @param string $cap Capability name.
+ * @param array $caps User capabilities.
+ */
+ $allowed = apply_filters( "auth_post_{$post_type}_meta_{$meta_key}", $allowed, $meta_key, $post->ID, $user_id, $cap, $caps );
+
+ if ( ! $allowed )
+ $caps[] = $cap;
+ } elseif ( $meta_key && is_protected_meta( $meta_key, 'post' ) ) {
+ $caps[] = $cap;
+ }
+ break;
+ case 'edit_comment':
+ $comment = get_comment( $args[0] );
+ if ( ! $comment ) {
+ $caps[] = 'do_not_allow';
break;
}
- $author_data = get_userdata($user_id);
- $page_author_data = get_userdata($page->post_author);
- if ($user_id == $page_author_data->ID)
- $caps[] = 'read';
+ $post = get_post( $comment->comment_post_ID );
+
+ /*
+ * If the post doesn't exist, we have an orphaned comment.
+ * Fall back to the edit_posts capability, instead.
+ */
+ if ( $post ) {
+ $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
+ } else {
+ $caps = map_meta_cap( 'edit_posts', $user_id );
+ }
+ break;
+ case 'unfiltered_upload':
+ if ( defined('ALLOW_UNFILTERED_UPLOADS') && ALLOW_UNFILTERED_UPLOADS && ( !is_multisite() || is_super_admin( $user_id ) ) )
+ $caps[] = $cap;
+ else
+ $caps[] = 'do_not_allow';
+ break;
+ case 'unfiltered_html' :
+ // Disallow unfiltered_html for all users, even admins and super admins.
+ if ( defined( 'DISALLOW_UNFILTERED_HTML' ) && DISALLOW_UNFILTERED_HTML )
+ $caps[] = 'do_not_allow';
+ elseif ( is_multisite() && ! is_super_admin( $user_id ) )
+ $caps[] = 'do_not_allow';
+ else
+ $caps[] = $cap;
+ break;
+ case 'edit_files':
+ case 'edit_plugins':
+ case 'edit_themes':
+ // Disallow the file editors.
+ if ( defined( 'DISALLOW_FILE_EDIT' ) && DISALLOW_FILE_EDIT )
+ $caps[] = 'do_not_allow';
+ elseif ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS )
+ $caps[] = 'do_not_allow';
+ elseif ( is_multisite() && ! is_super_admin( $user_id ) )
+ $caps[] = 'do_not_allow';
+ else
+ $caps[] = $cap;
+ break;
+ case 'update_plugins':
+ case 'delete_plugins':
+ case 'install_plugins':
+ case 'upload_plugins':
+ case 'update_themes':
+ case 'delete_themes':
+ case 'install_themes':
+ case 'upload_themes':
+ case 'update_core':
+ // Disallow anything that creates, deletes, or updates core, plugin, or theme files.
+ // Files in uploads are excepted.
+ if ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS ) {
+ $caps[] = 'do_not_allow';
+ } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) {
+ $caps[] = 'do_not_allow';
+ } elseif ( 'upload_themes' === $cap ) {
+ $caps[] = 'install_themes';
+ } elseif ( 'upload_plugins' === $cap ) {
+ $caps[] = 'install_plugins';
+ } else {
+ $caps[] = $cap;
+ }
+ break;
+ case 'activate_plugins':
+ $caps[] = $cap;
+ if ( is_multisite() ) {
+ // update_, install_, and delete_ are handled above with is_super_admin().
+ $menu_perms = get_site_option( 'menu_items', array() );
+ if ( empty( $menu_perms['plugins'] ) )
+ $caps[] = 'manage_network_plugins';
+ }
+ break;
+ case 'delete_user':
+ case 'delete_users':
+ // If multisite only super admins can delete users.
+ if ( is_multisite() && ! is_super_admin( $user_id ) )
+ $caps[] = 'do_not_allow';
+ else
+ $caps[] = 'delete_users'; // delete_user maps to delete_users.
+ break;
+ case 'create_users':
+ if ( !is_multisite() )
+ $caps[] = $cap;
+ elseif ( is_super_admin( $user_id ) || get_site_option( 'add_new_users' ) )
+ $caps[] = $cap;
+ else
+ $caps[] = 'do_not_allow';
+ break;
+ case 'manage_links' :
+ if ( get_option( 'link_manager_enabled' ) )
+ $caps[] = $cap;
else
- $caps[] = 'read_private_pages';
+ $caps[] = 'do_not_allow';
+ break;
+ case 'customize' :
+ $caps[] = 'edit_theme_options';
+ break;
+ case 'delete_site':
+ $caps[] = 'manage_options';
break;
default:
+ // Handle meta capabilities for custom post types.
+ global $post_type_meta_caps;
+ if ( isset( $post_type_meta_caps[ $cap ] ) ) {
+ $args = array_merge( array( $post_type_meta_caps[ $cap ], $user_id ), $args );
+ return call_user_func_array( 'map_meta_cap', $args );
+ }
+
// If no meta caps match, return the original cap.
$caps[] = $cap;
}
- return $caps;
+ /**
+ * Filters a user's capabilities depending on specific context and/or privilege.
+ *
+ * @since 2.8.0
+ *
+ * @param array $caps Returns the user's actual capabilities.
+ * @param string $cap Capability name.
+ * @param int $user_id The user ID.
+ * @param array $args Adds the context to the cap. Typically the object ID.
+ */
+ return apply_filters( 'map_meta_cap', $caps, $cap, $user_id, $args );
}
-// Capability checking wrapper around the global $current_user object.
-function current_user_can($capability) {
+/**
+ * Whether the current user has a specific capability.
+ *
+ * While checking against particular roles in place of a capability is supported
+ * in part, this practice is discouraged as it may produce unreliable results.
+ *
+ * Note: Will always return true if the current user is a super admin, unless specifically denied.
+ *
+ * @since 2.0.0
+ *
+ * @see WP_User::has_cap()
+ * @see map_meta_cap()
+ *
+ * @param string $capability Capability name.
+ * @param int $object_id Optional. ID of the specific object to check against if `$capability` is a "meta" cap.
+ * "Meta" capabilities, e.g. 'edit_post', 'edit_user', etc., are capabilities used
+ * by map_meta_cap() to map to other "primitive" capabilities, e.g. 'edit_posts',
+ * 'edit_others_posts', etc. Accessed via func_get_args() and passed to WP_User::has_cap(),
+ * then map_meta_cap().
+ * @return bool Whether the current user has the given capability. If `$capability` is a meta cap and `$object_id` is
+ * passed, whether the current user has the given meta capability for the given object.
+ */
+function current_user_can( $capability ) {
$current_user = wp_get_current_user();
- if ( empty($current_user) )
+ if ( empty( $current_user ) )
return false;
- $args = array_slice(func_get_args(), 1);
- $args = array_merge(array($capability), $args);
+ $args = array_slice( func_get_args(), 1 );
+ $args = array_merge( array( $capability ), $args );
- return call_user_func_array(array(&$current_user, 'has_cap'), $args);
+ return call_user_func_array( array( $current_user, 'has_cap' ), $args );
}
-// Convenience wrappers around $wp_roles.
-function get_role($role) {
- global $wp_roles;
+/**
+ * Whether current user has a capability or role for a given site.
+ *
+ * @since 3.0.0
+ *
+ * @param int $blog_id Site ID.
+ * @param string $capability Capability or role name.
+ * @return bool
+ */
+function current_user_can_for_blog( $blog_id, $capability ) {
+ $switched = is_multisite() ? switch_to_blog( $blog_id ) : false;
- if ( ! isset($wp_roles) )
- $wp_roles = new WP_Roles();
+ $current_user = wp_get_current_user();
- return $wp_roles->get_role($role);
+ if ( empty( $current_user ) ) {
+ if ( $switched ) {
+ restore_current_blog();
+ }
+ return false;
+ }
+
+ $args = array_slice( func_get_args(), 2 );
+ $args = array_merge( array( $capability ), $args );
+
+ $can = call_user_func_array( array( $current_user, 'has_cap' ), $args );
+
+ if ( $switched ) {
+ restore_current_blog();
+ }
+
+ return $can;
}
-function add_role($role, $display_name, $capabilities = '') {
- global $wp_roles;
+/**
+ * Whether author of supplied post has capability or role.
+ *
+ * @since 2.9.0
+ *
+ * @param int|object $post Post ID or post object.
+ * @param string $capability Capability or role name.
+ * @return bool
+ */
+function author_can( $post, $capability ) {
+ if ( !$post = get_post($post) )
+ return false;
- if ( ! isset($wp_roles) )
- $wp_roles = new WP_Roles();
+ $author = get_userdata( $post->post_author );
+
+ if ( ! $author )
+ return false;
+
+ $args = array_slice( func_get_args(), 2 );
+ $args = array_merge( array( $capability ), $args );
- return $wp_roles->add_role($role, $display_name, $capabilities);
+ return call_user_func_array( array( $author, 'has_cap' ), $args );
}
-function remove_role($role) {
+/**
+ * Whether a particular user has capability or role.
+ *
+ * @since 3.1.0
+ *
+ * @param int|object $user User ID or object.
+ * @param string $capability Capability or role name.
+ * @return bool
+ */
+function user_can( $user, $capability ) {
+ if ( ! is_object( $user ) )
+ $user = get_userdata( $user );
+
+ if ( ! $user || ! $user->exists() )
+ return false;
+
+ $args = array_slice( func_get_args(), 2 );
+ $args = array_merge( array( $capability ), $args );
+
+ return call_user_func_array( array( $user, 'has_cap' ), $args );
+}
+
+/**
+ * Retrieves the global WP_Roles instance and instantiates it if necessary.
+ *
+ * @since 4.3.0
+ *
+ * @global WP_Roles $wp_roles WP_Roles global instance.
+ *
+ * @return WP_Roles WP_Roles global instance if not already instantiated.
+ */
+function wp_roles() {
global $wp_roles;
- if ( ! isset($wp_roles) )
+ if ( ! isset( $wp_roles ) ) {
$wp_roles = new WP_Roles();
+ }
+ return $wp_roles;
+}
+
+/**
+ * Retrieve role object.
+ *
+ * @since 2.0.0
+ *
+ * @param string $role Role name.
+ * @return WP_Role|null WP_Role object if found, null if the role does not exist.
+ */
+function get_role( $role ) {
+ return wp_roles()->get_role( $role );
+}
+
+/**
+ * Add role, if it does not exist.
+ *
+ * @since 2.0.0
+ *
+ * @param string $role Role name.
+ * @param string $display_name Display name for role.
+ * @param array $capabilities List of capabilities, e.g. array( 'edit_posts' => true, 'delete_posts' => false );
+ * @return WP_Role|null WP_Role object if role is added, null if already exists.
+ */
+function add_role( $role, $display_name, $capabilities = array() ) {
+ if ( empty( $role ) ) {
+ return;
+ }
+ return wp_roles()->add_role( $role, $display_name, $capabilities );
+}
+
+/**
+ * Remove role, if it exists.
+ *
+ * @since 2.0.0
+ *
+ * @param string $role Role name.
+ */
+function remove_role( $role ) {
+ wp_roles()->remove_role( $role );
+}
+
+/**
+ * Retrieve a list of super admins.
+ *
+ * @since 3.0.0
+ *
+ * @global array $super_admins
+ *
+ * @return array List of super admin logins
+ */
+function get_super_admins() {
+ global $super_admins;
+
+ if ( isset($super_admins) )
+ return $super_admins;
+ else
+ return get_site_option( 'site_admins', array('admin') );
+}
+
+/**
+ * Determine if user is a site admin.
+ *
+ * @since 3.0.0
+ *
+ * @param int $user_id (Optional) The ID of a user. Defaults to the current user.
+ * @return bool True if the user is a site admin.
+ */
+function is_super_admin( $user_id = false ) {
+ if ( ! $user_id || $user_id == get_current_user_id() )
+ $user = wp_get_current_user();
+ else
+ $user = get_userdata( $user_id );
+
+ if ( ! $user || ! $user->exists() )
+ return false;
+
+ if ( is_multisite() ) {
+ $super_admins = get_super_admins();
+ if ( is_array( $super_admins ) && in_array( $user->user_login, $super_admins ) )
+ return true;
+ } else {
+ if ( $user->has_cap('delete_users') )
+ return true;
+ }
- return $wp_roles->remove_role($role);
+ return false;
}
-?>
+/**
+ * Grants Super Admin privileges.
+ *
+ * @since 3.0.0
+ *
+ * @global array $super_admins
+ *
+ * @param int $user_id ID of the user to be granted Super Admin privileges.
+ * @return bool True on success, false on failure. This can fail when the user is
+ * already a super admin or when the `$super_admins` global is defined.
+ */
+function grant_super_admin( $user_id ) {
+ // If global super_admins override is defined, there is nothing to do here.
+ if ( isset( $GLOBALS['super_admins'] ) || ! is_multisite() ) {
+ return false;
+ }
+
+ /**
+ * Fires before the user is granted Super Admin privileges.
+ *
+ * @since 3.0.0
+ *
+ * @param int $user_id ID of the user that is about to be granted Super Admin privileges.
+ */
+ do_action( 'grant_super_admin', $user_id );
+
+ // Directly fetch site_admins instead of using get_super_admins()
+ $super_admins = get_site_option( 'site_admins', array( 'admin' ) );
+
+ $user = get_userdata( $user_id );
+ if ( $user && ! in_array( $user->user_login, $super_admins ) ) {
+ $super_admins[] = $user->user_login;
+ update_site_option( 'site_admins' , $super_admins );
+
+ /**
+ * Fires after the user is granted Super Admin privileges.
+ *
+ * @since 3.0.0
+ *
+ * @param int $user_id ID of the user that was granted Super Admin privileges.
+ */
+ do_action( 'granted_super_admin', $user_id );
+ return true;
+ }
+ return false;
+}
+
+/**
+ * Revokes Super Admin privileges.
+ *
+ * @since 3.0.0
+ *
+ * @global array $super_admins
+ *
+ * @param int $user_id ID of the user Super Admin privileges to be revoked from.
+ * @return bool True on success, false on failure. This can fail when the user's email
+ * is the network admin email or when the `$super_admins` global is defined.
+ */
+function revoke_super_admin( $user_id ) {
+ // If global super_admins override is defined, there is nothing to do here.
+ if ( isset( $GLOBALS['super_admins'] ) || ! is_multisite() ) {
+ return false;
+ }
+
+ /**
+ * Fires before the user's Super Admin privileges are revoked.
+ *
+ * @since 3.0.0
+ *
+ * @param int $user_id ID of the user Super Admin privileges are being revoked from.
+ */
+ do_action( 'revoke_super_admin', $user_id );
+
+ // Directly fetch site_admins instead of using get_super_admins()
+ $super_admins = get_site_option( 'site_admins', array( 'admin' ) );
+
+ $user = get_userdata( $user_id );
+ if ( $user && 0 !== strcasecmp( $user->user_email, get_site_option( 'admin_email' ) ) ) {
+ if ( false !== ( $key = array_search( $user->user_login, $super_admins ) ) ) {
+ unset( $super_admins[$key] );
+ update_site_option( 'site_admins', $super_admins );
+
+ /**
+ * Fires after the user's Super Admin privileges are revoked.
+ *
+ * @since 3.0.0
+ *
+ * @param int $user_id ID of the user Super Admin privileges were revoked from.
+ */
+ do_action( 'revoked_super_admin', $user_id );
+ return true;
+ }
+ }
+ return false;
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff