Gravity_Forms\Gravity_Forms\Abilities\GF_Ability_Schemas
Provides reusable schemas for Gravity Forms abilities.
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:10
Details
- Kind:
class - Namespace:
Gravity_Forms\Gravity_Forms\Abilities
Methods
| Method | Description |
|---|---|
entry_search_criteria_schema() | Get the entry search criteria schema. |
sorting_schema() | Get the sorting schema. |
paging_schema() | Get the paging schema. |
form_summary_properties() | Get the form summary schema properties. |
single_id_input_schema() | Get the input schema for an ability whose only required input is a single integer ID. |
form_ids_property() | Get the form_ids input property accepting a single integer or an array of integers. |
success_output_schema() | Get the output schema for abilities that only report success. |
form_mutation_output_schema() | Get the output schema for abilities that produce a new form (create, duplicate). |
form_field_item_schema() | Get the items schema for a form field definition array. |
phone_format_options() | Get the valid phone format keys from the registered phone field. |
form_settings_properties() | Get the form scheduling and entry limit settings properties. |
input_values_schema() | Get the input_values schema for submission abilities. |
validation_messages_schema() | Get the validation_messages output schema for submission abilities. |
entry_summary_properties() | Get the entry summary schema properties. |
Method Reference
entry_search_criteria_schema()
public static function entry_search_criteria_schema()
Get the entry search criteria schema.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:19
sorting_schema()
public static function sorting_schema()
Get the sorting schema.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:81
paging_schema()
public static function paging_schema()
Get the paging schema.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:113
form_summary_properties()
public static function form_summary_properties()
Get the form summary schema properties.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:143
single_id_input_schema()
public static function single_id_input_schema( $property, $description )
Get the input schema for an ability whose only required input is a single integer ID.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$property | string | The input property name (e.g. 'form_id', 'entry_id'). | |
$description | string | The property description. |
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:164
form_ids_property()
public static function form_ids_property()
Get the form_ids input property accepting a single integer or an array of integers.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:185
success_output_schema()
public static function success_output_schema()
Get the output schema for abilities that only report success.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:201
form_mutation_output_schema()
public static function form_mutation_output_schema()
Get the output schema for abilities that produce a new form (create, duplicate).
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:217
form_field_item_schema()
public static function form_field_item_schema( $include_field_id=false, $depth=0 )
Get the items schema for a form field definition array.
Shared by forms-create and forms-update. The update variant includes the field id property so existing fields can be matched.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$include_field_id | bool | false | Whether to include the 'id' property (update variant). |
$depth | 0 |
Returns
array
Since:
3.1.0next added $depth parameter to limit recursion depth for nested repeater fields.
Source: includes/abilities/schemas/class-gf-ability-schemas.php:242
phone_format_options()
public static function phone_format_options()
Get the valid phone format keys from the registered phone field.
Built from the live field so formats added via the gform_phone_formats filter validate instead of being rejected by the schema enum.
Returns
string[]
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:325
form_settings_properties()
public static function form_settings_properties()
Get the form scheduling and entry limit settings properties.
Shared by forms-create and forms-update.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:344
input_values_schema()
public static function input_values_schema()
Get the input_values schema for submission abilities.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:368
validation_messages_schema()
public static function validation_messages_schema()
Get the validation_messages output schema for submission abilities.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:386
entry_summary_properties()
public static function entry_summary_properties()
Get the entry summary schema properties.
Returns
array
Since: 3.1.0
Source: includes/abilities/schemas/class-gf-ability-schemas.php:401