GravityView  2.17
The best, easiest way to display Gravity Forms entries on your website.
Public Member Functions | Data Fields | Protected Member Functions
GravityView_Field_Created_By Class Reference
Inheritance diagram for GravityView_Field_Created_By:
GravityView_Field

Public Member Functions

 __construct ()
 
 field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
 
 replace_merge_tag ( $matches=array(), $text='', $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
 Exactly like Gravity Forms' User Meta functionality, but instead shows information on the user who created the entry instead of the currently logged-in user. 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

 $_custom_merge_tag = 'created_by'
 
 $group = 'meta'
 
 $icon = 'dashicons-admin-users'
 
 $is_searchable = true
 
 $name = 'created_by'
 
 $search_operators = array( 'is', 'isnot', 'in', 'not_in' )
 
- 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
 

Protected Member Functions

 custom_merge_tags ( $form=array(), $fields=array())
 Add custom merge tags to merge tag options. More...
 
- 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...
 

Additional Inherited Members

- Protected Attributes inherited from GravityView_Field
 $_custom_merge_tag = false
 
 $_field_id = ''
 
 $_field_options = array()
 

Detailed Description

Definition at line 8 of file class-gravityview-field-created-by.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

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

References GV\description.

Member Function Documentation

◆ custom_merge_tags()

custom_merge_tags (   $form = array(),
  $fields = array() 
)
protected

Add custom merge tags to merge tag options.

Since
1.16
Parameters
array$formGF Form array
GF_Field[]$fields Array of fields in the form
Returns
array Modified merge tags

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

◆ field_options()

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

Definition at line 123 of file class-gravityview-field-created-by.php.

◆ replace_merge_tag()

replace_merge_tag (   $matches = array(),
  $text = '',
  $form = array(),
  $entry = array(),
  $url_encode = false,
  $esc_html = false 
)

Exactly like Gravity Forms' User Meta functionality, but instead shows information on the user who created the entry instead of the currently logged-in user.

See also
https://docs.gravityview.co/article/281-the-createdby-merge-tag Read how to use the {created_by} merge tag
Since
1.16
Parameters
array$matchesArray of Merge Tag matches found in text by preg_match_all
string$textText to replace
array$formGravity Forms form array
array$entryEntry array
bool$url_encodeWhether to URL-encode output
bool$esc_htmlWhether to apply esc_html() to output
Returns
string Text, with user variables replaced, if they existed
Since
1.13.2

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

References $entry, and $value.

Field Documentation

◆ $_custom_merge_tag

$_custom_merge_tag = 'created_by'

Definition at line 18 of file class-gravityview-field-created-by.php.

◆ $group

$group = 'meta'

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

◆ $icon

$icon = 'dashicons-admin-users'

Definition at line 20 of file class-gravityview-field-created-by.php.

◆ $is_searchable

$is_searchable = true

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

◆ $name

$name = 'created_by'

Definition at line 10 of file class-gravityview-field-created-by.php.

◆ $search_operators

$search_operators = array( 'is', 'isnot', 'in', 'not_in' )

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


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