Add custom options for list fields. More...

Inheritance diagram for GravityView_Field_List:

Public Member Functions
	__construct ()

	_filter_field_label ( $label, $field, $form, $entry)
	When showing a single column values, display the label of the column instead of the field. More...

	add_form_fields ( $fields=array(), $form=array(), $include_parent_field=true)
	If a form has list fields, add the columns to the field picker. More...

	remove_columns_from_searchable_fields ( $fields)
	Removes columns from searchable field dropdown. More...

Public Member Functions inherited from GravityView_Field
	__construct ()
	GravityView_Field constructor. More...

	_filter_gform_custom_merge_tags ( $custom_merge_tags=array(), $form_id=0, $fields=array(), $element_id='')
	Add custom merge tags to merge tag options. More...

	_filter_gform_replace_merge_tags ( $text, $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
	Match the merge tag in replacement text for the field. More...

	_filter_sortable_fields ( $not_sortable)
	Use field settings to modify whether a field is sortable. More...

	add_entry_meta ( $entry_meta)
	Add the custom entry meta key to make it searchable and sortable. More...

	add_field_support ( $key, &$field_options)

	add_sortable_field ( $fields)
	Add the field to the Filter & Sort available fields. More...

	as_array ()
	Returns the field as an array to be used in field pickers. More...

	field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
	Tap in here to modify field options. More...

	replace_merge_tag ( $matches=array(), $text='', $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
	Run GravityView filters when using GFCommon::replace_variables() More...

	set_default_search_label ( $label='', $gf_field=null, $field=array())
	Allow setting a default search label for search fields based on the field type. More...

Static Public Member Functions
static	column_value (GF_Field_List $field, $field_value, $column_id=0, $format='html')
	Get the value of a Multiple Column List field for a specific column. More...

static	get_column_label (GF_Field_List $field, $column_id, $backup_label='')
	Get the column label for the list. More...

Data Fields
	$_gf_field_class_name = 'GF_Field_List'

	$group = 'advanced'

	$icon = 'dashicons-list-view'

	$is_searchable = true

	$is_sortable = false

	$name = 'list'

	$search_operators = array( 'contains' )

Data Fields inherited from GravityView_Field
	$_gf_field_class_name

	$contexts = array( 'single', 'multiple', 'edit', 'export' )

	$default_search_label

	$description

	$entry_meta_is_default_column = false

	$entry_meta_key = null

	$entry_meta_update_callback = null

	$group
	`standard`, `advanced`, `post`, `pricing`, `meta`, `gravityview`, or `add-ons` More...

	$icon = 'dashicons-admin-generic'

	$is_numeric
	boolean Is field content number-based? More...

	$is_searchable = true

	$is_sortable = true
	boolean Can the field be sorted in search? More...

	$label

	$name

	$search_operators

Additional Inherited Members
Protected Member Functions inherited from GravityView_Field
	custom_merge_tags ( $form=array(), $fields=array())
	Add custom Merge Tags to Merge Tag options, if custom Merge Tags exist. More...

	is_choice_value_enabled ()
	Check whether the `enableChoiceValue` flag is set for a GF field. More...

Protected Attributes inherited from GravityView_Field
	$_custom_merge_tag = false

	$_field_id = ''

	$_field_options = array()

Detailed Description

Add custom options for list fields.

Since: 1.14

Definition at line 14 of file class-gravityview-field-list.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 39 of file class-gravityview-field-list.php.

Member Function Documentation

◆ _filter_field_label()

_filter_field_label	(	$label,
		$field,
		$form,
		$entry
	)

When showing a single column values, display the label of the column instead of the field.

Since: 1.14

Parameters

string	$label	Existing label string
array	$field	GV field settings array, with `id`, `show_label`, `label`, `custom_label`, etc. keys
array	$form	Gravity Forms form array
array	$entry	Gravity Forms entry array

Returns: string Existing label if the field isn't

Definition at line 189 of file class-gravityview-field-list.php.

References $column_id, $field, GV\$form, GravityView_Field\$label, and gravityview_get_input_id_from_id().

◆ add_form_fields()

add_form_fields	(	$fields = `array()`,
		$form = `array()`,
		$include_parent_field = `true`
	)

If a form has list fields, add the columns to the field picker.

Since: 1.17

Parameters

array	$fields	Associative array of fields, with keys as field type
array	$form	GF Form array
bool	$include_parent_field	Whether to include the parent field when getting a field with inputs

Returns: array $fields with list field columns added, if exist. Unmodified if form has no list fields.

Merge the $list_columns into the $fields array at $index

See also: https://stackoverflow.com/a/1783125

Definition at line 84 of file class-gravityview-field-list.php.

References GV\$form, and $input_id.

◆ column_value()

static column_value	(	GF_Field_List	$field,
			$field_value,
			$column_id = `0`,
			$format = `'html'`
	)

static

Get the value of a Multiple Column List field for a specific column.

Since: 1.14

See also: GF_Field_List::get_value_entry_detail()

Parameters

GF_Field_List	$field	Gravity Forms field
string \| array	$field_value	Serialized or unserialized array value for the field
int \| string	$column_id	The numeric key of the column (0-index) or the label of the column
string	$format	If set to 'raw', return an array of values for the column. Otherwise, allow Gravity Forms to render using `html` or `text`