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

Public Member Functions

 __construct ()
 
 add_edit_entry_post_category_choices_filter ()
 Add filter to show live category choices in Edit Entry. More...
 
 edit_entry_post_category_choices ($choices, $field, $form_id)
 Always show the live Category values. More...
 
 field_options ($field_options, $template_id, $field_id, $context, $input_type)
 
 remove_edit_entry_post_category_choices_filter ()
 Remove filter to show live category choices in Edit Entry. More...
 
 set_post_categories ($form=array(), $entry_id=0)
 Update the post categories based on all post category fields. More...
 
- Public Member Functions inherited from GravityView_Field
 __construct ()
 GravityView_Field constructor. More...
 
 _filter_gform_custom_merge_tags ($custom_merge_tags=array(), $form_id, $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...
 
 field_options ($field_options, $template_id, $field_id, $context, $input_type)
 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_Post_Category'
 
 $group = 'post'
 
 $name = 'post_category'
 
 $search_operators = array( 'is', 'in', 'not in', 'isnot', '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 More...
 
 $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-post-category.php.

Constructor & Destructor Documentation

__construct ( )

Definition at line 18 of file class-gravityview-field-post-category.php.

Member Function Documentation

add_edit_entry_post_category_choices_filter ( )

Add filter to show live category choices in Edit Entry.

See also
edit_entry_post_category_choices
Since
1.17
Returns
void

Definition at line 90 of file class-gravityview-field-post-category.php.

edit_entry_post_category_choices (   $choices,
  $field,
  $form_id 
)

Always show the live Category values.

By default, Gravity Forms would show unchecked/default choices. We want to show the live Post categories

Since
1.17
Parameters
$choices
$field
$form_id
Returns
mixed

Definition at line 120 of file class-gravityview-field-post-category.php.

References $entry, and GravityView_Edit_Entry\getInstance().

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

Remove filter to show live category choices in Edit Entry.

See also
edit_entry_post_category_choices
Since
1.17
Returns
void

Definition at line 103 of file class-gravityview-field-post-category.php.

set_post_categories (   $form = array(),
  $entry_id = 0 
)

Update the post categories based on all post category fields.

Since
1.17
Parameters
array$formGravity Forms form array
int$entry_idNumeric ID of the entry that was updated
Returns
array|false|WP_Error Array of term taxonomy IDs of affected categories. WP_Error or false on failure. false if there are no post category fields or connected post.
Runs Filter:
gravityview/edit_entry/post_categories/append Should post categories be added to or replaced?
Since
1.17
Parameters
bool$appendIf true, don't delete existing categories, just add on. If false, replace the categories with the submitted categories. Default: false

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

References $entry, $field, $form, and gv_map_deep().

Field Documentation

$_gf_field_class_name = 'GF_Field_Post_Category'

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

$group = 'post'

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

$name = 'post_category'

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

$search_operators = array( 'is', 'in', 'not in', 'isnot', 'contains')

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


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