GravityView  2.17
The best, easiest way to display Gravity Forms entries on your website.
Public Member Functions | Data Fields
GravityView_Field_Section Class Reference

Add custom options for HTML field. More...

Inheritance diagram for GravityView_Field_Section:
GravityView_Field

Public Member Functions

 __construct ()
 
 field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
 
 prevent_empty_field ( $output='')
 Prevent Sections from being hidden when "Hide Empty Fields" is checked in View settings. 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...
 

Data Fields

 $_gf_field_class_name = 'GF_Field_Section'
 
 $group = 'standard'
 
 $icon = 'dashicons-minus'
 
 $is_searchable = false
 
 $name = 'section'
 
- 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 HTML field.

Definition at line 11 of file class-gravityview-field-section.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 23 of file class-gravityview-field-section.php.

Member Function Documentation

◆ field_options()

field_options (   $field_options,
  $template_id,
  $field_id,
  $context,
  $input_type,
  $form_id 
)

Definition at line 44 of file class-gravityview-field-section.php.

◆ prevent_empty_field()

prevent_empty_field (   $output = '')

Prevent Sections from being hidden when "Hide Empty Fields" is checked in View settings.

Since
1.15.1
Parameters
string$outputExisting section field output
Returns
string If output was empty, return an empty HTML comment tag. Otherwise, return output.

Definition at line 40 of file class-gravityview-field-section.php.

References $output.

Field Documentation

◆ $_gf_field_class_name

$_gf_field_class_name = 'GF_Field_Section'

Definition at line 17 of file class-gravityview-field-section.php.

◆ $group

$group = 'standard'

Definition at line 19 of file class-gravityview-field-section.php.

◆ $icon

$icon = 'dashicons-minus'

Definition at line 21 of file class-gravityview-field-section.php.

◆ $is_searchable

$is_searchable = false

Definition at line 15 of file class-gravityview-field-section.php.

◆ $name

$name = 'section'

Definition at line 13 of file class-gravityview-field-section.php.


The documentation for this class was generated from the following file: