GF_Field_Radio

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

Introduction

The GF_Field_Radio class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Radio Button 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, Product Option, and Shipping fields rendering when the field is a radio button.

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 = GFAPI::get_field( $form_or_id, $field_id );

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

Settings

Properties

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

Choices Properties

Each item in the choices array contains the following properties:

Below is what the output would look like:

$choices = array(
	array(
		'text'       => 'First Choice',
		'value'      => 'one',
		'isSelected' => false,
		'price'      => '$5.00', // Only populated if a product, product option or shipping field.
	),
	array(
		'text'       => 'Second Choice',
		'value'      => 'two',
		'isSelected' => true,
		'price'      => '',
	),
	array(
		'text'       => 'Third Choice',
		'value'      => 'three',
		'isSelected' => false,
		'price'      => '',
	),
	array(
		'text'          => 'Other',
		'value'         => 'gf_other_choice',
		'isSelected'    => false,
		'isOtherChoice' => true,
	),
);

Hooks

The following hooks are located in GF_Field_Radio:

• gform_field_choices_max_count_visible
• gform_field_choices
• gform_field_choice_markup_pre_render

Source Code

The source code is located in includes/fields/class-gf-field-radio.php in the Gravity Forms folder of your site’s plugins directory.