X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fa11948979fd6a4ea5705dc613b239699a459db3..9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f:/wp-includes/capabilities.php diff --git a/wp-includes/capabilities.php b/wp-includes/capabilities.php index 75a834b4..30c38b2c 100644 --- a/wp-includes/capabilities.php +++ b/wp-includes/capabilities.php @@ -34,7 +34,7 @@ class WP_Roles { * @access public * @var array */ - var $roles; + public $roles; /** * List of the role objects. @@ -43,7 +43,7 @@ class WP_Roles { * @access public * @var array */ - var $role_objects = array(); + public $role_objects = array(); /** * List of role names. @@ -52,7 +52,7 @@ class WP_Roles { * @access public * @var array */ - var $role_names = array(); + public $role_names = array(); /** * Option name for storing role list. @@ -61,7 +61,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 +70,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. * @@ -93,7 +107,7 @@ class WP_Roles { * @uses $wpdb Used to get the database prefix. * @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->get_blog_prefix() . 'user_roles'; if ( ! empty( $wp_user_roles ) ) { @@ -123,12 +137,12 @@ 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->get_blog_prefix() . 'user_roles'; @@ -160,7 +174,7 @@ class WP_Roles { * @param array $capabilities List of role capabilities in the above format. * @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 +197,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; @@ -208,7 +222,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; @@ -226,7 +240,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; @@ -244,7 +258,7 @@ class WP_Roles { * @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 ) { + public function get_role( $role ) { if ( isset( $this->role_objects[$role] ) ) return $this->role_objects[$role]; else @@ -259,7 +273,7 @@ class WP_Roles { * * @return array List of role names. */ - function get_names() { + public function get_names() { return $this->role_names; } @@ -272,7 +286,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] ); } } @@ -292,7 +306,7 @@ class WP_Role { * @access public * @var string */ - var $name; + public $name; /** * List of capabilities the role contains. @@ -301,7 +315,7 @@ class WP_Role { * @access public * @var array */ - var $capabilities; + public $capabilities; /** * Constructor - Set up object properties. @@ -315,7 +329,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; } @@ -330,7 +344,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 ) ) @@ -353,7 +367,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 ) ) @@ -377,7 +391,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]; @@ -411,7 +434,7 @@ class WP_User { * @access public * @var int */ - var $ID = 0; + public $ID = 0; /** * The individual capabilities the user has been given. @@ -420,7 +443,7 @@ class WP_User { * @access public * @var array */ - var $caps = array(); + public $caps = array(); /** * User metadata option name. @@ -429,7 +452,7 @@ class WP_User { * @access public * @var string */ - var $cap_key; + public $cap_key; /** * The roles the user is part of. @@ -438,7 +461,7 @@ class WP_User { * @access public * @var array */ - var $roles = array(); + public $roles = array(); /** * All capabilities the user has, including individual and role based. @@ -447,7 +470,7 @@ class WP_User { * @access public * @var array */ - var $allcaps = array(); + public $allcaps = array(); /** * The filter context applied to user data fields. @@ -473,7 +496,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( @@ -514,7 +537,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; @@ -530,7 +553,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 ) { @@ -590,7 +613,7 @@ class WP_User { * * @since 3.3.0 */ - function __isset( $key ) { + public function __isset( $key ) { if ( 'id' == $key ) { _deprecated_argument( 'WP_User->id', '2.1', __( 'Use WP_User->ID instead.' ) ); $key = 'ID'; @@ -610,7 +633,7 @@ class WP_User { * * @since 3.3.0 */ - 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; @@ -636,7 +659,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; @@ -654,7 +677,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 ); } @@ -667,7 +690,7 @@ class WP_User { * * @param string $key Property */ - function get( $key ) { + public function get( $key ) { return $this->__get( $key ); } @@ -680,18 +703,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 ); } @@ -738,7 +761,7 @@ class WP_User { * * @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 ) ) @@ -769,7 +792,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(); @@ -784,7 +807,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] ); @@ -805,7 +828,7 @@ 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; @@ -822,6 +845,17 @@ class WP_User { update_user_meta( $this->ID, $this->cap_key, $this->caps ); $this->get_role_caps(); $this->update_user_level_from_caps(); + + /** + * 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 ); } @@ -844,7 +878,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 ); @@ -863,7 +897,7 @@ 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->get_blog_prefix() . 'user_level', $this->user_level ); @@ -878,7 +912,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 ); } @@ -891,7 +925,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] ); @@ -904,7 +938,7 @@ 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 ); @@ -925,7 +959,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 ); @@ -942,6 +976,17 @@ 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, $this ); $capabilities['exist'] = true; // Everyone is allowed to exist @@ -964,7 +1009,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; } @@ -975,7 +1020,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'; @@ -1040,20 +1085,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; - - // If the user is the author... - if ( $user_id == $post_author_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; @@ -1062,10 +1102,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 @@ -1090,20 +1131,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; - - // If the user is the author... - if ( $user_id == $post_author_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; @@ -1112,10 +1148,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': @@ -1142,18 +1179,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; - - if ( $user_id == $post_author_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] ); @@ -1170,6 +1202,21 @@ function map_meta_cap( $cap, $user_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 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; @@ -1215,18 +1262,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; @@ -1259,6 +1313,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(); @@ -1271,7 +1328,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 ); } /**