GravityView_Roles_Capabilities
Source: includes/class-gravityview-roles-capabilities.php:26
Details
- Kind:
class - Namespace:
(global)
Methods
| Method | Description |
|---|---|
get_instance() | |
__construct() | Get things going |
filter_user_has_cap() | Add support for gravityview_full_access capability, and |
members_register_cap_group() | Add GravityView group to Members 1.x plugin management screen |
merge_with_all_caps() | Merge capabilities array with GravityView capabilities |
add_caps() | Add capabilities to their respective roles if they don't already exist |
all_caps() | Get an array of GravityView capabilities |
has_cap() | Check whether the current user has a capability |
maybe_add_full_access_caps() | Add Gravity Forms and GravityView's "full access" caps when any other caps are checked against. |
remove_caps() | Remove all GravityView caps_to_check from all roles |
Method Reference
get_instance()
public static function get_instance()
Returns
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:37
__construct()
public function __construct()
Get things going
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:51
filter_user_has_cap()
public function filter_user_has_cap( $usercaps=[], $caps=[], $args=[], $user=null )
Add support for gravityview_full_access capability, and
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$usercaps | [] | ||
$caps | array | [] | Actual capabilities for meta capability. |
$args | array | [] | Optional parameters passed to has_cap(), typically object ID. |
$user | WP_User | null | null | The user object, in WordPress 3.7.0 or higher |
$allcaps | array | An array of all the user's capabilities. |
Returns
mixed
See Also
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:80
members_register_cap_group()
function members_register_cap_group()
Add GravityView group to Members 1.x plugin management screen
Returns
void
See Also
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:145
merge_with_all_caps()
public static function merge_with_all_caps( $caps )
Merge capabilities array with GravityView capabilities
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$caps | array | Existing capabilities |
Returns
array— Modified capabilities array
Since: 1.15 (Used to add GravityView caps to the Members plugin)
Source: includes/class-gravityview-roles-capabilities.php:167
add_caps()
public function add_caps()
Add capabilities to their respective roles if they don't already exist
This could be simpler, but the goal is speed.
Returns
void
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:200
all_caps()
public static function all_caps( $single_role=false, $flat_array=true )
Get an array of GravityView capabilities
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$single_role | string | false | If set, get the caps_to_check for a specific role. Pass 'all' to get all caps_to_check in a flat array. Default: all |
$flat_array | boolean | true | True: return all caps in a one-dimensional array. False: a multi-dimensional array with $single_role as keys and the caps as the values |
Returns
array— If $role is set, flat array of caps_to_check. Otherwise, a multi-dimensional array of roles and their caps_to_check with the following keys: 'administrator', 'editor', 'author', 'contributor', 'subscriber'
See Also
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:260
has_cap()
public static function has_cap( $caps_to_check='', $object_id=null, $user_id=null )
Check whether the current user has a capability
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$caps_to_check | string | array | '' | Single capability or array of capabilities |
$object_id | int | null | null | (optional) Parameter can be used to check for capabilities against a specific object, such as a post or us |
$user_id | int | null | null | (optional) Check the capabilities for a user who is not necessarily the currently logged-in user |
Returns
bool— True: user has at least one passed capability; False: user does not have any defined capabilities
See Also
\WP_User::user_has_cap()- https://codex.wordpress.org/Plugin_API/Filter_Reference/user_has_cap You can filter permissions based on entry/View/form ID using
user_has_capfilter GFCommon::current_user_can_any
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:352
maybe_add_full_access_caps()
public static function maybe_add_full_access_caps( $caps_to_check=[] )
Add Gravity Forms and GravityView's "full access" caps when any other caps are checked against.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$caps_to_check | array | [] |
Returns
array
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:424
remove_caps()
public function remove_caps()
Remove all GravityView caps_to_check from all roles
Returns
void
Since: 1.15
Source: includes/class-gravityview-roles-capabilities.php:451