Gravity Forms

https://docs.gravityforms.com/
Admin
Gravity Forms is a powerful WordPress plugin for creating and managing various types of forms. It...
Tokens:2,568,896
Snippets:25,999
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Run database setup for a new install

Source: https://docs.gravityforms.com/manage-gravity-forms-and-add-ons-with-wpcli

Runs the database setup for a new Gravity Forms install. The command outputs 'Success: setup gravityforms' when the setup completes successfully.

```bash
$ wp gf setup
```

```text
Success: setup gravityforms
```

--------------------------------

### Install Unit Tests with VVV

Source: https://docs.gravityforms.com/rest-api-v2/rest-api-oauth-postman

Example command for installing unit tests when using VVV, using the provided database credentials.

```bash
bash tests/bin/install.sh wordpress_unit_tests root root localhost
```

--------------------------------

### Gravity Forms version installation examples

Source: https://docs.gravityforms.com/install-gravity-plugins-and-add-ons-via-composer

Examples of installing Gravity Forms with different version constraints: latest, exact version 2.9.5, pattern match 2.9.*, and exact version 2.9.0.

```bash
composer require gravity/gravityforms
```

```bash
composer require gravity/gravityforms:2.9.5
```

```bash
composer require gravity/gravityforms:2.9
```

```bash
composer require gravity/gravityforms:2.9.0
```

--------------------------------

### Force database setup on existing install

Source: https://docs.gravityforms.com/manage-gravity-forms-and-add-ons-with-wpcli

Forces the database setup on an existing install using the --force flag. The command outputs 'Success: Database upgraded.' when the setup completes.

```bash
$ wp gf setup --force
```

```text
Success: Database upgraded.
```

--------------------------------

### Attempt setup without --force on existing install

Source: https://docs.gravityforms.com/manage-gravity-forms-and-add-ons-with-wpcli

Attempts to run the database setup on an existing install without the --force flag. This fails with the error 'Error: Use the --force flag to force the database setup.'

```bash
$ wp gf setup
```

```text
Error: Use the --force flag to force the database setup.
```

--------------------------------

### wp gf setup

Source: https://docs.gravityforms.com/manage-gravity-forms-and-add-ons-with-wpcli

Runs the database setup for Gravity Forms or a specified add-on. Supports a --force flag to override existing installations.

```APIDOC
## [WP-CLI] wp gf setup

### Description
Runs the database setup for Gravity Forms or a specified Gravity Forms Add-On. It can be forced to run even if it has been run before.

### Command
`wp gf setup [<slug>] [--force]`

### Parameters
#### Arguments
- **<slug>** (string) - Optional - The plugin slug. Accepted values: _gravityforms_ or a Gravity Forms Add-On slug. Default: _gravityforms_.

#### Options
- **--force** (flag) - Optional - Runs the setup regardless of whether it has been run before.

### Examples
```
# Successfully running the database setup for a new install.
$ wp gf setup
Success: setup gravityforms
```

```
# Failing to run the database setup for an existing install.
$ wp gf setup
Error: Use the --force flag to force the database setup.
```

```
# Successfully running the database setup for an existing install.
$ wp gf setup --force
Success: Database upgraded.
```

```
# Successfully running the database setup for the Gravity Forms Polls Add-On.
$ wp gf setup gravityformspolls
Success: setup gravityformspolls
```

```
# Forcing the setup on a multisite network
$ for url in $(wp site list --fields=url --format=csv | tail -n +2); do echo Running setup for site:  $url; wp gf setup --force --url=$url; done
Running setup for site: https://one.site.local/
Success: Database upgraded.
Running setup for site: https://two.site.local/
Success: Database upgraded.
```
```

--------------------------------

### Shortcode setup for custom action example

Source: https://docs.gravityforms.com/gform_shortcode_form_property

Shortcode used on a page to trigger the custom action 'form_property'.

```php
[gravityform id="22" name="Poll" action="form_property" property="title"]
my content
[/gravityform]
```

--------------------------------

### Install Gravity plugins with Composer require

Source: https://docs.gravityforms.com/install-gravity-plugins-and-add-ons-via-composer

Installs the required plugins or add-ons your license key has access to. Use gravity/slug to get the plugin or add-on; for example, gravity/gravityforms for Gravity Forms and gravity/gravitysmtp for Gravity SMTP.

```bash
composer require gravity/gravityforms gravity/gravitysmtp
```

--------------------------------

### GET /entries (search)

Source: https://docs.gravityforms.com/web-api-examples

Retrieves entries using search criteria and field filters. The example shows how to filter entries by a field value and a start date.

```APIDOC
## GET /entries

### Description
Retrieves entries using search criteria and field filters. The example below retrieves entries that have the text "Test" as part of the last name field (id 1.6) and have been created since 2016-10-10.

### Method
GET

### Endpoint
/entries

### Parameters
#### Query Parameters
- **search** (string) - Required - A URL-encoded JSON string containing search criteria. The JSON object can include a `field_filters` array and a `start_date` string.

### Request Example
```json
{"field_filters":[{"key":"1.6","operator":"contains","value":"Test"}],"start_date":"2016-10-10"}
```

### Response
#### Success Response (200)
- **entries** (array) - List of entry objects matching the search criteria.

#### Response Example
```json
{
  "entries": []
}
```
```

--------------------------------

### Full Example of init() with Delayed Payment Support

Source: https://docs.gravityforms.com/add-delayed-payment-support-feed-add

Full example of an init() method that enables delayed payment support with a custom label. Includes parent::init() call and the add_delayed_payment_support() invocation.

```php
/**
 * Plugin starting point. Handles hooks, loading of language files, and delayed payment support.
 */
public function init() {
    parent::init();
    $this->add_delayed_payment_support(
        array(
            'option_label' => esc_html__( 'Subscribe contact to ActiveCampaign only when payment is received.', 'gravityformsactivecampaign' )
        )
    );
}
```

--------------------------------

### Example: add blog template to signup meta

Source: https://docs.gravityforms.com/gform_user_registration_signup_meta

Example that adds a 'blog_template' key to the signup meta. Place in functions.php of your active theme.

```php
add_filter( 'gform_user_registration_signup_meta', 'add_blog_template', 10, 4 );
        function add_blog_template( $signup_meta, $form, $entry, $feed ) {
            $signup_meta['blog_template'] = 1;
            return $signup_meta;
        }
```

--------------------------------

### remove_field() Example: Hide Setup Fee

Source: https://docs.gravityforms.com/field-manipulation-helpers

Overrides feed_settings_fields() to remove the default Setup Fee field from the feed settings page. The method calls parent::feed_settings_fields() to get the default fields, then uses remove_field() to hide the setupFee field.

```php
public function feed_settings_fields() {
    $default_settings = parent::feed_settings_fields();
    // Hide default display of setup fee
    $default_settings = $this->remove_field( 'setupFee', $default_settings );
    return $default_settings;
}
```

--------------------------------

### Install unit tests with bash script

Source: https://docs.gravityforms.com/rest-api-v2/class-oauth-request-php

Run the test installation script from the terminal. Replace the placeholders with your database name, user, password, and host.

```bash
tests/bin/install.sh [DB_NAME] [DB_USER] [DB_PASSWORD] [DB_HOST]
```

--------------------------------

### Get version when Gravity Forms is not installed

Source: https://docs.gravityforms.com/manage-gravity-forms-and-add-ons-with-wpcli

Attempting to get the version when Gravity Forms is not installed. The command outputs an error message instructing to use the wp gf install command.

```bash
$ wp gf version
```

```bash
Error: Gravity Forms is not installed. Use the wp gf install command.
```

--------------------------------

### Install Gravity Forms with --key

Source: https://docs.gravityforms.com/manage-gravity-forms-and-add-ons-with-wpcli

Installs Gravity Forms using a specified license key via the --key option. The output confirms the plugin was installed successfully.

```bash
$ wp gf install --key=abc123
Downloading installation package from http://...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Success: Installed 1 of 1 plugins.
```

--------------------------------

### Example 1: Get feed ID 1

Source: https://docs.gravityforms.com/managing-add-on-feeds-with-rest-api-v2

Example URL to retrieve feed ID 1.

```http
https://example.com/wp-json/gf/v2/feeds/1
```

--------------------------------

### getConfig() Example

Source: https://docs.gravityforms.com/gform-config

Example of retrieving the 'ajaxurl' value from the 'general' group and logging it to the console.

```javascript
const ajaxUrl = gform.config.getConfig('general', 'ajaxurl');
console.log('AJAX URL:', ajaxUrl);
```

--------------------------------

### Run composer install

Source: https://docs.gravityforms.com/install-gravity-plugins-and-add-ons-via-composer

Runs the Composer install command after manually configuring composer.json and auth.json.

```bash
composer install
```

--------------------------------

### GET /forms - PHP Example

Source: https://docs.gravityforms.com/web-api

PHP example to retrieve all active forms using the Gravity Forms REST API. It sets API keys, builds a signed request URL, sends a GET request via wp_remote_request, and processes the response. The example includes a calculate_signature function for HMAC-SHA1 signing.

```php
//set API keys
$api_key = 'your_api_key';
$private_key = 'your_private_key';

//set route
$route = 'forms';

//creating request URL
$expires = strtotime( '+60 mins' );
$string_to_sign = sprintf( '%s:%s:%s:%s', $api_key, 'GET', $route, $expires );
$sig = calculate_signature( $string_to_sign, $private_key );
$url = 'http://localhost/wp/gravityformsapi/' . $route . '?api_key=' . $api_key . '&signature=' . $sig . '&expires=' . $expires;

//retrieve data
$response = wp_remote_request( urlencode( $url ), array( 'method' => 'GET' ) );
if ( wp_remote_retrieve_response_code( $response ) != 200 || ( empty( wp_remote_retrieve_body( $response ) ) ) ){
    //http request failed
    die( 'There was an error attempting to access the API.' );
}

//result is in the response "body" and is json encoded.
$body = json_decode( wp_remote_retrieve_body( $response ), true );

if( $body['status'] > 202 ){
    die( "Could not retrieve forms." );
}

//forms retrieved successfully
$forms = $body['response'];

//To access each form, loop through the $forms array.
foreach ( $forms as $form ){
    $form_id = $form['id'];
    $form_title = $form['title'];
    $entry_count = $form['entries'];
}

function calculate_signature( $string, $private_key ) {
    $hash = hash_hmac( 'sha1', $string, $private_key, true );
    $sig = rawurlencode( base64_encode( $hash ) );
    return $sig;
}
```

--------------------------------

### Example 1: Get all feeds for form 190

Source: https://docs.gravityforms.com/managing-add-on-feeds-with-rest-api-v2

Example URL to retrieve all feeds for form ID 190.

```http
https://example.com/wp-json/gf/v2/forms/190/feeds
```

--------------------------------

### gform_preview_init

Source: https://docs.gravityforms.com/gform_preview_init

Documentation for the gform_preview_init action hook, including usage, parameters, examples, placement, and version history.

```APIDOC
## gform_preview_init

### Description
The `gform_preview_init` action is triggered when the form preview page loads, allowing further actions to be done.

### Usage
```php
add_action( 'gform_preview_init', 'my_function' );
```

### Parameters
- **$form_id** (int) - The current form ID

### Examples
```php
function my_function() {
    // Do something here
}
add_action( 'gform_preview_init', 'my_function' );
```

### Placement
This code can be used in the functions.php file of the active theme, a custom functions plugin, a custom add-on, or with a code snippets plugin.

### Since
This action hook was added in Gravity Forms 2.5. The $form_id parameter was added in Gravity Forms 2.9

### Source Code
This action hook is located in _preview.php_.
```

--------------------------------

### GET /gf/v2/feeds

Source: https://docs.gravityforms.com/managing-add-on-feeds-with-rest-api-v2

This snippet documents the GET /gf/v2/feeds endpoint, including its query parameters, response structure, and usage examples.

```APIDOC
## [GET] /gf/v2/feeds

### Description
Retrieves a list of feeds. You can filter the results by feed ID or add-on slug.

### Method
GET

### Endpoint
/gf/v2/feeds

### Parameters
#### Query Parameters
- **include** (string or array) - Optional - The ID of the Feed or an array of Feed IDs.
- **addon** (string) - Optional - The slug of the add-on to which the Feeds belong, including the **gravityforms** prefix.

### Response
#### Success Response (200)
- **id** (string) - The feed ID.
- **form_id** (string) - The ID of the form associated with the feed.
- **addon_slug** (string) - The slug of the add-on.
- **meta** (object) - The feed metadata, which varies by add-on.

#### Response Example
```json
[
  {
    "id": "1",
    "form_id": "0",
    "addon_slug": "gravityformscoupons",
    "meta": {
      "gravityForm": "0",
      "couponName": "Military Discount",
      "couponCode": "MD10",
      "couponAmountType": "percentage",
      "couponAmount": 10,
      "startDate": "",
      "endDate": "",
      "usageLimit": "",
      "isStackable": "0",
      "usageCount": 5
    }
  },
  {
    "id": "6",
    "form_id": "8",
    "addon_slug": "gravityformswebhooks",
    "meta": {
      "feedName": "My Test",
      "requestURL": "www.rocketgenius.com",
      "requestMethod": "POST",
      "requestFormat": "form",
      "requestHeaders": [
        {
          "key": "gf_custom",
          "value": "id",
          "custom_key": "MyCustomKey",
          "custom_value": ""
        }
      ],
      "requestBodyType": "all_fields",
      "feed_condition_conditional_logic": "0",
      "feed_condition_conditional_logic_object": []
    }
  },
  {
    "id": "34",
    "form_id": "190",
    "addon_slug": "gravityformsmailchimp",
    "meta": {
      "feedName": "Test API Feed Creation 10",
      "mailchimpList": "b19814053f",
      "mappedFields_EMAIL": "2",
      "mappedFields_FNAME": "1.3",
      "mappedFields_LNAME": "1.6",
      "mappedFields_MMERGE4": "",
      "mappedFields_MMERGE5": "",
      "mappedFields_MMERGE6": "",
      "double_optin": "1",
      "markAsVIP": "0",
      "note": "",
      "feed_condition_conditional_logic": "0",
      "feed_condition_conditional_logic_object": []
    }
  }
]
```

### Usage Examples
#### Example 1: Get all active feeds for all forms
```
https://example.com/wp-json/gf/v2/feeds
```

#### Example 2: Get specific feeds
```
https://example.com/wp-json/gf/v2/feeds?include[0]=1&include[1]=32
```

#### Example 3: Get all feeds for a specific add-on
```
https://example.com/wp-json/gf/v2/feeds?addon=gravityformsmailchimp
```
```

--------------------------------

### Run database setup for Gravity Forms Polls Add-On

Source: https://docs.gravityforms.com/manage-gravity-forms-and-add-ons-with-wpcli

Runs the database setup for the Gravity Forms Polls Add-On by passing its slug. The command outputs 'Success: setup gravityformspolls' when the setup completes.

```bash
$ wp gf setup gravityformspolls
```

```text
Success: setup gravityformspolls
```

--------------------------------

### GET /entries (read filter)

Source: https://docs.gravityforms.com/web-api-examples

Retrieves entries that have been read. The example uses the `is_read` field filter to get only read entries.

```APIDOC
## GET /entries

### Description
Retrieves entries that have been read. The search criteria uses the `is_read` field filter with the operator `is` and value `1`.

### Method
GET

### Endpoint
/entries

### Parameters
#### Query Parameters
- **search** (string) - Required - A URL-encoded JSON string containing search criteria. The JSON object must include a `field_filters` array with an object having `key`, `operator`, and `value` properties.
- **paging[page_size]** (integer) - Optional - The number of entries to return per page. Example: `1000`.

### Request Example
```json
{"field_filters":[{"key":"is_read","operator":"is","value":1}]}
```

### Response
#### Success Response (200)
- **entries** (array) - List of entry objects that have been read.

#### Response Example
```json
{
  "entries": []
}
```
```

--------------------------------

### System report command examples

Source: https://docs.gravityforms.com/wp-cli-tools

Example output for the system-report command, showing success and an error when using an older Gravity Forms version.

```bash
# Successfully using the "system-report" command to output the system report.
$ wp gf tool system-report
Success:
### Gravity Forms ###
...
```

```bash
# Using the "status" alias with an older Gravity Forms version.
$ wp gf tool status
Error: The system report is only available with Gravity Forms 2.2 or greater.
```

--------------------------------

### Modify request method to GET

Source: https://docs.gravityforms.com/gform_webhooks_request_method

Example that modifies the HTTP request method to 'GET'. Place in the functions.php file of your active theme.

```php
add_filter( 'gform_webhooks_request_method', 'set_method', 10, 4 );
function set_method( $request_method, $feed, $entry, $form ){
  return 'GET';
}
```

--------------------------------

### Install unit tests for VVV environment

Source: https://docs.gravityforms.com/rest-api-v2/class-oauth-request-php

Use this command when running in a VVV (Varying Vagrant Vagrants) environment. It passes the database credentials and host as arguments.

```bash
tests/bin/install.sh wordpress_unit_tests root root localhost
```

--------------------------------

### GFAPI::get_feed_name() usage example

Source: https://docs.gravityforms.com/managing-add-on-feeds-with-the-gfapi

Example usage of GFAPI::get_feed_name(). First retrieves the feed with ID 123, then gets its name.

```php
$feed = GFAPI::get_feed( 123 );
$feed_name = GFAPI::get_feed_name( $feed );
```

--------------------------------

### Example of $form_string parameter

Source: https://docs.gravityforms.com/gform_footer_init_scripts_filter

Example of the $form_string parameter, which contains the scripts used in the footer.

```html
<script type='text/javascript'> jQuery(document).bind('gform_post_render', function(event, formId, currentPage){if(formId == 75) {} } );jQuery(document).bind('gform_post_conditional_logic', function(event, formId, fields, isInit){} );</script><script type='text/javascript'> jQuery(document).ready(function(){jQuery(document).trigger('gform_post_render', [75, 1]) } ); </script>
```

--------------------------------

### GET /wp-json/gf/v2/entries (Use paging with offset)

Source: https://docs.gravityforms.com/searching-and-getting-entries-with-the-rest-api-v2

Retrieves entries with paging support, starting from a specified offset. The offset starts at 0.

```APIDOC
## GET /wp-json/gf/v2/entries

### Description
Retrieves entries with paging support, starting from a specified offset. The offset starts at 0.

### Method
GET

### Endpoint
`https://example.com/wp-json/gf/v2/entries`

### Parameters
#### Query Parameters
- **paging[page_size]** (integer) - Required - Number of results per page.
- **paging[offset]** (integer) - Required - Offset to start from (0-based).

### Request Example
```
curl --location --request GET -G 'https://example.com/wp-json/gf/v2/entries' \
--user 'alisha:XnVO ccCg lt3X W3Wa AlQQ mf0R' \
--header 'Content-Type: application/json' \
--data-urlencode 'paging[page_size]=20' \
--data-urlencode 'paging[offset]=15'
```
```

--------------------------------

### gform_abilities_init

Source: https://docs.gravityforms.com/gform_abilities_init

Documentation for the gform_abilities_init action hook, including usage, parameters, and an example for registering a custom ability.

```APIDOC
## gform_abilities_init

### Description
The `gform_abilities_init` action fires after all core Gravity Forms abilities are registered. It is a safe moment for add-ons or site code to register their own via `wp_register_ability()`. Note: Abilities with an unregistered category fall back to the add-ons category rather than being dropped.

### Usage
```php
add_action( 'gform_abilities_init', 'your_function_name' );
```

### Parameters
This action does not pass any parameters.

### Examples
#### Register a Custom Ability
```php
add_action( 'gform_abilities_init', function () {
    wp_register_ability( 'gravityforms-myaddon/sync-crm', array(
        'label'             => __( 'Sync to CRM', 'my-addon' ),
        'description'       => __( 'Pushes an entry to the CRM.', 'my-addon' ),
        'category'          => 'gravityforms-addons',
        'capability'        => 'gravityforms_edit_entries',
        'execute_callback'  => 'my_addon_sync_entry',
    ) );
} );
```

### Placement
This code can be used in the functions.php file of the active theme, a custom functions plugin, a custom add-on, or with a code snippets plugin. See also the PHP section in this article: Where Do I Put This Code?

### Source Code
This action is located in `gravityforms/includes/abilities/class-gf-abilities-service-provider.php`.

### Since
The action was added in Gravity Forms 3.1.0.
```

--------------------------------

### GET /gf/v2/forms/[FORM_ID]/results

Source: https://docs.gravityforms.com/getting-results-with-rest-api-v2

Documentation for the GET /gf/v2/forms/[FORM_ID]/results endpoint, including parameters, request example, and response schema.

```APIDOC
## GET /gf/v2/forms/[FORM_ID]/results

### Description
Retrieves survey, poll, quiz, or other add-on results for a specific form. The response includes entry counts, field data, status, timestamp, and labels.

### Method
GET

### Endpoint
/gf/v2/forms/[FORM_ID]/results

### Parameters
#### Path Parameters
- **FORM_ID** (integer) - Required - The ID of the form for which to retrieve results.

#### Query Parameters
- **search** (array) - Optional - An associative array containing the search arguments. Must be provided as JSON.

#### Search Arguments
An associative array supporting the following properties. Must be provided in request as JSON.

##### Field Filters
- **field_filters** (array) - Optional - One or more associative arrays. See Field Filter.
- **mode** (string) - Optional - Defaults to `all`. Possible values: `all` or `any`. Determines if the found entries have to match all the field filters or any.

##### Field Filter
An associative array supporting the following properties.
- **key** (string) - Required - The field ID, entry property, or entry meta key.
- **value** (string|integer|float|array) - Required - The value to find for the specified `key`.
- **operator** (string) - Optional - Defaults to `=`. Possible values: `=`, `IS`, `CONTAINS`, `IS NOT`, `ISNOT`, `<>`, `LIKE`, `NOT IN`, `NOTIN`, or `IN`. Lowercase is also supported.
- **is_numeric** (boolean) - Optional - Indicates if the values of the specified `key` are numeric.

### Request Example
```
curl "https://rocket.test/wp-json/gf/v2/forms/46/results" \
     -u 'ck_5f86565df60696c43af25f9194e106800770b8e9:cs_be0190310fefc061c564168670d0a96d68873c29'
```

### Response
#### Success Response (200)
- **entry_count** (string) - The number of entries included in the results.
- **field_data** (object) - Results for each field, keyed by field ID and including each choice value and total (grade or score).
- **status** (string) - Whether or not the request includes complete results. Returns `complete` or `incomplete`.
- **timestamp** (integer) - Timestamp indicating when the last cron task was run to calculate results.
- **labels** (object) - Labels for each field, keyed by field ID and including field label and choice values with associated labels.

#### Response Example
```
{
  "entry_count": 3,
  "field_data": {
    "1": {
      "glikertcol1307d0217": 1,
      "glikertcol16fe62d85": 0,
      "glikertcol1abdff2ca": 1,
      "glikertcol1734f064a": 1,
      "glikertcol162d7d431": 0
    },
    "3": {
      "grank3552035c7": 12,
      "grank30f9c9492": 8,
      "grank353117d68": 11,
      "grank33a45d22c": 10,
      "grank384c3da75": 4
    },
    "4": {
      "grating448a9311f": 0,
      "grating4bd2f576a": 1,
      "grating4d20d7980": 0,
      "grating407965b55": 1,
      "grating451a23053": 1
    },
    "5": {
      "gsurvey542f6dec1": 0,
      "gsurvey517188a2a": 1,
      "gsurvey550a16b4c": 2
    }
  },
  "status": "complete",
  "timestamp": 1718995135,
  "labels": {
    "1": {
      "label": "Untitled Survey Field",
      "choices": {
        "glikertcol1307d0217": "Strongly disagree",
        "glikertcol16fe62d85": "Disagree",
        "glikertcol1abdff2ca": "Neutral",
        "glikertcol1734f064a": "Agree",
        "glikertcol162d7d431": "Strongly agree"
      }
    },
    "3": {
      "label": "Untitled Survey Field",
      "choices": {
        "grank3552035c7": "First Choice",
        "grank30f9c9492": "Second Choice",
        "grank353117d68": "Third Choice",
        "grank33a45d22c": "Fourth Choice",
        "grank384c3da75": "Fifth Choice"
      }
    },
    "4": {
      "label": "Untitled Survey Field",
      "choices": {
        "grating448a9311f": "Terrible",
        "grating4bd2f576a": "Not so great",
        "grating4d20d7980": "Neutral",
        "grating407965b55": "Pretty good",
        "grating451a23053": "Excellent"
      }
    },
    "5": {
      "label": "Untitled Survey Field",
      "choices": {
        "gsurvey542f6dec1": "First Choice",
        "gsurvey517188a2a": "Second Choice",
        "gsurvey550a16b4c": "Third Choice"
      }
    }
  }
}
```
```

--------------------------------

### GET /forms - JavaScript Example

Source: https://docs.gravityforms.com/web-api

JavaScript example to retrieve all active forms using the Gravity Forms REST API. It includes a warning that this sample is not secure and should not be used on production sites. It uses jQuery and CryptoJS to calculate the HMAC-SHA1 signature and makes a GET request to the API.

```javascript
<script src="https://code.jquery.com/jquery-1.10.2.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/crypto-js/3.1.2/rollups/hmac-sha1.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/crypto-js/3.1.2/components/enc-base64-min.js"></script>
<script type="text/javascript">
function CalculateSig(stringToSign, privateKey){
    //calculate the signature needed for authentication
    var hash = CryptoJS.HmacSHA1(stringToSign, privateKey);
    var base64 = hash.toString(CryptoJS.enc.Base64);
    return encodeURIComponent(base64);
}

//set variables
var d = new Date;
var expiration = 3600; // 1 hour,
var unixtime = parseInt(d.getTime() / 1000);
var future_unixtime = unixtime + expiration;
var publicKey = "your_public_key";
var privateKey = "your_private_key";
var method = "GET";
var route = "forms";

stringToSign = publicKey + ":" + method + ":" + route + ":" + future_unixtime;
sig = CalculateSig(stringToSign, privateKey);
var url = 'http://localhost/wp.dev/gravityformsapi/' + route + '?api_key=' + publicKey + '&signature=' + sig + '&expires=' + future_unixtime;

$.get(url, function(data, textStatus){
    //get the data from the api
    if ( data.status != 200 || ( typeof( data ) != 'object' ) ) {
        //http request failed
        document.write( 'There was an error attempting to access the API - ' + data.status + ': ' + data.response );
        return;
    }
    forms         = data.response;
    document.write('<p>Results</p>');
    document.write('<table border="1"><th>Form ID</th><th>Form Title</th><th>Entry Count</th>');
    for (var form in forms) {
        document.write('<tr><td>' + forms[form]['id'] + '</td><td>' + forms[form]['title'] + '</td><td>' + forms[form]['entries'] + '</td></tr>');
    }
    document.write("</table>");
});
</script>
```

--------------------------------

### Enable custom app settings with __return_true

Source: https://docs.gravityforms.com/gform_square_show_custom_app_settings/square-settings-custom-application-input

Example that returns true to display the custom app settings link. Place this code in the functions.php file of your active theme.

```php
add_filter( 'gform_square_show_custom_app_settings', '__return_true' );
```

--------------------------------

### Use gf-download URL

Source: https://docs.gravityforms.com/gform_zapier_field_value

This example demonstrates how to replace the direct file URL with a more secure gf-download URL for file upload fields.

```APIDOC
## Use gf-download URL

### Description
This example shows how to replace the direct URL to the file, which is stored in the entry, with the more secure gf-download URL.

### Code
```php
add_filter( 'gform_zapier_field_value', function ( $value, $form_id, $field_id, $entry ) {
    $field = GFAPI::get_field( $form_id, $field_id );
    if ( $field instanceof GF_Field_FileUpload ) {
        $value = $field->get_download_url( $value );
    }
    return $value;
}, 10, 4 );
```
```

--------------------------------

### Payment Add-On Class Configuration Example

Source: https://docs.gravityforms.com/gfpaymentaddon

Complete example of including the framework and defining a payment add-on class with configuration variables. The $_supports_callbacks variable enables callbacks/webhooks and creates the appropriate database table; $_requires_credit_card prevents feed creation until a credit card field is added.

```php
if ( method_exists( 'GFForms', 'include_payment_addon_framework' ) ) {
    GFForms::include_payment_addon_framework();
    class GFPayPal extends GFPaymentAddOn {
        protected $_version = "2.3.7";
        protected $_min_gravityforms_version = "1.8.12";
        protected $_slug = 'gravityformspaypal';
        protected $_path = 'gravityformspaypal/paypal.php';
        protected $_full_path = __FILE__;
        protected $_title = 'Gravity Forms PayPal Standard Add-On';
        protected $_short_title = 'PayPal';
        protected $_supports_callbacks = true;
        protected $_requires_credit_card = false;
    }
}
```

--------------------------------

### GET /entries

Source: https://docs.gravityforms.com/web-api

Documentation for the GET /entries endpoint of the Gravity Forms REST API v1, including parameters, request example, and response structure.

```APIDOC
## GET /entries

### Description
Returns the latest entries across all forms. Use the Paging parameter to limit the number of entries to avoid database timeouts.

### Method
GET

### Endpoint
/gravityformsapi/entries

### Parameters
#### Query Parameters
- **Paging** - Controls the number of entries retrieved per page and allows paging to be implemented.
- **Sorting** - Allows entries to be sorted by a specific field and to be sorted ascending/descending.
- **Search** - Allows entries to be filtered by search criteria and field filters.

### Request Example
GET /gravityformsapi/entries?api_key=your_api_key&signature=your_signature&expires=your_expires&paging[page_size]=5&paging[offset]=5

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code.
- **response** (object) - Contains the response data.
  - **entries** (array) - Array of entry objects.
  - **total_count** (integer) - Total number of entries including those outside the current page.

#### Response Example
{
  "status": 200,
  "response": {
    "entries": [
      {
        "id": "1",
        "date_created": "2023-01-01 12:00:00",
        "1": "Field value"
      }
    ],
    "total_count": 10
  }
}

### Error Handling
If the response status is greater than 202, an error object is returned with code, message, and data fields.
```
Tokens:
Raw