Class GFAddOn

Handles all tasks mostly common to any Gravity Forms Add-On, including third party ones.

Direct known subclasses

Indirect known subclasses

Abstract
Package: GFAddOn
Author: Rocketgenius
Located at addon/class-gf-addon.php

Methods summary
`public`	# `__construct( )` Class constructor which hooks the instance into the WordPress init action Class constructor which hooks the instance into the WordPress init action
`public static`	# `register( string $class, string $overrides = null )` Registers an addon so that it gets initialized appropriately Registers an addon so that it gets initialized appropriately Parameters `$class` - The class name `$overrides` - Specify the class to replace/override
`public static array`	# `get_registered_addons( )` Gets all active, registered Add-Ons. Gets all active, registered Add-Ons. Returns `array` Active, registered Add-Ons. Since Unknown Uses GFAddOn::$_registered_addons
`public static`	# `init_addons( )` Initializes all addons. Initializes all addons.
`public`	# `pre_init( )` Gets executed before all init functions. Override this function to perform initialization tasks that must be done prior to init Gets executed before all init functions. Override this function to perform initialization tasks that must be done prior to init Used by `GFPaymentAddOn::pre_init()`
`public`	# `init( )` Plugin starting point. Handles hooks and loading of language files. Plugin starting point. Handles hooks and loading of language files.
`public`	# `init_admin( )` Override this function to add initialization code (i.e. hooks) for the admin site (WP dashboard) Override this function to add initialization code (i.e. hooks) for the admin site (WP dashboard)
`public`	# `init_frontend( )` Override this function to add initialization code (i.e. hooks) for the public (customer facing) site Override this function to add initialization code (i.e. hooks) for the public (customer facing) site
`public`	# `init_ajax( )` Override this function to add AJAX hooks or to add initialization code when an AJAX request is being performed Override this function to add AJAX hooks or to add initialization code when an AJAX request is being performed
`public array`	# `minimum_requirements( )` Override this function to provide a list of requirements needed to use Add-On. Override this function to provide a list of requirements needed to use Add-On. Custom requirements can be defined by adding a callback to the minimum requirements array. A custom requirement receives and should return an array with two parameters: bool $meets_requirements If the custom requirements check passed. array $errors An array of error messages to present to the user. Following is an example of the array that is expected to be returned by this function: Returns `array` array Since 2.2 Used by `GFAddOn::meets_minimum_requirements()` Example https://gist.github.com/JeffMatson/a8d23e16e333e5116060906c6f091aa7
`public boolean\|array`	# `meets_minimum_requirements( )` Performs a check to see if WordPress environment meets minimum requirements need to use Add-On. Performs a check to see if WordPress environment meets minimum requirements need to use Add-On. Returns `boolean\|array` bool\|array Since 2.2 Uses `GFAddOn::minimum_requirements()` `GFAddOn::get_slug()`
`public`	# `failed_requirements_init( )` Register failed requirements page under Gravity Forms settings. Register failed requirements page under Gravity Forms settings. Since 2.2 Uses `GFAddOn::current_user_can_any()` `GFAddOn::get_short_title()` `GFAddOn::plugin_settings_title()` GFCommon::get_base_path() RGForms::add_settings_page()
`public`	# `setup( )` Performs upgrade tasks when the version of the Add-On changes. To add additional upgrade tasks, override the upgrade() function, which will only get executed when the plugin version has changed. Performs upgrade tasks when the version of the Add-On changes. To add additional upgrade tasks, override the upgrade() function, which will only get executed when the plugin version has changed.
`public`	# `upgrade( mixed $previous_version )` Override this function to add to add database update scripts or any other code to be executed when the Add-On version changes Override this function to add to add database update scripts or any other code to be executed when the Add-On version changes
`public`	# `post_gravityforms_upgrade( mixed $db_version, mixed $previous_db_version, mixed $force_upgrade )` Gets called when Gravity Forms upgrade process is completed. This function is intended to be used internally, override the upgrade() function to execute database update scripts. Gets called when Gravity Forms upgrade process is completed. This function is intended to be used internally, override the upgrade() function to execute database update scripts. Parameters `$db_version` Current Gravity Forms database version `$previous_db_version` Previous Gravity Forms database version `$force_upgrade` True if this is a request to force an upgrade. False if this is a standard upgrade (due to version change)
`public`	# `styles( )` Override this function to provide a list of styles to be enqueued. When overriding this function, be sure to call parent::styles() to ensure the base class scripts are enqueued. See scripts() for an example of the format expected to be returned. Override this function to provide a list of styles to be enqueued. When overriding this function, be sure to call parent::styles() to ensure the base class scripts are enqueued. See scripts() for an example of the format expected to be returned.
`public`	# `scripts( )` Override this function to provide a list of scripts to be enqueued. When overriding this function, be sure to call parent::scripts() to ensure the base class scripts are enqueued. Following is an example of the array that is expected to be returned by this function: <pre> <code> Override this function to provide a list of scripts to be enqueued. When overriding this function, be sure to call parent::scripts() to ensure the base class scripts are enqueued. Following is an example of the array that is expected to be returned by this function: <code> array( array( 'handle' => 'maskedinput', 'src' => GFCommon::get_base_url() . '/js/jquery.maskedinput-1.3.min.js', 'version' => GFCommon::$version, 'deps' => array( 'jquery' ), 'in_footer' => false, // Determines where the script will be enqueued. The script will be enqueued if any of the conditions match. 'enqueue' => array( // admin_page - Specified one or more pages (known pages) where the script is supposed to be enqueued. // To enqueue scripts in the front end (public website), simply don't define this setting. array( 'admin_page' => array( 'form_settings', 'plugin_settings' ) ), // tab - Specifies a form settings or plugin settings tab in which the script is supposed to be enqueued. // If none are specified, the script will be enqueued in any of the form settings or plugin_settings page array( 'tab' => 'signature'), // query - Specifies a set of query string ($_GET) values. // If all specified query string values match the current requested page, the script will be enqueued array( 'query' => 'page=gf_edit_forms&view=settings&id=_notempty_' ) // post - Specifies a set of post ($_POST) values. // If all specified posted values match the current request, the script will be enqueued array( 'post' => 'posted_field=val' ) ) ), array( 'handle' => 'super_signature_script', 'src' => $this->get_base_url() . '/super_signature/ss.js', 'version' => $this->_version, 'deps' => array( 'jquery'), 'callback' => array( $this, 'localize_scripts' ), 'strings' => array( // Accessible in JavaScript using the global variable "[script handle]_strings" 'stringKey1' => __( 'The string', 'gravityforms' ), 'stringKey2' => __( 'Another string.', 'gravityforms' ) ) "enqueue" => array( // field_types - Specifies one or more field types that requires this script. // The script will only be enqueued if the current form has a field of any of the specified field types. // Only applies when a current form is available. array( 'field_types' => array( 'signature' ) ) ) ) ); </code>
`public array`	# `get_entry_meta( array $entry_meta, integer $form_id )` Override this method to activate and configure entry meta. Override this method to activate and configure entry meta. Parameters `$entry_meta` An array of entry meta already registered with the gform_entry_meta filter. `$form_id` The form id Returns `array` The filtered entry meta array.
`public`	# `get_results_page_config( )` Returns the configuration for the results page. By default this is not activated. To activate the results page override this function and return an array with the configuration data. Returns the configuration for the results page. By default this is not activated. To activate the results page override this function and return an array with the configuration data. Example: public function get_results_page_config() { return array( "title" => 'Quiz Results', "capabilities" => array("gravityforms_quiz_results"), "callbacks" => array( "fields" => array($this, 'results_fields'), "calculation" => array($this, 'results_calculation'), "markup" => array($this, 'results_markup'), ) ); }
`public`	# `results_page_init( mixed $results_page_config )` Initializes the result page functionality. To activate result page functionality, override the get_results_page_config() function. Initializes the result page functionality. To activate result page functionality, override the get_results_page_config() function. Parameters `$results_page_config` configuration returned by get_results_page_config()
`public`	# `set_logging_supported( mixed $plugins )`
`public`	# `members_register_cap_group( )` Register the Gravity Forms Add-Ons capabilities group with the Members plugin. Register the Gravity Forms Add-Ons capabilities group with the Members plugin. Since 2.4
`public`	# `members_register_caps( )` Register the Add-On capabilities and their human readable labels with the Members plugin. Register the Add-On capabilities and their human readable labels with the Members plugin. Since 2.4 Uses `GFAddOn::get_short_title()`
`public array`	# `get_members_caps( )` Get Add-On capabilities and their human readable labels. Get Add-On capabilities and their human readable labels. Returns `array` array Since 2.4
`public static array`	# `filter_ure_capabilities_groups_tree( array $groups = array() )` Register Gravity Forms Add-Ons capabilities group with User Role Editor plugin. Register Gravity Forms Add-Ons capabilities group with User Role Editor plugin. Parameters `$groups` Existing capabilities groups. Returns `array` array Since 2.4
`public array`	# `filter_ure_custom_capability_groups( array $groups = array(), string $cap_id = '' )` Register Gravity Forms capabilities with Gravity Forms group in User Role Editor plugin. Register Gravity Forms capabilities with Gravity Forms group in User Role Editor plugin. Parameters `$groups` Current capability groups. `$cap_id` Capability identifier. Returns `array` array Since 2.4
`public boolean`	# `current_user_can_any( string\|array $caps )` Checks whether the current user is assigned to a capability or role. Checks whether the current user is assigned to a capability or role. Parameters `$caps` An string or array of capabilities to check Returns `boolean` Returns true if the current user is assigned to any of the capabilities. Since Unknown Used by `GFAddOn::failed_requirements_init()`
`public`	# `render_settings( mixed $sections )`
`public`	# `settings( mixed $sections )`
`public`	# `single_section( mixed $section, mixed $is_first = false )`
`public`	# `single_setting_row( mixed $field )`
`public`	# `single_setting_label( mixed $field )` Displays the label for a field, including the tooltip and requirement indicator. Displays the label for a field, including the tooltip and requirement indicator.
`public`	# `single_setting_row_save( mixed $field )`
`public`	# `single_setting( mixed $field )`
`public`	# `set_settings( mixed $settings )`
`public`	# `set_previous_settings( mixed $settings )`
`public`	# `get_previous_settings( )`
`public`	# `get_posted_settings( )`
`public static`	# `maybe_decode_json( mixed $value )`
`public static`	# `is_json( mixed $value )`
`public`	# `get_current_settings( )`
`public`	# `get_setting( mixed $setting_name, mixed $default_value = '', mixed $settings = false )`
`public`	# `setting_dependency_met( mixed $dependency )` Used by `GFAddOn::settings_field_map()`
`public`	# `has_setting_field_type( mixed $type, mixed $fields )`
`public`	# `add_default_save_button( mixed $sections )`
`public`	# `get_save_success_message( mixed $sections )`
`public`	# `get_save_error_message( mixed $sections )`
`public`	# `get_save_button( mixed $sections )`
`public`	# `settings_text( mixed $field, mixed $echo = true )` Used by `GFAddOn::settings_dynamic_field_map()`
`public`	# `settings_textarea( mixed $field, mixed $echo = true )`
`public`	# `settings_hidden( mixed $field, mixed $echo = true )` Used by `GFAddOn::settings_generic_map()` `GFAddOn::settings_dynamic_field_map()`
`public`	# `settings_checkbox( mixed $field, mixed $echo = true )`
`public string`	# `checkbox_item( mixed $choice, mixed $horizontal_class, mixed $attributes, mixed $value, mixed $tooltip, mixed $error_icon = '' )` Returns the markup for an individual checkbox item give the parameters Returns the markup for an individual checkbox item give the parameters Parameters `$choice` Choice array with all configured properties `$horizontal_class` CSS class to style checkbox items horizontally `$attributes` String containing all the attributes for the input tag. `$value` Currently selection (1 if field has been checked. 0 or null otherwise) `$tooltip` String containing a tooltip for this checkbox item. `$error_icon` Returns `string` - The markup of an individual checkbox item
`public string`	# `checkbox_input( mixed $choice, mixed $attributes, mixed $value, mixed $tooltip )` Returns the markup for an individual checkbox input and its associated label Returns the markup for an individual checkbox input and its associated label Parameters `$choice` Choice array with all configured properties `$attributes` String containing all the attributes for the input tag. `$value` Currently selection (1 if field has been checked. 0 or null otherwise) `$tooltip` String containing a tooltip for this checkbox item. Returns `string` - The markup of an individual checkbox input and its associated label
`public`	# `settings_radio( mixed $field, mixed $echo = true )`
`public boolean`	# `choices_have_icon( array $choices = array() )` Determines if any of the available settings choices have an icon. Determines if any of the available settings choices have an icon. Parameters `$choices` (default: array()) Returns `boolean` bool
`public`	# `settings_select( mixed $field, mixed $echo = true )` Used by `GFAddOn::settings_dynamic_field_map()`
`public string`	# `settings_select_custom( array $field, boolean $echo = true )` Renders and initializes a drop down field with a input field for custom input based on the $field array. Renders and initializes a drop down field with a input field for custom input based on the $field array. Parameters `$field` - Field array containing the configuration options of this field `$echo` = true - true to echo the output to the screen, false to simply return the contents as a string Returns `string` The HTML for the field
`public string`	# `get_select_options( array $choices, string $selected_value )` Prepares an HTML string of options for a drop down field. Prepares an HTML string of options for a drop down field. Parameters `$choices` - Array containing all the options for the drop down field `$selected_value` - The value currently selected for the field Returns `string` The HTML for the select options
`public string`	# `get_select_option( array $choice, string $selected_value )` Prepares an HTML string for a single drop down field option. Prepares an HTML string for a single drop down field option. Parameters `$choice` - Array containing the settings for the drop down option `$selected_value` - The value currently selected for the field Returns `string` The HTML for the select choice
`public string`	# `settings_generic_map( array $field, boolean $echo = true )` Renders and initializes a generic map field based on the $field array whose choices are populated by the fields to be mapped. Renders and initializes a generic map field based on the $field array whose choices are populated by the fields to be mapped. Parameters `$field` Field array containing the configuration options of this field. `$echo` Determines if field contents should automatically be displayed. Defaults to true. Returns `string` The HTML for the field Since 2.2 Uses `GFAddOn::field_failed_validation()` GFCommon::get_base_url() GFAddOn::get_current_forn() `GFAddOn::get_error_icon()` `GFAddOn::get_mapping_field()` `GFAddOn::settings_hidden()`
`public string`	# `settings_field_map( array $field, boolean $echo = true )` Renders and initializes a field map field based on the $field array whose choices are populated by the fields to be mapped. Renders and initializes a field map field based on the $field array whose choices are populated by the fields to be mapped. Parameters `$field` Field array containing the configuration options of this field. `$echo` Determines if field contents should automatically be displayed. Defaults to true. Returns `string` The HTML for the field Since unknown Uses `GFAddOn::field_map_table_header()` `GFAddOn::get_mapped_field_name()` `GFAddOn::get_required_indicator()` `GFAddOn::maybe_get_tooltip()` `GFAddOn::setting_dependency_met()` `GFAddOn::settings_field_map_select()`
`public string`	# `settings_dynamic_field_map( array $field, boolean $echo = true )` Renders and initializes a dynamic field map field based on the $field array whose choices are populated by the fields to be mapped. Renders and initializes a dynamic field map field based on the $field array whose choices are populated by the fields to be mapped. Parameters `$field` Field array containing the configuration options of this field. `$echo` Determines if field contents should automatically be displayed. Defaults to true. Returns `string` The HTML for the field Since 1.9.5.13 Uses `GFAddOn::field_failed_validation()` `GFAddOn::get_current_form()` `GFAddOn::get_error_icon()` `GFAddOn::get_mapping_field()` `GFAddOn::settings_field_map_select()` `GFAddOn::settings_hidden()` `GFAddOn::settings_select()` `GFAddOn::settings_text()` GFCommon::get_base_url()
`public string`	# `settings_field_map_select( array $field, integer $form_id )` Renders a field select field for field maps. Renders a field select field for field maps. Parameters `$field` Field array containing the configuration options of this field. `$form_id` Form ID to retrieve fields from. Returns `string` The HTML for the field Since unknown Uses `GFAddOn::get_field_map_choices()` GF_Field::get_form_editor_field_title() Used by `GFAddOn::settings_field_map()` `GFAddOn::settings_dynamic_field_map()`
`public string`	# `get_mapping_field( string $type, array $select_field, array $text_field )` Prepares the markup for mapping field key and value fields. Prepares the markup for mapping field key and value fields. Parameters `$type` The field type being prepared; key or value. `$select_field` The drop down field properties. `$text_field` The text field properties. Returns `string` string Since 2.2 Uses `GFAddOn::get_current_form()` `GFAddOn::get_field_map_choices()` Used by `GFAddOn::settings_generic_map()` `GFAddOn::settings_dynamic_field_map()`
`public string`	# `field_map_table_header( )` Heading row for field map table. Heading row for field map table. Returns `string` string Since 2.2 Uses `GFAddOn::field_map_title()` Used by `GFAddOn::settings_field_map()`
`public string`	# `field_map_title( )` Heading for field map field column. Heading for field map field column. Returns `string` string Since 2.2 Used by `GFAddOn::field_map_table_header()` Used-by GFAddOn::field_map_table_header()
`public static array`	# `get_field_map_choices( integer $form_id, array\|string $field_type = null, array\|string $exclude_field_types = null )` Get field map choices for specific form. Get field map choices for specific form. Parameters `$form_id` Form ID to display fields for. `$field_type` Field types to only include as choices. Defaults to null. `$exclude_field_types` Field types to exclude from choices. Defaults to null. Returns `array` array Since unknown Uses GFCommon::get_label() GFFormsModel::get_entry_meta() GFFormsModel::get_form_meta() GF_Field::get_entry_inputs() GF_Field::get_form_editor_field_title() GF_Field::get_input_type() Used by `GFAddOn::settings_field_map_select()` `GFAddOn::get_mapping_field()`
`public string`	# `get_mapped_field_name( array $parent_field, string $field_name )` Get input name for field map field. Get input name for field map field. Parameters `$parent_field` Field map field. `$field_name` Child field. Returns `string` string Since unknown Used by `GFAddOn::settings_field_map()` Used-by GFAddOn::settings_field_map() GFAddOn::validate_field_map_settings()
`public static array`	# `get_field_map_fields( array $feed, string $field_name )` Get mapped key/value pairs for standard field map. Get mapped key/value pairs for standard field map. Parameters `$feed` Feed object. `$field_name` Field map field name. Returns `array` array Since unknown
`public static array`	# `get_dynamic_field_map_fields( array $feed, string $field_name )` Get mapped key/value pairs for dynamic field map. Get mapped key/value pairs for dynamic field map. Parameters `$feed` Feed object. `$field_name` Dynamic field map field name. Returns `array` array Since 1.9.9.9
`public array`	# `get_generic_map_fields( array $feed, string $field_name, array $form = array(), array $entry = array() )` Get mapped key/value pairs for generic map. Get mapped key/value pairs for generic map. Parameters `$feed` Feed object or settings array. `$field_name` Generic map field name. `$form` Form object. Defaults to empty array. `$entry` Entry object. Defaults to empty array. Returns `array` array Since 2.2 Uses GFCommon::replace_variables()
`public string`	# `settings_field_select( array $field, boolean $echo = true )` Renders and initializes a drop down field based on the $field array whose choices are populated by the form's fields. Renders and initializes a drop down field based on the $field array whose choices are populated by the form's fields. Parameters `$field` - Field array containing the configuration options of this field `$echo` = true - true to echo the output to the screen, false to simply return the contents as a string Returns `string` The HTML for the field
`public`	# `prepare_field_select_field( mixed $field )`
`public string\|null`	# `get_default_field_select_field( array $field )` Returns the field to be selected by default for field select fields based on matching labels. Returns the field to be selected by default for field select fields based on matching labels. Parameters `$field` - Field array containing the configuration options of this field Returns `string\|null` string\|null
`public array`	# `get_form_fields_as_choices( array $form, array $args = array() )` Retrieve an array of form fields formatted for select, radio and checkbox settings fields. Retrieve an array of form fields formatted for select, radio and checkbox settings fields. Parameters `$form` - The form object `$args` - Additional settings to check for (field and input types to include, callback for applicable input type) Returns `array` The array of formatted form fields
`public string`	# `settings_checkbox_and_select( array $field, boolean $echo = true )` Renders and initializes a checkbox field that displays a select field when checked based on the $field array. Renders and initializes a checkbox field that displays a select field when checked based on the $field array. Parameters `$field` - Field array containing the configuration options of this field `$echo` = true - true to echo the output to the screen, false to simply return the contents as a string Returns `string` The HTML for the field
`public`	# `prepare_settings_checkbox_and_select( mixed $field )`
`public`	# `settings_save( mixed $field, mixed $echo = true )`
`public array`	# `get_field_attributes( array $field, array $default = array() )` Parses the properties of the $field meta array and returns a set of HTML attributes to be added to the HTML element. Parses the properties of the $field meta array and returns a set of HTML attributes to be added to the HTML element. Parameters `$field` - current field meta to be parsed. `$default` - default set of properties. Will be appended to the properties specified in the $field array Returns `array` - resulting HTML attributes ready to be included in the HTML element.
`public array`	# `get_choice_attributes( array $choice, array $field_attributes, mixed $default_choice_attributes = array() )` Parses the properties of the $choice meta array and returns a set of HTML attributes to be added to the HTML element. Parses the properties of the $choice meta array and returns a set of HTML attributes to be added to the HTML element. Parameters `$choice` - current choice meta to be parsed. `$field_attributes` - current field's attributes. `$default_choice_attributes` Returns `array` - resulting HTML attributes ready to be included in the HTML element.
`public`	# `prepend_attribute( mixed $name, mixed $attribute, mixed $current_attribute )`
`public boolean`	# `validate_settings( mixed $fields, mixed $settings )` Validates settings fields. Validates that all fields are valid. Fields can be invalid when they are blank and marked as required or if it fails a custom validation check. To specify a custom validation, use the 'validation_callback' field meta property and implement the validation function with the custom logic. Validates settings fields. Validates that all fields are valid. Fields can be invalid when they are blank and marked as required or if it fails a custom validation check. To specify a custom validation, use the 'validation_callback' field meta property and implement the validation function with the custom logic. Parameters `$fields` A list of all fields from the field meta configuration `$settings` A list of submitted settings values Returns `boolean` - Returns true if all fields have passed validation, and false otherwise.
`public`	# `validate_text_settings( mixed $field, mixed $settings )`
`public`	# `validate_textarea_settings( mixed $field, mixed $settings )`
`public`	# `validate_radio_settings( mixed $field, mixed $settings )`
`public`	# `validate_select_settings( mixed $field, mixed $settings )`
`public`	# `validate_checkbox_settings( mixed $field, mixed $settings )`
`public`	# `validate_select_custom_settings( mixed $field, mixed $settings )`
`public`	# `validate_field_select_settings( mixed $field, mixed $settings )`
`public`	# `validate_field_map_settings( mixed $field, mixed $settings )`
`public`	# `validate_checkbox_and_select_settings( mixed $field, mixed $settings )`
`public boolean`	# `is_choice_valid( array $choice, string\|array $value )` Helper to determine if the current choice is a match for the submitted field value. Helper to determine if the current choice is a match for the submitted field value. Parameters `$choice` The choice properties. `$value` The submitted field value. Returns `boolean` bool
`public`	# `set_field_error( array $field, string $error_message = '' )` Sets the validation error message Sets the error message to be displayed when a field fails validation. When implementing a custom validation callback function, use this function to specify the error message to be displayed. Sets the validation error message Sets the error message to be displayed when a field fails validation. When implementing a custom validation callback function, use this function to specify the error message to be displayed. Parameters `$field` - The current field meta `$error_message` - The error message to be displayed
`public mixed`	# `get_field_errors( array\|boolean $field = false )` Gets the validation errors for a field. Returns validation errors associated with the specified field or a list of all validation messages (if a field isn't specified) Gets the validation errors for a field. Returns validation errors associated with the specified field or a list of all validation messages (if a field isn't specified) Parameters `$field` - Optional. The field meta. When specified, errors for this field will be returned Returns `mixed` - If a field is specified, a string containing the error message will be returned. Otherwise, an array of all errors will be returned
`public string`	# `get_error_icon( array $field )` Gets the invalid field icon Returns the markup for an alert icon to indicate and highlight invalid fields. Gets the invalid field icon Returns the markup for an alert icon to indicate and highlight invalid fields. Parameters `$field` - The field meta. Returns `string` - The full markup for the icon Used by `GFAddOn::settings_generic_map()` `GFAddOn::settings_dynamic_field_map()`
`public string`	# `maybe_get_tooltip( array $item )` Returns the tooltip markup if a tooltip is configured for the supplied item (field/child field/choice). Returns the tooltip markup if a tooltip is configured for the supplied item (field/child field/choice). Parameters `$item` The item properties. Returns `string` string Used by `GFAddOn::settings_field_map()`
`public string`	# `get_required_indicator( mixed $field )` Gets the required indicator Gets the markup of the required indicator symbol to highlight fields that are required 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 Used by `GFAddOn::settings_field_map()`
`public boolean\|mixed`	# `field_failed_validation( mixed $field )` Checks if the specified field failed validation Checks if the specified field failed validation Parameters `$field` The field meta to be checked Returns `boolean\|mixed` - Returns a validation error string if the field has failed validation. Otherwise returns false Used by `GFAddOn::settings_generic_map()` `GFAddOn::settings_dynamic_field_map()`
`public mixed`	# `filter_settings( mixed $fields, mixed $settings )` Filter settings fields. Runs through each field and applies the 'save_callback', if set, before saving the settings. To specify a custom save filter, use the 'save_callback' field meta property and implement the save filter function with the custom logic. Filter settings fields. Runs through each field and applies the 'save_callback', if set, before saving the settings. To specify a custom save filter, use the 'save_callback' field meta property and implement the save filter function with the custom logic. Parameters `$fields` A list of all fields from the field meta configuration `$settings` A list of submitted settings values Returns `mixed` $settings - The updated settings values.
`public`	# `add_field_before( mixed $name, mixed $fields, mixed $settings )`
`public`	# `add_field_after( mixed $name, mixed $fields, mixed $settings )`
`public`	# `add_field( mixed $name, mixed $fields, mixed $settings, mixed $pos )`
`public`	# `remove_field( mixed $name, mixed $settings )`
`public`	# `replace_field( mixed $name, mixed $fields, mixed $settings )`
`public`	# `get_field( mixed $name, mixed $settings )`
`public`	# `build_choices( mixed $key_value_pairs )`
`public string`	# `simple_condition( mixed $setting_name_root )` Helper to create a simple conditional logic set of fields. It creates one row of conditional logic with Field/Operator/Value inputs. Helper to create a simple conditional logic set of fields. It creates one row of conditional logic with Field/Operator/Value inputs. Parameters `$setting_name_root` - The root name to be used for inputs. It will be used as a prefix to the inputs that make up the conditional logic fields. Returns `string` The HTML
`public array`	# `get_conditional_logic_fields( )` Override this to define the array of choices which should be used to populate the Simple Condition fields drop down. Override this to define the array of choices which should be used to populate the Simple Condition fields drop down. Each choice should have 'label' and 'value' properties. Returns `array` array
`public boolean`	# `is_simple_condition_met( string $setting_name_root, array $form, array $entry, array $feed = array() )` Evaluate the rules defined for the Simple Condition field. Evaluate the rules defined for the Simple Condition field. Parameters `$setting_name_root` The root name used as the prefix to the inputs that make up the Simple Condition field. `$form` The form currently being processed. `$entry` The entry currently being processed. `$feed` The feed currently being processed or an empty array when the field is stored in the form settings. Returns `boolean` bool
`public`	# `form_settings_init( )` Initializes form settings page Hooks up the required scripts and actions for the Form Settings page Initializes form settings page Hooks up the required scripts and actions for the Form Settings page
`public`	# `plugin_page_init( )` Initializes plugin settings page Hooks up the required scripts and actions for the Plugin Settings page Initializes plugin settings page Hooks up the required scripts and actions for the Plugin Settings page
`public array`	# `create_plugin_page_menu( mixed $menus )` Creates plugin page menu item Target of gform_addon_navigation filter. Creates a menu item in the left nav, linking to the plugin page Creates plugin page menu item Target of gform_addon_navigation filter. Creates a menu item in the left nav, linking to the plugin page Parameters `$menus` Current list of menu items Returns `array` - Returns a new list of menu items
`public`	# `maybe_save_form_settings( mixed $form )`
`public`	# `save_form_settings( mixed $form, mixed $settings )`
`public`	# `form_settings( mixed $form )` Custom form settings page Override this function to implement a complete custom form settings page. Before overriding this function, consider using the form_settings_fields() and specifying your field meta. Custom form settings page Override this function to implement a complete custom form settings page. Before overriding this function, consider using the form_settings_fields() and specifying your field meta.
`public`	# `form_settings_page_title( )` Custom form settings title Override this function to display a custom title on the Form Settings Page. By default, the first section in the configuration done in form_settings_fields() will be used as the page title. Use this function to override that behavior and add a custom page title. Custom form settings title Override this function to display a custom title on the Form Settings Page. By default, the first section in the configuration done in form_settings_fields() will be used as the page title. Use this function to override that behavior and add a custom page title.
`public`	# `form_settings_icon( )` Override this function to customize the form settings icon Override this function to customize the form settings icon
`public`	# `plugin_page( )` Override this function to create a custom plugin page Override this function to create a custom plugin page
`public`	# `plugin_page_icon( )` Override this function to customize the plugin page icon Override this function to customize the plugin page icon
`public`	# `plugin_page_title( )` Override this function to customize the plugin page title Override this function to customize the plugin page title
`public`	# `plugin_page_container( )` Plugin page container Target of the plugin menu left nav icon. Displays the outer plugin page markup and calls plugin_page() to render the actual page. Override plugin_page() in order to provide a custom plugin page Plugin page container Target of the plugin menu left nav icon. Displays the outer plugin page markup and calls plugin_page() to render the actual page. Override plugin_page() in order to provide a custom plugin page
`public boolean`	# `has_app_menu( )` Checks whether the current Add-On has a top level app menu. Checks whether the current Add-On has a top level app menu. Returns `boolean` bool
`public`	# `create_app_menu( )` Creates a top level app menu. Adds the app settings page automatically if it's configured. Target of the WordPress admin_menu action. Not intended to be overridden or called directly by add-ons. Creates a top level app menu. Adds the app settings page automatically if it's configured. Target of the WordPress admin_menu action. Not intended to be overridden or called directly by add-ons.
`public array`	# `get_app_menu_items( )` Override this function to create a top level app menu. Override this function to create a top level app menu. e.g. $menu_item['name'] = 'gravitycontacts'; $menu_item['label'] = __("Contacts", 'gravitycontacts'); $menu_item['permission'] = 'gravitycontacts_view_contacts'; $menu_item['callback'] = array($this, 'app_menu'); Returns `array` The array of menu items
`public string`	# `get_app_menu_icon( )` Override this function to specify a custom icon for the top level app menu. Accepts a dashicon class or a URL. Override this function to specify a custom icon for the top level app menu. Accepts a dashicon class or a URL. Returns `string` string
`public`	# `load_screen_options( )` Override this function to load custom screen options. Override this function to load custom screen options. e.g. $screen = get_current_screen(); if(!is_object($screen) \|\| $screen->id != $this->app_hook_suffix) return; if($this->is_contact_list_page()){ $args = array( 'label' => __('Contacts per page', 'gravitycontacts'), 'default' => 20, 'option' => 'gcontacts_per_page' ); add_screen_option( 'per_page', $args );
`public`	# `app_tab_page( )` Handles the rendering of app menu items that implement the tabs UI. Handles the rendering of app menu items that implement the tabs UI. Not intended to be overridden or called directly by add-ons.
`public array`	# `get_form_settings( mixed $form )` Returns the form settings for the Add-On Returns the form settings for the Add-On Parameters `$form` Returns `array` array
`public array`	# `add_form_settings_menu( mixed $tabs, mixed $form_id )` Add the form settings tab. Add the form settings tab. Override this function to add the tab conditionally. Parameters `$tabs` `$form_id` Returns `array` array
`public`	# `form_settings_fields( mixed $form )` Override this function to specify the settings fields to be rendered on the form settings page Override this function to specify the settings fields to be rendered on the form settings page
`public`	# `plugin_settings_init( )`
`public`	# `plugin_settings_link( mixed $links, mixed $file )`
`public`	# `plugin_settings_page( )` Plugin settings page Plugin settings page
`public`	# `plugin_settings_title( )` Used by `GFAddOn::failed_requirements_init()`
`public`	# `plugin_settings_icon( )`
`public`	# `plugin_settings( )` Override this function to add a custom settings page. Override this function to add a custom settings page.
`public boolean`	# `has_plugin_settings_page( )` Checks whether the current Add-On has a settings page. Checks whether the current Add-On has a settings page. Returns `boolean` bool
`public mixed`	# `get_plugin_settings( )` Returns the currently saved plugin settings Returns the currently saved plugin settings Returns `mixed` mixed
`public mixed`	# `get_plugin_setting( string $setting_name )` Get plugin setting Returns the plugin setting specified by the $setting_name parameter Get plugin setting Returns the plugin setting specified by the $setting_name parameter Parameters `$setting_name` - Plugin setting to be returned Returns `mixed` - Returns the specified plugin setting or null if the setting doesn't exist
`public`	# `update_plugin_settings( array $settings )` Updates plugin settings with the provided settings Updates plugin settings with the provided settings Parameters `$settings` - Plugin settings to be saved
`public`	# `maybe_save_plugin_settings( )` Saves the plugin settings if the submit button was pressed Saves the plugin settings if the submit button was pressed
`public array`	# `plugin_settings_fields( )` Override this function to specify the settings fields to be rendered on the plugin settings page Override this function to specify the settings fields to be rendered on the plugin settings page Returns `array` array
`public array\|mixed\|`	# `get_app_settings_tabs( )` Returns the tabs for the settings app menu item Returns the tabs for the settings app menu item Not intended to be overridden or called directly by add-ons. Returns `array\|mixed\|` array\|mixed\|void
`public`	# `app_settings_uninstall_tab( )` Renders the app settings uninstall tab. Renders the app settings uninstall tab. Not intended to be overridden or called directly by add-ons.
`public`	# `app_tab_page_header( mixed $tabs, mixed $current_tab, mixed $title, string $message = '' )` Renders the header for the tabs UI. Renders the header for the tabs UI. Parameters `$tabs` `$current_tab` `$title` `$message`
`public`	# `app_tab_page_footer( )` Renders the footer for the tabs UI. Renders the footer for the tabs UI.
`public`	# `app_settings_tab( )`
`public string`	# `app_settings_title( )` Override this function to specific a custom app settings title Override this function to specific a custom app settings title Returns `string` string
`public string`	# `app_settings_icon( )` Override this function to specific a custom app settings icon Override this function to specific a custom app settings icon Returns `string` string
`public boolean`	# `has_app_settings( )` Checks whether the current Add-On has a settings page. Checks whether the current Add-On has a settings page. Returns `boolean` bool
`public`	# `app_settings( )` Override this function to add a custom app settings page. Override this function to add a custom app settings page.
`public mixed`	# `get_app_settings( )` Returns the currently saved plugin settings Returns the currently saved plugin settings Returns `mixed` mixed
`public mixed`	# `get_app_setting( string $setting_name )` Get app setting Returns the app setting specified by the $setting_name parameter Get app setting Returns the app setting specified by the $setting_name parameter Parameters `$setting_name` - Plugin setting to be returned Returns `mixed` - Returns the specified plugin setting or null if the setting doesn't exist
`public`	# `update_app_settings( array $settings )` Updates app settings with the provided settings Updates app settings with the provided settings Parameters `$settings` - App settings to be saved
`public`	# `maybe_save_app_settings( )` Saves the plugin settings if the submit button was pressed Saves the plugin settings if the submit button was pressed
`public array`	# `app_settings_fields( )` Override this function to specify the settings fields to be rendered on the plugin settings page Override this function to specify the settings fields to be rendered on the plugin settings page Returns `array` array
`public array`	# `settings_fields_only( string $settings_type = 'plugin' )` Returns an flattened array of field settings for the specified settings type ignoring sections. Returns an flattened array of field settings for the specified settings type ignoring sections. Parameters `$settings_type` The settings type. e.g. 'plugin' Returns `array` array
`public`	# `render_uninstall( )` Override this function to customize the markup for the uninstall section on the plugin settings page Override this function to customize the markup for the uninstall section on the plugin settings page
`public`	# `uninstall_warning_message( )`
`public`	# `uninstall_confirm_message( )`
`public`	# `uninstall( )` Called when the user chooses to uninstall the Add-On - after permissions have been checked and before removing all Add-On settings and Form settings. Called when the user chooses to uninstall the Add-On - after permissions have been checked and before removing all Add-On settings and Form settings. Override this method to perform additional functions such as dropping database tables. Return false to cancel the uninstall request.
`public`	# `plugin_message( )` Returns the message that will be displayed if the current version of Gravity Forms is not supported. Returns the message that will be displayed if the current version of Gravity Forms is not supported. Override this method to display a custom message.
`public`	# `get_locking_config( )` Returns the configuration for locking Returns the configuration for locking e.g. array( "object_type" => 'contact', "capabilities" => array("gravityforms_contacts_edit_contacts"), "redirect_url" => admin_url("admin.php?page=gf_contacts"), "edit_url" => admin_url(sprintf("admin.php?page=gf_contacts&id=%d", $contact_id)), "strings" => $strings ); Override this method to implement locking
`public`	# `is_locking_edit_page( )` Returns TRUE if the current page is the edit page. Otherwise, returns FALSE Returns TRUE if the current page is the edit page. Otherwise, returns FALSE Override this method to implement locking on the edit page.
`public`	# `is_locking_list_page( )` Returns TRUE if the current page is the list page. Otherwise, returns FALSE Returns TRUE if the current page is the list page. Otherwise, returns FALSE Override this method to display locking info on the list page.
`public`	# `is_locking_view_page( )` Returns TRUE if the current page is the view page. Otherwise, returns FALSE Returns TRUE if the current page is the view page. Otherwise, returns FALSE Override this method to display locking info on the view page.
`public`	# `get_locking_object_id( )` Returns the ID of the object to be locked. E.g. Form ID Returns the ID of the object to be locked. E.g. Form ID Override this method to implement locking
`public string`	# `lock_info( integer $object_id, boolean $echo = true )` Outputs information about the user currently editing the specified object Outputs information about the user currently editing the specified object Parameters `$object_id` The Object ID `$echo` Whether to echo Returns `string` The markup for the lock info
`public string`	# `list_row_class( integer $object_id, boolean $echo = true )` Outputs class for the row for the specified Object ID on the list page. Outputs class for the row for the specified Object ID on the list page. Parameters `$object_id` The object ID `$echo` Whether to echo Returns `string` The markup for the class
`public boolean`	# `is_object_locked( integer\|mixed $object_id )` Checked whether an object is locked Checked whether an object is locked Parameters `$object_id` The object ID Returns `boolean` bool
`public string`	# `get_mapped_field_value( string $setting_name, array $form, array $entry, mixed $settings = false )` Returns the value of the mapped field. Returns the value of the mapped field. Parameters `$setting_name` `$form` `$entry` `$settings` Returns `string` string
`public string`	# `get_field_value( array $form, array $entry, string $field_id )` Returns the value of the selected field. Returns the value of the selected field. Parameters `$form` `$entry` `$field_id` Returns `string` field value Used by `GFPaymentAddOn::get_submission_data()`
`public string`	# `maybe_override_field_value( string $field_value, array $form, array $entry, string $field_id )` Enables use of the gform_SLUG_field_value filter to override the field value. Override this function to prevent the filter being used or to implement a custom filter. Enables use of the gform_SLUG_field_value filter to override the field value. Override this function to prevent the filter being used or to implement a custom filter. Parameters `$field_value` `$form` `$entry` `$field_id` Returns `string` string
`public string`	# `get_full_address( array $entry, string $field_id )` Returns the combined value of the specified Address field. Returns the combined value of the specified Address field. Parameters `$entry` `$field_id` Returns `string` string
`public string`	# `get_full_name( array $entry, string $field_id )` Returns the combined value of the specified Name field. Returns the combined value of the specified Name field. Parameters `$entry` `$field_id` Returns `string` string
`public string`	# `get_list_field_value( array $entry, string $field_id, GF_Field_List $field )` Returns the value of the specified List field. Returns the value of the specified List field. Parameters `$entry` `$field_id` `$field` Returns `string` string
`public string`	# `get_first_field_by_type( string $field_type, integer $subfield_id = null, integer $form_id = null, mixed $return_first_only = true )` Returns the field ID of the first field of the desired type. Returns the field ID of the first field of the desired type. Parameters `$field_type` `$subfield_id` (default: null) `$form_id` (default: null) `$return_first_only` Returns `string` string
`public string`	# `note_avatar( )` Override this function to specify a custom avatar (i.e. the payment gateway logo) for entry notes created by the Add-On Override this function to specify a custom avatar (i.e. the payment gateway logo) for entry notes created by the Add-On Returns `string` - A fully qualified URL for the avatar
`public`	# `notes_avatar( mixed $avatar, mixed $note )`
`public`	# `add_note( mixed $entry_id, mixed $note, mixed $note_type = null )` Used by `GFPaymentAddOn::process_subscription()`
`final protected`	# `method_is_overridden( mixed $method_name, mixed $base_class = 'GFAddOn' )`
`public string`	# `get_base_url( string $full_path = '' )` Returns the url of the root folder of the current Add-On. Returns the url of the root folder of the current Add-On. Parameters `$full_path` Optional. The full path the the plugin file. Returns `string` string
`final public static string`	# `get_gfaddon_base_url( )` Returns the url of the Add-On Framework root folder. Returns the url of the Add-On Framework root folder. Returns `string` string
`final public static string`	# `get_gfaddon_base_path( )` Returns the physical path of the Add-On Framework root folder. Returns the physical path of the Add-On Framework root folder. Returns `string` string
`public string`	# `get_base_path( string $full_path = '' )` Returns the physical path of the plugins root folder. Returns the physical path of the plugins root folder. Parameters `$full_path` Returns `string` string
`public boolean`	# `is_gravityforms_installed( )` Checks whether the Gravity Forms is installed. Checks whether the Gravity Forms is installed. Returns `boolean` bool
`public`	# `table_exists( mixed $table_name )`
`public boolean\|mixed`	# `is_gravityforms_supported( mixed $min_gravityforms_version = '' )` Checks whether the current version of Gravity Forms is supported Checks whether the current version of Gravity Forms is supported Parameters `$min_gravityforms_version` Returns `boolean\|mixed` bool\|mixed
`public`	# `get_short_title( )` Returns this plugin's short title. Used to display the plugin title in small areas such as tabs Returns this plugin's short title. Used to display the plugin title in small areas such as tabs Used by `GFAddOn::failed_requirements_init()` `GFAddOn::members_register_caps()`
`public string`	# `get_version( )` Return this plugin's version. Return this plugin's version. Returns `string` string Since 2.0
`public`	# `get_plugin_settings_url( )` Returns the unescaped URL for the plugin settings tab associated with this plugin Returns the unescaped URL for the plugin settings tab associated with this plugin
`public`	# `get_current_form( )` Returns the current form object based on the id query var. Otherwise returns false Returns the current form object based on the id query var. Otherwise returns false Used by `GFAddOn::settings_dynamic_field_map()` `GFAddOn::get_mapping_field()`
`public`	# `is_postback( )` Returns TRUE if the current request is a postback, otherwise returns FALSE Returns TRUE if the current request is a postback, otherwise returns FALSE
`public`	# `is_save_postback( )` Returns TRUE if the settings "Save" button was pressed Returns TRUE if the settings "Save" button was pressed
`public`	# `is_form_editor( )` Returns TRUE if the current page is the form editor page. Otherwise, returns FALSE Returns TRUE if the current page is the form editor page. Otherwise, returns FALSE
`public`	# `is_form_list( )` Returns TRUE if the current page is the form list page. Otherwise, returns FALSE Returns TRUE if the current page is the form list page. Otherwise, returns FALSE
`public boolean`	# `is_form_settings( string $tab = null )` Returns TRUE if the current page is the form settings page, or a specific form settings tab (specified by the $tab parameter). Otherwise returns FALSE Returns TRUE if the current page is the form settings page, or a specific form settings tab (specified by the $tab parameter). Otherwise returns FALSE Parameters `$tab` - Specifies a specific form setting page/tab Returns `boolean` bool
`public boolean`	# `is_plugin_settings( string $tab = '' )` Returns TRUE if the current page is the plugin settings main page, or a specific plugin settings tab (specified by the $tab parameter). Otherwise returns FALSE Returns TRUE if the current page is the plugin settings main page, or a specific plugin settings tab (specified by the $tab parameter). Otherwise returns FALSE Parameters `$tab` - Specifies a specific plugin setting page/tab. Returns `boolean` bool
`public boolean`	# `is_app_settings( string $tab = '' )` Returns TRUE if the current page is the app settings main page, or a specific apps settings tab (specified by the $tab parameter). Otherwise returns FALSE Returns TRUE if the current page is the app settings main page, or a specific apps settings tab (specified by the $tab parameter). Otherwise returns FALSE Parameters `$tab` - Specifies a specific app setting page/tab. Returns `boolean` bool
`public boolean`	# `is_plugin_page( )` Returns TRUE if the current page is the plugin page. Otherwise returns FALSE Returns TRUE if the current page is the plugin page. Otherwise returns FALSE Returns `boolean` bool
`public boolean`	# `is_entry_view( )` Returns TRUE if the current page is the entry view page. Otherwise, returns FALSE Returns TRUE if the current page is the entry view page. Otherwise, returns FALSE Returns `boolean` bool
`public boolean`	# `is_entry_edit( )` Returns TRUE if the current page is the entry edit page. Otherwise, returns FALSE Returns TRUE if the current page is the entry edit page. Otherwise, returns FALSE Returns `boolean` bool
`public`	# `is_entry_list( )`
`public`	# `is_results( )` Returns TRUE if the current page is the results page. Otherwise, returns FALSE Returns TRUE if the current page is the results page. Otherwise, returns FALSE
`public`	# `is_print( )` Returns TRUE if the current page is the print page. Otherwise, returns FALSE Returns TRUE if the current page is the print page. Otherwise, returns FALSE
`public`	# `is_preview( )` Returns TRUE if the current page is the preview page. Otherwise, returns FALSE Returns TRUE if the current page is the preview page. Otherwise, returns FALSE
`public`	# `has_deprecated_elements( )`
`public static`	# `get_all_deprecated_protected_methods( mixed $add_on_class_name = '' )`
`public static`	# `get_deprecated_protected_methods_for_base_class( mixed $base_class_name, mixed $add_on_class_name = '' )`
`public`	# `maybe_wp_kses( mixed $html, mixed $allowed_html = 'post', mixed $allowed_protocols = array() )`
`public`	# `get_slug( )` Returns the slug for the add-on. Returns the slug for the add-on. Since 2.0 Used by `GFAddOn::meets_minimum_requirements()`
`public`	# `get_path( )` Returns the path for the add-on. Returns the path for the add-on. Since 2.2
`public string\|array`	# `get_capabilities( string $capability = '' )` Get all or a specific capability for Add-On. Get all or a specific capability for Add-On. Parameters `$capability` Capability to return. Returns `string\|array` string\|array Since 2.2.5.27
`public`	# `load_text_domain( )` Initializing translations. Initializing translations. Since 2.0.7
`public`	# `current_user_can_uninstall( )`

Properties summary
`protected string`	`$_version` Version number of the Add-On Version number of the Add-On	#
`protected string`	`$_min_gravityforms_version` Gravity Forms minimum version requirement Gravity Forms minimum version requirement	#
`protected string`	`$_slug` URL-friendly identifier used for form settings, add-on settings, text domain localization... URL-friendly identifier used for form settings, add-on settings, text domain localization... Used by `GFPaymentAddOn::setup()` `GFPaymentAddOn::is_payment_gateway()` `GFPaymentAddOn::is_callback_valid()` `GFPaymentAddOn::maybe_process_callback()` `GFPaymentAddOn::register_callback()`	#
`protected string`	`$_path` Relative path to the plugin from the plugins folder. Example "gravityforms/gravityforms.php" Relative path to the plugin from the plugins folder. Example "gravityforms/gravityforms.php"	#
`protected string`	`$_full_path` Full path the the plugin. Example: __FILE__ Full path the the plugin. Example: __FILE__	#
`protected string`	`$_url` URL to the Gravity Forms website. Example: 'http://www.gravityforms.com' OR affiliate link. URL to the Gravity Forms website. Example: 'http://www.gravityforms.com' OR affiliate link.	#
`protected string`	`$_title` Title of the plugin to be used on the settings page, form settings and plugins page. Example: 'Gravity Forms MailChimp Add-On' Title of the plugin to be used on the settings page, form settings and plugins page. Example: 'Gravity Forms MailChimp Add-On'	#
`protected string`	`$_short_title` Short version of the plugin title to be used on menus and other places where a less verbose string is useful. Example: 'MailChimp' Short version of the plugin title to be used on menus and other places where a less verbose string is useful. Example: 'MailChimp'	#
`protected array`	`$_capabilities` Members plugin integration. List of capabilities to add to roles. Members plugin integration. List of capabilities to add to roles.	#`array()`
`public string`	`$app_hook_suffix` The hook suffix for the app menu The hook suffix for the app menu	#
`protected string\|array`	`$_capabilities_settings_page` A string or an array of capabilities or roles that have access to the settings page A string or an array of capabilities or roles that have access to the settings page	#`array()`
`protected string\|array`	`$_capabilities_form_settings` A string or an array of capabilities or roles that have access to the form settings A string or an array of capabilities or roles that have access to the form settings	#`array()`
`protected string\|array`	`$_capabilities_plugin_page` A string or an array of capabilities or roles that have access to the plugin page A string or an array of capabilities or roles that have access to the plugin page	#`array()`
`protected string\|array`	`$_capabilities_app_menu` A string or an array of capabilities or roles that have access to the app menu A string or an array of capabilities or roles that have access to the app menu	#`array()`
`protected string\|array`	`$_capabilities_app_settings` A string or an array of capabilities or roles that have access to the app settings page A string or an array of capabilities or roles that have access to the app settings page	#`array()`
`protected string\|array`	`$_capabilities_uninstall` A string or an array of capabilities or roles that can uninstall the plugin A string or an array of capabilities or roles that can uninstall the plugin	#`array()`

Classes

Class GFAddOn

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Since

Uses

Used by

Returns

Since

Used by

Example

Returns

Since

Uses

Since

Uses

Parameters

Parameters

Returns

Parameters

Since

Since

Uses

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Used by

Used by

Used by

Used by

Parameters

Returns

Parameters

Returns

Parameters

Returns

Used by

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Since

Uses

Parameters

Returns

Since

Uses

Parameters

Returns

Since

Uses

Parameters

Returns

Since

Uses

Used by

Parameters

Returns

Since

Uses

Used by

Returns

Since

Uses

Used by

Returns