3 * User API: WP_Roles class
11 * Core class used to implement a user roles API.
13 * The role option is simple, the structure is organized by role name that store
14 * the name in value of the 'name' key. The capabilities are stored as an array
15 * in the value of the 'capability' key.
18 * 'rolename' => array (
19 * 'name' => 'rolename',
20 * 'capabilities' => array()
28 * List of roles and capabilities.
37 * List of the role objects.
43 public $role_objects = array();
52 public $role_names = array();
55 * Option name for storing role list.
64 * Whether to use the database for retrieval and storage.
70 public $use_db = true;
77 public function __construct() {
82 * Make private/protected methods readable for backward compatibility.
87 * @param callable $name Method to call.
88 * @param array $arguments Arguments to pass when calling.
89 * @return mixed|false Return value of the callback, false otherwise.
91 public function __call( $name, $arguments ) {
92 if ( '_init' === $name ) {
93 return call_user_func_array( array( $this, $name ), $arguments );
99 * Set up the object properties.
101 * The role key is set to the current prefix for the $wpdb object with
102 * 'user_roles' appended. If the $wp_user_roles global is set, then it will
103 * be used and the role option will not be updated or used.
108 * @global array $wp_user_roles Used to set the 'roles' property value.
110 protected function _init() {
111 global $wp_user_roles, $wpdb;
113 $this->role_key = $wpdb->get_blog_prefix() . 'user_roles';
114 if ( ! empty( $wp_user_roles ) ) {
115 $this->roles = $wp_user_roles;
116 $this->use_db = false;
118 $this->roles = get_option( $this->role_key );
121 if ( empty( $this->roles ) )
124 $this->role_objects = array();
125 $this->role_names = array();
126 foreach ( array_keys( $this->roles ) as $role ) {
127 $this->role_objects[$role] = new WP_Role( $role, $this->roles[$role]['capabilities'] );
128 $this->role_names[$role] = $this->roles[$role]['name'];
132 * After the roles have been initialized, allow plugins to add their own roles.
136 * @param WP_Roles $this A reference to the WP_Roles object.
138 do_action( 'wp_roles_init', $this );
142 * Reinitialize the object
144 * Recreates the role objects. This is typically called only by switch_to_blog()
145 * after switching wpdb to a new site ID.
148 * @deprecated 4.7.0 Use new WP_Roles()
151 public function reinit() {
152 _deprecated_function( __METHOD__, '4.7.0', 'new WP_Roles()' );
157 * Add role name with capabilities to list.
159 * Updates the list of roles, if the role doesn't already exist.
161 * The capabilities are defined in the following format `array( 'read' => true );`
162 * To explicitly deny a role a capability you set the value for that capability to false.
167 * @param string $role Role name.
168 * @param string $display_name Role display name.
169 * @param array $capabilities List of role capabilities in the above format.
170 * @return WP_Role|void WP_Role object, if role is added.
172 public function add_role( $role, $display_name, $capabilities = array() ) {
173 if ( empty( $role ) || isset( $this->roles[ $role ] ) ) {
177 $this->roles[$role] = array(
178 'name' => $display_name,
179 'capabilities' => $capabilities
182 update_option( $this->role_key, $this->roles );
183 $this->role_objects[$role] = new WP_Role( $role, $capabilities );
184 $this->role_names[$role] = $display_name;
185 return $this->role_objects[$role];
189 * Remove role by name.
194 * @param string $role Role name.
196 public function remove_role( $role ) {
197 if ( ! isset( $this->role_objects[$role] ) )
200 unset( $this->role_objects[$role] );
201 unset( $this->role_names[$role] );
202 unset( $this->roles[$role] );
205 update_option( $this->role_key, $this->roles );
207 if ( get_option( 'default_role' ) == $role )
208 update_option( 'default_role', 'subscriber' );
212 * Add capability to role.
217 * @param string $role Role name.
218 * @param string $cap Capability name.
219 * @param bool $grant Optional, default is true. Whether role is capable of performing capability.
221 public function add_cap( $role, $cap, $grant = true ) {
222 if ( ! isset( $this->roles[$role] ) )
225 $this->roles[$role]['capabilities'][$cap] = $grant;
227 update_option( $this->role_key, $this->roles );
231 * Remove capability from role.
236 * @param string $role Role name.
237 * @param string $cap Capability name.
239 public function remove_cap( $role, $cap ) {
240 if ( ! isset( $this->roles[$role] ) )
243 unset( $this->roles[$role]['capabilities'][$cap] );
245 update_option( $this->role_key, $this->roles );
249 * Retrieve role object by name.
254 * @param string $role Role name.
255 * @return WP_Role|null WP_Role object if found, null if the role does not exist.
257 public function get_role( $role ) {
258 if ( isset( $this->role_objects[$role] ) )
259 return $this->role_objects[$role];
265 * Retrieve list of role names.
270 * @return array List of role names.
272 public function get_names() {
273 return $this->role_names;
277 * Whether role name is currently in the list of available roles.
282 * @param string $role Role name to look up.
285 public function is_role( $role ) {
286 return isset( $this->role_names[$role] );