X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/341dfbb66f24f5145174c373267f889c31615cc5..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/capabilities.php?ds=sidebyside diff --git a/wp-includes/capabilities.php b/wp-includes/capabilities.php index 19bdaa48..42133f6f 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,34 @@ 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|false Return value of the callback, false otherwise. + */ + public function __call( $name, $arguments ) { + if ( '_init' === $name ) { + return call_user_func_array( array( $this, $name ), $arguments ); + } + return false; + } + /** * Set up the object properties. * @@ -90,12 +105,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; @@ -108,7 +124,39 @@ class WP_Roles { $this->role_objects = array(); $this->role_names = array(); - foreach ( (array) $this->roles as $role => $data ) { + foreach ( array_keys( $this->roles ) as $role ) { + $this->role_objects[$role] = new WP_Role( $role, $this->roles[$role]['capabilities'] ); + $this->role_names[$role] = $this->roles[$role]['name']; + } + } + + /** + * Reinitialize the object + * + * Recreates the role objects. This is typically called only by switch_to_blog() + * after switching wpdb to a new blog ID. + * + * @since 3.5.0 + * @access public + * + * @global wpdb $wpdb + */ + public function reinit() { + // There is no need to reinit if using the wp_user_roles global. + if ( ! $this->use_db ) + return; + + global $wpdb; + + // Duplicated from _init() to avoid an extra function call. + $this->role_key = $wpdb->get_blog_prefix() . 'user_roles'; + $this->roles = get_option( $this->role_key ); + if ( empty( $this->roles ) ) + return; + + $this->role_objects = array(); + $this->role_names = array(); + foreach ( array_keys( $this->roles ) as $role ) { $this->role_objects[$role] = new WP_Role( $role, $this->roles[$role]['capabilities'] ); $this->role_names[$role] = $this->roles[$role]['name']; } @@ -128,9 +176,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|void WP_Role object, if role is added. */ - function add_role( $role, $display_name, $capabilities = array() ) { + public function add_role( $role, $display_name, $capabilities = array() ) { if ( isset( $this->roles[$role] ) ) return; @@ -153,7 +201,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; @@ -163,6 +211,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' ); } /** @@ -175,7 +226,10 @@ 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; + $this->roles[$role]['capabilities'][$cap] = $grant; if ( $this->use_db ) update_option( $this->role_key, $this->roles ); @@ -190,7 +244,10 @@ 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; + unset( $this->roles[$role]['capabilities'][$cap] ); if ( $this->use_db ) update_option( $this->role_key, $this->roles ); @@ -203,9 +260,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 @@ -220,7 +277,7 @@ class WP_Roles { * * @return array List of role names. */ - function get_names() { + public function get_names() { return $this->role_names; } @@ -233,8 +290,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] ); } } @@ -254,7 +310,7 @@ class WP_Role { * @access public * @var string */ - var $name; + public $name; /** * List of capabilities the role contains. @@ -263,7 +319,7 @@ class WP_Role { * @access public * @var array */ - var $capabilities; + public $capabilities; /** * Constructor - Set up object properties. @@ -277,7 +333,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; } @@ -285,21 +341,15 @@ class WP_Role { /** * Assign role a capability. * - * @see WP_Roles::add_cap() Method uses implementation for role. * @since 2.0.0 * @access public * * @param string $cap Capability name. * @param bool $grant Whether role has capability privilege. */ - function add_cap( $cap, $grant = true ) { - global $wp_roles; - - if ( ! isset( $wp_roles ) ) - $wp_roles = new WP_Roles(); - + public function add_cap( $cap, $grant = true ) { $this->capabilities[$cap] = $grant; - $wp_roles->add_cap( $this->name, $cap, $grant ); + wp_roles()->add_cap( $this->name, $cap, $grant ); } /** @@ -315,14 +365,9 @@ class WP_Role { * * @param string $cap Capability name. */ - function remove_cap( $cap ) { - global $wp_roles; - - if ( ! isset( $wp_roles ) ) - $wp_roles = new WP_Roles(); - + public function remove_cap( $cap ) { unset( $this->capabilities[$cap] ); - $wp_roles->remove_cap( $this->name, $cap ); + wp_roles()->remove_cap( $this->name, $cap ); } /** @@ -339,7 +384,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]; @@ -355,16 +409,31 @@ class WP_Role { * @since 2.0.0 * @package WordPress * @subpackage User + * + * @property string $nickname + * @property string $user_description + * @property string $user_firstname + * @property string $user_lastname + * @property string $user_login + * @property string $user_pass + * @property string $user_nicename + * @property string $user_email + * @property string $user_url + * @property string $user_registered + * @property string $user_activation_key + * @property string $user_status + * @property string $display_name + * @property string $spam + * @property string $deleted */ class WP_User { /** * User data container. * * @since 2.0.0 - * @access private - * @var array + * @var object */ - var $data; + public $data; /** * The user's ID. @@ -373,7 +442,7 @@ class WP_User { * @access public * @var int */ - var $ID = 0; + public $ID = 0; /** * The individual capabilities the user has been given. @@ -382,7 +451,7 @@ class WP_User { * @access public * @var array */ - var $caps = array(); + public $caps = array(); /** * User metadata option name. @@ -391,7 +460,7 @@ class WP_User { * @access public * @var string */ - var $cap_key; + public $cap_key; /** * The roles the user is part of. @@ -400,7 +469,7 @@ class WP_User { * @access public * @var array */ - var $roles = array(); + public $roles = array(); /** * All capabilities the user has, including individual and role based. @@ -409,7 +478,7 @@ class WP_User { * @access public * @var array */ - var $allcaps = array(); + public $allcaps = array(); /** * The filter context applied to user data fields. @@ -420,6 +489,11 @@ class WP_User { */ var $filter = null; + /** + * @static + * @access private + * @var array + */ private static $back_compat_keys; /** @@ -430,12 +504,13 @@ class WP_User { * @since 2.0.0 * @access public * - * @param int|string $id User's ID + * @global wpdb $wpdb + * + * @param int|string|stdClass|WP_User $id User's ID, a WP_User object, or a user object from the DB. * @param string $name Optional. User's username * @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( @@ -448,18 +523,30 @@ class WP_User { ); } + if ( $id instanceof WP_User ) { + $this->init( $id->data, $blog_id ); + return; + } elseif ( is_object( $id ) ) { + $this->init( $id, $blog_id ); + return; + } + if ( ! empty( $id ) && ! is_numeric( $id ) ) { $name = $id; $id = 0; } - if ( $id ) + if ( $id ) { $data = self::get_data_by( 'id', $id ); - else + } else { $data = self::get_data_by( 'login', $name ); + } - if ( $data ) + if ( $data ) { $this->init( $data, $blog_id ); + } else { + $this->data = new stdClass; + } } /** @@ -468,7 +555,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; @@ -480,11 +567,15 @@ class WP_User { * * @since 3.3.0 * + * @static + * + * @global wpdb $wpdb + * * @param string $field The field to query against: 'id', 'slug', 'email' or 'login' * @param string|int $value The field value - * @return object Raw user object + * @return object|false Raw user object */ - static function get_data_by( $field, $value ) { + public static function get_data_by( $field, $value ) { global $wpdb; if ( 'id' == $field ) { @@ -492,7 +583,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 ); } @@ -537,12 +630,31 @@ class WP_User { return $user; } + /** + * Makes private/protected methods readable for backwards compatibility. + * + * @since 4.3.0 + * @access public + * + * @param callable $name Method to call. + * @param array $arguments Arguments to pass when calling. + * @return mixed|false Return value of the callback, false otherwise. + */ + public function __call( $name, $arguments ) { + if ( '_init_caps' === $name ) { + return call_user_func_array( array( $this, $name ), $arguments ); + } + return false; + } + /** * 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'; @@ -561,8 +673,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; @@ -588,7 +702,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; @@ -598,6 +712,18 @@ class WP_User { $this->data->$key = $value; } + /** + * Determine whether the user exists in the database. + * + * @since 3.4.0 + * @access public + * + * @return bool True if user exists in the database, false if not. + */ + public function exists() { + return ! empty( $this->ID ); + } + /** * Retrieve the value of a property or meta key. * @@ -606,8 +732,9 @@ class WP_User { * @since 3.3.0 * * @param string $key Property + * @return mixed */ - function get( $key ) { + public function get( $key ) { return $this->__get( $key ); } @@ -619,11 +746,23 @@ class WP_User { * @since 3.3.0 * * @param string $key Property + * @return bool */ - 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. + */ + public function to_array() { + return get_object_vars( $this->data ); + } + /** * Set up capability object properties. * @@ -635,13 +774,15 @@ class WP_User { * @access protected * @since 2.1.0 * + * @global wpdb $wpdb + * * @param string $cap_key Optional capability key */ - function _init_caps( $cap_key = '' ) { + protected function _init_caps( $cap_key = '' ) { 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; @@ -662,18 +803,16 @@ class WP_User { * granted permission to. * * @since 2.0.0 - * @uses $wp_roles * @access public + * + * @return array List of all capabilities for the user. */ - function get_role_caps() { - global $wp_roles; - - if ( ! isset( $wp_roles ) ) - $wp_roles = new WP_Roles(); + public function get_role_caps() { + $wp_roles = 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' ) ); + $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(); @@ -682,6 +821,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; } /** @@ -694,11 +835,21 @@ 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(); $this->update_user_level_from_caps(); + + /** + * Fires immediately after the user has been given a new role. + * + * @since 4.3.0 + * + * @param int $user_id The user ID. + * @param string $role The new role. + */ + do_action( 'add_user_role', $this->ID, $role ); } /** @@ -709,13 +860,23 @@ 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] ); update_user_meta( $this->ID, $this->cap_key, $this->caps ); $this->get_role_caps(); $this->update_user_level_from_caps(); + + /** + * Fires immediately after a role as been removed from a user. + * + * @since 4.3.0 + * + * @param int $user_id The user ID. + * @param string $role The removed role. + */ + do_action( 'remove_user_role', $this->ID, $role ); } /** @@ -730,13 +891,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] ); - if ( 1 == count( $this->roles ) && $role == $this->roles[0] ) - return; - + $old_roles = $this->roles; if ( !empty( $role ) ) { $this->caps[$role] = true; $this->roles = array( $role => true ); @@ -746,7 +908,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 ); } /** @@ -768,7 +941,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 ); @@ -786,11 +959,13 @@ class WP_User { * * @since 2.0.0 * @access public + * + * @global wpdb $wpdb */ - 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 ); } /** @@ -802,9 +977,11 @@ 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 ); + $this->get_role_caps(); + $this->update_user_level_from_caps(); } /** @@ -815,11 +992,14 @@ class WP_User { * * @param string $cap Capability name. */ - function remove_cap( $cap ) { - if ( empty( $this->caps[$cap] ) ) + public function remove_cap( $cap ) { + if ( ! isset( $this->caps[ $cap ] ) ) { return; - unset( $this->caps[$cap] ); + } + unset( $this->caps[ $cap ] ); update_user_meta( $this->ID, $this->cap_key, $this->caps ); + $this->get_role_caps(); + $this->update_user_level_from_caps(); } /** @@ -827,12 +1007,14 @@ class WP_User { * * @since 2.1.0 * @access public + * + * @global wpdb $wpdb */ - 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(); } @@ -841,16 +1023,15 @@ class WP_User { * * This is useful for looking up whether the user has a specific role * assigned to the user. The second optional parameter can also be used to - * check for capabilities against a specific post. + * check for capabilities against a specific object, such as a post or user. * * @since 2.0.0 * @access public * * @param string|int $cap Capability or role name to search. - * @param int $post_id Optional. Post ID to check capability against specific post. * @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 ); @@ -867,8 +1048,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 user'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 ] ) ) @@ -889,7 +1081,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; } @@ -898,9 +1090,11 @@ class WP_User { * * @since 3.0.0 * + * @global wpdb $wpdb + * * @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'; @@ -936,20 +1130,19 @@ function map_meta_cap( $cap, $user_id ) { $caps[] = 'promote_users'; break; case 'edit_user': + case 'edit_users': // Allow user to edit itself - if ( isset( $args[0] ) && $user_id == $args[0] ) + if ( 'edit_user' == $cap && isset( $args[0] ) && $user_id == $args[0] ) break; - // Fall through - case 'edit_users': + // 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'; // Explicit due to primitive fall through + $caps[] = 'edit_users'; // edit_user maps to edit_users. break; case 'delete_post': case 'delete_page': - $author_data = get_userdata( $user_id ); $post = get_post( $args[0] ); if ( 'revision' == $post->post_type ) { @@ -966,21 +1159,15 @@ function map_meta_cap( $cap, $user_id ) { break; } - if ( '' != $post->post_author ) { - $post_author_data = get_userdata( $post->post_author ); - } else { - // No author set yet, so default to current user for cap checks. - $post_author_data = $author_data; - } - - // 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; @@ -989,18 +1176,22 @@ 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 // edit_others_posts case 'edit_post': case 'edit_page': - $author_data = get_userdata( $user_id ); $post = get_post( $args[0] ); + if ( empty( $post ) ) { + $caps[] = 'do_not_allow'; + break; + } if ( 'revision' == $post->post_type ) { $post = get_post( $post->post_parent ); @@ -1016,22 +1207,15 @@ function map_meta_cap( $cap, $user_id ) { break; } - if ( '' != $post->post_author ) { - $post_author_data = get_userdata( $post->post_author ); - } else { - // No author set yet, so default to current user for cap checks. - $post_author_data = $author_data; - } - - //echo "current user id : $user_id, post author id: " . $post_author_data->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; @@ -1040,15 +1224,15 @@ 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': case 'read_page': - $author_data = get_userdata( $user_id ); $post = get_post( $args[0] ); if ( 'revision' == $post->post_type ) { @@ -1065,33 +1249,50 @@ function map_meta_cap( $cap, $user_id ) { break; } - if ( 'private' != $post->post_status ) { + $status_obj = get_post_status_object( $post->post_status ); + if ( $status_obj->public ) { $caps[] = $post_type->cap->read; break; } - if ( '' != $post->post_author ) { - $post_author_data = get_userdata( $post->post_author ); + 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 { - // No author set yet, so default to current user for cap checks. - $post_author_data = $author_data; + $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 ); - if ( is_object( $post_author_data ) && $user_id == $post_author_data->ID ) - $caps[] = $post_type->cap->read; - else - $caps[] = $post_type->cap->read_private_posts; + $caps[] = $post_type->cap->publish_posts; break; case 'edit_post_meta': 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; @@ -1101,10 +1302,19 @@ 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 ); + /* + * 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 ) ) ) @@ -1112,54 +1322,88 @@ function map_meta_cap( $cap, $user_id ) { 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': - if ( defined('DISALLOW_FILE_EDIT') && DISALLOW_FILE_EDIT ) { + // Disallow the file editors. + if ( defined( 'DISALLOW_FILE_EDIT' ) && DISALLOW_FILE_EDIT ) $caps[] = 'do_not_allow'; - break; - } - // Fall through if not DISALLOW_FILE_EDIT. + 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 edits core, plugin, or theme files. + // 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'; - break; - } - // Fall through if not DISALLOW_FILE_MODS. - case 'unfiltered_html': - // Disallow unfiltered_html for all users, even admins and super admins. - if ( defined('DISALLOW_UNFILTERED_HTML') && DISALLOW_UNFILTERED_HTML ) { + } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) { $caps[] = 'do_not_allow'; - break; + } 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'; } - // Fall through if not DISALLOW_UNFILTERED_HTML + break; case 'delete_user': case 'delete_users': - // If multisite these caps are allowed only for super admins. - if ( is_multisite() && !is_super_admin( $user_id ) ) { + // If multisite only super admins can delete users. + if ( is_multisite() && ! is_super_admin( $user_id ) ) $caps[] = 'do_not_allow'; - } else { - if ( 'delete_user' == $cap ) - $cap = 'delete_users'; - $caps[] = $cap; - } + else + $caps[] = 'delete_users'; // delete_user maps to delete_users. break; case 'create_users': if ( !is_multisite() ) $caps[] = $cap; - elseif ( is_super_admin() || get_site_option( 'add_new_users' ) ) + 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(); @@ -1172,7 +1416,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 ); } /** @@ -1205,21 +1459,27 @@ function current_user_can( $capability ) { * @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 ( empty( $current_user ) ) { + if ( $switched ) { + restore_current_blog(); + } return false; - - // Create new object to avoid stomping the global current_user. - $user = new WP_User( $current_user->ID) ; - - // Set the blog id. @todo add blog id arg to WP_User constructor? - $user->for_blog( $blog_id ); + } $args = array_slice( func_get_args(), 2 ); $args = array_merge( array( $capability ), $args ); - return call_user_func_array( array( &$user, 'has_cap' ), $args ); + $can = call_user_func_array( array( $current_user, 'has_cap' ), $args ); + + if ( $switched ) { + restore_current_blog(); + } + + return $can; } /** @@ -1235,15 +1495,15 @@ function author_can( $post, $capability ) { if ( !$post = get_post($post) ) return false; - $author = new WP_User( $post->post_author ); + $author = get_userdata( $post->post_author ); - if ( empty( $author->ID ) ) + 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 ); + return call_user_func_array( array( $author, 'has_cap' ), $args ); } /** @@ -1257,71 +1517,70 @@ function author_can( $post, $capability ) { */ function user_can( $user, $capability ) { if ( ! is_object( $user ) ) - $user = new WP_User( $user ); + $user = get_userdata( $user ); - if ( ! $user || ! $user->ID ) + 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 ); + return call_user_func_array( array( $user, 'has_cap' ), $args ); } /** - * Retrieve role object. + * Retrieves the global WP_Roles instance and instantiates it if necessary. * - * @see WP_Roles::get_role() Uses method to retrieve role object. - * @since 2.0.0 + * @since 4.3.0 * - * @param string $role Role name. - * @return object + * @global WP_Roles $wp_roles WP_Roles global instance. + * + * @return WP_Roles WP_Roles global instance if not already instantiated. */ -function get_role( $role ) { +function wp_roles() { global $wp_roles; - if ( ! isset( $wp_roles ) ) + if ( ! isset( $wp_roles ) ) { $wp_roles = new WP_Roles(); + } + return $wp_roles; +} - return $wp_roles->get_role( $role ); +/** + * 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. * - * @see WP_Roles::add_role() Uses method to add role. * @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 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; - - if ( ! isset( $wp_roles ) ) - $wp_roles = new WP_Roles(); - - return $wp_roles->add_role( $role, $display_name, $capabilities ); + return wp_roles()->add_role( $role, $display_name, $capabilities ); } /** * Remove role, if it exists. * - * @see WP_Roles::remove_role() Uses method to remove role. * @since 2.0.0 * * @param string $role Role name. - * @return null */ function remove_role( $role ) { - global $wp_roles; - - if ( ! isset( $wp_roles ) ) - $wp_roles = new WP_Roles(); - - return $wp_roles->remove_role( $role ); + wp_roles()->remove_role( $role ); } /** @@ -1329,7 +1588,7 @@ function remove_role( $role ) { * * @since 3.0.0 * - * @uses $super_admins Super admins global variable, if set. + * @global array $super_admins * * @return array List of super admin logins */ @@ -1351,12 +1610,12 @@ function get_super_admins() { * @return bool True if the user is a site admin. */ function is_super_admin( $user_id = false ) { - if ( $user_id ) - $user = new WP_User( $user_id ); - else + if ( ! $user_id || $user_id == get_current_user_id() ) $user = wp_get_current_user(); + else + $user = get_userdata( $user_id ); - if ( empty( $user->ID ) ) + if ( ! $user || ! $user->exists() ) return false; if ( is_multisite() ) { @@ -1370,5 +1629,3 @@ function is_super_admin( $user_id = false ) { return false; } - -?>