X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/6c8f14c09105d0afa4c1574215c59b5021040e76..5d244c8fd9a27c9f89dd08da2af6fbc67d4fce63:/wp-includes/capabilities.php diff --git a/wp-includes/capabilities.php b/wp-includes/capabilities.php index 3503316c..bdb5c7a2 100644 --- a/wp-includes/capabilities.php +++ b/wp-includes/capabilities.php @@ -13,14 +13,12 @@ * the name in value of the 'name' key. The capabilities are stored as an array * in the value of the 'capability' key. * - * - * array ( - * 'rolename' => array ( - * 'name' => 'rolename', - * 'capabilities' => array() - * ) - * ) - * + * array ( + * 'rolename' => array ( + * 'name' => 'rolename', + * 'capabilities' => array() + * ) + * ) * * @since 2.0.0 * @package WordPress @@ -34,7 +32,7 @@ class WP_Roles { * @access public * @var array */ - var $roles; + public $roles; /** * List of the role objects. @@ -43,7 +41,7 @@ class WP_Roles { * @access public * @var array */ - var $role_objects = array(); + public $role_objects = array(); /** * List of role names. @@ -52,7 +50,7 @@ class WP_Roles { * @access public * @var array */ - var $role_names = array(); + public $role_names = array(); /** * Option name for storing role list. @@ -61,7 +59,7 @@ class WP_Roles { * @access public * @var string */ - var $role_key; + public $role_key; /** * Whether to use the database for retrieval and storage. @@ -70,17 +68,31 @@ class WP_Roles { * @access public * @var bool */ - var $use_db = true; + public $use_db = true; /** * Constructor * * @since 2.0.0 */ - function __construct() { + public function __construct() { $this->_init(); } + /** + * Make private/protected methods readable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param callable $name Method to call. + * @param array $arguments Arguments to pass when calling. + * @return mixed|bool Return value of the callback, false otherwise. + */ + public function __call( $name, $arguments ) { + return call_user_func_array( array( $this, $name ), $arguments ); + } + /** * Set up the object properties. * @@ -90,12 +102,13 @@ class WP_Roles { * * @since 2.1.0 * @access protected - * @uses $wpdb Used to get the database prefix. + * + * @global wpdb $wpdb WordPress database abstraction object. * @global array $wp_user_roles Used to set the 'roles' property value. */ - function _init () { + protected function _init() { global $wpdb, $wp_user_roles; - $this->role_key = $wpdb->prefix . 'user_roles'; + $this->role_key = $wpdb->get_blog_prefix() . 'user_roles'; if ( ! empty( $wp_user_roles ) ) { $this->roles = $wp_user_roles; $this->use_db = false; @@ -123,15 +136,15 @@ class WP_Roles { * @since 3.5.0 * @access public */ - function reinit() { + public function reinit() { // There is no need to reinit if using the wp_user_roles global. if ( ! $this->use_db ) return; - global $wpdb, $wp_user_roles; + global $wpdb; // Duplicated from _init() to avoid an extra function call. - $this->role_key = $wpdb->prefix . 'user_roles'; + $this->role_key = $wpdb->get_blog_prefix() . 'user_roles'; $this->roles = get_option( $this->role_key ); if ( empty( $this->roles ) ) return; @@ -158,9 +171,9 @@ class WP_Roles { * @param string $role Role name. * @param string $display_name Role display name. * @param array $capabilities List of role capabilities in the above format. - * @return null|WP_Role WP_Role object if role is added, null if already exists. + * @return WP_Role|null WP_Role object if role is added, null if already exists. */ - function add_role( $role, $display_name, $capabilities = array() ) { + public function add_role( $role, $display_name, $capabilities = array() ) { if ( isset( $this->roles[$role] ) ) return; @@ -183,7 +196,7 @@ class WP_Roles { * * @param string $role Role name. */ - function remove_role( $role ) { + public function remove_role( $role ) { if ( ! isset( $this->role_objects[$role] ) ) return; @@ -193,6 +206,9 @@ class WP_Roles { if ( $this->use_db ) update_option( $this->role_key, $this->roles ); + + if ( get_option( 'default_role' ) == $role ) + update_option( 'default_role', 'subscriber' ); } /** @@ -205,7 +221,7 @@ class WP_Roles { * @param string $cap Capability name. * @param bool $grant Optional, default is true. Whether role is capable of performing capability. */ - function add_cap( $role, $cap, $grant = true ) { + public function add_cap( $role, $cap, $grant = true ) { if ( ! isset( $this->roles[$role] ) ) return; @@ -223,7 +239,7 @@ class WP_Roles { * @param string $role Role name. * @param string $cap Capability name. */ - function remove_cap( $role, $cap ) { + public function remove_cap( $role, $cap ) { if ( ! isset( $this->roles[$role] ) ) return; @@ -239,9 +255,9 @@ class WP_Roles { * @access public * * @param string $role Role name. - * @return object|null Null, if role does not exist. WP_Role object, if found. + * @return WP_Role|null WP_Role object if found, null if the role does not exist. */ - function get_role( $role ) { + public function get_role( $role ) { if ( isset( $this->role_objects[$role] ) ) return $this->role_objects[$role]; else @@ -256,7 +272,7 @@ class WP_Roles { * * @return array List of role names. */ - function get_names() { + public function get_names() { return $this->role_names; } @@ -269,7 +285,7 @@ class WP_Roles { * @param string $role Role name to look up. * @return bool */ - function is_role( $role ) { + public function is_role( $role ) { return isset( $this->role_names[$role] ); } } @@ -289,7 +305,7 @@ class WP_Role { * @access public * @var string */ - var $name; + public $name; /** * List of capabilities the role contains. @@ -298,7 +314,7 @@ class WP_Role { * @access public * @var array */ - var $capabilities; + public $capabilities; /** * Constructor - Set up object properties. @@ -312,7 +328,7 @@ class WP_Role { * @param string $role Role name. * @param array $capabilities List of capabilities. */ - function __construct( $role, $capabilities ) { + public function __construct( $role, $capabilities ) { $this->name = $role; $this->capabilities = $capabilities; } @@ -327,7 +343,7 @@ class WP_Role { * @param string $cap Capability name. * @param bool $grant Whether role has capability privilege. */ - function add_cap( $cap, $grant = true ) { + public function add_cap( $cap, $grant = true ) { global $wp_roles; if ( ! isset( $wp_roles ) ) @@ -350,7 +366,7 @@ class WP_Role { * * @param string $cap Capability name. */ - function remove_cap( $cap ) { + public function remove_cap( $cap ) { global $wp_roles; if ( ! isset( $wp_roles ) ) @@ -374,7 +390,16 @@ class WP_Role { * @param string $cap Capability name. * @return bool True, if user has capability. False, if doesn't have capability. */ - function has_cap( $cap ) { + public function has_cap( $cap ) { + /** + * Filter which capabilities a role has. + * + * @since 2.0.0 + * + * @param array $capabilities Array of role capabilities. + * @param string $cap Capability name. + * @param string $name Role name. + */ $capabilities = apply_filters( 'role_has_cap', $this->capabilities, $cap, $this->name ); if ( !empty( $capabilities[$cap] ) ) return $capabilities[$cap]; @@ -408,7 +433,7 @@ class WP_User { * @access public * @var int */ - var $ID = 0; + public $ID = 0; /** * The individual capabilities the user has been given. @@ -417,7 +442,7 @@ class WP_User { * @access public * @var array */ - var $caps = array(); + public $caps = array(); /** * User metadata option name. @@ -426,7 +451,7 @@ class WP_User { * @access public * @var string */ - var $cap_key; + public $cap_key; /** * The roles the user is part of. @@ -435,7 +460,7 @@ class WP_User { * @access public * @var array */ - var $roles = array(); + public $roles = array(); /** * All capabilities the user has, including individual and role based. @@ -444,7 +469,7 @@ class WP_User { * @access public * @var array */ - var $allcaps = array(); + public $allcaps = array(); /** * The filter context applied to user data fields. @@ -470,7 +495,7 @@ class WP_User { * @param int $blog_id Optional Blog ID, defaults to current blog. * @return WP_User */ - function __construct( $id = 0, $name = '', $blog_id = '' ) { + public function __construct( $id = 0, $name = '', $blog_id = '' ) { if ( ! isset( self::$back_compat_keys ) ) { $prefix = $GLOBALS['wpdb']->prefix; self::$back_compat_keys = array( @@ -511,7 +536,7 @@ class WP_User { * @param object $data User DB row object * @param int $blog_id Optional. The blog id to initialize for */ - function init( $data, $blog_id = '' ) { + public function init( $data, $blog_id = '' ) { $this->data = $data; $this->ID = (int) $data->ID; @@ -527,7 +552,7 @@ class WP_User { * @param string|int $value The field value * @return object Raw user object */ - static function get_data_by( $field, $value ) { + public static function get_data_by( $field, $value ) { global $wpdb; if ( 'id' == $field ) { @@ -535,7 +560,9 @@ class WP_User { // to int 1. if ( ! is_numeric( $value ) ) return false; - $value = absint( $value ); + $value = intval( $value ); + if ( $value < 1 ) + return false; } else { $value = trim( $value ); } @@ -584,8 +611,10 @@ class WP_User { * Magic method for checking the existence of a certain custom field * * @since 3.3.0 + * @param string $key + * @return bool */ - function __isset( $key ) { + public function __isset( $key ) { if ( 'id' == $key ) { _deprecated_argument( 'WP_User->id', '2.1', __( 'Use WP_User->ID instead.' ) ); $key = 'ID'; @@ -604,8 +633,10 @@ class WP_User { * Magic method for accessing custom fields * * @since 3.3.0 + * @param string $key + * @return mixed */ - function __get( $key ) { + public function __get( $key ) { if ( 'id' == $key ) { _deprecated_argument( 'WP_User->id', '2.1', __( 'Use WP_User->ID instead.' ) ); return $this->ID; @@ -631,7 +662,7 @@ class WP_User { * * @since 3.3.0 */ - function __set( $key, $value ) { + public function __set( $key, $value ) { if ( 'id' == $key ) { _deprecated_argument( 'WP_User->id', '2.1', __( 'Use WP_User->ID instead.' ) ); $this->ID = $value; @@ -649,7 +680,7 @@ class WP_User { * * @return bool True if user exists in the database, false if not. */ - function exists() { + public function exists() { return ! empty( $this->ID ); } @@ -662,7 +693,7 @@ class WP_User { * * @param string $key Property */ - function get( $key ) { + public function get( $key ) { return $this->__get( $key ); } @@ -675,18 +706,18 @@ class WP_User { * * @param string $key Property */ - function has_prop( $key ) { + public function has_prop( $key ) { return $this->__isset( $key ); } - /* + /** * Return an array representation. * * @since 3.5.0 * * @return array Array representation. */ - function to_array() { + public function to_array() { return get_object_vars( $this->data ); } @@ -707,7 +738,7 @@ class WP_User { global $wpdb; if ( empty($cap_key) ) - $this->cap_key = $wpdb->prefix . 'capabilities'; + $this->cap_key = $wpdb->get_blog_prefix() . 'capabilities'; else $this->cap_key = $cap_key; @@ -730,8 +761,10 @@ class WP_User { * @since 2.0.0 * @uses $wp_roles * @access public + * + * @return array List of all capabilities for the user. */ - function get_role_caps() { + public function get_role_caps() { global $wp_roles; if ( ! isset( $wp_roles ) ) @@ -748,6 +781,8 @@ class WP_User { $this->allcaps = array_merge( (array) $this->allcaps, (array) $the_role->capabilities ); } $this->allcaps = array_merge( (array) $this->allcaps, (array) $this->caps ); + + return $this->allcaps; } /** @@ -760,7 +795,7 @@ class WP_User { * * @param string $role Role name. */ - function add_role( $role ) { + public function add_role( $role ) { $this->caps[$role] = true; update_user_meta( $this->ID, $this->cap_key, $this->caps ); $this->get_role_caps(); @@ -775,7 +810,7 @@ class WP_User { * * @param string $role Role name. */ - function remove_role( $role ) { + public function remove_role( $role ) { if ( !in_array($role, $this->roles) ) return; unset( $this->caps[$role] ); @@ -796,13 +831,14 @@ class WP_User { * * @param string $role Role name. */ - function set_role( $role ) { + public function set_role( $role ) { if ( 1 == count( $this->roles ) && $role == current( $this->roles ) ) return; foreach ( (array) $this->roles as $oldrole ) unset( $this->caps[$oldrole] ); + $old_roles = $this->roles; if ( !empty( $role ) ) { $this->caps[$role] = true; $this->roles = array( $role => true ); @@ -812,7 +848,18 @@ class WP_User { update_user_meta( $this->ID, $this->cap_key, $this->caps ); $this->get_role_caps(); $this->update_user_level_from_caps(); - do_action( 'set_user_role', $this->ID, $role ); + + /** + * Fires after the user's role has changed. + * + * @since 2.9.0 + * @since 3.6.0 Added $old_roles to include an array of the user's previous roles. + * + * @param int $user_id The user ID. + * @param string $role The new role. + * @param array $old_roles An array of the user's previous roles. + */ + do_action( 'set_user_role', $this->ID, $role, $old_roles ); } /** @@ -834,7 +881,7 @@ class WP_User { * @param string $item Level capability name. * @return int Max Level. */ - function level_reduction( $max, $item ) { + public function level_reduction( $max, $item ) { if ( preg_match( '/^level_(10|[0-9])$/i', $item, $matches ) ) { $level = intval( $matches[1] ); return max( $max, $level ); @@ -853,10 +900,10 @@ class WP_User { * @since 2.0.0 * @access public */ - function update_user_level_from_caps() { + public function update_user_level_from_caps() { global $wpdb; $this->user_level = array_reduce( array_keys( $this->allcaps ), array( $this, 'level_reduction' ), 0 ); - update_user_meta( $this->ID, $wpdb->prefix . 'user_level', $this->user_level ); + update_user_meta( $this->ID, $wpdb->get_blog_prefix() . 'user_level', $this->user_level ); } /** @@ -868,7 +915,7 @@ class WP_User { * @param string $cap Capability name. * @param bool $grant Whether to grant capability to user. */ - function add_cap( $cap, $grant = true ) { + public function add_cap( $cap, $grant = true ) { $this->caps[$cap] = $grant; update_user_meta( $this->ID, $this->cap_key, $this->caps ); } @@ -881,7 +928,7 @@ class WP_User { * * @param string $cap Capability name. */ - function remove_cap( $cap ) { + public function remove_cap( $cap ) { if ( ! isset( $this->caps[$cap] ) ) return; unset( $this->caps[$cap] ); @@ -894,11 +941,11 @@ class WP_User { * @since 2.1.0 * @access public */ - function remove_all_caps() { + public function remove_all_caps() { global $wpdb; $this->caps = array(); delete_user_meta( $this->ID, $this->cap_key ); - delete_user_meta( $this->ID, $wpdb->prefix . 'user_level' ); + delete_user_meta( $this->ID, $wpdb->get_blog_prefix() . 'user_level' ); $this->get_role_caps(); } @@ -915,7 +962,7 @@ class WP_User { * @param string|int $cap Capability or role name to search. * @return bool True, if user has capability; false, if user does not have capability. */ - function has_cap( $cap ) { + public function has_cap( $cap ) { if ( is_numeric( $cap ) ) { _deprecated_argument( __FUNCTION__, '2.0', __('Usage of user levels by plugins and themes is deprecated. Use roles and capabilities instead.') ); $cap = $this->translate_level_to_cap( $cap ); @@ -932,8 +979,19 @@ class WP_User { return true; } + /** + * Dynamically filter a user's capabilities. + * + * @since 2.0.0 + * @since 3.7.0 Added the user object. + * + * @param array $allcaps An array of all the role's capabilities. + * @param array $caps Actual capabilities for meta capability. + * @param array $args Optional parameters passed to has_cap(), typically object ID. + * @param WP_User $user The user object. + */ // Must have ALL requested caps - $capabilities = apply_filters( 'user_has_cap', $this->allcaps, $caps, $args ); + $capabilities = apply_filters( 'user_has_cap', $this->allcaps, $caps, $args, $this ); $capabilities['exist'] = true; // Everyone is allowed to exist foreach ( (array) $caps as $cap ) { if ( empty( $capabilities[ $cap ] ) ) @@ -954,7 +1012,7 @@ class WP_User { * @param int $level Level number, 1 to 10. * @return string */ - function translate_level_to_cap( $level ) { + public function translate_level_to_cap( $level ) { return 'level_' . $level; } @@ -965,7 +1023,7 @@ class WP_User { * * @param int $blog_id Optional Blog ID, defaults to current blog. */ - function for_blog( $blog_id = '' ) { + public function for_blog( $blog_id = '' ) { global $wpdb; if ( ! empty( $blog_id ) ) $cap_key = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities'; @@ -1030,22 +1088,15 @@ function map_meta_cap( $cap, $user_id ) { break; } - $post_author_id = $post->post_author; - - // If no author set yet, default to current user for cap checks. - if ( ! $post_author_id ) - $post_author_id = $user_id; - - $post_author_data = $post_author_id == get_current_user_id() ? wp_get_current_user() : get_userdata( $post_author_id ); - - // If the user is the author... - if ( is_object( $post_author_data ) && $user_id == $post_author_data->ID ) { + // 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) ) + 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; @@ -1054,10 +1105,11 @@ function map_meta_cap( $cap, $user_id ) { // 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 ) + if ( 'publish' == $post->post_status ) { $caps[] = $post_type->cap->delete_published_posts; - elseif ( 'private' == $post->post_status ) + } elseif ( 'private' == $post->post_status ) { $caps[] = $post_type->cap->delete_private_posts; + } } break; // edit_post breaks down to edit_posts, edit_published_posts, or @@ -1065,6 +1117,8 @@ function map_meta_cap( $cap, $user_id ) { case 'edit_post': case 'edit_page': $post = get_post( $args[0] ); + if ( empty( $post ) ) + break; if ( 'revision' == $post->post_type ) { $post = get_post( $post->post_parent ); @@ -1080,22 +1134,15 @@ function map_meta_cap( $cap, $user_id ) { break; } - $post_author_id = $post->post_author; - - // If no author set yet, default to current user for cap checks. - if ( ! $post_author_id ) - $post_author_id = $user_id; - - $post_author_data = $post_author_id == get_current_user_id() ? wp_get_current_user() : get_userdata( $post_author_id ); - - // If the user is the author... - if ( is_object( $post_author_data ) && $user_id == $post_author_data->ID ) { + // 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) ) + 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; @@ -1104,10 +1151,11 @@ function map_meta_cap( $cap, $user_id ) { // 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 ) + if ( 'publish' == $post->post_status ) { $caps[] = $post_type->cap->edit_published_posts; - elseif ( 'private' == $post->post_status ) + } elseif ( 'private' == $post->post_status ) { $caps[] = $post_type->cap->edit_private_posts; + } } break; case 'read_post': @@ -1134,20 +1182,13 @@ function map_meta_cap( $cap, $user_id ) { break; } - $post_author_id = $post->post_author; - - // If no author set yet, default to current user for cap checks. - if ( ! $post_author_id ) - $post_author_id = $user_id; - - $post_author_data = $post_author_id == get_current_user_id() ? wp_get_current_user() : get_userdata( $post_author_id ); - - if ( is_object( $post_author_data ) && $user_id == $post_author_data->ID ) + if ( $post->post_author && $user_id == $post->post_author ) { $caps[] = $post_type->cap->read; - elseif ( $status_obj->private ) + } elseif ( $status_obj->private ) { $caps[] = $post_type->cap->read_private_posts; - else + } else { $caps = map_meta_cap( 'edit_post', $user_id, $post->ID ); + } break; case 'publish_post': $post = get_post( $args[0] ); @@ -1159,12 +1200,26 @@ function map_meta_cap( $cap, $user_id ) { case 'delete_post_meta': case 'add_post_meta': $post = get_post( $args[0] ); - $post_type_object = get_post_type_object( $post->post_type ); - $caps = map_meta_cap( $post_type_object->cap->edit_post, $user_id, $post->ID ); + $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; @@ -1174,10 +1229,10 @@ function map_meta_cap( $cap, $user_id ) { break; case 'edit_comment': $comment = get_comment( $args[0] ); + if ( empty( $comment ) ) + break; $post = get_post( $comment->comment_post_ID ); - $post_type_object = get_post_type_object( $post->post_type ); - - $caps = map_meta_cap( $post_type_object->cap->edit_post, $user_id, $post->ID ); + $caps = map_meta_cap( 'edit_post', $user_id, $post->ID ); break; case 'unfiltered_upload': if ( defined('ALLOW_UNFILTERED_UPLOADS') && ALLOW_UNFILTERED_UPLOADS && ( !is_multisite() || is_super_admin( $user_id ) ) ) @@ -1210,18 +1265,25 @@ function map_meta_cap( $cap, $user_id ) { 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 ) + if ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS ) { $caps[] = 'do_not_allow'; - elseif ( is_multisite() && ! is_super_admin( $user_id ) ) + } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) { $caps[] = 'do_not_allow'; - else + } elseif ( 'upload_themes' === $cap ) { + $caps[] = 'install_themes'; + } elseif ( 'upload_plugins' === $cap ) { + $caps[] = 'install_plugins'; + } else { $caps[] = $cap; + } break; case 'activate_plugins': $caps[] = $cap; @@ -1254,6 +1316,9 @@ function map_meta_cap( $cap, $user_id ) { else $caps[] = 'do_not_allow'; break; + case 'customize' : + $caps[] = 'edit_theme_options'; + break; default: // Handle meta capabilities for custom post types. $post_type_meta_caps = _post_type_meta_capabilities(); @@ -1266,7 +1331,17 @@ function map_meta_cap( $cap, $user_id ) { $caps[] = $cap; } - return apply_filters('map_meta_cap', $caps, $cap, $user_id, $args); + /** + * 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 ); } /** @@ -1299,21 +1374,25 @@ function current_user_can( $capability ) { * @return bool */ function current_user_can_for_blog( $blog_id, $capability ) { - if ( is_multisite() ) - switch_to_blog( $blog_id ); + $switched = is_multisite() ? switch_to_blog( $blog_id ) : false; $current_user = wp_get_current_user(); - if ( empty( $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 ( is_multisite() ) + if ( $switched ) { restore_current_blog(); + } return $can; } @@ -1371,7 +1450,7 @@ function user_can( $user, $capability ) { * @since 2.0.0 * * @param string $role Role name. - * @return object + * @return WP_Role|null WP_Role object if found, null if the role does not exist. */ function get_role( $role ) { global $wp_roles; @@ -1391,7 +1470,7 @@ function get_role( $role ) { * @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 null|WP_Role WP_Role object if role is added, null if already exists. + * @return WP_Role|null WP_Role object if role is added, null if already exists. */ function add_role( $role, $display_name, $capabilities = array() ) { global $wp_roles; @@ -1409,7 +1488,6 @@ function add_role( $role, $display_name, $capabilities = array() ) { * @since 2.0.0 * * @param string $role Role name. - * @return null */ function remove_role( $role ) { global $wp_roles; @@ -1417,7 +1495,7 @@ function remove_role( $role ) { if ( ! isset( $wp_roles ) ) $wp_roles = new WP_Roles(); - return $wp_roles->remove_role( $role ); + $wp_roles->remove_role( $role ); } /**