Skip to main content

Gravity_Forms\Gravity_Forms\Settings\Fields\Checkbox_And_Select

Source: includes/settings/fields/class-checkbox-and-select.php:13

Details

  • Kind: class
  • Namespace: Gravity_Forms\Gravity_Forms\Settings\Fields
  • Extends: Base

Properties

PropertyTypeDescription
$typestringField type.
$inputsBase[]Child inputs.

Methods

MethodDescription
__construct()Initialize Checkbox and Select field.
markup()Render field.
get_values_from_post()Get the correctly-grouped values from $_POST for use in validation.
save_field()Filter out unneeded select values when the checkbox isn't checked.
do_validation()Validate posted field value.

Method Reference

__construct()

public function __construct( $props, $settings )

Initialize Checkbox and Select field.

Parameters

NameTypeDefaultDescription
$propsarrayField properties.
$settings\Gravity_Forms\Gravity_Forms\Settings\SettingsSettings instance.

Since: 2.5

Source: includes/settings/fields/class-checkbox-and-select.php:41

markup()

public function markup()

Render field.

Returns

  • string

Since: 2.5

Source: includes/settings/fields/class-checkbox-and-select.php:106

get_values_from_post()

public function get_values_from_post( $values )

Get the correctly-grouped values from $_POST for use in validation.

Parameters

NameTypeDefaultDescription
$valuesarrayThe $_POST values.

Returns

  • array

Since: 2.5

Source: includes/settings/fields/class-checkbox-and-select.php:139

save_field()

public function save_field( $field_values, $field_value )

Filter out unneeded select values when the checkbox isn't checked.

Parameters

NameTypeDefaultDescription
$field_valuesarrayPosted field values.
$field_valuearray | bool | stringPosted value for field.

Returns

  • array

Since: 2.5

Source: includes/settings/fields/class-checkbox-and-select.php:165

do_validation()

public function do_validation( $values )

Validate posted field value.

Parameters

NameTypeDefaultDescription
$valuesarrayPosted field values.

Since: 2.5-beta-3

Source: includes/settings/fields/class-checkbox-and-select.php:187