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

Public Member Functions

 __construct ()
 
 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...
 
 add_hooks ()
 Add filters to modify the front-end label and the Add Field label. More...
 
 field_label ( $label='', $field=array(), $form=array(), $entry=array())
 Use the GV Admin Field label for the Password field instead of the per-input setting. More...
 
 get_value ( $value, $field, $view, $source, $entry, $request)
 Filter the value of the field, future. 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_Password'
 
 $group = 'advanced'
 
 $is_searchable = false
 
 $name = 'password'
 
- 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

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

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

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

References add_hooks().

Member Function Documentation

◆ 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$fieldsAssociative array of fields, with keys as field type
array$formGF Form array
bool$include_parent_fieldWhether 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.

Definition at line 101 of file class-gravityview-field-password.php.

References $field.

◆ add_hooks()

add_hooks ( )

Add filters to modify the front-end label and the Add Field label.

Since
1.17
Returns
void

Definition at line 56 of file class-gravityview-field-password.php.

Referenced by __construct().

◆ field_label()

field_label (   $label = '',
  $field = array(),
  $form = array(),
  $entry = array() 
)

Use the GV Admin Field label for the Password field instead of the per-input setting.

Since
1.17
Parameters
string$labelField label HTML
array$fieldGravityView field array
array$formGravity Forms form array
array$entryGravity Forms entry array
Returns
string If a custom field label isn't set, return the field label for the password field

Definition at line 74 of file class-gravityview-field-password.php.

References $field, GV\$form, and GravityView_Field\$label.

◆ get_value()

get_value (   $value,
  $field,
  $view,
  $source,
  $entry,
  $request 
)

Filter the value of the field, future.

Since
2.0
Parameters
mixed$valueThe value of the field.
\GV\Field$fieldThe field as seen by future.
\GV\View$viewThe view requested in.
\GV\Source$sourceThe data source (form).
\GV\Entry$entryThe entry.
\GV\Request$requestThe request context.
Returns
mixed $value The filtered value.

Passwords should never be exposed.

Definition at line 43 of file class-gravityview-field-password.php.

Field Documentation

◆ $_gf_field_class_name

$_gf_field_class_name = 'GF_Field_Password'
See also
GF_Field_Password

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

◆ $group

$group = 'advanced'

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

◆ $is_searchable

$is_searchable = false

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

◆ $name

$name = 'password'

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


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