mirror of
https://github.com/WordPress/WordPress.git
synced 2024-11-05 02:10:45 +01:00
df1c0c2363
Creates: `class-wp-roles.php` `class-wp-role.php` `class-wp-user.php` `capbilities-functions.php` `capbilities.php` contains only top-level code. Class files only contains classes. Functions file only contains functions. See #33413. Built from https://develop.svn.wordpress.org/trunk@33752 git-svn-id: http://core.svn.wordpress.org/trunk@33720 1a063a9b-81f0-0310-95a4-ce76da25c4cd
534 lines
14 KiB
PHP
534 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* WordPress Roles and Capabilities.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage User
|
|
*/
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @param string $cap Capability name.
|
|
* @param int $user_id User ID.
|
|
* @return array Actual capabilities for meta capability.
|
|
*/
|
|
function map_meta_cap( $cap, $user_id ) {
|
|
$args = array_slice( func_get_args(), 2 );
|
|
$caps = array();
|
|
|
|
switch ( $cap ) {
|
|
case 'remove_user':
|
|
$caps[] = 'remove_users';
|
|
break;
|
|
case 'promote_user':
|
|
$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;
|
|
|
|
// If multisite these caps are allowed only for super admins.
|
|
if ( is_multisite() && !is_super_admin( $user_id ) )
|
|
$caps[] = 'do_not_allow';
|
|
else
|
|
$caps[] = 'edit_users'; // edit_user maps to edit_users.
|
|
break;
|
|
case 'delete_post':
|
|
case 'delete_page':
|
|
$post = get_post( $args[0] );
|
|
|
|
if ( 'revision' == $post->post_type ) {
|
|
$post = get_post( $post->post_parent );
|
|
}
|
|
|
|
$post_type = get_post_type_object( $post->post_type );
|
|
|
|
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;
|
|
}
|
|
|
|
// 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...
|
|
if ( 'publish' == $post->post_status ) {
|
|
$caps[] = $post_type->cap->delete_published_posts;
|
|
} elseif ( 'trash' == $post->post_status ) {
|
|
if ( 'publish' == get_post_meta( $post->ID, '_wp_trash_meta_status', true ) ) {
|
|
$caps[] = $post_type->cap->delete_published_posts;
|
|
}
|
|
} else {
|
|
// If the post is draft...
|
|
$caps[] = $post_type->cap->delete_posts;
|
|
}
|
|
} else {
|
|
// The user is trying to edit someone else's post.
|
|
$caps[] = $post_type->cap->delete_others_posts;
|
|
// The post is published, extra cap required.
|
|
if ( 'publish' == $post->post_status ) {
|
|
$caps[] = $post_type->cap->delete_published_posts;
|
|
} elseif ( 'private' == $post->post_status ) {
|
|
$caps[] = $post_type->cap->delete_private_posts;
|
|
}
|
|
}
|
|
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 ( empty( $post ) ) {
|
|
$caps[] = 'do_not_allow';
|
|
break;
|
|
}
|
|
|
|
if ( 'revision' == $post->post_type ) {
|
|
$post = get_post( $post->post_parent );
|
|
}
|
|
|
|
$post_type = get_post_type_object( $post->post_type );
|
|
|
|
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;
|
|
}
|
|
|
|
// 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...
|
|
if ( 'publish' == $post->post_status ) {
|
|
$caps[] = $post_type->cap->edit_published_posts;
|
|
} elseif ( 'trash' == $post->post_status ) {
|
|
if ( 'publish' == get_post_meta( $post->ID, '_wp_trash_meta_status', true ) ) {
|
|
$caps[] = $post_type->cap->edit_published_posts;
|
|
}
|
|
} else {
|
|
// If the post is draft...
|
|
$caps[] = $post_type->cap->edit_posts;
|
|
}
|
|
} else {
|
|
// The user is trying to edit someone else's post.
|
|
$caps[] = $post_type->cap->edit_others_posts;
|
|
// The post is published, extra cap required.
|
|
if ( 'publish' == $post->post_status ) {
|
|
$caps[] = $post_type->cap->edit_published_posts;
|
|
} elseif ( 'private' == $post->post_status ) {
|
|
$caps[] = $post_type->cap->edit_private_posts;
|
|
}
|
|
}
|
|
break;
|
|
case 'read_post':
|
|
case 'read_page':
|
|
$post = get_post( $args[0] );
|
|
|
|
if ( 'revision' == $post->post_type ) {
|
|
$post = get_post( $post->post_parent );
|
|
}
|
|
|
|
$post_type = get_post_type_object( $post->post_type );
|
|
|
|
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 {
|
|
$caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
|
|
}
|
|
break;
|
|
case 'publish_post':
|
|
$post = get_post( $args[0] );
|
|
$post_type = get_post_type_object( $post->post_type );
|
|
|
|
$caps[] = $post_type->cap->publish_posts;
|
|
break;
|
|
case 'edit_post_meta':
|
|
case 'delete_post_meta':
|
|
case 'add_post_meta':
|
|
$post = get_post( $args[0] );
|
|
$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}" ) ) {
|
|
/**
|
|
* Filter 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 {@see 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 );
|
|
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 ( empty( $comment ) )
|
|
break;
|
|
$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[] = '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.
|
|
$post_type_meta_caps = _post_type_meta_capabilities();
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Filter 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 );
|
|
}
|
|
|
|
/**
|
|
* Whether current user has capability or role.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param string $capability Capability or role name.
|
|
* @return bool
|
|
*/
|
|
function current_user_can( $capability ) {
|
|
$current_user = wp_get_current_user();
|
|
|
|
if ( empty( $current_user ) )
|
|
return false;
|
|
|
|
$args = array_slice( func_get_args(), 1 );
|
|
$args = array_merge( array( $capability ), $args );
|
|
|
|
return call_user_func_array( array( $current_user, 'has_cap' ), $args );
|
|
}
|
|
|
|
/**
|
|
* Whether current user has a capability or role for a given blog.
|
|
*
|
|
* @since 3.0.0
|
|
*
|
|
* @param int $blog_id Blog 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;
|
|
|
|
$current_user = wp_get_current_user();
|
|
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
|
|
$author = get_userdata( $post->post_author );
|
|
|
|
if ( ! $author )
|
|
return false;
|
|
|
|
$args = array_slice( func_get_args(), 2 );
|
|
$args = array_merge( array( $capability ), $args );
|
|
|
|
return call_user_func_array( array( $author, 'has_cap' ), $args );
|
|
}
|
|
|
|
/**
|
|
* 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 ) ) {
|
|
$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() ) {
|
|
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 false;
|
|
}
|