Gravity_Forms\Gravity_Forms\Abilities\GF_Ability
Extends the WordPress ability object with Gravity Forms-specific guards and lifecycle hooks.
Since: 3.1.0
Source: includes/abilities/class-gf-ability.php:10
Details
- Kind:
class - Namespace:
Gravity_Forms\Gravity_Forms\Abilities - Extends:
WP_Ability
Methods
| Method | Description |
|---|---|
check_permissions() | Check ability permissions. |
execute() | Execute the ability after input validation and permission checks. |
do_execute() | Execute the ability after re-checking permissions. |
Method Reference
check_permissions()
public function check_permissions( $input=[] )
Check ability permissions.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | [] | The ability input. |
Returns
bool|\WP_Error— True to allow, false to deny, or a WP_Error with a denial reason. Do not narrow to bool: a WP_Error return would then raise a TypeError at this boundary.
Since: 3.1.0
Source: includes/abilities/class-gf-ability.php:22
execute()
public function execute( $input=null )
Execute the ability after input validation and permission checks.
Overridden so denials from the parent's permission gate fire the gform_ability_permission_denied action; the parent returns its error before do_execute() is ever reached.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | mixed | null | The ability input. |
Returns
mixed
Since: 3.1.0
Source: includes/abilities/class-gf-ability.php:71
do_execute()
public function do_execute( $input=[] )
Execute the ability after re-checking permissions.
This stays public so the tests can drive it directly. Production code must call execute() instead, which adds the schema validation this method skips.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | [] | The ability input. |
Returns
mixed
Since: 3.1.0
Source: includes/abilities/class-gf-ability.php:94