<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* User API: WP_Role class

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Users

[5] Fix | Delete

* @since 4.4.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core class used to extend the user roles API.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 2.0.0

[12] Fix | Delete

*/

[13] Fix | Delete

#[AllowDynamicProperties]

[14] Fix | Delete

class WP_Role {

[15] Fix | Delete

/**

[16] Fix | Delete

* Role name.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 2.0.0

[19] Fix | Delete

* @var string

[20] Fix | Delete

*/

[21] Fix | Delete

public $name;

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* List of capabilities the role contains.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 2.0.0

[27] Fix | Delete

* @var bool[] Array of key/value pairs where keys represent a capability name and boolean values

[28] Fix | Delete

* represent whether the role has that capability.

[29] Fix | Delete

*/

[30] Fix | Delete

public $capabilities;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Constructor - Set up object properties.

[34] Fix | Delete

*

[35] Fix | Delete

* The list of capabilities must have the key as the name of the capability

[36] Fix | Delete

* and the value a boolean of whether it is granted to the role.

[37] Fix | Delete

*

[38] Fix | Delete

* @since 2.0.0

[39] Fix | Delete

*

[40] Fix | Delete

* @param string $role Role name.

[41] Fix | Delete

* @param bool[] $capabilities Array of key/value pairs where keys represent a capability name and boolean values

[42] Fix | Delete

* represent whether the role has that capability.

[43] Fix | Delete

*/

[44] Fix | Delete

public function __construct( $role, $capabilities ) {

[45] Fix | Delete

$this->name = $role;

[46] Fix | Delete

$this->capabilities = $capabilities;

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Assign role a capability.

[51] Fix | Delete

*

[52] Fix | Delete

* @since 2.0.0

[53] Fix | Delete

*

[54] Fix | Delete

* @param string $cap Capability name.

[55] Fix | Delete

* @param bool $grant Whether role has capability privilege.

[56] Fix | Delete

*/

[57] Fix | Delete

public function add_cap( $cap, $grant = true ) {

[58] Fix | Delete

$this->capabilities[ $cap ] = $grant;

[59] Fix | Delete

wp_roles()->add_cap( $this->name, $cap, $grant );

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Removes a capability from a role.

[64] Fix | Delete

*

[65] Fix | Delete

* @since 2.0.0

[66] Fix | Delete

*

[67] Fix | Delete

* @param string $cap Capability name.

[68] Fix | Delete

*/

[69] Fix | Delete

public function remove_cap( $cap ) {

[70] Fix | Delete

unset( $this->capabilities[ $cap ] );

[71] Fix | Delete

wp_roles()->remove_cap( $this->name, $cap );

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Determines whether the role has the given capability.

[76] Fix | Delete

*

[77] Fix | Delete

* @since 2.0.0

[78] Fix | Delete

*

[79] Fix | Delete

* @param string $cap Capability name.

[80] Fix | Delete

* @return bool Whether the role has the given capability.

[81] Fix | Delete

*/

[82] Fix | Delete

public function has_cap( $cap ) {

[83] Fix | Delete

/**

[84] Fix | Delete

* Filters which capabilities a role has.

[85] Fix | Delete

*

[86] Fix | Delete

* @since 2.0.0

[87] Fix | Delete

*

[88] Fix | Delete

* @param bool[] $capabilities Array of key/value pairs where keys represent a capability name and boolean values

[89] Fix | Delete

* represent whether the role has that capability.

[90] Fix | Delete

* @param string $cap Capability name.

[91] Fix | Delete

* @param string $name Role name.

[92] Fix | Delete

*/

[93] Fix | Delete

$capabilities = apply_filters( 'role_has_cap', $this->capabilities, $cap, $this->name );

[94] Fix | Delete

[95] Fix | Delete

if ( ! empty( $capabilities[ $cap ] ) ) {

[96] Fix | Delete

return $capabilities[ $cap ];

[97] Fix | Delete

} else {

[98] Fix | Delete

return false;

[99] Fix | Delete

}

[100] Fix | Delete

}

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete