gform/submission/submission_started

Description

The gform/submission/submission_started filter allows developers to execute custom synchronous logic immediately before a form submission is processed

Usage

gform.addFilter( 'gform/submission/submission_started', ( data ) => {
    // Custom logic here
    return data;
} );

Parameters

NameTypeDescription
dataObjectThe data object containing submission information.
data.formHTMLFormElementThe form element being submitted.
data.submissionTypestringThe type of submission being made.
data.submissionMethodstringHow the submission will be processed.

Examples

Log submission details.

gform.addFilter( 'gform/submission/submission_started', ( data ) => {
    console.log( 'Submission Type:', data.submissionType );
    console.log( 'Submission Method:', data.submissionMethod );
    
    
    return data;
} );

Placement

Reference the article Adding JavaScript Code to the Frontend of Your Site.

Source Code

This filter is located in submission.js

Since

The filter was added in Gravity Forms 2.9.26