{"id":42894,"date":"2025-03-18T11:29:12","date_gmt":"2025-03-18T15:29:12","guid":{"rendered":"https:\/\/docs.gravityforms.com\/?p=42894"},"modified":"2025-04-18T16:56:55","modified_gmt":"2025-04-18T20:56:55","slug":"field-properties","status":"publish","type":"post","link":"https:\/\/docs.gravityforms.com\/field-properties\/","title":{"rendered":"Field Properties"},"content":{"rendered":"\n

Introduction<\/h2>\n\n\n\n

Each field in the Settings API is configured with the following properties:<\/p>\n\n\n\n

Property<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
type<\/td>string<\/a><\/td>The setting field type. Possible values: text, textarea, hidden, checkbox, radio, select, select_custom, field_map, dynamic_field_map, field_select, checkbox_and_select, save or a custom type.<\/td><\/tr>
input_type<\/td>string<\/a><\/td>The value of the fields input type attribute (e.g. password). Applies to fields of type text.<\/td><\/tr>
name<\/td>string<\/a><\/td>The setting name. For feed based add-ons this will be used as key to the setting value in the feed meta array.<\/td><\/tr>
id<\/td>string<\/a><\/td>The value of the id attribute of the element containing this setting. If the id is not specified, then the value from the name property will be used instead.<\/td><\/tr>
label<\/td>string<\/a><\/td>The setting label.<\/td><\/tr>
required<\/td>boolean<\/a><\/td>Determines whether the field is required to be filled out or not. Use true or false. The indicator for a required field will be displayed next to the label.<\/td><\/tr>
class<\/td>string<\/a><\/td>The value of the class attribute for the field input<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Note: There are three useful Gravity Form’s classes named “small”, “medium”, and “large” which you may use to control the size of the field generated.<\/p>\n\n\n\n

Property<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
tooltip<\/td>string<\/a><\/td>The content to be included in the tooltip for this setting.<\/td><\/tr>
tooltip_class<\/td>string<\/a><\/td>The tooltip class; the value to be appended to the class attribute of the element containing this settings tooltip.<\/td><\/tr>
hidden<\/td>boolean<\/a><\/td>Controls the display of the field. If set to true, the html is still created but the field is not visible. The style “display:none” is applied. This functions similarly to the field type of “hidden”. The main difference is that when using the field type of hidden, a hidden text box is generated (). With this property, you can hide any field type.<\/td><\/tr>
default_value<\/td>string<\/a><\/td>The default value for the field. Does not apply to the checkbox field.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

For fields of type radio or select, if a default_value is specified for the field and a matching value is found for a choice, the radio button\/dropdown item will be selected. If the choice does not have a value specified but does have a label, the label will be used to find a match.<\/p>\n\n\n\n

Property<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
horizontal<\/td>boolean<\/td>When set to true, the checkboxes or radio buttons will be displayed side-by-side instead of one per line. Applies to fields of type checkbox or radio only.<\/td><\/tr>
dependency<\/td>string<\/a>|array<\/a><\/td>See Dependency above.<\/td><\/tr>
choices<\/td>array<\/a><\/td>An array of choices. Required for radio, checkbox and select field types. See Choices below.<\/td><\/tr>
allow_html<\/td>boolean<\/a><\/td>For Textarea fields only, if set to true, HTML in the textarea won’t be all stripped, it uses wp_kses() with the post context instead of sanitize_text_field(), so any HTML allowed in a post, will be allowed in the textarea, if the property doesn’t exist or is set to false, all HTML tags will be stripped, and other things sanitize_text_field() does.<\/td><\/tr>
use_editor<\/td>boolean<\/a><\/td>For Textarea fields only, when set to true, it initialize as Rich Text Editor. HTML will be handled just like when allow_html is set to true.<\/td><\/tr>
feedback_callback<\/td>string<\/a>|array<\/a><\/td>For text fields only. The function containing the feedback logic e.g. array( $this, ‘is_valid_setting’ ).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

The feedback callback function should return true or false and will determine which feedback indicator will be displayed in the UI. At present, the indicator is either a check icon for true or an x icon for false. This display is purely informative and does not prevent the settings from being saved. Check out the API key settings in the MailChimp Add-On for an example.<\/p>\n\n\n\n

Property<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
callback<\/td>array<\/a><\/td>Allows you to specify a different function used to create the field html instead of the function associated with the field type. This is the same as if you implemented a custom field type. e.g. array( $this, ‘my_replacement_function_for_displaying_field’ )<\/td><\/tr>
validation_callback<\/td>string<\/a>|array<\/a><\/td>The function containing the custom validation logic e.g. array( $this, ‘is_valid_setting’ ).<\/td><\/tr>
after_input<\/td>string<\/a><\/td>The content which is to be appended after the text field.<\/td><\/tr>
field_map<\/td>array<\/a><\/td>An array of child fields, such as those used by a third-party service, which the user would map to their form fields. Used by the field_map and dynamic_field_map field types. Each child field is configured using the Field Properties.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Resources<\/h2>\n\n\n\n
\n