PHP Class WPDKUserCapabilities

## Overview You have not confuse the property as roleCapabilities by the method roleCapabilities(). The properties are a linear array such array( cap1, cap2, ..., capn). The method instead return a key values pair array such array( cap1 => array( cap1, desc, owner), ... ). The method return the extend information, the property only the name.

Since: 1.6.0

Author: =undo= ([email protected])

Show file Open project: wpxtreme/wpdk Class Usage Examples

Public Properties

Property	Type	Description
$allCapabilities	array	The list of all capabilities
$capabilities	array	This is the capabilities list without WordPress capabilties
$defaultCapabilities	array	The standard WordPress capabilities list
$roleCapabilities	array	All capabilities in all roles
$userCapabilities	array	The list of capabilities added to users

Public Methods

Method	Description
add_cap ( WPDKUserCapability $cap, array $roles = [], array $users = [] )	Add a capability to roles and/or users
allCapabilities ( ) : array	Return a key value pairs array with all registered capabilities.
capabilityExists ( string $cap ) : boolean	Return TRUE if a capability exists
defaultCapabilities ( ) : array	Return a key value pairs array with unique id key of capability and the description as value.
delete ( string \| array $id )	Delete capabilities
delete_extended_data ( string \| WPDKUserCapability $capability )	Delete the capabilties extended data
getInstance ( ) : WPDKUserCapabilities	Return a singleton instance of WPDKUserCapabilities class
get_extended_data ( string \| WPDKUserCapability $capability ) : boolean	Return the capabilties extended data or FALSE if not found.
init ( ) : WPDKUserCapabilities	Return a singleton instance of WPDKUserCapabilities class
roleCapabilities ( ) : array	Gets an array of capabilities according to each user role. Each role will return its caps, which are then added to the overall $capabilities array.
update_extended_data ( WPDKUserCapability $capability )	Updated the capabilties extended data
userCapabilities ( ) : array	Return the capability added to user.
usersCapability ( ) : array	Return a key value pairs array. For each user the list of its capabilties.
usersWithCaps ( string \| array $caps )	Return a list of users id with any caps

Private Methods

Method	Description
__construct ( ) : WPDKUserCapabilities	Create an instance of WPDKUserCapabilities class
oldLevels ( ) : array	Return a key value pairs array with unique id key of capability and the description as value.

Method Details

add_cap() public method

Add a capability to roles and/or users

Since: 1.5.4

public add_cap ( WPDKUserCapability $cap, array $roles = [], array $users = [] )
$cap	WPDKUserCapability	An instance of WPDKUserCapability class
$roles	array	Optional. List of roles where add this cap
$users	array	Optional. List of user id where add this cap

allCapabilities() public method

[cap] = [cap, desc, owner]

public allCapabilities ( ) : array
return	array

capabilityExists() public method

Return TRUE if a capability exists

Since: 1.5.4

public capabilityExists ( string $cap ) : boolean
$cap	string	Capability ID
return	boolean

defaultCapabilities() public static method

Make sure we keep the default capabilities in case users screw 'em up. A user could easily remove a useful WordPress capability from all roles. When this happens, the capability is no longer stored in any of the roles, so it basically doesn't exist. This function will house all of the default WordPress capabilities in case this scenario comes into play. For those reading this note, yes, I did "accidentally" remove all capabilities from my administrator account when developing this plugin. And yes, that was fun putting back together.

public static defaultCapabilities ( ) : array
return	array	$defaults All the default WordPress capabilities.

delete() public method

Delete capabilities

public delete ( string \| array $id )
$id	string \| array	Any single or array of caps

delete_extended_data() public method

Delete the capabilties extended data

Since: 1.5.4

public delete_extended_data ( string \| WPDKUserCapability $capability )
$capability	string \| WPDKUserCapability	Any cap id or WPDKUserCapability istance

getInstance() public static method

Return a singleton instance of WPDKUserCapabilities class

Deprecation: since 1.5.4 use get_instance() or init() instead

public static getInstance ( ) : WPDKUserCapabilities
return	WPDKUserCapabilities

get_extended_data() public method

Return the capabilties extended data or FALSE if not found.

Since: 1.5.4

public get_extended_data ( string \| WPDKUserCapability $capability ) : boolean
$capability	string \| WPDKUserCapability	Any cap id or WPDKUserCapability istance
return	boolean

init() public static method

Return a singleton instance of WPDKUserCapabilities class

public static init ( ) : WPDKUserCapabilities
return	WPDKUserCapabilities

roleCapabilities() public method

Note that if no role has the capability, it technically no longer exists. Since this could be a problem with folks accidentally deleting the default WordPress capabilities, the members_default_capabilities() will return all the defaults. [cap] = [cap, desc, owner]

public roleCapabilities ( ) : array
return	array	$capabilities All the capabilities of all the user roles.

update_extended_data() public method

Updated the capabilties extended data

Since: 1.5.4

public update_extended_data ( WPDKUserCapability $capability )
$capability	WPDKUserCapability	An instance of WPDKUserCapability class

userCapabilities() public method

[cap] = [cap, desc, owner]

public userCapabilities ( ) : array
return	array

usersCapability() public method

This return array is used to hash from user id its capabilities. [user_id] => [list of capabilities]

public usersCapability ( ) : array
return	array

usersWithCaps() public method

Return a list of users id with any caps

Since: 1.5.4

public usersWithCaps ( string \| array $caps )
$caps	string \| array	Any single or array of caps

Property Details

$allCapabilities public property

The list of all capabilities

public array $allCapabilities
return	array

$capabilities public property

This is the capabilities list without WordPress capabilties

public array $capabilities
return	array

$defaultCapabilities public property

The standard WordPress capabilities list

public array $defaultCapabilities
return	array

$roleCapabilities public property

All capabilities in all roles

public array $roleCapabilities
return	array

$userCapabilities public property

The list of capabilities added to users

public array $userCapabilities
return	array