Gravity Forms Functions

• add_api_call
• add_categories_as_choices
• add_dismissible_message — Add a dismissible message to the array of dismissible messages.
• add_emails_sent
• add_error_message
• add_message
• admin_notices_style — Prevent notices from displaying before they are in their correct location.
• admin_screen_reader_title — Outputs a visually hidden page header for screen readers.
• akismet_enabled
• all_caps — Returns all the plugin capabilities.
• cache_remote_message
• calculate
• check_for_gf_widgets — Check the widgets in the referenced sidebar to see if any are GF form widgets.
• check_type_and_ext — Check the file type/extension to ensure it's allowed, and that the extension matches the actual file type.
• check_update
• clean_extensions — Returns an array of file extensions with periods and spaces removed.
• compare_floats — Reliably compare floats.
• conditional_shortcode
• create_post
• current_user_can_any
• current_user_can_uninstall
• current_user_can_which
• darken_color — Darken a given color string by a specific amount.
• date_display
• decode_merge_tag
• delete_directory
• dismiss_message — Adds a dismissible message to the user meta of the current user so it's not displayed again.
• display_admin_message
• display_dismissible_message — Outputs dismissible messages on the page.
• echo_if
• email_domain_matches — Checks if notification from email is using the site domain.
• encode_merge_tag
• encode_shortcodes
• ensure_wp_version
• entry_is_spam_akismet — Callback for gform_entry_is_spam; performs the Akimset spam check.
• esc_like
• evaluate_conditional_logic — Evaluates conditional logic based on the specified $logic variable. This method is used when evaluating non-field conditional logic such as Notification, Confirmation and Feeds.
• evaluate_minimum_requirements — Evaluate minimum requirements for an add-on.
• file_name_has_disallowed_extension
• find_admin_notices — Parse any admin notices and hide any that are non-GF-related.
• fix_notification_routing — Removes an empty routing rule that can prevent the sending of some legacy notifications.
• form_has_fields — Determines if the given form has an array based fields property.
• form_requires_login — Determines if the user must be logged in to view and submit the form.
• format_date — Formats the given date/time for display.
• format_email_message — Formats the email message to improve Spam Assassin score.
• format_email_to — Formats emails to improve Spam Assassin score.
• format_file_size — Converts a file size to an easily readable string.
• format_html_message — Maybe wrap the notification message in html tags.
• format_post_category
• format_text_message
• format_variable_value
• gapi
• generate_block_styles_palette — Generate a color palette based on the block styles available for the Forms Block. Generally used in
• generate_download_hash — Generates a hash for a Gravity Forms download.
• get_akismet_field
• get_akismet_fields — Prepares a query string containing the data to be sent to Akismet.
• get_api_calls
• get_browser_class
• get_calculation_value — Gets the calculation value for a specific field.
• get_canadian_provinces
• get_card_type
• get_card_types
• get_country_code
• get_currency
• get_db_version — Return the version of MySQL or MariaDB currently in use.
• get_dbms_type — Return current database management system.
• get_dbms_version — Returns the raw value from a SELECT version() or SELECT sqlite_version() db query.
• get_default_date_format — Returns the date format from the WordPress general settings, if configured, or Y-m-d.
• get_default_time_format — Returns the time format from the WordPress general settings, if configured, or H:i.
• get_disallowed_file_extensions
• get_emails_sent
• get_embed_post
• get_entry_info_filter_columns
• get_entry_info_filter_settings
• get_entry_meta_filter_settings
• get_entry_payment_status_text — Returns the display text for the specified entry payment status value.
• get_entry_payment_statuses — Returns an array of supported entry payment statuses.
• get_entry_payment_statuses_as_choices — Returns an array of supported entry payment statuses formatted for use as drop down choices.
• get_environment_setting — Gets an environment setting for the current environment.
• get_field_filter_settings
• get_field_filters_from_post
• get_field_ids_from_formula_tag — Given a calculation formula tag, (e.g. {:1} + 3), gather any field IDs referenced
• get_field_input — Returns the HTML for the field input(s).
• get_field_placeholder_attribute
• get_field_type_title
• get_fields_by_type
• get_gmt_timestamp
• get_hooks_javascript_code — Get the Javascript code from the gforms_hooks file and return it.
• get_icon_markup — Prepare icon markup based on icon type.
• get_inline_script_tag — Common method for outputting scripts inline. Allows for users on WordPress 5.7 and up
• get_input_placeholder_attribute
• get_input_placeholder_value
• get_installed_translations — Returns an array of locales or mo translation files found in the WP_LANG_DIR/plugins directory.
• get_key — Returns the license key MD5.
• get_key_info
• get_lead_field_display — Returns the value to be displayed on the entry detail page and for the {all_fields} merge tag.
• get_local_timestamp — Converts the given timestamp to a pseudo timestamp which has been adjusted for the timezone in the WordPress settings.
• get_nested_key — Check a field group for nested fields and return the key.
• get_notifications
• get_notifications_to_send
• get_option_info
• get_order_total
• get_other_choice_value — Get the placeholder to use for the radio button field other choice.
• get_post_image_variable
• get_preview_link — Gets the html for the preview form link if capabilities are met.
• get_preview_link_args — Get default arguments for the preview link. The toolbar menu generator function requires array data, while other
• get_preview_link_data — Returns preview link data as array when needed by menu builder functions.
• get_product_fields
• get_product_fields_by_type
• get_remote_message
• get_remote_post_params
• get_remote_request_params
• get_repeater_item_field_value — Gets a field value from a repeater item, handling both hydrated (structured) and flattened entry data.
• get_repeater_items_from_lead — Gets repeater items from the lead array, handling both saved entries (flattened keys) and submission-time leads.
• get_repeater_product_fields — Recursively collects product fields from a repeater field and adds them to the products array.
• get_section_fields
• get_select_choices — Returns the choicse markup for the given field.
• get_selection_value
• get_submission_currency — Verifies the posted currency value to ensure it wasn't tampered with.
• get_submitted_fields
• get_submitted_pricing_fields
• get_support_url — Gets the support url configured for the current environment.
• get_tabindex
• get_total
• get_ul_classes
• get_upload_page_slug
• get_us_state_code
• get_us_states
• get_version_info — Get the license and plugins information.
• get_visibility_options
• get_visibility_tooltip
• gf_apply_filters — Gravity Forms pre-processing for apply_filters
• gf_do_action — Gravity Forms pre-processing for do_action.
• gf_feed_processor — Returns an instance of the GF_Feed_Processor class
• gf_global — Outputs the gf_global and returns either the gf_global var declaration or the array containing the gf_global values.
• gf_has_action — Determines if a callback has been registered for the specified action.
• gf_has_filter — Determines if a callback has been registered for the specified filter.
• gf_has_filters — Determines if a callback has been registered for the specified filter.
• gf_header — Display the Gravity Forms header.
• gf_logging — Returns an instance of the GFLogging class
• gf_register_widget
• gf_results_cache
• gf_upgrade
• gf_vars
• gform_add_meta — Add metadata associated with an entry.
• gform_admin_pre_render — Passes the given form through the gform_admin_pre_render filter.
• gform_default_entry_content
• gform_delete_meta — Delete metadata associated with an entry.
• gform_do_shortcode — Prints or enqueues form scripts and processes shortcodes found in the supplied content.
• gform_get_meta
• gform_get_meta_values_for_entries
• gform_tooltip — Displays the tooltip
• gform_update_meta — Add or update metadata associated with an entry.
• gforms_register_theme_json
• gravity_form — Main Gravity Forms function call.
• gravity_form_enqueue_scripts — Enqueues form scripts for the specified form.
• has_admin_notification
• has_akismet — Determines if the Akismet integration is available.
• has_consent_field — Whether the form has a consent field.
• has_credit_card_field
• has_currency_value
• has_field_by_type
• has_list_field
• has_merge_tag
• has_multifile_fileupload_field
• has_pages
• has_post_field
• has_repeater_field — Whether the form contains a repeater field.
• has_required_field — Whether the form has a required field.
• has_update
• has_user_notification
• implode_non_blank
• insert_calculation_variables
• insert_field_variable
• insert_post_content_variables
• int_range — Forces an integer into a range of integers. Returns the value or the minimum if it's outside the range.
• is_akismet_spam
• is_bp_active
• is_dark_color — Detect if a color is dark against a passed threshold. Default is set at 465 in the range of 1 - 765.
• is_date_time_formatted — Determines if the specified text is formatted as a date or time.
• is_empty_array
• is_entry_detail
• is_entry_detail_edit
• is_entry_detail_view
• is_form_editor
• is_frontend_default_css_disabled — Applies the gform_disable_css filter and checks 'disable css global' setting to decide if default css should be output or not.
• is_legacy_markup_enabled — Determines if a form has legacy markup enabled.
• is_legacy_markup_enabled_og — Determines if a form has legacy markup enabled.
• is_logging_plugin_active — Checks if the logging plugin is active.
• is_network_active — Determines if this is a network activated multisite installation.
• is_post_field
• is_preview
• is_pricing_field — Checks if the given type is a pricing field.
• is_product_field — Checks if a field is a product field.
• is_section_empty
• is_spam_entry — Determines if the supplied entry is spam.
• is_ssl
• is_valid_card_checksum
• is_valid_for_calcuation
• is_wp_version
• legacy_determine_locale — This is a copy of the determine_locale() method added in Wordpress 5.0. It is used for previous
• legacy_get_version_info — The legacy version of the get_version_info() method.
• lighten_color — Lighten a given color by a specific amount.
• load_gf_text_domain — Initializing translations.
• log_debug
• log_error
• log_once_per_request — Logs message only once per request.
• log_remote_response — Log the remote request response.
• mark_akismet_spam
• match_file_extension
• matches_card_type
• maybe_add_leading_zero — Adds a leading zero if the first character is a comma or period.
• maybe_format_numeric — If the specified conditional logic operation requires a number formatted as numeric, this method will format it and return the result.
• maybe_output_gf_vars — Outputs the gf_vars variable if a script that requires it has been enqueued.
• maybe_sanitize_confirmation_message — Sanitizes a confirmation message.
• maybe_wp_kses — Sanitizes html content. Checks the unfiltered_html capability.
• notices_section — Display the wrapper for admin notifications.
• object_to_array
• openssl_decrypt — Decrypt AES-256-CTR with HMAC-SHA-512 hash.
• openssl_encrypt — Encrypt with AES-256-CTR plus HMAC-SHA-512 hash.
• output_default_css — Decides whether to output the default css or not.
• output_hooks_javascript — Outputs gforms object and hooks methods depended upon by gform_gravityforms script early so that inline scripts
• output_svg — Output an SVG as markup, referenced by the key (which is the filename, minus extension).
• parse_date — Creates an array from the given value using year, month, and day as keys.
• post_to_manager — Post request to Gravity Manager.
• prepare_post_category_value — Prepare the saved value of a Post Category field for display.
• random_str — Generate a random string, using a cryptographically secure
• record_cron_event — Maintains a semipersistent record of the 3 most recent events for the specified hook.
• remove_dismissible_message — Remove a dismissible message from the array of sticky dismissible messages.
• remove_extra_commas — Strip extra commas from email headers.
• replace_field_variable
• replace_variables
• replace_variables_post_image
• replace_variables_prepopulate
• requires_gf_hooks_javascript — Tests if we should output the hooks JavaScript on the active theme
• requires_gf_vars
• rest_sanitize_request_arg — Sanitize a request argument based on details registered to the route.
• rest_validate_request_arg — Validate a request argument based on details registered to the route.
• rgar — Get a specific property of an array without needing to check if that property exists.
• rgar — Get a specific property of an array without needing to check if that property exists.
• rgars — Gets a specific property within a multidimensional array.
• rgblank — Checks if the string is empty
• rgempty — Determines if a value is empty.
• rgexplode — Converts a delimiter separated string to an array.
• rgget — Helper function for getting values from query strings or arrays
• rgobj — Gets a property value from an object
• rgpost — Helper function to obtain POST values.
• round_number
• safe_strlen
• safe_strtoupper
• safe_substr
• safe_unserialize — Unserializes a string while suppressing errors, checks if the result is of the expected type.
• selection_display
• send_email
• send_form_submission_notifications
• send_json — Sends a JSON response with a delimiter indicating the beginning and end of the JSON string.
• send_json_error — Sends an error JSON response with a delimiter indicating the beginning and end of the JSON string.
• send_json_success — Sends a success JSON response with a delimiter indicating the beginning and end of the JSON string.
• send_notification
• send_notifications
• send_resume_link
• set_array_value — Sets a new value on an existing array, given a known path.
• set_content_type_boundary — Sets the boundary attribute of the Content-type email header.
• set_mail_charset — Sets the character set email header.
• set_spam_filter — Sets the name of the spam filter that flagged entry as spam during a form submission.
• spam_enabled
• table_exists — Checks for the existence of a MySQL table.
• timer_end — Returns the number of seconds that have elapsed since the start time was stashed for the specified event.
• timer_start — Stashes the start time of the specified event.
• to_money — Returns the given number using currency formatting.
• to_number — Removes currency formatting from a value.
• trim_deep — Trims a string or an array recursively.
• truncate_url
• update_site_registration
• whitelist — Whitelists a value. Returns the value or the first value in the array.