3 * WordPress Roles and Capabilities.
10 * WordPress User Roles.
12 * The role option is simple, the structure is organized by role name that store
13 * the name in value of the 'name' key. The capabilities are stored as an array
14 * in the value of the 'capability' key.
18 * 'rolename' => array (
19 * 'name' => 'rolename',
20 * 'capabilities' => array()
31 * List of roles and capabilities.
40 * List of the role objects.
46 var $role_objects = array();
55 var $role_names = array();
58 * Option name for storing role list.
67 * Whether to use the database for retrieval and storage.
80 function __construct() {
85 * Set up the object properties.
87 * The role key is set to the current prefix for the $wpdb object with
88 * 'user_roles' appended. If the $wp_user_roles global is set, then it will
89 * be used and the role option will not be updated or used.
93 * @uses $wpdb Used to get the database prefix.
94 * @global array $wp_user_roles Used to set the 'roles' property value.
97 global $wpdb, $wp_user_roles;
98 $this->role_key = $wpdb->prefix . 'user_roles';
99 if ( ! empty( $wp_user_roles ) ) {
100 $this->roles = $wp_user_roles;
101 $this->use_db = false;
103 $this->roles = get_option( $this->role_key );
106 if ( empty( $this->roles ) )
109 $this->role_objects = array();
110 $this->role_names = array();
111 foreach ( (array) $this->roles as $role => $data ) {
112 $this->role_objects[$role] = new WP_Role( $role, $this->roles[$role]['capabilities'] );
113 $this->role_names[$role] = $this->roles[$role]['name'];
118 * Add role name with capabilities to list.
120 * Updates the list of roles, if the role doesn't already exist.
122 * The capabilities are defined in the following format `array( 'read' => true );`
123 * To explicitly deny a role a capability you set the value for that capability to false.
128 * @param string $role Role name.
129 * @param string $display_name Role display name.
130 * @param array $capabilities List of role capabilities in the above format.
131 * @return null|WP_Role WP_Role object if role is added, null if already exists.
133 function add_role( $role, $display_name, $capabilities = array() ) {
134 if ( isset( $this->roles[$role] ) )
137 $this->roles[$role] = array(
138 'name' => $display_name,
139 'capabilities' => $capabilities
142 update_option( $this->role_key, $this->roles );
143 $this->role_objects[$role] = new WP_Role( $role, $capabilities );
144 $this->role_names[$role] = $display_name;
145 return $this->role_objects[$role];
149 * Remove role by name.
154 * @param string $role Role name.
156 function remove_role( $role ) {
157 if ( ! isset( $this->role_objects[$role] ) )
160 unset( $this->role_objects[$role] );
161 unset( $this->role_names[$role] );
162 unset( $this->roles[$role] );
165 update_option( $this->role_key, $this->roles );
169 * Add capability to role.
174 * @param string $role Role name.
175 * @param string $cap Capability name.
176 * @param bool $grant Optional, default is true. Whether role is capable of performing capability.
178 function add_cap( $role, $cap, $grant = true ) {
179 $this->roles[$role]['capabilities'][$cap] = $grant;
181 update_option( $this->role_key, $this->roles );
185 * Remove capability from role.
190 * @param string $role Role name.
191 * @param string $cap Capability name.
193 function remove_cap( $role, $cap ) {
194 unset( $this->roles[$role]['capabilities'][$cap] );
196 update_option( $this->role_key, $this->roles );
200 * Retrieve role object by name.
205 * @param string $role Role name.
206 * @return object|null Null, if role does not exist. WP_Role object, if found.
208 function get_role( $role ) {
209 if ( isset( $this->role_objects[$role] ) )
210 return $this->role_objects[$role];
216 * Retrieve list of role names.
221 * @return array List of role names.
223 function get_names() {
224 return $this->role_names;
228 * Whether role name is currently in the list of available roles.
233 * @param string $role Role name to look up.
236 function is_role( $role )
238 return isset( $this->role_names[$role] );
243 * WordPress Role class.
260 * List of capabilities the role contains.
269 * Constructor - Set up object properties.
271 * The list of capabilities, must have the key as the name of the capability
272 * and the value a boolean of whether it is granted to the role.
277 * @param string $role Role name.
278 * @param array $capabilities List of capabilities.
280 function __construct( $role, $capabilities ) {
282 $this->capabilities = $capabilities;
286 * Assign role a capability.
288 * @see WP_Roles::add_cap() Method uses implementation for role.
292 * @param string $cap Capability name.
293 * @param bool $grant Whether role has capability privilege.
295 function add_cap( $cap, $grant = true ) {
298 if ( ! isset( $wp_roles ) )
299 $wp_roles = new WP_Roles();
301 $this->capabilities[$cap] = $grant;
302 $wp_roles->add_cap( $this->name, $cap, $grant );
306 * Remove capability from role.
308 * This is a container for {@link WP_Roles::remove_cap()} to remove the
309 * capability from the role. That is to say, that {@link
310 * WP_Roles::remove_cap()} implements the functionality, but it also makes
311 * sense to use this class, because you don't need to enter the role name.
316 * @param string $cap Capability name.
318 function remove_cap( $cap ) {
321 if ( ! isset( $wp_roles ) )
322 $wp_roles = new WP_Roles();
324 unset( $this->capabilities[$cap] );
325 $wp_roles->remove_cap( $this->name, $cap );
329 * Whether role has capability.
331 * The capabilities is passed through the 'role_has_cap' filter. The first
332 * parameter for the hook is the list of capabilities the class has
333 * assigned. The second parameter is the capability name to look for. The
334 * third and final parameter for the hook is the role name.
339 * @param string $cap Capability name.
340 * @return bool True, if user has capability. False, if doesn't have capability.
342 function has_cap( $cap ) {
343 $capabilities = apply_filters( 'role_has_cap', $this->capabilities, $cap, $this->name );
344 if ( !empty( $capabilities[$cap] ) )
345 return $capabilities[$cap];
353 * WordPress User class.
361 * User data container.
379 * The individual capabilities the user has been given.
388 * User metadata option name.
397 * The roles the user is part of.
403 var $roles = array();
406 * All capabilities the user has, including individual and role based.
412 var $allcaps = array();
415 * The filter context applied to user data fields.
423 private static $back_compat_keys;
428 * Retrieves the userdata and passes it to {@link WP_User::init()}.
433 * @param int|string $id User's ID
434 * @param string $name Optional. User's username
435 * @param int $blog_id Optional Blog ID, defaults to current blog.
438 function __construct( $id = 0, $name = '', $blog_id = '' ) {
439 if ( ! isset( self::$back_compat_keys ) ) {
440 $prefix = $GLOBALS['wpdb']->prefix;
441 self::$back_compat_keys = array(
442 'user_firstname' => 'first_name',
443 'user_lastname' => 'last_name',
444 'user_description' => 'description',
445 'user_level' => $prefix . 'user_level',
446 $prefix . 'usersettings' => $prefix . 'user-settings',
447 $prefix . 'usersettingstime' => $prefix . 'user-settings-time',
451 if ( ! empty( $id ) && ! is_numeric( $id ) ) {
457 $data = self::get_data_by( 'id', $id );
459 $data = self::get_data_by( 'login', $name );
462 $this->init( $data, $blog_id );
466 * Sets up object properties, including capabilities.
468 * @param object $data User DB row object
469 * @param int $blog_id Optional. The blog id to initialize for
471 function init( $data, $blog_id = '' ) {
473 $this->ID = (int) $data->ID;
475 $this->for_blog( $blog_id );
479 * Return only the main user fields
483 * @param string $field The field to query against: 'id', 'slug', 'email' or 'login'
484 * @param string|int $value The field value
485 * @return object Raw user object
487 static function get_data_by( $field, $value ) {
490 if ( 'id' == $field ) {
491 // Make sure the value is numeric to avoid casting objects, for example,
493 if ( ! is_numeric( $value ) )
495 $value = absint( $value );
497 $value = trim( $value );
509 $user_id = wp_cache_get($value, 'userslugs');
510 $db_field = 'user_nicename';
513 $user_id = wp_cache_get($value, 'useremail');
514 $db_field = 'user_email';
517 $value = sanitize_user( $value );
518 $user_id = wp_cache_get($value, 'userlogins');
519 $db_field = 'user_login';
525 if ( false !== $user_id ) {
526 if ( $user = wp_cache_get( $user_id, 'users' ) )
530 if ( !$user = $wpdb->get_row( $wpdb->prepare(
531 "SELECT * FROM $wpdb->users WHERE $db_field = %s", $value
535 update_user_caches( $user );
541 * Magic method for checking the existence of a certain custom field
545 function __isset( $key ) {
546 if ( 'id' == $key ) {
547 _deprecated_argument( 'WP_User->id', '2.1', __( 'Use <code>WP_User->ID</code> instead.' ) );
551 if ( isset( $this->data->$key ) )
554 if ( isset( self::$back_compat_keys[ $key ] ) )
555 $key = self::$back_compat_keys[ $key ];
557 return metadata_exists( 'user', $this->ID, $key );
561 * Magic method for accessing custom fields
565 function __get( $key ) {
566 if ( 'id' == $key ) {
567 _deprecated_argument( 'WP_User->id', '2.1', __( 'Use <code>WP_User->ID</code> instead.' ) );
571 if ( isset( $this->data->$key ) ) {
572 $value = $this->data->$key;
574 if ( isset( self::$back_compat_keys[ $key ] ) )
575 $key = self::$back_compat_keys[ $key ];
576 $value = get_user_meta( $this->ID, $key, true );
579 if ( $this->filter ) {
580 $value = sanitize_user_field( $key, $value, $this->ID, $this->filter );
587 * Magic method for setting custom fields
591 function __set( $key, $value ) {
592 if ( 'id' == $key ) {
593 _deprecated_argument( 'WP_User->id', '2.1', __( 'Use <code>WP_User->ID</code> instead.' ) );
598 $this->data->$key = $value;
602 * Retrieve the value of a property or meta key.
604 * Retrieves from the users and usermeta table.
608 * @param string $key Property
610 function get( $key ) {
611 return $this->__get( $key );
615 * Determine whether a property or meta key is set
617 * Consults the users and usermeta tables.
621 * @param string $key Property
623 function has_prop( $key ) {
624 return $this->__isset( $key );
628 * Set up capability object properties.
630 * Will set the value for the 'cap_key' property to current database table
631 * prefix, followed by 'capabilities'. Will then check to see if the
632 * property matching the 'cap_key' exists and is an array. If so, it will be
638 * @param string $cap_key Optional capability key
640 function _init_caps( $cap_key = '' ) {
643 if ( empty($cap_key) )
644 $this->cap_key = $wpdb->prefix . 'capabilities';
646 $this->cap_key = $cap_key;
648 $this->caps = get_user_meta( $this->ID, $this->cap_key, true );
650 if ( ! is_array( $this->caps ) )
651 $this->caps = array();
653 $this->get_role_caps();
657 * Retrieve all of the role capabilities and merge with individual capabilities.
659 * All of the capabilities of the roles the user belongs to are merged with
660 * the users individual roles. This also means that the user can be denied
661 * specific roles that their role might have, but the specific user isn't
662 * granted permission to.
668 function get_role_caps() {
671 if ( ! isset( $wp_roles ) )
672 $wp_roles = new WP_Roles();
674 //Filter out caps that are not role names and assign to $this->roles
675 if ( is_array( $this->caps ) )
676 $this->roles = array_filter( array_keys( $this->caps ), array( &$wp_roles, 'is_role' ) );
678 //Build $allcaps from role caps, overlay user's $caps
679 $this->allcaps = array();
680 foreach ( (array) $this->roles as $role ) {
681 $the_role = $wp_roles->get_role( $role );
682 $this->allcaps = array_merge( (array) $this->allcaps, (array) $the_role->capabilities );
684 $this->allcaps = array_merge( (array) $this->allcaps, (array) $this->caps );
690 * Updates the user's meta data option with capabilities and roles.
695 * @param string $role Role name.
697 function add_role( $role ) {
698 $this->caps[$role] = true;
699 update_user_meta( $this->ID, $this->cap_key, $this->caps );
700 $this->get_role_caps();
701 $this->update_user_level_from_caps();
705 * Remove role from user.
710 * @param string $role Role name.
712 function remove_role( $role ) {
713 if ( !in_array($role, $this->roles) )
715 unset( $this->caps[$role] );
716 update_user_meta( $this->ID, $this->cap_key, $this->caps );
717 $this->get_role_caps();
718 $this->update_user_level_from_caps();
722 * Set the role of the user.
724 * This will remove the previous roles of the user and assign the user the
725 * new one. You can set the role to an empty string and it will remove all
726 * of the roles from the user.
731 * @param string $role Role name.
733 function set_role( $role ) {
734 foreach ( (array) $this->roles as $oldrole )
735 unset( $this->caps[$oldrole] );
737 if ( 1 == count( $this->roles ) && $role == $this->roles[0] )
740 if ( !empty( $role ) ) {
741 $this->caps[$role] = true;
742 $this->roles = array( $role => true );
744 $this->roles = false;
746 update_user_meta( $this->ID, $this->cap_key, $this->caps );
747 $this->get_role_caps();
748 $this->update_user_level_from_caps();
749 do_action( 'set_user_role', $this->ID, $role );
753 * Choose the maximum level the user has.
755 * Will compare the level from the $item parameter against the $max
756 * parameter. If the item is incorrect, then just the $max parameter value
759 * Used to get the max level based on the capabilities the user has. This
760 * is also based on roles, so if the user is assigned the Administrator role
761 * then the capability 'level_10' will exist and the user will get that
767 * @param int $max Max level of user.
768 * @param string $item Level capability name.
769 * @return int Max Level.
771 function level_reduction( $max, $item ) {
772 if ( preg_match( '/^level_(10|[0-9])$/i', $item, $matches ) ) {
773 $level = intval( $matches[1] );
774 return max( $max, $level );
781 * Update the maximum user level for the user.
783 * Updates the 'user_level' user metadata (includes prefix that is the
784 * database table prefix) with the maximum user level. Gets the value from
785 * the all of the capabilities that the user has.
790 function update_user_level_from_caps() {
792 $this->user_level = array_reduce( array_keys( $this->allcaps ), array( $this, 'level_reduction' ), 0 );
793 update_user_meta( $this->ID, $wpdb->prefix . 'user_level', $this->user_level );
797 * Add capability and grant or deny access to capability.
802 * @param string $cap Capability name.
803 * @param bool $grant Whether to grant capability to user.
805 function add_cap( $cap, $grant = true ) {
806 $this->caps[$cap] = $grant;
807 update_user_meta( $this->ID, $this->cap_key, $this->caps );
811 * Remove capability from user.
816 * @param string $cap Capability name.
818 function remove_cap( $cap ) {
819 if ( empty( $this->caps[$cap] ) )
821 unset( $this->caps[$cap] );
822 update_user_meta( $this->ID, $this->cap_key, $this->caps );
826 * Remove all of the capabilities of the user.
831 function remove_all_caps() {
833 $this->caps = array();
834 delete_user_meta( $this->ID, $this->cap_key );
835 delete_user_meta( $this->ID, $wpdb->prefix . 'user_level' );
836 $this->get_role_caps();
840 * Whether user has capability or role name.
842 * This is useful for looking up whether the user has a specific role
843 * assigned to the user. The second optional parameter can also be used to
844 * check for capabilities against a specific post.
849 * @param string|int $cap Capability or role name to search.
850 * @param int $post_id Optional. Post ID to check capability against specific post.
851 * @return bool True, if user has capability; false, if user does not have capability.
853 function has_cap( $cap ) {
854 if ( is_numeric( $cap ) ) {
855 _deprecated_argument( __FUNCTION__, '2.0', __('Usage of user levels by plugins and themes is deprecated. Use roles and capabilities instead.') );
856 $cap = $this->translate_level_to_cap( $cap );
859 $args = array_slice( func_get_args(), 1 );
860 $args = array_merge( array( $cap, $this->ID ), $args );
861 $caps = call_user_func_array( 'map_meta_cap', $args );
863 // Multisite super admin has all caps by definition, Unless specifically denied.
864 if ( is_multisite() && is_super_admin( $this->ID ) ) {
865 if ( in_array('do_not_allow', $caps) )
870 // Must have ALL requested caps
871 $capabilities = apply_filters( 'user_has_cap', $this->allcaps, $caps, $args );
872 $capabilities['exist'] = true; // Everyone is allowed to exist
873 foreach ( (array) $caps as $cap ) {
874 if ( empty( $capabilities[ $cap ] ) )
882 * Convert numeric level to level capability name.
884 * Prepends 'level_' to level number.
889 * @param int $level Level number, 1 to 10.
892 function translate_level_to_cap( $level ) {
893 return 'level_' . $level;
897 * Set the blog to operate on. Defaults to the current blog.
901 * @param int $blog_id Optional Blog ID, defaults to current blog.
903 function for_blog( $blog_id = '' ) {
905 if ( ! empty( $blog_id ) )
906 $cap_key = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
909 $this->_init_caps( $cap_key );
914 * Map meta capabilities to primitive capabilities.
916 * This does not actually compare whether the user ID has the actual capability,
917 * just what the capability or capabilities are. Meta capability list value can
918 * be 'delete_user', 'edit_user', 'remove_user', 'promote_user', 'delete_post',
919 * 'delete_page', 'edit_post', 'edit_page', 'read_post', or 'read_page'.
923 * @param string $cap Capability name.
924 * @param int $user_id User ID.
925 * @return array Actual capabilities for meta capability.
927 function map_meta_cap( $cap, $user_id ) {
928 $args = array_slice( func_get_args(), 2 );
933 $caps[] = 'remove_users';
936 $caps[] = 'promote_users';
939 // Allow user to edit itself
940 if ( isset( $args[0] ) && $user_id == $args[0] )
944 // If multisite these caps are allowed only for super admins.
945 if ( is_multisite() && !is_super_admin( $user_id ) )
946 $caps[] = 'do_not_allow';
948 $caps[] = 'edit_users'; // Explicit due to primitive fall through
952 $author_data = get_userdata( $user_id );
953 $post = get_post( $args[0] );
955 if ( 'revision' == $post->post_type ) {
956 $post = get_post( $post->post_parent );
959 $post_type = get_post_type_object( $post->post_type );
961 if ( ! $post_type->map_meta_cap ) {
962 $caps[] = $post_type->cap->$cap;
963 // Prior to 3.1 we would re-call map_meta_cap here.
964 if ( 'delete_post' == $cap )
965 $cap = $post_type->cap->$cap;
969 if ( '' != $post->post_author ) {
970 $post_author_data = get_userdata( $post->post_author );
972 // No author set yet, so default to current user for cap checks.
973 $post_author_data = $author_data;
976 // If the user is the author...
977 if ( is_object( $post_author_data ) && $user_id == $post_author_data->ID ) {
978 // If the post is published...
979 if ( 'publish' == $post->post_status ) {
980 $caps[] = $post_type->cap->delete_published_posts;
981 } elseif ( 'trash' == $post->post_status ) {
982 if ('publish' == get_post_meta($post->ID, '_wp_trash_meta_status', true) )
983 $caps[] = $post_type->cap->delete_published_posts;
985 // If the post is draft...
986 $caps[] = $post_type->cap->delete_posts;
989 // The user is trying to edit someone else's post.
990 $caps[] = $post_type->cap->delete_others_posts;
991 // The post is published, extra cap required.
992 if ( 'publish' == $post->post_status )
993 $caps[] = $post_type->cap->delete_published_posts;
994 elseif ( 'private' == $post->post_status )
995 $caps[] = $post_type->cap->delete_private_posts;
998 // edit_post breaks down to edit_posts, edit_published_posts, or
1002 $author_data = get_userdata( $user_id );
1003 $post = get_post( $args[0] );
1005 if ( 'revision' == $post->post_type ) {
1006 $post = get_post( $post->post_parent );
1009 $post_type = get_post_type_object( $post->post_type );
1011 if ( ! $post_type->map_meta_cap ) {
1012 $caps[] = $post_type->cap->$cap;
1013 // Prior to 3.1 we would re-call map_meta_cap here.
1014 if ( 'edit_post' == $cap )
1015 $cap = $post_type->cap->$cap;
1019 if ( '' != $post->post_author ) {
1020 $post_author_data = get_userdata( $post->post_author );
1022 // No author set yet, so default to current user for cap checks.
1023 $post_author_data = $author_data;
1026 //echo "current user id : $user_id, post author id: " . $post_author_data->ID . "<br />";
1027 // If the user is the author...
1028 if ( is_object( $post_author_data ) && $user_id == $post_author_data->ID ) {
1029 // If the post is published...
1030 if ( 'publish' == $post->post_status ) {
1031 $caps[] = $post_type->cap->edit_published_posts;
1032 } elseif ( 'trash' == $post->post_status ) {
1033 if ('publish' == get_post_meta($post->ID, '_wp_trash_meta_status', true) )
1034 $caps[] = $post_type->cap->edit_published_posts;
1036 // If the post is draft...
1037 $caps[] = $post_type->cap->edit_posts;
1040 // The user is trying to edit someone else's post.
1041 $caps[] = $post_type->cap->edit_others_posts;
1042 // The post is published, extra cap required.
1043 if ( 'publish' == $post->post_status )
1044 $caps[] = $post_type->cap->edit_published_posts;
1045 elseif ( 'private' == $post->post_status )
1046 $caps[] = $post_type->cap->edit_private_posts;
1051 $author_data = get_userdata( $user_id );
1052 $post = get_post( $args[0] );
1054 if ( 'revision' == $post->post_type ) {
1055 $post = get_post( $post->post_parent );
1058 $post_type = get_post_type_object( $post->post_type );
1060 if ( ! $post_type->map_meta_cap ) {
1061 $caps[] = $post_type->cap->$cap;
1062 // Prior to 3.1 we would re-call map_meta_cap here.
1063 if ( 'read_post' == $cap )
1064 $cap = $post_type->cap->$cap;
1068 if ( 'private' != $post->post_status ) {
1069 $caps[] = $post_type->cap->read;
1073 if ( '' != $post->post_author ) {
1074 $post_author_data = get_userdata( $post->post_author );
1076 // No author set yet, so default to current user for cap checks.
1077 $post_author_data = $author_data;
1080 if ( is_object( $post_author_data ) && $user_id == $post_author_data->ID )
1081 $caps[] = $post_type->cap->read;
1083 $caps[] = $post_type->cap->read_private_posts;
1085 case 'edit_post_meta':
1086 case 'delete_post_meta':
1087 case 'add_post_meta':
1088 $post = get_post( $args[0] );
1089 $post_type_object = get_post_type_object( $post->post_type );
1090 $caps = map_meta_cap( $post_type_object->cap->edit_post, $user_id, $post->ID );
1092 $meta_key = isset( $args[ 1 ] ) ? $args[ 1 ] : false;
1094 if ( $meta_key && has_filter( "auth_post_meta_{$meta_key}" ) ) {
1095 $allowed = apply_filters( "auth_post_meta_{$meta_key}", false, $meta_key, $post->ID, $user_id, $cap, $caps );
1098 } elseif ( $meta_key && is_protected_meta( $meta_key, 'post' ) ) {
1102 case 'edit_comment':
1103 $comment = get_comment( $args[0] );
1104 $post = get_post( $comment->comment_post_ID );
1105 $post_type_object = get_post_type_object( $post->post_type );
1107 $caps = map_meta_cap( $post_type_object->cap->edit_post, $user_id, $post->ID );
1109 case 'unfiltered_upload':
1110 if ( defined('ALLOW_UNFILTERED_UPLOADS') && ALLOW_UNFILTERED_UPLOADS && ( !is_multisite() || is_super_admin( $user_id ) ) )
1113 $caps[] = 'do_not_allow';
1116 case 'edit_plugins':
1118 if ( defined('DISALLOW_FILE_EDIT') && DISALLOW_FILE_EDIT ) {
1119 $caps[] = 'do_not_allow';
1122 // Fall through if not DISALLOW_FILE_EDIT.
1123 case 'update_plugins':
1124 case 'delete_plugins':
1125 case 'install_plugins':
1126 case 'update_themes':
1127 case 'delete_themes':
1128 case 'install_themes':
1130 // Disallow anything that creates, deletes, or edits core, plugin, or theme files.
1131 // Files in uploads are excepted.
1132 if ( defined('DISALLOW_FILE_MODS') && DISALLOW_FILE_MODS ) {
1133 $caps[] = 'do_not_allow';
1136 // Fall through if not DISALLOW_FILE_MODS.
1137 case 'unfiltered_html':
1138 // Disallow unfiltered_html for all users, even admins and super admins.
1139 if ( defined('DISALLOW_UNFILTERED_HTML') && DISALLOW_UNFILTERED_HTML ) {
1140 $caps[] = 'do_not_allow';
1143 // Fall through if not DISALLOW_UNFILTERED_HTML
1145 case 'delete_users':
1146 // If multisite these caps are allowed only for super admins.
1147 if ( is_multisite() && !is_super_admin( $user_id ) ) {
1148 $caps[] = 'do_not_allow';
1150 if ( 'delete_user' == $cap )
1151 $cap = 'delete_users';
1155 case 'create_users':
1156 if ( !is_multisite() )
1158 elseif ( is_super_admin() || get_site_option( 'add_new_users' ) )
1161 $caps[] = 'do_not_allow';
1164 // Handle meta capabilities for custom post types.
1165 $post_type_meta_caps = _post_type_meta_capabilities();
1166 if ( isset( $post_type_meta_caps[ $cap ] ) ) {
1167 $args = array_merge( array( $post_type_meta_caps[ $cap ], $user_id ), $args );
1168 return call_user_func_array( 'map_meta_cap', $args );
1171 // If no meta caps match, return the original cap.
1175 return apply_filters('map_meta_cap', $caps, $cap, $user_id, $args);
1179 * Whether current user has capability or role.
1183 * @param string $capability Capability or role name.
1186 function current_user_can( $capability ) {
1187 $current_user = wp_get_current_user();
1189 if ( empty( $current_user ) )
1192 $args = array_slice( func_get_args(), 1 );
1193 $args = array_merge( array( $capability ), $args );
1195 return call_user_func_array( array( $current_user, 'has_cap' ), $args );
1199 * Whether current user has a capability or role for a given blog.
1203 * @param int $blog_id Blog ID
1204 * @param string $capability Capability or role name.
1207 function current_user_can_for_blog( $blog_id, $capability ) {
1208 $current_user = wp_get_current_user();
1210 if ( empty( $current_user ) )
1213 // Create new object to avoid stomping the global current_user.
1214 $user = new WP_User( $current_user->ID) ;
1216 // Set the blog id. @todo add blog id arg to WP_User constructor?
1217 $user->for_blog( $blog_id );
1219 $args = array_slice( func_get_args(), 2 );
1220 $args = array_merge( array( $capability ), $args );
1222 return call_user_func_array( array( &$user, 'has_cap' ), $args );
1226 * Whether author of supplied post has capability or role.
1230 * @param int|object $post Post ID or post object.
1231 * @param string $capability Capability or role name.
1234 function author_can( $post, $capability ) {
1235 if ( !$post = get_post($post) )
1238 $author = new WP_User( $post->post_author );
1240 if ( empty( $author->ID ) )
1243 $args = array_slice( func_get_args(), 2 );
1244 $args = array_merge( array( $capability ), $args );
1246 return call_user_func_array( array( &$author, 'has_cap' ), $args );
1250 * Whether a particular user has capability or role.
1254 * @param int|object $user User ID or object.
1255 * @param string $capability Capability or role name.
1258 function user_can( $user, $capability ) {
1259 if ( ! is_object( $user ) )
1260 $user = new WP_User( $user );
1262 if ( ! $user || ! $user->ID )
1265 $args = array_slice( func_get_args(), 2 );
1266 $args = array_merge( array( $capability ), $args );
1268 return call_user_func_array( array( &$user, 'has_cap' ), $args );
1272 * Retrieve role object.
1274 * @see WP_Roles::get_role() Uses method to retrieve role object.
1277 * @param string $role Role name.
1280 function get_role( $role ) {
1283 if ( ! isset( $wp_roles ) )
1284 $wp_roles = new WP_Roles();
1286 return $wp_roles->get_role( $role );
1290 * Add role, if it does not exist.
1292 * @see WP_Roles::add_role() Uses method to add role.
1295 * @param string $role Role name.
1296 * @param string $display_name Display name for role.
1297 * @param array $capabilities List of capabilities, e.g. array( 'edit_posts' => true, 'delete_posts' => false );
1298 * @return null|WP_Role WP_Role object if role is added, null if already exists.
1300 function add_role( $role, $display_name, $capabilities = array() ) {
1303 if ( ! isset( $wp_roles ) )
1304 $wp_roles = new WP_Roles();
1306 return $wp_roles->add_role( $role, $display_name, $capabilities );
1310 * Remove role, if it exists.
1312 * @see WP_Roles::remove_role() Uses method to remove role.
1315 * @param string $role Role name.
1318 function remove_role( $role ) {
1321 if ( ! isset( $wp_roles ) )
1322 $wp_roles = new WP_Roles();
1324 return $wp_roles->remove_role( $role );
1328 * Retrieve a list of super admins.
1332 * @uses $super_admins Super admins global variable, if set.
1334 * @return array List of super admin logins
1336 function get_super_admins() {
1337 global $super_admins;
1339 if ( isset($super_admins) )
1340 return $super_admins;
1342 return get_site_option( 'site_admins', array('admin') );
1346 * Determine if user is a site admin.
1350 * @param int $user_id (Optional) The ID of a user. Defaults to the current user.
1351 * @return bool True if the user is a site admin.
1353 function is_super_admin( $user_id = false ) {
1355 $user = new WP_User( $user_id );
1357 $user = wp_get_current_user();
1359 if ( empty( $user->ID ) )
1362 if ( is_multisite() ) {
1363 $super_admins = get_super_admins();
1364 if ( is_array( $super_admins ) && in_array( $user->user_login, $super_admins ) )
1367 if ( $user->has_cap('delete_users') )