GravityView  2.1.1
The best, easiest way to display Gravity Forms entries on your website.
Namespaces | Data Structures | Functions | Variables
GV Namespace Reference

Namespaces

 Mocks
 
 REST
 
 Shortcodes
 
 Widgets
 
 Wrappers
 

Data Structures

class  Addon_Settings
 If this file is called directly, abort. More...
 
class  Admin_Request
 If this file is called directly, abort. More...
 
class  Collection
 If this file is called directly, abort. More...
 
class  Context
 If this file is called directly, abort. More...
 
class  Core
 If this file is called directly, abort. More...
 
class  EDD_SL_Plugin_Updater
 Allows plugins to use their own update API. More...
 
class  Edit_Entry_Renderer
 If this file is called directly, abort. More...
 
class  Entry
 If this file is called directly, abort. More...
 
class  Entry_Collection
 If this file is called directly, abort. More...
 
class  Entry_Filter
 If this file is called directly, abort. More...
 
class  Entry_Legacy_Template
 If this file is called directly, abort. More...
 
class  Entry_List_Template
 If this file is called directly, abort. More...
 
class  Entry_Offset
 If this file is called directly, abort. More...
 
class  Entry_Renderer
 If this file is called directly, abort. More...
 
class  Entry_Sort
 If this file is called directly, abort. More...
 
class  Entry_Table_Template
 If this file is called directly, abort. More...
 
class  Entry_Template
 If this file is called directly, abort. More...
 
class  Extension
 If this file is called directly, abort. More...
 
class  Field
 If this file is called directly, abort. More...
 
class  Field_Collection
 If this file is called directly, abort. More...
 
class  Field_CSV_Template
 If this file is called directly, abort. More...
 
class  Field_HTML_Template
 If this file is called directly, abort. More...
 
class  Field_Renderer
 If this file is called directly, abort. More...
 
class  Field_Template
 If this file is called directly, abort. More...
 
class  Form
 If this file is called directly, abort. More...
 
class  Form_Collection
 If this file is called directly, abort. More...
 
class  Frontend_Request
 If this file is called directly, abort. More...
 
class  GF_Entry
 If this file is called directly, abort. More...
 
class  GF_Entry_Filter
 If this file is called directly, abort. More...
 
class  GF_Field
 If this file is called directly, abort. More...
 
class  GF_Form
 If this file is called directly, abort. More...
 
class  Internal_Field
 If this file is called directly, abort. More...
 
class  Internal_Source
 If this file is called directly, abort. More...
 
class  Join
 If this file is called directly, abort. More...
 
class  Legacy_Override_Template
 If this file is called directly, abort. More...
 
class  License_Handler
 If this file is called directly, abort. More...
 
class  Logger
 The abstract class. More...
 
class  LogLevel
 If this file is called directly, abort. More...
 
class  Mock_Request
 If this file is called directly, abort. More...
 
class  Multi_Entry
 If this file is called directly, abort. More...
 
class  oEmbed
 If this file is called directly, abort. More...
 
class  Plugin
 If this file is called directly, abort. More...
 
class  Renderer
 If this file is called directly, abort. More...
 
class  Request
 If this file is called directly, abort. More...
 
class  Settings
 If this file is called directly, abort. More...
 
class  Shortcode
 If this file is called directly, abort. More...
 
class  Source
 If this file is called directly, abort. More...
 
class  Template
 If this file is called directly, abort. More...
 
class  Template_Context
 If this file is called directly, abort. More...
 
class  Utils
 If this file is called directly, abort. More...
 
class  View
 If this file is called directly, abort. More...
 
class  View_Collection
 If this file is called directly, abort. More...
 
class  View_Legacy_Template
 If this file is called directly, abort. More...
 
class  View_List_Template
 If this file is called directly, abort. More...
 
class  View_Renderer
 If this file is called directly, abort. More...
 
class  View_Settings
 If this file is called directly, abort. More...
 
class  View_Table_Template
 If this file is called directly, abort. More...
 
class  View_Template
 If this file is called directly, abort. More...
 
class  Widget
 If this file is called directly, abort. More...
 
class  Widget_Collection
 If this file is called directly, abort. More...
 
class  WP_Action_Logger
 If this file is called directly, abort. More...
 

Functions

 all ()
 Get all the settings. More...
 
 app_settings_fields ()
 Specify the settings fields to be rendered on the plugin settings page. More...
 
 app_settings_icon ()
 Prevent displaying of any icon. More...
 
 app_settings_tab ()
 
 app_settings_title ()
 The Settings title. More...
 
 app_settings_uninstall_tab ()
 
 as_html ( $field, $echo=true)
 
 create_app_menu ()
 Add Settings link to GravityView menu. More...
 
 defaults ()
 Default settings. More...
 
 get ( $key, $default=null)
 Retrieve a setting. More...
 
 get_app_setting ( $setting_name)
 Retrieve a setting. More...
 
 get_app_settings ()
 Get all settings. More...
 
 get_default_settings ()
 Default settings. More...
 
 get_license_handler ()
 Allow public access to the GV class. More...
 
 get_posted_settings ()
 When the settings are saved, make sure the license key matches the previously activated key. More...
 
 get_required_indicator ( $field)
 Gets the required indicator Gets the markup of the required indicator symbol to highlight fields that are required. More...
 
static getSetting ( $key)
 Get the setting for GravityView by name. More...
 
 is_save_postback ()
 Check whether GravityView is being saved. More...
 
 license_key_notice ()
 Display a notice if the plugin is inactive. More...
 
 maybe_save_app_settings ()
 Check for the gravityview_edit_settings capability before saving plugin settings. More...
 
 scripts ()
 Add tooltip script to app settings page. More...
 
 set ( $settings, $value=null)
 Sets a subset of settings. More...
 
 settings_edd_license ( $field, $echo=true)
 Register the settings field for the EDD License field type. More...
 
 settings_html ( $field, $echo=true)
 Allow pure HTML settings row. More...
 
 settings_save ( $field, $echo=true)
 Allow customizing the Save field parameters. More...
 
 settings_submit ( $field, $echo=true)
 
 single_setting_label ( $field)
 The same as the parent, except added support for field descriptions . More...
 
 single_setting_row ( $field)
 Keep GravityView styling for `$field['description']`, even though Gravity Forms added support for it. More...
 
 single_setting_row_html ( $field)
 No needed for pure HTML settings row. More...
 
 styles ()
 Register styles in the app admin page. More...
 
 update ( $settings)
 Updates settings. More...
 
 update_app_settings ( $settings)
 Updates app settings with the provided settings. More...
 

Variables

 $form = ob_get_clean()
 
 $i = 0
 
 $reasons = $this->get_uninstall_reasons()
 
padding bottom
 
scale description p description
 
padding top
 
scale description ul
 
gv form field wrapper
 

Function Documentation

◆ all()

GV\all ( )

◆ app_settings_fields()

GV\app_settings_fields ( )

Specify the settings fields to be rendered on the plugin settings page.

Returns
array
Since
1.15 Added Support Port support
2.0 Added REST API
Runs Filter:
gravityview_settings_fields Filter the settings fields.
Parameters
array$fieldsThe fields to filter.
Runs Filter:
gravityview/settings/fields Filter the settings fields.
Parameters
array$fieldsThe fields to filter.

Redux backward compatibility

Since
1.7.4
Runs Filter:
gravityview/settings/extension/sections Modify the GravityView settings page Extensions can tap in here to insert their own section and settings. $sections[] = array( 'title' => __( 'GravityView My Extension Settings', 'gravityview' ), 'fields' => $settings, );
Parameters
array$extension_settingsEmpty array, ready for extension settings!

Definition at line 770 of file class-gv-settings-addon.php.

References $field, defaults(), get(), get_app_setting(), get_license_handler(), gravityview(), GRAVITYVIEW_FILE, and GVCommon\has_cap().

◆ app_settings_icon()

GV\app_settings_icon ( )

Prevent displaying of any icon.

Returns
string

Definition at line 418 of file class-gv-settings-addon.php.

◆ app_settings_tab()

GV\app_settings_tab ( )

Definition at line 396 of file class-gv-settings-addon.php.

◆ app_settings_title()

GV\app_settings_title ( )

The Settings title.

Returns
string

Definition at line 409 of file class-gv-settings-addon.php.

◆ app_settings_uninstall_tab()

GV\app_settings_uninstall_tab ( )

Definition at line 353 of file class-gv-settings-addon.php.

Referenced by settings_save().

◆ as_html()

GV\as_html (   $field,
  $echo = true 
)

Definition at line 535 of file class-gv-settings-addon.php.

References $attributes, $field, $name, $value, and get().

Referenced by settings_submit().

◆ create_app_menu()

GV\create_app_menu ( )

Add Settings link to GravityView menu.

Returns
void

If not multisite, always show. If multisite and the plugin is network activated, show; we need to register the submenu page for the Network Admin settings to work. If multisite and not network admin, we don't want the settings to show.

Since
1.7.6

Override whether to show the Settings menu on a per-blog basis.

Since
1.7.6
Parameters
bool$hide_if_network_activatedDefault: true

Definition at line 732 of file class-gv-settings-addon.php.

References gravityview().

◆ defaults()

GV\defaults ( )
private

Default settings.

Returns
array The defaults.
Runs Filter:
gravityview/settings/default Filter default global settings.
Parameters
[in,out]arrayThe defaults.

Definition at line 506 of file class-gv-settings-addon.php.

Referenced by all(), app_settings_fields(), View_Settings\as_atts(), GravityView_View_Data\get_default_args(), get_default_settings(), get_gravityview(), GVCommon\get_template_settings(), and View_Settings\with_defaults().

◆ get()

GV\get (   $key,
  $default = null 
)

Retrieve a setting.

Parameters
string$keyThe setting key.
string$defaultA default if not found.
Returns
mixed The setting value.

Backward compatibility with Redux

Definition at line 442 of file class-gv-settings-addon.php.

References all().

Referenced by Mock_Request\__call(), GravityView_Field\__construct(), Utils\_GET(), Addon_Settings\_load_license_handler(), Utils\_POST(), Utils\_REQUEST(), Utils\_SERVER(), GravityView_Field_List\add_form_fields(), GravityView_Field_Address\add_hooks(), GravityView_Edit_Entry_User_Registration\add_hooks(), GravityView_Entry_Approval\after_update_entry_update_approved_meta(), app_settings_fields(), as_html(), Core\bootstrap(), GVCommon\calculate_get_entries_criteria(), GVCommon\check_entry_display(), GravityView_Entry_Approval_Status\choice_pluck(), GravityView_Edit_Entry_Render\custom_validation(), GravityView_API\entry_create_custom_slug(), GravityView_Field_Post_Image\explode_value(), GravityView_Widget_Search\filter_entries(), GravityView_Plugin_Hooks_Gravity_Forms_Survey\fix_survey_field_value(), Widget\from_configuration(), View\from_post(), Template_Context\from_template(), Utils\get(), Settings\get(), Entry_Template\get_back_label(), GravityView_Field_Payment_Amount\get_content(), GravityView_Field_Date_Created\get_content(), GravityView_Widget_Search\get_datepicker_format(), GravityView_Admin_Installer\get_download_display_details(), View\get_entries(), GravityView_API\get_entry_slug(), GravityView_Widget_Search\get_field_label(), GVCommon\get_form_fields(), GravityView_Admin_ApproveEntries\get_form_id(), GV_License_Handler\get_instance(), GVCommon\get_link_html(), GravityView_GFFormsModel\get_post_field_images(), get_posted_settings(), GravityView_Migrate\get_redux_license_status(), GravityView_Migrate\get_redux_settings(), GravityView_frontend\get_search_criteria(), GravityView_Widget_Search\get_search_input_label(), Widget\get_setting(), License_Handler\get_site_data(), Internal_Field\get_value(), GravityView_Shortcode\get_view_detail(), GravityView_Edit_Entry_Render\gform_pre_validation(), gravityview(), Core\init(), Extension\is_compatible(), License_Handler\license_call(), License_Handler\license_details(), GravityView_Field_Entry_Approval\maybe_prevent_field_render(), GravityView_Edit_Entry_Render\maybe_update_post_fields(), GravityView_Theme_Hooks_SiteOrigin\merge_content_meta_keys(), GravityView_Field_Workflow_Final_Status\modify_search_filters(), GravityView_Field_Entry_Approval\modify_search_parameters(), GravityView_Admin_Installer\render_download(), GravityView_Widget_Page_Links\render_frontend(), GravityView_Admin_Installer\render_screen(), GravityView_Merge_Tags\replace_entry_link(), GravityView_Field_Payment_Amount\replace_merge_tag(), Extension\settings(), settings_save(), GravityView_Field_Custom\show_field_in_edit_entry(), single_setting_label(), single_setting_row(), License_Handler\strings(), Entry_List_Template\the_field(), View_List_Template\the_field(), View_Table_Template\the_field(), and GravityView_Edit_Entry_Render\unselect_default_values().

◆ get_app_setting()

GV\get_app_setting (   $setting_name)

Retrieve a setting.

Parameters
string$setting_nameThe setting key.
Returns
mixed The setting or null

Definition at line 430 of file class-gv-settings-addon.php.

Referenced by app_settings_fields().

◆ get_app_settings()

GV\get_app_settings ( )

Get all settings.

Returns
array The settings.

Definition at line 477 of file class-gv-settings-addon.php.

References all().

◆ get_default_settings()

GV\get_default_settings ( )

Default settings.

Returns
array The defaults.

Definition at line 497 of file class-gv-settings-addon.php.

References defaults().

◆ get_license_handler()

GV\get_license_handler ( )

Allow public access to the GV class.

Since
1.7.4
Returns

Definition at line 673 of file class-gv-settings-addon.php.

Referenced by app_settings_fields(), and license_key_notice().

◆ get_posted_settings()

GV\get_posted_settings ( )

When the settings are saved, make sure the license key matches the previously activated key.

Returns
array settings from parent::get_posted_settings(), with license_key_response and license_key_status potentially unset

Definition at line 1169 of file class-gv-settings-addon.php.

References get().

Referenced by license_key_notice().

◆ get_required_indicator()

GV\get_required_indicator (   $field)

Gets the required indicator Gets the markup of the required indicator symbol to highlight fields that are required.

Parameters
$field- The field meta.
Returns
string - Returns markup of the required indicator symbol

Definition at line 761 of file class-gv-settings-addon.php.

◆ getSetting()

static GV\getSetting (   $key)
static

Get the setting for GravityView by name.

Parameters
string$keyOption key to fetch
Returns
mixed

Definition at line 464 of file class-gv-settings-addon.php.

References gravityview().

◆ is_save_postback()

GV\is_save_postback ( )

Check whether GravityView is being saved.

The generic is_save_postback() is true for all addons

Since
2.0.8
Returns
bool

Definition at line 583 of file class-gv-settings-addon.php.

Referenced by license_key_notice(), and maybe_save_app_settings().

◆ license_key_notice()

GV\license_key_notice ( )

Display a notice if the plugin is inactive.

Returns
void

I wanted to remove the period from after the buttons in the string, but didn't want to mess up the translation strings for the translators.

Since
1.17

PhpMissingBreakStatementInspection

Definition at line 592 of file class-gv-settings-addon.php.

References $title, $url, GravityView_Admin_Notices\add_notice(), Utils\get(), get_license_handler(), get_posted_settings(), gravityview(), and is_save_postback().

◆ maybe_save_app_settings()

GV\maybe_save_app_settings ( )

Check for the gravityview_edit_settings capability before saving plugin settings.

Gravity Forms says you're able to edit if you're able to view settings. GravityView allows two different permissions.

Since
1.15
Returns
void

Definition at line 1152 of file class-gv-settings-addon.php.

References GVCommon\has_cap(), and is_save_postback().

◆ scripts()

GV\scripts ( )

Add tooltip script to app settings page.

Not enqueued by Gravity Forms for some reason.

Since
1.21.5
See also
GFAddOn::scripts()
Returns
array Array of scripts

Definition at line 686 of file class-gv-settings-addon.php.

◆ set()

GV\set (   $settings,
  $value = null 
)

Sets a subset of settings.

Parameters
array|stringAn array of settings to update, or string (key) and $value to update one setting.
mixed$valueA value if $settings is string (key). Default: null.

Definition at line 998 of file class-gv-settings-addon.php.

References all().

◆ settings_edd_license()

GV\settings_edd_license (   $field,
  $echo = true 
)
protected

Register the settings field for the EDD License field type.

Parameters
array$field
bool$echoWhether to echo the
Returns
string

Definition at line 1024 of file class-gv-settings-addon.php.

References $field, and License_Handler\settings_edd_license_activation().

◆ settings_html()

GV\settings_html (   $field,
  $echo = true 
)
protected

Allow pure HTML settings row.

Since
2.0.6
Parameters
array$field
bool$echoWhether to echo the
Returns
string

Definition at line 1053 of file class-gv-settings-addon.php.

References $field, and Utils\get().

◆ settings_save()

GV\settings_save (   $field,
  $echo = true 
)

Allow customizing the Save field parameters.

Parameters
array$field
bool$echo
Returns
string

Definition at line 1093 of file class-gv-settings-addon.php.

References $field, $output, app_settings_uninstall_tab(), get(), and settings_submit().

◆ settings_submit()

GV\settings_submit (   $field,
  $echo = true 
)

Definition at line 569 of file class-gv-settings-addon.php.

References $field, as_html(), and gravityview().

Referenced by settings_save().

◆ single_setting_label()

GV\single_setting_label (   $field)

The same as the parent, except added support for field descriptions .

Parameters
$fieldarray

Definition at line 1138 of file class-gv-settings-addon.php.

References $description, $field, and get().

◆ single_setting_row()

GV\single_setting_row (   $field)

Keep GravityView styling for `$field['description']`, even though Gravity Forms added support for it.

Converts `$field['description']to$field['gv_description'] Converts$field['subtitle']to$field['description']`

See also
single_setting_label Converts gv_description back to description
http://share.gravityview.co/P28uGp/2OIRKxog for image that shows subtitle vs description
Since
1.21.5.2
Parameters
array$field
Returns
void

Definition at line 1127 of file class-gv-settings-addon.php.

References $field, and get().

◆ single_setting_row_html()

GV\single_setting_row_html (   $field)

No needed for pure HTML settings row.

Since
2.0.6
Parameters
array$field
Returns
void

Definition at line 1073 of file class-gv-settings-addon.php.

References $field.

◆ styles()

GV\styles ( )

Register styles in the app admin page.

Returns
array

Definition at line 705 of file class-gv-settings-addon.php.

References GRAVITYVIEW_FILE.

Referenced by GravityView_Welcome\getting_started_screen().

◆ update()

GV\update (   $settings)

Updates settings.

Parameters
array$settingsThe settings array.
Returns
boolean False if value was not updated and true if value was updated.

Definition at line 1013 of file class-gv-settings-addon.php.

Referenced by Settings\__construct(), GravityView_Field_Is_Starred\print_script(), and update_app_settings().

◆ update_app_settings()

GV\update_app_settings (   $settings)

Updates app settings with the provided settings.

Same as the GFAddon, except it returns the value from update_option()

Parameters
array$settings- App settings to be saved
Returns
boolean False if value was not updated and true if value was updated.

Definition at line 988 of file class-gv-settings-addon.php.

References update().

Variable Documentation

◆ $form

return $form = ob_get_clean()

Definition at line 348 of file class-gv-settings-addon.php.

Referenced by GravityView_Field_List\_filter_field_label(), GravityView_Field\_filter_gform_custom_merge_tags(), GravityView_Field\_filter_gform_replace_merge_tags(), GravityView_Field_Time\_get_time_format_for_field(), GravityView_frontend\_override_sorting_id_by_field_type(), GravityView_Entry_Approval\_send_notifications(), Form_Collection\add(), GravityView_frontend\add_columns_sort_links(), GravityView_Admin_Views\add_custom_column_content(), GravityView_Plugin_Hooks_Gravity_Forms_Quiz\add_form_fields(), GravityView_Field_List\add_form_fields(), GravityView_Field_Address\add_hooks(), GravityView_Edit_Entry_User_Registration\add_hooks(), GravityView_Field_Total\add_to_blacklist(), GravityView_Admin_Views\add_view_dropdown(), GravityView_Plugin_Hooks_Gravity_Forms_Signature\after_edit_entry(), GravityView_Entry_Approval\after_submission(), GravityView_Entry_Approval\after_update_entry_update_approved_meta(), GravityView_Recent_Entries_Widget\ajax_get_view_merge_tag_data(), GravityView_Entry_Approval\autounapprove(), GF_Form\by_id(), GF_Field\by_id(), GVCommon\check_entry_display(), GravityView_Field_Product\clear_product_info_cache(), GravityView_Ajax\create_preset_form(), GravityView_Field_Is_Approved\custom_merge_tags(), GravityView_Plugin_Hooks_Gravity_Forms_Coupon\edit_entry_field_value(), GravityView_Cache\entry_added(), GravityView_Cache\entry_created(), GravityView_Cache\entry_updated(), GravityView_Field_Post_Image\explode_value(), GravityView_API\field_class(), GravityView_API\field_html_attr_id(), GravityView_API\field_label(), GravityView_Field_Password\field_label(), GravityView_Admin_ApproveEntries\filter_links_entry_list(), GravityView_HTML_Elements\form_dropdown(), GF_Field\from_configuration(), GF_Form\from_form(), Form_Collection\get(), GravityView_Admin_ApproveEntries\get_approved_column(), GravityView_Entry_Approval\get_approved_column_input_label(), GravityView_Admin_Views\get_available_fields(), GravityView_Ajax\get_available_fields_html(), GravityView_Field_Address\get_choices_state(), GravityView_Admin_Views\get_connected_form_links(), GravityView_Admin_Views\get_entry_default_fields(), GF_Form\get_field(), GVCommon\get_field(), View_Table_Template\get_field_column_label(), GravityView_Field_FileUpload\get_field_input(), GVCommon\get_field_label(), GVCommon\get_field_type(), GravityView_Admin\get_floaty(), GVCommon\get_form_fields(), GVCommon\get_form_from_entry_id(), GravityView_GFFormsModel\get_post_field_images(), GravityView_GFFormsModel\get_post_fields(), GravityView_frontend\get_search_criteria_paging(), GravityView_Migrate\get_search_fields(), GravityView_Widget_Search\get_search_filter_details(), GravityView_Widget_Search\get_searchable_fields(), GravityView_Ajax\get_sortable_fields(), GV\Mocks\GravityView_API_field_label(), GV\Mocks\GravityView_API_field_value(), gravityview_field_output(), GV\Mocks\GravityView_frontend_get_view_entries(), gravityview_get_field(), gravityview_get_field_label(), gravityview_get_field_type(), gravityview_get_form_fields(), gravityview_is_single_entry(), gv_class(), GVCommon\has_product_field(), GravityView_Field\is_choice_value_enabled(), GVCommon\is_field_numeric(), GravityView_frontend\is_field_sortable(), GravityView_GFFormsModel\is_value_match(), GravityView_Field_Notes\maybe_send_entry_notes(), View\offsetGet(), GravityView_Ajax\pre_get_form_fields(), GravityView_Admin_Views\render_active_areas(), GravityView_Admin_Views\render_additional_fields(), GravityView_Admin_Views\render_available_fields(), GravityView_Admin_Views\render_field_pickers(), GravityView_Admin_Metaboxes\render_merge_tags_scripts(), GravityView_Merge_Tags\replace_get_variables(), GravityView_Merge_Tags\replace_gv_merge_tags(), GravityView_API\replace_variables(), GravityView_Merge_Tags\replace_variables(), GravityView_Field_Post_Category\set_post_categories(), GravityView_Field_Custom\show_field_in_edit_entry(), Entry_Table_Template\the_field(), Entry_List_Template\the_field(), View_List_Template\the_field(), View_Table_Template\the_field(), GravityView_Entry_Approval\update_approved_meta(), and GravityView_Recent_Entries_Widget\widget().

◆ $i

$i = 0

◆ $reasons

$reasons = $this->get_uninstall_reasons()

Definition at line 303 of file class-gv-settings-addon.php.

Referenced by Addon_Settings\get_uninstall_reasons().

◆ bottom

padding bottom

Definition at line 245 of file class-gv-settings-addon.php.

◆ description

scale description p description

◆ top

padding top

Definition at line 249 of file class-gv-settings-addon.php.

Referenced by GravityView_Admin_Bar\add_floaty_icon().

◆ ul

scale description ul

◆ wrapper

gv form field wrapper
Initial value:
{
margin-top: 30px

Definition at line 251 of file class-gv-settings-addon.php.