WP_Roles

Description

array (
 'rolename' => array (
 'name' => 'rolename',
 'capabilities' => array()
 )
)

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 1

Every hook that fires from inside WP_Roles, in the order it appears in the class, grouped by the method that fires it.

Properties · 6

$rolesarray[]public

List of roles and capabilities.

$role_objectsWP_Role[]public

List of the role objects.

$role_namesstring[]public

List of role names.

$role_keystringpublic

Option name for storing role list.

$use_dbboolpublic

Whether to use the database for retrieval and storage.

$site_idintprotected

The site ID the roles are initialized for.

Methods · 15

• __construct()Constructor.
• __call()Makes private/protected methods readable for backward compatibility.
• _init()Sets up the object properties.
• reinit()Reinitializes the object.
• add_role()Adds a role name with capabilities to the list.
• remove_role()Removes a role by name.
• add_cap()Adds a capability to role.
• remove_cap()Removes a capability from role.
• get_role()Retrieves a role object by name.
• get_names()Retrieves a list of role names.
• is_role()Determines whether a role name is currently in the list of available roles.
• init_roles()Initializes all of the available roles.
• for_site()Sets the site to operate on. Defaults to the current site.
• get_site_id()Gets the ID of the site for which roles are currently initialized.
• get_roles_data()Gets the available roles data.

Source code

View on Trac ↗View on GitHub ↗

26#[AllowDynamicProperties]27class WP_Roles {28	/**29	 * List of roles and capabilities.30	 *31	 * @since 2.0.032	 * @var array[]33	 */34	public $roles;35 36	/**37	 * List of the role objects.38	 *39	 * @since 2.0.040	 * @var WP_Role[]41	 */42	public $role_objects = array();43 44	/**45	 * List of role names.46	 *47	 * @since 2.0.048	 * @var string[]49	 */50	public $role_names = array();51 52	/**53	 * Option name for storing role list.54	 *55	 * @since 2.0.056	 * @var string57	 */58	public $role_key;59 60	/**61	 * Whether to use the database for retrieval and storage.62	 *63	 * @since 2.1.064	 * @var bool65	 */66	public $use_db = true;67 68	/**69	 * The site ID the roles are initialized for.70	 *71	 * @since 4.9.072	 * @var int73	 */74	protected $site_id = 0;75 76	/**77	 * Constructor.78	 *79	 * @since 2.0.080	 * @since 4.9.0 The `$site_id` argument was added.81	 *82	 * @global array $wp_user_roles Used to set the 'roles' property value.83	 *84	 * @param int $site_id Site ID to initialize roles for. Default is the current site.85	 */86	public function __construct( $site_id = null ) {87		global $wp_user_roles;88 89		$this->use_db = empty( $wp_user_roles );90 91		$this->for_site( $site_id );92	}93 94	/**95	 * Makes private/protected methods readable for backward compatibility.96	 *97	 * @since 4.0.098	 *99	 * @param string $name      Method to call.100	 * @param array  $arguments Arguments to pass when calling.101	 * @return mixed|false Return value of the callback, false otherwise.102	 */103	public function __call( $name, $arguments ) {104		if ( '_init' === $name ) {105			return $this->_init( ...$arguments );

Changelog

Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-roles.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.