Gravity_Forms\Gravity_Forms\Abilities\GF_Abilities_Handler_Confirmations
Handles confirmation ability callbacks.
Confirmations are keyed by ID on the form. Writes persist through GFFormsModel::save_form_confirmations() — a targeted save that does not round-trip the whole form (unlike editing confirmations through forms-update), so a targeted edit can never drop fields, and delete is supported.
Since: 3.1.0
Source: includes/abilities/handlers/class-gf-abilities-handler-confirmations.php:15
Details
- Kind:
class - Namespace:
Gravity_Forms\Gravity_Forms\Abilities
Methods
| Method | Description |
|---|---|
list_confirmations() | List a form's confirmations. |
create_confirmation() | Create a confirmation on a form. |
update_confirmation() | Update one confirmation (partial merge by ID). |
delete_confirmation() | Delete one confirmation. |
sanitize() | Apply the unfiltered_html kses gate to a confirmation's message. |
Method Reference
list_confirmations()
public static function list_confirmations( $input )
List a form's confirmations.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | The ability input. |
Returns
array|\WP_Error
Since: 3.1.0
Source: includes/abilities/handlers/class-gf-abilities-handler-confirmations.php:51
create_confirmation()
public static function create_confirmation( $input )
Create a confirmation on a form.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | The ability input. |
Returns
array|\WP_Error
Since: 3.1.0
Source: includes/abilities/handlers/class-gf-abilities-handler-confirmations.php:72
update_confirmation()
public static function update_confirmation( $input )
Update one confirmation (partial merge by ID).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | The ability input. |
Returns
array|\WP_Error
Since: 3.1.0
Source: includes/abilities/handlers/class-gf-abilities-handler-confirmations.php:113
delete_confirmation()
public static function delete_confirmation( $input )
Delete one confirmation.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | The ability input. |
Returns
array|\WP_Error
Since: 3.1.0
Source: includes/abilities/handlers/class-gf-abilities-handler-confirmations.php:167
sanitize()
public static function sanitize( $confirmation )
Apply the unfiltered_html kses gate to a confirmation's message.
This mirrors the admin confirmation save, which the abilities write path skips. It is a no-op for users who hold unfiltered_html.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$confirmation | array | The confirmation settings. |
Returns
array
Since: 3.1.0
Source: includes/abilities/handlers/class-gf-abilities-handler-confirmations.php:211