* the name in value of the 'name' key. The capabilities are stored as an array
* in the value of the 'capability' key.
*
- * <code>
- * array (
- * 'rolename' => array (
- * 'name' => 'rolename',
- * 'capabilities' => array()
- * )
- * )
- * </code>
+ * array (
+ * 'rolename' => array (
+ * 'name' => 'rolename',
+ * 'capabilities' => array()
+ * )
+ * )
*
* @since 2.0.0
* @package WordPress
* @access public
* @var array
*/
- var $roles;
+ public $roles;
/**
* List of the role objects.
* @access public
* @var array
*/
- var $role_objects = array();
+ public $role_objects = array();
/**
* List of role names.
* @access public
* @var array
*/
- var $role_names = array();
+ public $role_names = array();
/**
* Option name for storing role list.
* @access public
* @var string
*/
- var $role_key;
+ public $role_key;
/**
* Whether to use the database for retrieval and storage.
* @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 ) {
+ if ( '_init' === $name ) {
+ return call_user_func_array( array( $this, $name ), $arguments );
+ }
+ return false;
+ }
+
/**
* Set up the object properties.
*
*
* @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->get_blog_prefix() . 'user_roles';
if ( ! empty( $wp_user_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';
* @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;
*
* @param string $role Role name.
*/
- function remove_role( $role ) {
+ public function remove_role( $role ) {
if ( ! isset( $this->role_objects[$role] ) )
return;
* @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;
* @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;
* @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
*
* @return array List of role names.
*/
- function get_names() {
+ public function get_names() {
return $this->role_names;
}
* @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] );
}
}
* @access public
* @var string
*/
- var $name;
+ public $name;
/**
* List of capabilities the role contains.
* @access public
* @var array
*/
- var $capabilities;
+ public $capabilities;
/**
* Constructor - Set up object properties.
* @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;
}
* @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 ) )
*
* @param string $cap Capability name.
*/
- function remove_cap( $cap ) {
+ public function remove_cap( $cap ) {
global $wp_roles;
if ( ! isset( $wp_roles ) )
* @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];
* @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.
* @access public
* @var int
*/
- var $ID = 0;
+ public $ID = 0;
/**
* The individual capabilities the user has been given.
* @access public
* @var array
*/
- var $caps = array();
+ public $caps = array();
/**
* User metadata option name.
* @access public
* @var string
*/
- var $cap_key;
+ public $cap_key;
/**
* The roles the user is part of.
* @access public
* @var array
*/
- var $roles = array();
+ public $roles = array();
/**
* All capabilities the user has, including individual and role based.
* @access public
* @var array
*/
- var $allcaps = array();
+ public $allcaps = array();
/**
* The filter context applied to user data fields.
* @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(
);
}
- if ( is_a( $id, 'WP_User' ) ) {
+ if ( $id instanceof WP_User ) {
$this->init( $id->data, $blog_id );
return;
} elseif ( is_object( $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;
+ }
}
/**
* @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;
*
* @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 ) {
* 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 <code>WP_User->ID</code> instead.' ) );
$key = 'ID';
* 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 <code>WP_User->ID</code> instead.' ) );
return $this->ID;
*
* @since 3.3.0
*/
- function __set( $key, $value ) {
+ public function __set( $key, $value ) {
if ( 'id' == $key ) {
_deprecated_argument( 'WP_User->id', '2.1', __( 'Use <code>WP_User->ID</code> instead.' ) );
$this->ID = $value;
*
* @return bool True if user exists in the database, false if not.
*/
- function exists() {
+ public function exists() {
return ! empty( $this->ID );
}
*
* @param string $key Property
*/
- function get( $key ) {
+ public function get( $key ) {
return $this->__get( $key );
}
*
* @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 );
}
*
* @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 ) )
*
* @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();
*
* @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] );
*
* @param string $role Role name.
*/
- function set_role( $role ) {
+ public function set_role( $role ) {
if ( 1 == count( $this->roles ) && $role == current( $this->roles ) )
return;
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 );
}
* @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 );
* @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 );
* @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();
}
/**
*
* @param string $cap Capability name.
*/
- function remove_cap( $cap ) {
- if ( ! isset( $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();
}
/**
* @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 );
* @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 );
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, $this );
$capabilities['exist'] = true; // Everyone is allowed to exist
* @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;
}
*
* @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';
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;
// 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
case 'edit_post':
case 'edit_page':
$post = get_post( $args[0] );
- if ( empty( $post ) )
+ if ( empty( $post ) ) {
+ $caps[] = 'do_not_allow';
break;
+ }
if ( 'revision' == $post->post_type ) {
$post = get_post( $post->post_parent );
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;
// 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':
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] );
$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;
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;
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();
$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 );
}
/**
* @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;
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff