X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/449d082fcc4873c1f7d363a0d9f7409be7f6e77d..46588ee871246a923d972538dbc93b26f4fda932:/wp-includes/capabilities.php?ds=sidebyside
diff --git a/wp-includes/capabilities.php b/wp-includes/capabilities.php
index ab6ec352..8a3d3350 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,22 +68,36 @@ class WP_Roles {
* @access public
* @var bool
*/
- var $use_db = true;
+ public $use_db = true;
/**
- * PHP4 Constructor - Call {@link WP_Roles::_init()} method.
+ * Constructor
*
* @since 2.0.0
+ */
+ public function __construct() {
+ $this->_init();
+ }
+
+ /**
+ * Make private/protected methods readable for backwards compatibility.
+ *
+ * @since 4.0.0
* @access public
*
- * @return WP_Roles
+ * @param callable $name Method to call.
+ * @param array $arguments Arguments to pass when calling.
+ * @return mixed|bool Return value of the callback, false otherwise.
*/
- function WP_Roles() {
- $this->_init();
+ public function __call( $name, $arguments ) {
+ if ( '_init' === $name ) {
+ return call_user_func_array( array( $this, $name ), $arguments );
+ }
+ return false;
}
/**
- * Setup the object properties.
+ * Set up the object properties.
*
* The role key is set to the current prefix for the $wpdb object with
* 'user_roles' appended. If the $wp_user_roles global is set, then it will
@@ -93,13 +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 () {
- global $wpdb;
- global $wp_user_roles;
- $this->role_key = $wpdb->prefix . 'user_roles';
+ protected function _init() {
+ global $wpdb, $wp_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;
@@ -112,7 +124,37 @@ 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
+ */
+ 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'];
}
@@ -123,15 +165,18 @@ class WP_Roles {
*
* Updates the list of roles, if the role doesn't already exist.
*
+ * The capabilities are defined in the following format `array( 'read' => true );`
+ * To explicitly deny a role a capability you set the value for that capability to false.
+ *
* @since 2.0.0
* @access public
*
* @param string $role Role name.
* @param string $display_name Role display name.
- * @param array $capabilities List of role capabilities.
- * @return null|WP_Role WP_Role object if role is added, null if already exists.
+ * @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;
@@ -154,7 +199,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;
@@ -164,6 +209,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' );
}
/**
@@ -174,9 +222,12 @@ class WP_Roles {
*
* @param string $role Role name.
* @param string $cap Capability name.
- * @param bool $grant Optional, default is true. Whether role is capable of preforming capability.
+ * @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 );
@@ -191,7 +242,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 );
@@ -204,9 +258,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
@@ -221,7 +275,7 @@ class WP_Roles {
*
* @return array List of role names.
*/
- function get_names() {
+ public function get_names() {
return $this->role_names;
}
@@ -234,8 +288,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] );
}
}
@@ -255,7 +308,7 @@ class WP_Role {
* @access public
* @var string
*/
- var $name;
+ public $name;
/**
* List of capabilities the role contains.
@@ -264,22 +317,21 @@ class WP_Role {
* @access public
* @var array
*/
- var $capabilities;
+ public $capabilities;
/**
- * PHP4 Constructor - Setup object properties.
+ * Constructor - Set up object properties.
*
* The list of capabilities, must have the key as the name of the capability
- * and the value a boolean of whether it is granted to the role or not.
+ * and the value a boolean of whether it is granted to the role.
*
* @since 2.0.0
* @access public
*
* @param string $role Role name.
* @param array $capabilities List of capabilities.
- * @return WP_Role
*/
- function WP_Role( $role, $capabilities ) {
+ public function __construct( $role, $capabilities ) {
$this->name = $role;
$this->capabilities = $capabilities;
}
@@ -294,7 +346,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 ) )
@@ -317,7 +369,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 ) )
@@ -341,7 +393,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];
@@ -357,18 +418,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.
*
- * This will be set as properties of the object.
- *
* @since 2.0.0
- * @access private
- * @var array
+ * @var object
*/
- var $data;
+ public $data;
/**
* The user's ID.
@@ -377,18 +451,7 @@ class WP_User {
* @access public
* @var int
*/
- var $ID = 0;
-
- /**
- * The deprecated user's ID.
- *
- * @since 2.0.0
- * @access public
- * @deprecated Use WP_User::$ID
- * @see WP_User::$ID
- * @var int
- */
- var $id = 0;
+ public $ID = 0;
/**
* The individual capabilities the user has been given.
@@ -397,7 +460,7 @@ class WP_User {
* @access public
* @var array
*/
- var $caps = array();
+ public $caps = array();
/**
* User metadata option name.
@@ -406,7 +469,7 @@ class WP_User {
* @access public
* @var string
*/
- var $cap_key;
+ public $cap_key;
/**
* The roles the user is part of.
@@ -415,7 +478,7 @@ class WP_User {
* @access public
* @var array
*/
- var $roles = array();
+ public $roles = array();
/**
* All capabilities the user has, including individual and role based.
@@ -424,87 +487,287 @@ class WP_User {
* @access public
* @var array
*/
- var $allcaps = array();
+ public $allcaps = array();
/**
- * First name of the user.
+ * The filter context applied to user data fields.
*
- * Created to prevent notices.
- *
- * @since 2.7.0
- * @access public
+ * @since 2.9.0
+ * @access private
* @var string
*/
- var $first_name = '';
+ var $filter = null;
- /**
- * Last name of the user.
- *
- * Created to prevent notices.
- *
- * @since 2.7.0
- * @access public
- * @var string
- */
- var $last_name = '';
+ private static $back_compat_keys;
/**
- * PHP4 Constructor - Sets up the object properties.
+ * Constructor
*
- * Retrieves the userdata and then assigns all of the data keys to direct
- * properties of the object. Calls {@link WP_User::_init_caps()} after
- * setting up the object's user data properties.
+ * Retrieves the userdata and passes it to {@link WP_User::init()}.
*
* @since 2.0.0
* @access public
*
- * @param int|string $id User's ID or username
- * @param int $name Optional. User's username
- * @return WP_User
+ * @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.
*/
- function WP_User( $id, $name = '' ) {
+ public function __construct( $id = 0, $name = '', $blog_id = '' ) {
+ if ( ! isset( self::$back_compat_keys ) ) {
+ $prefix = $GLOBALS['wpdb']->prefix;
+ self::$back_compat_keys = array(
+ 'user_firstname' => 'first_name',
+ 'user_lastname' => 'last_name',
+ 'user_description' => 'description',
+ 'user_level' => $prefix . 'user_level',
+ $prefix . 'usersettings' => $prefix . 'user-settings',
+ $prefix . 'usersettingstime' => $prefix . 'user-settings-time',
+ );
+ }
- if ( empty( $id ) && empty( $name ) )
+ if ( $id instanceof WP_User ) {
+ $this->init( $id->data, $blog_id );
+ return;
+ } elseif ( is_object( $id ) ) {
+ $this->init( $id, $blog_id );
return;
+ }
- if ( ! is_numeric( $id ) ) {
+ if ( ! empty( $id ) && ! is_numeric( $id ) ) {
$name = $id;
$id = 0;
}
- if ( ! empty( $id ) )
- $this->data = get_userdata( $id );
- else
- $this->data = get_userdatabylogin( $name );
+ if ( $id ) {
+ $data = self::get_data_by( 'id', $id );
+ } else {
+ $data = self::get_data_by( 'login', $name );
+ }
- if ( empty( $this->data->ID ) )
- return;
+ if ( $data ) {
+ $this->init( $data, $blog_id );
+ } else {
+ $this->data = new stdClass;
+ }
+ }
+
+ /**
+ * Sets up object properties, including capabilities.
+ *
+ * @param object $data User DB row object
+ * @param int $blog_id Optional. The blog id to initialize for
+ */
+ public function init( $data, $blog_id = '' ) {
+ $this->data = $data;
+ $this->ID = (int) $data->ID;
+
+ $this->for_blog( $blog_id );
+ }
+
+ /**
+ * Return only the main user fields
+ *
+ * @since 3.3.0
+ *
+ * @param string $field The field to query against: 'id', 'slug', 'email' or 'login'
+ * @param string|int $value The field value
+ * @return object|false Raw user object
+ */
+ public static function get_data_by( $field, $value ) {
+ global $wpdb;
- foreach ( get_object_vars( $this->data ) as $key => $value ) {
- $this->{$key} = $value;
+ if ( 'id' == $field ) {
+ // Make sure the value is numeric to avoid casting objects, for example,
+ // to int 1.
+ if ( ! is_numeric( $value ) )
+ return false;
+ $value = intval( $value );
+ if ( $value < 1 )
+ return false;
+ } else {
+ $value = trim( $value );
}
- $this->id = $this->ID;
- $this->_init_caps();
+ if ( !$value )
+ return false;
+
+ switch ( $field ) {
+ case 'id':
+ $user_id = $value;
+ $db_field = 'ID';
+ break;
+ case 'slug':
+ $user_id = wp_cache_get($value, 'userslugs');
+ $db_field = 'user_nicename';
+ break;
+ case 'email':
+ $user_id = wp_cache_get($value, 'useremail');
+ $db_field = 'user_email';
+ break;
+ case 'login':
+ $value = sanitize_user( $value );
+ $user_id = wp_cache_get($value, 'userlogins');
+ $db_field = 'user_login';
+ break;
+ default:
+ return false;
+ }
+
+ if ( false !== $user_id ) {
+ if ( $user = wp_cache_get( $user_id, 'users' ) )
+ return $user;
+ }
+
+ if ( !$user = $wpdb->get_row( $wpdb->prepare(
+ "SELECT * FROM $wpdb->users WHERE $db_field = %s", $value
+ ) ) )
+ return false;
+
+ update_user_caches( $user );
+
+ return $user;
}
/**
- * Setup capability object properties.
+ * Magic method for checking the existence of a certain custom field
+ *
+ * @since 3.3.0
+ * @param string $key
+ * @return bool
+ */
+ public function __isset( $key ) {
+ if ( 'id' == $key ) {
+ _deprecated_argument( 'WP_User->id', '2.1', __( 'Use WP_User->ID
instead.' ) );
+ $key = 'ID';
+ }
+
+ if ( isset( $this->data->$key ) )
+ return true;
+
+ if ( isset( self::$back_compat_keys[ $key ] ) )
+ $key = self::$back_compat_keys[ $key ];
+
+ return metadata_exists( 'user', $this->ID, $key );
+ }
+
+ /**
+ * Magic method for accessing custom fields
+ *
+ * @since 3.3.0
+ * @param string $key
+ * @return mixed
+ */
+ public function __get( $key ) {
+ if ( 'id' == $key ) {
+ _deprecated_argument( 'WP_User->id', '2.1', __( 'Use WP_User->ID
instead.' ) );
+ return $this->ID;
+ }
+
+ if ( isset( $this->data->$key ) ) {
+ $value = $this->data->$key;
+ } else {
+ if ( isset( self::$back_compat_keys[ $key ] ) )
+ $key = self::$back_compat_keys[ $key ];
+ $value = get_user_meta( $this->ID, $key, true );
+ }
+
+ if ( $this->filter ) {
+ $value = sanitize_user_field( $key, $value, $this->ID, $this->filter );
+ }
+
+ return $value;
+ }
+
+ /**
+ * Magic method for setting custom fields
+ *
+ * @since 3.3.0
+ */
+ public function __set( $key, $value ) {
+ if ( 'id' == $key ) {
+ _deprecated_argument( 'WP_User->id', '2.1', __( 'Use WP_User->ID
instead.' ) );
+ $this->ID = $value;
+ return;
+ }
+
+ $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.
+ *
+ * Retrieves from the users and usermeta table.
+ *
+ * @since 3.3.0
+ *
+ * @param string $key Property
+ */
+ public function get( $key ) {
+ return $this->__get( $key );
+ }
+
+ /**
+ * Determine whether a property or meta key is set
+ *
+ * Consults the users and usermeta tables.
+ *
+ * @since 3.3.0
+ *
+ * @param string $key Property
+ */
+ 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.
*
* Will set the value for the 'cap_key' property to current database table
* prefix, followed by 'capabilities'. Will then check to see if the
* property matching the 'cap_key' exists and is an array. If so, it will be
* used.
*
- * @since 2.1.0
* @access protected
+ * @since 2.1.0
+ *
+ * @param string $cap_key Optional capability key
*/
- function _init_caps() {
+ function _init_caps( $cap_key = '' ) {
global $wpdb;
- $this->cap_key = $wpdb->prefix . 'capabilities';
- $this->caps = &$this->{$this->cap_key};
+
+ if ( empty($cap_key) )
+ $this->cap_key = $wpdb->get_blog_prefix() . 'capabilities';
+ else
+ $this->cap_key = $cap_key;
+
+ $this->caps = get_user_meta( $this->ID, $this->cap_key, true );
+
if ( ! is_array( $this->caps ) )
$this->caps = array();
+
$this->get_role_caps();
}
@@ -519,8 +782,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 ) )
@@ -528,15 +793,17 @@ class WP_User {
//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();
foreach ( (array) $this->roles as $role ) {
- $role =& $wp_roles->get_role( $role );
- $this->allcaps = array_merge( $this->allcaps, $role->capabilities );
+ $the_role = $wp_roles->get_role( $role );
+ $this->allcaps = array_merge( (array) $this->allcaps, (array) $the_role->capabilities );
}
- $this->allcaps = array_merge( $this->allcaps, $this->caps );
+ $this->allcaps = array_merge( (array) $this->allcaps, (array) $this->caps );
+
+ return $this->allcaps;
}
/**
@@ -549,9 +816,9 @@ class WP_User {
*
* @param string $role Role name.
*/
- function add_role( $role ) {
+ public function add_role( $role ) {
$this->caps[$role] = true;
- update_usermeta( $this->ID, $this->cap_key, $this->caps );
+ update_user_meta( $this->ID, $this->cap_key, $this->caps );
$this->get_role_caps();
$this->update_user_level_from_caps();
}
@@ -564,12 +831,13 @@ class WP_User {
*
* @param string $role Role name.
*/
- function remove_role( $role ) {
- if ( empty( $this->roles[$role] ) || ( count( $this->roles ) <= 1 ) )
+ public function remove_role( $role ) {
+ if ( !in_array($role, $this->roles) )
return;
unset( $this->caps[$role] );
- update_usermeta( $this->ID, $this->cap_key, $this->caps );
+ update_user_meta( $this->ID, $this->cap_key, $this->caps );
$this->get_role_caps();
+ $this->update_user_level_from_caps();
}
/**
@@ -584,18 +852,35 @@ 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 );
} else {
$this->roles = false;
}
- update_usermeta( $this->ID, $this->cap_key, $this->caps );
+ 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 );
}
/**
@@ -617,7 +902,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 );
@@ -636,10 +921,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_usermeta( $this->ID, $wpdb->prefix.'user_level', $this->user_level );
+ $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 );
}
/**
@@ -651,9 +936,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_usermeta( $this->ID, $this->cap_key, $this->caps );
+ update_user_meta( $this->ID, $this->cap_key, $this->caps );
+ $this->get_role_caps();
+ $this->update_user_level_from_caps();
}
/**
@@ -664,10 +951,14 @@ class WP_User {
*
* @param string $cap Capability name.
*/
- function remove_cap( $cap ) {
- if ( empty( $this->caps[$cap] ) ) return;
- unset( $this->caps[$cap] );
- update_usermeta( $this->ID, $this->cap_key, $this->caps );
+ public function remove_cap( $cap ) {
+ if ( ! isset( $this->caps[ $cap ] ) ) {
+ return;
+ }
+ unset( $this->caps[ $cap ] );
+ update_user_meta( $this->ID, $this->cap_key, $this->caps );
+ $this->get_role_caps();
+ $this->update_user_level_from_caps();
}
/**
@@ -676,11 +967,11 @@ class WP_User {
* @since 2.1.0
* @access public
*/
- function remove_all_caps() {
+ public function remove_all_caps() {
global $wpdb;
$this->caps = array();
- update_usermeta( $this->ID, $this->cap_key, '' );
- update_usermeta( $this->ID, $wpdb->prefix.'user_level', '' );
+ delete_user_meta( $this->ID, $this->cap_key );
+ delete_user_meta( $this->ID, $wpdb->get_blog_prefix() . 'user_level' );
$this->get_role_caps();
}
@@ -689,27 +980,47 @@ 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 specfic 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 ) {
- if ( is_numeric( $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 );
+ }
$args = array_slice( func_get_args(), 1 );
$args = array_merge( array( $cap, $this->ID ), $args );
$caps = call_user_func_array( 'map_meta_cap', $args );
+
+ // Multisite super admin has all caps by definition, Unless specifically denied.
+ if ( is_multisite() && is_super_admin( $this->ID ) ) {
+ if ( in_array('do_not_allow', $caps) )
+ return false;
+ 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 ) {
- //echo "Checking cap $cap
";
- if ( empty( $capabilities[$cap] ) || !$capabilities[$cap] )
+ if ( empty( $capabilities[ $cap ] ) )
return false;
}
@@ -727,10 +1038,25 @@ 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;
}
+ /**
+ * Set the blog to operate on. Defaults to the current blog.
+ *
+ * @since 3.0.0
+ *
+ * @param int $blog_id Optional Blog ID, defaults to current blog.
+ */
+ public function for_blog( $blog_id = '' ) {
+ global $wpdb;
+ if ( ! empty( $blog_id ) )
+ $cap_key = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
+ else
+ $cap_key = '';
+ $this->_init_caps( $cap_key );
+ }
}
/**
@@ -738,8 +1064,8 @@ class WP_User {
*
* This does not actually compare whether the user ID has the actual capability,
* just what the capability or capabilities are. Meta capability list value can
- * be 'delete_user', 'edit_user', 'delete_post', 'delete_page', 'edit_post',
- * 'edit_page', 'read_post', or 'read_page'.
+ * be 'delete_user', 'edit_user', 'remove_user', 'promote_user', 'delete_post',
+ * 'delete_page', 'edit_post', 'edit_page', 'read_post', or 'read_page'.
*
* @since 2.0.0
*
@@ -752,160 +1078,301 @@ function map_meta_cap( $cap, $user_id ) {
$caps = array();
switch ( $cap ) {
- case 'delete_user':
- $caps[] = 'delete_users';
+ case 'remove_user':
+ $caps[] = 'remove_users';
+ break;
+ case 'promote_user':
+ $caps[] = 'promote_users';
break;
case 'edit_user':
- if ( !isset( $args[0] ) || $user_id != $args[0] ) {
- $caps[] = 'edit_users';
- }
+ case 'edit_users':
+ // Allow user to edit itself
+ if ( 'edit_user' == $cap && isset( $args[0] ) && $user_id == $args[0] )
+ break;
+
+ // If multisite these caps are allowed only for super admins.
+ if ( is_multisite() && !is_super_admin( $user_id ) )
+ $caps[] = 'do_not_allow';
+ else
+ $caps[] = 'edit_users'; // edit_user maps to edit_users.
break;
case 'delete_post':
- $author_data = get_userdata( $user_id );
- //echo "post ID: {$args[0]}
";
+ case 'delete_page':
$post = get_post( $args[0] );
- if ( 'page' == $post->post_type ) {
- $args = array_merge( array( 'delete_page', $user_id ), $args );
- return call_user_func_array( 'map_meta_cap', $args );
+
+ if ( 'revision' == $post->post_type ) {
+ $post = get_post( $post->post_parent );
+ }
+
+ $post_type = get_post_type_object( $post->post_type );
+
+ if ( ! $post_type->map_meta_cap ) {
+ $caps[] = $post_type->cap->$cap;
+ // Prior to 3.1 we would re-call map_meta_cap here.
+ if ( 'delete_post' == $cap )
+ $cap = $post_type->cap->$cap;
+ break;
}
- $post_author_data = get_userdata( $post->post_author );
- //echo "current user id : $user_id, post author id: " . $post_author_data->ID . "
";
- // If the user is the author...
- if ( $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[] = 'delete_published_posts';
- else
+ if ( 'publish' == $post->post_status ) {
+ $caps[] = $post_type->cap->delete_published_posts;
+ } elseif ( 'trash' == $post->post_status ) {
+ if ( 'publish' == get_post_meta( $post->ID, '_wp_trash_meta_status', true ) ) {
+ $caps[] = $post_type->cap->delete_published_posts;
+ }
+ } else {
// If the post is draft...
- $caps[] = 'delete_posts';
+ $caps[] = $post_type->cap->delete_posts;
+ }
} else {
// The user is trying to edit someone else's post.
- $caps[] = 'delete_others_posts';
+ $caps[] = $post_type->cap->delete_others_posts;
// The post is published, extra cap required.
- if ( 'publish' == $post->post_status )
- $caps[] = 'delete_published_posts';
- elseif ( 'private' == $post->post_status )
- $caps[] = 'delete_private_posts';
- }
- break;
- case 'delete_page':
- $author_data = get_userdata( $user_id );
- //echo "post ID: {$args[0]}
";
- $page = get_page( $args[0] );
- $page_author_data = get_userdata( $page->post_author );
- //echo "current user id : $user_id, page author id: " . $page_author_data->ID . "
";
- // If the user is the author...
- if ( $user_id == $page_author_data->ID ) {
- // If the page is published...
- if ( $page->post_status == 'publish' )
- $caps[] = 'delete_published_pages';
- else
- // If the page is draft...
- $caps[] = 'delete_pages';
- } else {
- // The user is trying to edit someone else's page.
- $caps[] = 'delete_others_pages';
- // The page is published, extra cap required.
- if ( $page->post_status == 'publish' )
- $caps[] = 'delete_published_pages';
- elseif ( $page->post_status == 'private' )
- $caps[] = 'delete_private_pages';
+ if ( 'publish' == $post->post_status ) {
+ $caps[] = $post_type->cap->delete_published_posts;
+ } elseif ( 'private' == $post->post_status ) {
+ $caps[] = $post_type->cap->delete_private_posts;
+ }
}
break;
// edit_post breaks down to edit_posts, edit_published_posts, or
// edit_others_posts
case 'edit_post':
- $author_data = get_userdata( $user_id );
- //echo "post ID: {$args[0]}
";
+ case 'edit_page':
$post = get_post( $args[0] );
- if ( 'page' == $post->post_type ) {
- $args = array_merge( array( 'edit_page', $user_id ), $args );
- return call_user_func_array( 'map_meta_cap', $args );
+ if ( empty( $post ) ) {
+ $caps[] = 'do_not_allow';
+ break;
+ }
+
+ if ( 'revision' == $post->post_type ) {
+ $post = get_post( $post->post_parent );
+ }
+
+ $post_type = get_post_type_object( $post->post_type );
+
+ if ( ! $post_type->map_meta_cap ) {
+ $caps[] = $post_type->cap->$cap;
+ // Prior to 3.1 we would re-call map_meta_cap here.
+ if ( 'edit_post' == $cap )
+ $cap = $post_type->cap->$cap;
+ break;
}
- $post_author_data = get_userdata( $post->post_author );
- //echo "current user id : $user_id, post author id: " . $post_author_data->ID . "
";
- // If the user is the author...
- if ( $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[] = 'edit_published_posts';
- else
+ if ( 'publish' == $post->post_status ) {
+ $caps[] = $post_type->cap->edit_published_posts;
+ } elseif ( 'trash' == $post->post_status ) {
+ if ( 'publish' == get_post_meta( $post->ID, '_wp_trash_meta_status', true ) ) {
+ $caps[] = $post_type->cap->edit_published_posts;
+ }
+ } else {
// If the post is draft...
- $caps[] = 'edit_posts';
+ $caps[] = $post_type->cap->edit_posts;
+ }
} else {
// The user is trying to edit someone else's post.
- $caps[] = 'edit_others_posts';
+ $caps[] = $post_type->cap->edit_others_posts;
// The post is published, extra cap required.
- if ( 'publish' == $post->post_status )
- $caps[] = 'edit_published_posts';
- elseif ( 'private' == $post->post_status )
- $caps[] = 'edit_private_posts';
- }
- break;
- case 'edit_page':
- $author_data = get_userdata( $user_id );
- //echo "post ID: {$args[0]}
";
- $page = get_page( $args[0] );
- $page_author_data = get_userdata( $page->post_author );
- //echo "current user id : $user_id, page author id: " . $page_author_data->ID . "
";
- // If the user is the author...
- if ( $user_id == $page_author_data->ID ) {
- // If the page is published...
- if ( 'publish' == $page->post_status )
- $caps[] = 'edit_published_pages';
- else
- // If the page is draft...
- $caps[] = 'edit_pages';
- } else {
- // The user is trying to edit someone else's page.
- $caps[] = 'edit_others_pages';
- // The page is published, extra cap required.
- if ( 'publish' == $page->post_status )
- $caps[] = 'edit_published_pages';
- elseif ( 'private' == $page->post_status )
- $caps[] = 'edit_private_pages';
+ if ( 'publish' == $post->post_status ) {
+ $caps[] = $post_type->cap->edit_published_posts;
+ } elseif ( 'private' == $post->post_status ) {
+ $caps[] = $post_type->cap->edit_private_posts;
+ }
}
break;
case 'read_post':
+ case 'read_page':
$post = get_post( $args[0] );
- if ( 'page' == $post->post_type ) {
- $args = array_merge( array( 'read_page', $user_id ), $args );
- return call_user_func_array( 'map_meta_cap', $args );
+
+ if ( 'revision' == $post->post_type ) {
+ $post = get_post( $post->post_parent );
}
- if ( 'private' != $post->post_status ) {
- $caps[] = 'read';
+ $post_type = get_post_type_object( $post->post_type );
+
+ if ( ! $post_type->map_meta_cap ) {
+ $caps[] = $post_type->cap->$cap;
+ // Prior to 3.1 we would re-call map_meta_cap here.
+ if ( 'read_post' == $cap )
+ $cap = $post_type->cap->$cap;
break;
}
- $author_data = get_userdata( $user_id );
- $post_author_data = get_userdata( $post->post_author );
- if ( $user_id == $post_author_data->ID )
- $caps[] = 'read';
- else
- $caps[] = 'read_private_posts';
+ $status_obj = get_post_status_object( $post->post_status );
+ if ( $status_obj->public ) {
+ $caps[] = $post_type->cap->read;
+ break;
+ }
+
+ if ( $post->post_author && $user_id == $post->post_author ) {
+ $caps[] = $post_type->cap->read;
+ } elseif ( $status_obj->private ) {
+ $caps[] = $post_type->cap->read_private_posts;
+ } else {
+ $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
+ }
break;
- case 'read_page':
- $page = get_page( $args[0] );
+ case 'publish_post':
+ $post = get_post( $args[0] );
+ $post_type = get_post_type_object( $post->post_type );
- if ( 'private' != $page->post_status ) {
- $caps[] = 'read';
+ $caps[] = $post_type->cap->publish_posts;
+ break;
+ case 'edit_post_meta':
+ case 'delete_post_meta':
+ case 'add_post_meta':
+ $post = get_post( $args[0] );
+ $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
+
+ $meta_key = isset( $args[ 1 ] ) ? $args[ 1 ] : false;
+
+ if ( $meta_key && has_filter( "auth_post_meta_{$meta_key}" ) ) {
+ /**
+ * Filter whether the user is allowed to add post meta to a post.
+ *
+ * The dynamic portion of the hook name, `$meta_key`, refers to the
+ * meta key passed to {@see map_meta_cap()}.
+ *
+ * @since 3.3.0
+ *
+ * @param bool $allowed Whether the user can add the post meta. Default false.
+ * @param string $meta_key The meta key.
+ * @param int $post_id Post ID.
+ * @param int $user_id User ID.
+ * @param string $cap Capability name.
+ * @param array $caps User capabilities.
+ */
+ $allowed = apply_filters( "auth_post_meta_{$meta_key}", false, $meta_key, $post->ID, $user_id, $cap, $caps );
+ if ( ! $allowed )
+ $caps[] = $cap;
+ } elseif ( $meta_key && is_protected_meta( $meta_key, 'post' ) ) {
+ $caps[] = $cap;
+ }
+ break;
+ case 'edit_comment':
+ $comment = get_comment( $args[0] );
+ if ( empty( $comment ) )
break;
+ $post = get_post( $comment->comment_post_ID );
+ $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 ) ) )
+ $caps[] = $cap;
+ else
+ $caps[] = 'do_not_allow';
+ break;
+ case 'unfiltered_html' :
+ // Disallow unfiltered_html for all users, even admins and super admins.
+ if ( defined( 'DISALLOW_UNFILTERED_HTML' ) && DISALLOW_UNFILTERED_HTML )
+ $caps[] = 'do_not_allow';
+ elseif ( is_multisite() && ! is_super_admin( $user_id ) )
+ $caps[] = 'do_not_allow';
+ else
+ $caps[] = $cap;
+ break;
+ case 'edit_files':
+ case 'edit_plugins':
+ case 'edit_themes':
+ // Disallow the file editors.
+ if ( defined( 'DISALLOW_FILE_EDIT' ) && DISALLOW_FILE_EDIT )
+ $caps[] = 'do_not_allow';
+ elseif ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS )
+ $caps[] = 'do_not_allow';
+ elseif ( is_multisite() && ! is_super_admin( $user_id ) )
+ $caps[] = 'do_not_allow';
+ else
+ $caps[] = $cap;
+ break;
+ case 'update_plugins':
+ case 'delete_plugins':
+ case 'install_plugins':
+ case 'upload_plugins':
+ case 'update_themes':
+ case 'delete_themes':
+ case 'install_themes':
+ case 'upload_themes':
+ case 'update_core':
+ // Disallow anything that creates, deletes, or updates core, plugin, or theme files.
+ // Files in uploads are excepted.
+ if ( defined( 'DISALLOW_FILE_MODS' ) && DISALLOW_FILE_MODS ) {
+ $caps[] = 'do_not_allow';
+ } elseif ( is_multisite() && ! is_super_admin( $user_id ) ) {
+ $caps[] = 'do_not_allow';
+ } elseif ( 'upload_themes' === $cap ) {
+ $caps[] = 'install_themes';
+ } elseif ( 'upload_plugins' === $cap ) {
+ $caps[] = 'install_plugins';
+ } else {
+ $caps[] = $cap;
}
-
- $author_data = get_userdata( $user_id );
- $page_author_data = get_userdata( $page->post_author );
- if ( $user_id == $page_author_data->ID )
- $caps[] = 'read';
+ break;
+ case 'activate_plugins':
+ $caps[] = $cap;
+ if ( is_multisite() ) {
+ // update_, install_, and delete_ are handled above with is_super_admin().
+ $menu_perms = get_site_option( 'menu_items', array() );
+ if ( empty( $menu_perms['plugins'] ) )
+ $caps[] = 'manage_network_plugins';
+ }
+ break;
+ case 'delete_user':
+ case 'delete_users':
+ // If multisite only super admins can delete users.
+ if ( is_multisite() && ! is_super_admin( $user_id ) )
+ $caps[] = 'do_not_allow';
else
- $caps[] = 'read_private_pages';
+ $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' ) )
+ $caps[] = $cap;
+ else
+ $caps[] = 'do_not_allow';
+ break;
+ case 'manage_links' :
+ if ( get_option( 'link_manager_enabled' ) )
+ $caps[] = $cap;
+ else
+ $caps[] = 'do_not_allow';
+ break;
+ case 'customize' :
+ $caps[] = 'edit_theme_options';
+ break;
+ case 'delete_site':
+ $caps[] = 'manage_options';
break;
default:
+ // Handle meta capabilities for custom post types.
+ $post_type_meta_caps = _post_type_meta_capabilities();
+ if ( isset( $post_type_meta_caps[ $cap ] ) ) {
+ $args = array_merge( array( $post_type_meta_caps[ $cap ], $user_id ), $args );
+ return call_user_func_array( 'map_meta_cap', $args );
+ }
+
// If no meta caps match, return the original cap.
$caps[] = $cap;
}
- return $caps;
+ /**
+ * 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 );
}
/**
@@ -925,7 +1392,86 @@ function current_user_can( $capability ) {
$args = array_slice( func_get_args(), 1 );
$args = array_merge( array( $capability ), $args );
- return call_user_func_array( array( &$current_user, 'has_cap' ), $args );
+ return call_user_func_array( array( $current_user, 'has_cap' ), $args );
+}
+
+/**
+ * Whether current user has a capability or role for a given blog.
+ *
+ * @since 3.0.0
+ *
+ * @param int $blog_id Blog ID
+ * @param string $capability Capability or role name.
+ * @return bool
+ */
+function current_user_can_for_blog( $blog_id, $capability ) {
+ $switched = is_multisite() ? switch_to_blog( $blog_id ) : false;
+
+ $current_user = wp_get_current_user();
+
+ if ( empty( $current_user ) ) {
+ if ( $switched ) {
+ restore_current_blog();
+ }
+ return false;
+ }
+
+ $args = array_slice( func_get_args(), 2 );
+ $args = array_merge( array( $capability ), $args );
+
+ $can = call_user_func_array( array( $current_user, 'has_cap' ), $args );
+
+ if ( $switched ) {
+ restore_current_blog();
+ }
+
+ return $can;
+}
+
+/**
+ * Whether author of supplied post has capability or role.
+ *
+ * @since 2.9.0
+ *
+ * @param int|object $post Post ID or post object.
+ * @param string $capability Capability or role name.
+ * @return bool
+ */
+function author_can( $post, $capability ) {
+ if ( !$post = get_post($post) )
+ return false;
+
+ $author = get_userdata( $post->post_author );
+
+ if ( ! $author )
+ return false;
+
+ $args = array_slice( func_get_args(), 2 );
+ $args = array_merge( array( $capability ), $args );
+
+ return call_user_func_array( array( $author, 'has_cap' ), $args );
+}
+
+/**
+ * Whether a particular user has capability or role.
+ *
+ * @since 3.1.0
+ *
+ * @param int|object $user User ID or object.
+ * @param string $capability Capability or role name.
+ * @return bool
+ */
+function user_can( $user, $capability ) {
+ if ( ! is_object( $user ) )
+ $user = get_userdata( $user );
+
+ if ( ! $user || ! $user->exists() )
+ return false;
+
+ $args = array_slice( func_get_args(), 2 );
+ $args = array_merge( array( $capability ), $args );
+
+ return call_user_func_array( array( $user, 'has_cap' ), $args );
}
/**
@@ -935,7 +1481,7 @@ function current_user_can( $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;
@@ -954,8 +1500,8 @@ function get_role( $role ) {
*
* @param string $role Role name.
* @param string $display_name Display name for role.
- * @param array $capabilities List of capabilities.
- * @return null|WP_Role WP_Role object if role is added, null if already exists.
+ * @param array $capabilities List of capabilities, e.g. array( 'edit_posts' => true, 'delete_posts' => false );
+ * @return WP_Role|null WP_Role object if role is added, null if already exists.
*/
function add_role( $role, $display_name, $capabilities = array() ) {
global $wp_roles;
@@ -973,7 +1519,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;
@@ -981,7 +1526,52 @@ function remove_role( $role ) {
if ( ! isset( $wp_roles ) )
$wp_roles = new WP_Roles();
- return $wp_roles->remove_role( $role );
+ $wp_roles->remove_role( $role );
+}
+
+/**
+ * Retrieve a list of super admins.
+ *
+ * @since 3.0.0
+ *
+ * @uses $super_admins Super admins global variable, if set.
+ *
+ * @return array List of super admin logins
+ */
+function get_super_admins() {
+ global $super_admins;
+
+ if ( isset($super_admins) )
+ return $super_admins;
+ else
+ return get_site_option( 'site_admins', array('admin') );
}
-?>
+/**
+ * Determine if user is a site admin.
+ *
+ * @since 3.0.0
+ *
+ * @param int $user_id (Optional) The ID of a user. Defaults to the current user.
+ * @return bool True if the user is a site admin.
+ */
+function is_super_admin( $user_id = false ) {
+ if ( ! $user_id || $user_id == get_current_user_id() )
+ $user = wp_get_current_user();
+ else
+ $user = get_userdata( $user_id );
+
+ if ( ! $user || ! $user->exists() )
+ return false;
+
+ if ( is_multisite() ) {
+ $super_admins = get_super_admins();
+ if ( is_array( $super_admins ) && in_array( $user->user_login, $super_admins ) )
+ return true;
+ } else {
+ if ( $user->has_cap('delete_users') )
+ return true;
+ }
+
+ return false;
+}