wppaste
WordPress

WP_Role

Since
2.0.0
Source
wp-includes/class-wp-role.php:15
Core class used to extend the user roles API.

Compatibility

WordPress
since 2.0.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 1

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

Properties · 2

$namestringpublic
Role name.
$capabilitiesbool[]public
List of capabilities the role contains.

Methods · 4

Source code

#[AllowDynamicProperties]class WP_Role {	/**	 * Role name.	 *	 * @since 2.0.0	 * @var string	 */	public $name; 	/**	 * List of capabilities the role contains.	 *	 * @since 2.0.0	 * @var bool[] Array of key/value pairs where keys represent a capability name and boolean values	 *             represent whether the role has that capability.	 */	public $capabilities; 	/**	 * 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.	 *	 * @since 2.0.0	 *	 * @param string $role         Role name.	 * @param bool[] $capabilities Array of key/value pairs where keys represent a capability name and boolean values	 *                             represent whether the role has that capability.	 */	public function __construct( $role, $capabilities ) {		$this->name         = $role;		$this->capabilities = $capabilities;	} 	/**	 * Assign role a capability.	 *	 * @since 2.0.0	 *	 * @param string $cap   Capability name.	 * @param bool   $grant Whether role has capability privilege.	 */	public function add_cap( $cap, $grant = true ) {		$this->capabilities[ $cap ] = $grant;		wp_roles()->add_cap( $this->name, $cap, $grant );	} 	/**	 * Removes a capability from a role.	 *	 * @since 2.0.0	 *	 * @param string $cap Capability name.	 */	public function remove_cap( $cap ) {		unset( $this->capabilities[ $cap ] );		wp_roles()->remove_cap( $this->name, $cap );	} 	/**	 * Determines whether the role has the given capability.	 *	 * @since 2.0.0	 *	 * @param string $cap Capability name.	 * @return bool Whether the role has the given capability.	 */	public function has_cap( $cap ) {		/**		 * Filters which capabilities a role has.		 *		 * @since 2.0.0		 *		 * @param bool[] $capabilities Array of key/value pairs where keys represent a capability name and boolean values		 *                             represent whether the role has that capability.		 * @param string $cap          Capability name.		 * @param string $name         Role name.		 */

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.0.4 tag, from src/wp-includes/class-wp-role.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.