API Functions

Validating Form Submissions with the GFAPI

The GFAPI::validate_form() method, added in Gravity Forms 2.6.3.2, is used to validate the form input values. If the form passes validation the configured anti-spam checks will also be performed.

Validating Field Submissions with the GFAPI

The GFAPI::validate_field() method, added in Gravity Forms 2.7, is used to validate the input values of a specific field.

Updating Forms with the GFAPI

The GFAPI::update_form(), GFAPI::update_forms(), GFAPI::update_form_property(), and GFAPI::update_forms_property() methods are used to update forms and their properties.

Updating Entries with the GFAPI

The GFAPI::update_entry(), GFAPI::update_entries(), GFAPI::update_entry_property(), and GFAPI::update_entry_field() methods are used to update entries in the database.

Submitting Forms with the GFAPI

The GFAPI::submit_form() method is used to create an entry by sending input values through the complete form submission process.

Sending Notifications with the GFAPI

The GFAPI::send_notifications() method is used to send notifications for a specific event and the given form and entry.

Searching and Getting Entries with the GFAPI

The GFAPI::entry_exists(), GFAPI::get_entry(), GFAPI::get_entries(), GFAPI::get_entry_ids(), and GFAPI::count_entries() methods are used to search, count, get, and check if entries exist.

Managing Notes with the GFAPI

Introduction The GFAPI methods for managing notes were added in Gravity Forms 2.4.18. See the GFAPI article for other available methods.

Managing Add-On Feeds with the GFAPI

The GFAPI includes methods which are used to manage form Feeds, the properties which determine if and how form submissions are processed by an add-on.

Helper Functions

A list of all helper functions.