Gravity Flow

https://docs.gravityflow.io/
Admin
Gravity Flow is a WordPress workflow automation plugin that routes Gravity Forms submissions through...
Tokens:266,888
Snippets:2,196
Trust Score:10
Update:4 hours ago
Show doc for...
Tokens:
Raw
### Start step JSON example

Source: https://docs.gravityflow.io/workflow-step-object/

Example of a workflow start step object in JSON format for the Gravity Flow REST API V2. Shows the structure with id, type, settings, and status fields.

```json
{
    "id": 1179,
    "type": "workflow_start",
    "label": "Start",
    "name": "Start",
    "is_active": true,
    "entry_count": 0,
    "supports_expiration": false,
    "assignees": [],
    "settings": {
        "step_name": "Start",
        "description": "",
        "step_type": "workflow_start",
        "feed_condition_conditional_logic": "0",
        "feed_condition_conditional_logic_object": [],
        "scheduled": "0",
        "schedule_type": "delay",
        "schedule_date": "",
        "schedule_delay_offset": "",
        "schedule_delay_unit": "hours",
        "schedule_date_field_before_after": "after",
        "schedule_date_field_offset": "0",
        "schedule_date_field_offset_unit": "hours",
        "instructionsEnable": "0",
        "instructionsValue": "",
        "display_fields_mode": "all_fields",
        "destination_complete": "next",
        "_entry_count": 0
    },
    "is_current_step": false,
    "status": "complete",
    "expiration_timestamp": false,
    "is_expired": false,
    "is_queued": false
}
```

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

### start

Source: https://docs.gravityflow.io/step-class/

Attempts to start this step for the current entry. If the step is scheduled then the entry will be queued.

```APIDOC
## start

### Description
Attempts to start this step for the current entry. If the step is scheduled then the entry will be queued.

### Method
Function

### Parameters
None

### Returns
Boolean
```

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

### Full example with enqueue and localize

Source: https://docs.gravityflow.io/gravityflow_enqueue_frontend_scripts/

Complete example that enqueues custom JavaScript and CSS, and localizes script data with AJAX URL and nonce.

```php
add_action( 'gravityflow_enqueue_frontend_scripts', 'gfw_custom_frontend_scripts' );

function gfw_custom_frontend_scripts() {
    // Example: Enqueue custom JavaScript for Gravity Flow frontend
    wp_enqueue_script( 
        'my-gravityflow-custom', 
        get_template_directory_uri() . '/js/gravityflow-custom.js', 
        array( 'jquery' ), 
        '1.0.0' 
    );
    
    // Example: Enqueue custom CSS for Gravity Flow frontend styling
    wp_enqueue_style( 
        'my-gravityflow-custom', 
        get_template_directory_uri() . '/css/gravityflow-custom.css', 
        array(), 
        '1.0.0' 
    );
    
    // Example: Localize script with custom data
    wp_localize_script( 'my-gravityflow-custom', 'myGravityFlowVars', array(
        'ajaxurl' => admin_url( 'admin-ajax.php' ),
        'nonce'   => wp_create_nonce( 'my_custom_nonce' )
    ) );
}
```

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

### entry_detail_status_box example (approval step)

Source: https://docs.gravityflow.io/step-class/

Example override of entry_detail_status_box that displays the step name, status, and assignee statuses. Uses evaluate_status(), get_name(), and get_assignees().

```php
public function entry_detail_status_box( $form ) {
		$status = $this->evaluate_status();
		?>

		<h4 style="padding:10px;"><?php echo $this->get_name() . ': ' . $status; ?></h4>

		<div style="padding:10px;">
			<ul>
				<?php
				$assignees = $this->get_assignees();
				foreach ( $assignees as $assignee ) {
					$assignee_status_label = $assignee->get_status_label();
					$assignee_status_li    = sprintf( '<li>%s</li>', $assignee_status_label );

					echo $assignee_status_li;
				}

				?>
			</ul>
		</div>
		<?php

	}
```

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

### API Response for Get Workflow Steps

Source: https://docs.gravityflow.io/get-steps-by-entry-with-rest-api-v2/

Example JSON array of workflow step objects returned on success. Contains step properties such as id, type, label, name, is_active, entry_count, supports_expiration, assignees, and settings.

```json
[
  {
    "id": 121,
    "type": "workflow_start",
    "label": "Start",
    "name": "Start",
    "is_active": true,
    "entry_count": 0,
    "supports_expiration": false,
    "assignees": [],
    "settings": {
      "step_name": "Start",
      "description": "",
      "step_type": "workflow_start",
      "feed_condition_conditional_logic": "0",
      "feed_condition_conditional_logic_object": [],
      "scheduled": "0",
      "schedule_type": "delay",
      "schedule_date": "",
      "schedule_delay_offset": "",
      "schedule_delay_unit": "hours",
      "schedule_date_field_before_after": "after",
      "schedule_date_field_offset": "0",
```

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

### end method example (approval step)

Source: https://docs.gravityflow.io/step-class/

Example override of end that triggers status-based notifications and calls parent::end(). It sends approval/rejection notifications and performs post actions based on status.

```php
public function end() {
		$status = $this->evaluate_status();
		$entry  = $this->get_entry();
		if ( $status == 'approved' ) {
			$this->send_approval_notification();
			$this->maybe_perform_post_action( $entry, $this->publish_post_on_approval ? 'publish' : '' );
		} elseif ( $status == 'rejected' ) {
			$this->send_rejection_notification();
			$this->maybe_perform_post_action( $entry, $this->post_action_on_rejection );
		}
		if ( $status == 'approved' || $status == 'rejected' ) {
			GFAPI::send_notifications( $this->get_form(), $entry, 'workflow_approval' );
		}
		parent::end();
}
```

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

### get_actions() override example for approval step

Source: https://docs.gravityflow.io/step-class/

Example override of get_actions that returns Approve and Reject actions with icons and note field visibility based on note mode.

```php
public function get_actions() {
		return array(
			array(
				'key'             => 'approve',
				'label'           => __( 'Approve', 'gravityflow' ),
				'icon'            => $this->get_approve_icon(),
				'show_note_field' => in_array( $this->note_mode, array(
						'required_if_approved',
						'required_if_reverted_or_rejected',
						'required',
					)
				),
			),
			array(
				'key'             => 'reject',
				'label'           => __( 'Reject', 'gravityflow' ),
				'icon'            => $this->get_reject_icon(),
				'show_note_field' => in_array( $this->note_mode, array(
						'required_if_rejected',
						'required_if_reverted_or_rejected',
						'required',
					)
				),

			),
		);
	}
```

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

### Combined example of gravityflow reports shortcode attributes

Source: https://docs.gravityflow.io/shortcodes/

Example combining form, category, range, and step_id attributes in a single shortcode.

```shortcode
[gravityflow page="reports" form="7" category="step" range="last-12-months" step_id="14"]
```

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

### Example usage of process_assignee_status

Source: https://docs.gravityflow.io/step-class/

Example snippet showing how to call process_assignee_status when the assignee is the current user, used in the User Input step type.

```php
if ( $assignee->is_current_user() ) {
	$feedback = $this->process_assignee_status( $assignee, $new_status, $form );
	 break;
}
```

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

### get_settings() override example for feed add-on step

Source: https://docs.gravityflow.io/step-class/

Example override of get_settings that returns settings based on the feed type, including a title and fields from the feeds setting.

```php
public function get_settings() {
		if ( ! $this->is_supported() ) {
			return array();
		}

		return array(
			'title'  => $this->get_label(),
			'fields' => array( $this->get_feeds_setting() ),
		);
	}
```

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

### Filter to change capability for get forms steps

Source: https://docs.gravityflow.io/gravityflow_rest_api_capability_get_forms_steps/

This example changes the capability checked for the REST API endpoints that get workflow steps. It sets the capability to 'gravityflow_settings' instead of the default 'gravityflow_create_steps'. Place this code in functions.php, a custom functions plugin, a custom add-on, or a code snippets plugin.

```php
add_filter( 'gravityflow_rest_api_capability_get_forms_steps', 'flow_capability_form_steps_type', 10, 2 );
function flow_capability_form_steps_type( $capability, $request ) {
	$capability = 'gravityflow_settings';     
	return $capability;
}
```

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

### get_status_config example (outgoing webhook step)

Source: https://docs.gravityflow.io/step-class/

Example override of get_status_config that defines how HTTP response codes (200/400/500) map to step statuses. Returns an array of status configurations with labels and default destinations.

```php
public function get_status_config() {
		return array(
			array(
				'status'                    => 'complete',
				'status_label'              => __( 'Success', 'gravityflow' ),
				'destination_setting_label' => esc_html__( 'Next Step if Success', 'gravityflow' ),
				'default_destination'       => 'next',
			),
			array(
				'status'                    => 'error_client',
				'status_label'              => __( 'Error - Client', 'gravityflow' ),
				'destination_setting_label' => esc_html__( 'Next Step if Client Error', 'gravityflow' ),
				'default_destination'       => 'complete',
			),
			array(
				'status'                    => 'error_server',
				'status_label'              => __( 'Error - Server', 'gravityflow' ),
				'destination_setting_label' => esc_html__( 'Next Step if Server Error', 'gravityflow' ),
				'default_destination'       => 'complete',
			),
			array(
				'status'                    => 'error',
				'status_label'              => __( 'Error - Other', 'gravityflow' ),
				'destination_setting_label' => esc_html__( 'Next step if Other Error', 'gravityflow' ),
				'default_destination'       => 'complete',
			),
		);
	}
```

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

### Customize list field output in status table

Source: https://docs.gravityflow.io/gravityflow_field_value_status_table/

This example provides three starting points for customizing list field output in the status table. It shows how to display the HTML table version, a comma-separated list, or a custom unordered list built from the unserialized array.

```php
add_filter( 'gravityflow_field_value_status_table', 'sh_reformat_value_lists', 10, 4 );

function sh_reformat_value_lists( $value, $form_id, $column_name, $entry ) {
    if ( $form_id == '76' && $column_name == '2' ) {
        //This would give you the html table version
        $value = html_entity_decode( $value );
        $form = GFAPI::get_form( $form_id );
        $field = GFFormsModel::get_field( $form, $column_name );
        if ( $field ) {
            //This will give you a , separated list of the values
            $value = $field->get_value_entry_detail( $entry['2'], '', false, $format = 'text', 'screen' );
        }
        //Or you can use custom code with this starting point to build your own based on the array.
        $list = maybe_unserialize( $entry['2'] );
        if ( ! empty( $list ) ) {
            $value = '<ul>';
            foreach ( $list as $row ) {
                $value .= '<li>';
                if ( is_array( $row ) ) {
                    foreach ( $row as $column ) {
                        $value .= '- ' . $column . '<br/>';
                    }
                } else {
                    $value .= $row;
                }
                $value .= '</li>';
            }
            $value .= '</ul>';
        }
    }
    return $value;
}
```

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

### Replace entry ID with form field value using gravityflow_field_value_status_table

Source: https://docs.gravityflow.io/gravityflow_field_value_status_table/

Use this filter to replace the entry ID column value with a value from a form field. The example checks for form ID 2 and column 'id', then uses rgar() to get field 191 from the entry.

```php
add_filter( 'gravityflow_field_value_status_table', 'sh_gravityflow_field_value_status_table', 10, 4 );

function sh_gravityflow_field_value_status_table( $label, $form_id, $column_name, $entry ) {
    if ( $form_id == 2 && $column_name == 'id' ) {
        $label = rgar( $entry, '191' );
    }
    return $label;
}
```

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

### PHP Request to Get Specific Step

Source: https://docs.gravityflow.io/get-specific-step-with-rest-api-v2/

Example PHP code using wp_remote_get to call the Gravity Flow REST API v2 endpoint. Requires updating the entry ID, step ID, domain, and authentication value. The response is checked for errors and the expected 200 status code.

```php
//Update these variables
$entry_id = '1273';
$step_id  = '127';
$domain   = 'https://develop.local';
$auth_value = 'Basic replace-me-with-basic-auth-based-on-user-application-password';

// {@see https://codex.wordpress.org/HTTP_API}
$response = wp_remote_get( $domain . '/wp-json/gravityflow/v2/entries/' . $entry_id . '/workflow/steps/' . $step_id, array(
    'headers' => array(
        'Authorization' => $auth_value,
    ),
) );

if ( ! is_wp_error( $response ) ) {
    // The request went through successfully, check the response code against
    // what we're expecting
    if ( 200 == wp_remote_retrieve_response_code( $response ) ) {
        // Do something with the response
        // $body = wp_remote_retrieve_body( $response );
        // $headers = wp_remote_retrieve_headers( $response );
    } else {
        // The response code was not what we were expecting, record the message
        $error_message = wp_remote_retrieve_response_message( $response );
    }
} else {
    // There was an error making the request
    $error_message = $response->get_error_message();
}
```

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

### Disable automatic major version updates with gravityflow_major_version_auto_updates_allowed

Source: https://docs.gravityflow.io/gravityflow_major_version_auto_updates_allowed/

Use this filter to prevent automatic installation of major Gravity Flow releases when automatic updates are enabled. The example returns false to disallow major version updates. Place this code in the active theme's functions.php, a custom functions plugin, a custom add-on, or a code snippets plugin.

```php
add_filter( 'gravityflow_major_version_auto_updates_allowed', '__return_false' );
```

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

### Hook registration example

Source: https://docs.gravityflow.io/gravityflow_enqueue_frontend_scripts/

Shows how to register a callback for the gravityflow_enqueue_frontend_scripts action using add_action.

```php
add_action( 'gravityflow_enqueue_frontend_scripts', 'my_custom_frontend_scripts', 10 );
```

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

### PHP Request to Restart Step via REST API v2

Source: https://docs.gravityflow.io/restart-step-rest-api-v2/

Use this PHP snippet to restart a workflow step by sending a GET request to the Gravity Flow REST API v2 endpoint. It requires updating the $entry_id, $step_id, $domain, and $auth_value variables. The example checks for a 200 response code and handles errors using is_wp_error and wp_remote_retrieve_response_message.

```php
//Update these variables
$entry_id = '1273';
$step_id  = '127';
$domain   = 'https://develop.local';
$auth_value = 'Basic replace-me-with-basic-auth-based-on-user-application-password';

// {@see https://codex.wordpress.org/HTTP_API}
$response = wp_remote_get( $domain . '/wp-json/gravityflow/v2/entries/' . $entry_id . '/workflow/steps/' . $step_id . '/restart', array(
    'headers' => array(
        'Authorization' => $auth_value,
    ),
) );

if ( ! is_wp_error( $response ) ) {
    // The request went through successfully, check the response code against
    // what we're expecting
    if ( 200 == wp_remote_retrieve_response_code( $response ) ) {
        // Do something with the response
        // $body = wp_remote_retrieve_body( $response );
        // $headers = wp_remote_retrieve_headers( $response );
    } else {
        // The response code was not what we were expecting, record the message
        $error_message = wp_remote_retrieve_response_message( $response );
    }
} else {
    // There was an error making the request
    $error_message = $response->get_error_message();
}
```

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

### GET /wp-json/gf/v2/entries/{entry_id}/workflows/status

Source: https://docs.gravityflow.io/category/developers/

Gets the workflow status, and current step details if available, for an existing entry. This endpoint is accessed via a GET request to the provided URL.

```APIDOC
## GET /wp-json/gf/v2/entries/{entry_id}/workflows/status

### Description
Gets the workflow status, and current step details if available, for an existing entry.

### Method
GET

### Endpoint
/wp-json/gf/v2/entries/{entry_id}/workflows/status

### Parameters
#### Path Parameters
- **entry_id** (integer) - Required - The ID of the entry.

### Response
#### Success Response (200)
- **status** (string) - The workflow status.
- **current_step** (object) - The current step details, if available.

#### Response Example
{
  "status": "pending",
  "current_step": {}
}
```

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

### Access step setting value in process()

Source: https://docs.gravityflow.io/the-workflow-step-framework/

Shows how to read a setting value using $this->setting_name. The example dumps the value of 'custom_setting' to the output. The process() method must return a boolean indicating step completion.

```php
/**
* Process the step.
 *
* @return bool Is the step complete?
*/
public function process(){
	// Do something here.
	var_dump( 'Setting: ' . $this->custom_setting );
}
```

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

### is_supported

Source: https://docs.gravityflow.io/step-class/

Is this step supported on this server? Override to hide this step in the list of step types if the requirements are not met.

```APIDOC
## is_supported

### Description
Is this step supported on this server? Override to hide this step in the list of step types if the requirements are not met.

### Return Type
Boolean

### Parameters
None

```

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

### maybe_filter_validation_result() override example for approval step

Source: https://docs.gravityflow.io/step-class/

Example override of maybe_filter_validation_result that applies the 'gravityflow_validation_approval' filter to the validation result.

```php
public function maybe_filter_validation_result( $validation_result, $new_status ) {
		return apply_filters( 'gravityflow_validation_approval', $validation_result, $this );
	}
```

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

### get_settings

Source: https://docs.gravityflow.io/step-class/

Override this method to add settings to the step. Use the Gravity Forms Add-On Framework Settings API.

```APIDOC
## get_settings

### Description
Override this method to add settings to the step. Use the [Gravity Forms Add-On Framework Settings API](https://docs.gravityforms.com/category/developers/php-api/add-on-framework/settings-api/).

### Method
PHP Method

### Endpoint
`public function get_settings()`

### Parameters
None

### Returns
[Array](https://docs.gravityforms.com/array)

### Example
This example shows how the [Gravity_Flow_Step_Feed_Add_On step type](https://docs.gravityflow.io/step_feed_class/) provides settings based on the feed type it is associated with.

```php
public function get_settings() {
    if ( ! $this->is_supported() ) {
        return array();
    }

    return array(
        'title'  => $this->get_label(),
        'fields' => array( $this->get_feeds_setting() ),
    );
}
```
```

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

### get_icon_url() override example for notification step

Source: https://docs.gravityflow.io/step-class/

Example override of get_icon_url that returns HTML markup for a font-awesome envelope icon.

```php
public function get_icon_url() {
		return '<i class="fa fa-envelope-o"></i>';
	}
```

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

### Get all the steps for a form

Source: https://docs.gravityflow.io/the-workflow-orchestration-api/

Instantiates the API and retrieves all steps for the form as an array of Gravity_Flow_Step objects.

```php
$api = new Gravity_Flow_API( $form_id );

/* @var Gravity_Flow_Step[] $steps */
$steps = $api->get_steps();
```

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

### status_evaluation override example from Gravity_Flow_Step_Feed_Add_On

Source: https://docs.gravityflow.io/step-class/

Example override that returns 'pending' until all feeds for the step have been added to the entry meta processed_feeds array.

```php
public function status_evaluation() {
	$add_on_feeds = $this->get_processed_add_on_feeds();
	$feeds        = $this->get_feeds();

	$form  = $this->get_form();
	$entry = $this->get_entry();

	foreach ( $feeds as $feed ) {
		$setting_key = 'feed_' . $feed['id'];
		if ( $this->{$setting_key} && ! in_array( $feed['id'], $add_on_feeds ) && $this->is_feed_condition_met( $feed, $form, $entry ) ) {
			return 'pending';
		}
	}

	return 'complete';
}
```

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

### Example Response: {"result":"created"}

Source: https://docs.gravityflow.io/incoming-webhook-create-entry-rest-api-v2/

The expected response from the Incoming Webhook REST API v2 when the entry is successfully created.

```json
{"result":"created"}
```

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

### get_label() override example for outgoing webhook step

Source: https://docs.gravityflow.io/step-class/

Example override of get_label that returns an escaped, translatable label 'Outgoing Webhook'.

```php
public function get_label() {
		return esc_html__( 'Outgoing Webhook', 'gravityflow' );
	}
```

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

### GET /wp-json/gf/v2/entries/{entry_id}/workflow/steps

Source: https://docs.gravityflow.io/gravity-flow-3-0-key-features/

Retrieves all steps for the specified entry incl. current step status.

```APIDOC
## GET /wp-json/gf/v2/entries/{entry_id}/workflow/steps

### Description
Retrieves all steps for the specified entry incl. current step status.

### Method
GET

### Endpoint
/wp-json/gf/v2/entries/{entry_id}/workflow/steps

### Parameters
#### Path Parameters
- **entry_id** (integer) - Required - The ID of the entry.

### Response
#### Success Response (200)
- **steps** (array) - List of workflow steps for the entry.

#### Response Example
{
  "steps": []
}
```
Tokens:
Raw