GF_Field_Checkbox

• Introduction
• Settings and Properties
• Settings
• Properties
• Hooks
• Source Code

Introduction

The GF_Field_Checkbox class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Checkbox field is rendered when the form is displayed and how its value is handled during and after form submission. This class also handles the Product Option field rendering when it is a checkbox.

Settings and Properties

Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.

Properties contain the values specified by the settings and generally are part of the Field Object.

The properties may be retrieved by accessing the Field Object as follows:

//get the field
$field = GFFormsModel::get_field( $form, 1 );

//get the admin label
$admin_label = $field->adminLabel;

Settings

The following settings are available for the field:

Properties

Below is a listing of the properties inherited from the parent class and ones specific to the field:

Each element of the choices array can contain the following properties:

$choices = array(
	array(
		'text'       => 'First Choice',
		'value'      => 'one',
		'isSelected' => false,
		'price'      => '$5.00' //only populated if a product option field
	),
	array(
		'text'       => 'Second Choice',
		'value'      => 'two',
		'isSelected' => true,
		'price'      => ''
	),
	array(
		'text'       => 'Third Choice',
		'value'      => 'three',
		'isSelected' => false,
		'price'      => ''
	),
);

Each element of the inputs array can contain the following properties:

$inputs = array(
	array(
		'id'    => '1.1',
		'label' => 'First Choice',
	),
	array(
		'id'    => '1.2',
		'label' => 'Second Choice',
	),
	array(
		'id'    => '1.3',
		'label' => 'Third Choice',
	),
);

Hooks

The following hooks are located in GF_Field_Checkbox:

• gform_checkbox_select_all_label
• gform_checkbox_deselect_all_label
• gform_checkbox_limit_exact_message
• gform_checkbox_limit_max_message
• gform_checkbox_limit_min_message
• gform_checkbox_limit_range_message
• gform_field_choices_max_count_visible
• gform_field_choice_markup_pre_render
• gform_field_choices

Source Code

The source code is located in includes/fields/class-gf-field-checkbox.php in the Gravity Forms folder of your sites plugins directory.