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

Add custom options for Code field. More...

Inheritance diagram for GravityView_Field_Custom:
GravityView_Field

Public Member Functions

 __construct ()
 
 add_default_field ( $entry_default_fields, $form=array(), $zone='')
 Add as a default field, outside those set in the Gravity Form form. More...
 
 field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
 
 show_field_in_edit_entry ( $fields, $edit_fields=null, $form=array(), $view_id=0)
 Adds the GravityView Custom Content field to the Edit Entry form. 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

 $contexts = array( 'single', 'multiple', 'edit' )
 
 $group = 'gravityview'
 
 $icon = 'dashicons-editor-code'
 
 $is_searchable = false
 
 $is_sortable = false
 
 $name = 'custom'
 
- 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 Code field.

Since
1.2

Definition at line 12 of file class-gravityview-field-custom.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 34 of file class-gravityview-field-custom.php.

References GV\description.

Member Function Documentation

◆ add_default_field()

add_default_field (   $entry_default_fields,
  $form = array(),
  $zone = '' 
)

Add as a default field, outside those set in the Gravity Form form.

Since
2.10 Moved here from GravityView_Admin_Views::get_entry_default_fields
Parameters
array$entry_default_fieldsExisting fields
string | array$formform_ID or form object
string$zoneEither 'single', 'directory', 'edit', 'header', 'footer'
Returns
array

Definition at line 57 of file class-gravityview-field-custom.php.

References GV\description.

◆ field_options()

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

Definition at line 70 of file class-gravityview-field-custom.php.

◆ show_field_in_edit_entry()

show_field_in_edit_entry (   $fields,
  $edit_fields = null,
  $form = array(),
  $view_id = 0 
)

Adds the GravityView Custom Content field to the Edit Entry form.

It does this by pretending to be a HTML field so that Gravity Forms displays it

Since
1.19.2
Parameters
GF_Field[]$fields Gravity Forms form fields
array | null$edit_fieldsFields for the Edit Entry tab configured in the View Configuration
array$formGF Form array (fields key modified to have only fields configured to show in Edit Entry)
int$view_idView ID
Returns
GF_Field[] If Custom Content field exists, returns fields array with the fields inserted. Otherwise, returns unmodified fields array.

Definition at line 135 of file class-gravityview-field-custom.php.

References $entry, GV\$form, GV\$i, Utils\get(), gravityview(), and GravityView_Merge_Tags\replace_variables().

Field Documentation

◆ $contexts

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

Definition at line 16 of file class-gravityview-field-custom.php.

◆ $group

$group = 'gravityview'

Definition at line 30 of file class-gravityview-field-custom.php.

◆ $icon

$icon = 'dashicons-editor-code'

Definition at line 32 of file class-gravityview-field-custom.php.

◆ $is_searchable

$is_searchable = false

Definition at line 28 of file class-gravityview-field-custom.php.

◆ $is_sortable

$is_sortable = false

Definition at line 22 of file class-gravityview-field-custom.php.

◆ $name

$name = 'custom'

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


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