{"id":44213,"date":"2025-06-11T11:37:49","date_gmt":"2025-06-11T15:37:49","guid":{"rendered":"https:\/\/docs.gravityforms.com\/?p=44213"},"modified":"2025-06-11T11:37:51","modified_gmt":"2025-06-11T15:37:51","slug":"gform-submission","status":"publish","type":"post","link":"https:\/\/docs.gravityforms.com\/gform-submission\/","title":{"rendered":"gform.submission"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"h-introduction\">Introduction<\/h2>\n\n\n\n<p>The <code>gform.submission<\/code> object provides functions for managing form submissions with JavaScript. It includes methods for submitting a form, detecting the submission method, and preventing duplicate submissions.<\/p>\n\n\n\n<p>This can be useful when you need to submit a form programmatically, without relying on the standard submit button.<\/p>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><thead><tr><th>Name<\/th><th>Type<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td><code>SUBMISSION_METHOD_AJAX<\/code><\/td><td><code>string<\/code><\/td><td>Represents the &#8220;ajax&#8221; submission method.<\/td><\/tr><tr><td><code>SUBMISSION_METHOD_IFRAME<\/code><\/td><td><code>string<\/code><\/td><td>Represents the &#8220;iframe&#8221; submission method.<\/td><\/tr><tr><td><code>SUBMISSION_METHOD_POSTBACK<\/code><\/td><td><code>string<\/code><\/td><td>Represents the &#8220;postback&#8221; submission method.<\/td><\/tr><tr><td><code>SUBMISSION_TYPE_NEXT<\/code><\/td><td><code>string<\/code><\/td><td>Used when moving to the next page in a multi-page form.<\/td><\/tr><tr><td><code>SUBMISSION_TYPE_PREVIOUS<\/code><\/td><td><code>string<\/code><\/td><td>Used when moving to the previous page in a multi-page form.<\/td><\/tr><tr><td><code>SUBMISSION_TYPE_SAVE_AND_CONTINUE<\/code><\/td><td><code>string<\/code><\/td><td>Used when saving a form to continue later.<\/td><\/tr><tr><td><code>SUBMISSION_TYPE_SEND_LINK<\/code><\/td><td><code>string<\/code><\/td><td>Used when sending the save and continue link.<\/td><\/tr><tr><td><code>SUBMISSION_TYPE_SUBMIT<\/code><\/td><td><code>string<\/code><\/td><td>Used for the final form submission.<\/td><\/tr><tr><td><code>ajax<\/code><\/td><td><code>object<\/code><\/td><td>Contains internal AJAX submission utilities such as <code>submitFormAjax<\/code> and <code>displayConfirmation<\/code>.<\/td><\/tr><tr><td><code>getSubmissionMethod(form)<\/code><\/td><td><code>function<\/code><\/td><td>Returns the method used to submit the form (e.g., <code>ajax<\/code>, <code>iframe<\/code>).<\/td><\/tr><tr><td><code>handleButtonClick(event)<\/code><\/td><td><code>function<\/code><\/td><td>Handles the click event for form buttons.<\/td><\/tr><tr><td><code>lockSubmission(form)<\/code><\/td><td><code>function<\/code><\/td><td>Prevents duplicate submissions for a specific form.<\/td><\/tr><tr><td><code>removeSpinner(form)<\/code><\/td><td><code>function<\/code><\/td><td>Removes the loading spinner from the submit button.<\/td><\/tr><tr><td><code>submitForm(form, type, method)<\/code><\/td><td><code>function<\/code><\/td><td>Submits the form using the specified type and method.<\/td><\/tr><tr><td><code>unlockSubmission(form)<\/code><\/td><td><code>function<\/code><\/td><td>Unlocks the form, allowing it to be submitted again.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-examples\">Examples<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-submitting-a-form-programmatically\">Submitting a Form Programmatically<\/h3>\n\n\n\n<p>The example below shows how to create a helper function that submits a Gravity Form using the gform.submission API. The function accepts a form ID and handles validation and locking to avoid multiple submissions.<\/p>\n\n\n<div class=\"wp-block-syntaxhighlighter-code \"><pre class=\"brush: jscript; title: ; notranslate\" title=\"\">\nconst submitForm = async (formId) =&gt; {\n\tif (!window?.gform?.submission?.submitForm) {\n\t\treturn;\n\t}\n\n\tconst form = document.getElementById(`gform_${formId}`);\n\tif (!form) {\n\t\treturn;\n\t}\n\n\tconst submission = window.gform.submission;\n\tif (!submission.lockSubmission(form)) {\n\t\treturn;\n\t}\n\n\tawait submission.submitForm(form, submission.SUBMISSION_TYPE_SUBMIT, submission.getSubmissionMethod(form));\n}\n<\/pre><\/div>","protected":false},"excerpt":{"rendered":"<p>The gform.submission object provides functions for managing form submissions with JavaScript. It includes methods for submitting a form, detecting the submission method, and preventing duplicate submissions.<\/p>\n","protected":false},"author":52,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"_autodraft_ids":[],"jetpack_post_was_ever_published":false,"_sb_is_suggestion_mode":false,"_sb_show_suggestion_boards":false,"_sb_show_comment_boards":false,"_sb_suggestion_history":"","_sb_update_block_changes":"","_is_real_time_mode":false,"_realtime_collaborators":"","footnotes":"","cf_checklist_status":[]},"categories":[210],"tags":[],"class_list":["post-44213","post","type-post","status-publish","format-standard","hentry","category-javascript","wpautop"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v27.3 (Yoast SEO v27.4) - https:\/\/yoast.com\/product\/yoast-seo-premium-wordpress\/ -->\n<title>gform.submission - Gravity Forms Documentation<\/title>\n<meta name=\"description\" content=\"The gform.submission object provides functions for managing form submissions with JavaScript. It includes methods for submitting a form, detecting the submission method, and preventing duplicate submissions.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.gravityforms.com\/gform-submission\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"gform.submission\" \/>\n<meta property=\"og:description\" content=\"The gform.submission object provides functions for managing form submissions with JavaScript. It includes methods for submitting a form, detecting the submission method, and preventing duplicate submissions.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.gravityforms.com\/gform-submission\/\" \/>\n<meta property=\"og:site_name\" content=\"Gravity Forms Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2025-06-11T15:37:49+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-06-11T15:37:51+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2023\/08\/gf-docs-default-v3.png\" \/>\n\t<meta property=\"og:image:width\" content=\"544\" \/>\n\t<meta property=\"og:image:height\" content=\"288\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Dario\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@gravityforms\" \/>\n<meta name=\"twitter:site\" content=\"@gravityforms\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Dario\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/\"},\"author\":{\"name\":\"Dario\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/person\\\/acf2ff624683e2d7264ba969921fd50e\"},\"headline\":\"gform.submission\",\"datePublished\":\"2025-06-11T15:37:49+00:00\",\"dateModified\":\"2025-06-11T15:37:51+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/\"},\"wordCount\":207,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#organization\"},\"articleSection\":[\"JavaScript\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/\",\"name\":\"gform.submission - Gravity Forms Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#website\"},\"datePublished\":\"2025-06-11T15:37:49+00:00\",\"dateModified\":\"2025-06-11T15:37:51+00:00\",\"description\":\"The gform.submission object provides functions for managing form submissions with JavaScript. It includes methods for submitting a form, detecting the submission method, and preventing duplicate submissions.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-submission\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/docs.gravityforms.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"gform.submission\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#website\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/\",\"name\":\"Gravity Forms Documentation\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/docs.gravityforms.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#organization\",\"name\":\"Gravity Forms\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/wp-content\\\/uploads\\\/2020\\\/01\\\/gravity-forms-2020-logo-stacked.png\",\"contentUrl\":\"https:\\\/\\\/docs.gravityforms.com\\\/wp-content\\\/uploads\\\/2020\\\/01\\\/gravity-forms-2020-logo-stacked.png\",\"width\":392,\"height\":515,\"caption\":\"Gravity Forms\"},\"image\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/x.com\\\/gravityforms\",\"http:\\\/\\\/@gravityforms.com\"]},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/person\\\/acf2ff624683e2d7264ba969921fd50e\",\"name\":\"Dario\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/b04dae864801947724ed88af0a96d38fc6068202143a3524df343d2858de9023?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/b04dae864801947724ed88af0a96d38fc6068202143a3524df343d2858de9023?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/b04dae864801947724ed88af0a96d38fc6068202143a3524df343d2858de9023?s=96&d=mm&r=g\",\"caption\":\"Dario\"},\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/author\\\/darion\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"gform.submission - Gravity Forms Documentation","description":"The gform.submission object provides functions for managing form submissions with JavaScript. It includes methods for submitting a form, detecting the submission method, and preventing duplicate submissions.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.gravityforms.com\/gform-submission\/","og_locale":"en_US","og_type":"article","og_title":"gform.submission","og_description":"The gform.submission object provides functions for managing form submissions with JavaScript. It includes methods for submitting a form, detecting the submission method, and preventing duplicate submissions.","og_url":"https:\/\/docs.gravityforms.com\/gform-submission\/","og_site_name":"Gravity Forms Documentation","article_published_time":"2025-06-11T15:37:49+00:00","article_modified_time":"2025-06-11T15:37:51+00:00","og_image":[{"width":544,"height":288,"url":"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2023\/08\/gf-docs-default-v3.png","type":"image\/png"}],"author":"Dario","twitter_card":"summary_large_image","twitter_creator":"@gravityforms","twitter_site":"@gravityforms","twitter_misc":{"Written by":"Dario"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/docs.gravityforms.com\/gform-submission\/#article","isPartOf":{"@id":"https:\/\/docs.gravityforms.com\/gform-submission\/"},"author":{"name":"Dario","@id":"https:\/\/docs.gravityforms.com\/#\/schema\/person\/acf2ff624683e2d7264ba969921fd50e"},"headline":"gform.submission","datePublished":"2025-06-11T15:37:49+00:00","dateModified":"2025-06-11T15:37:51+00:00","mainEntityOfPage":{"@id":"https:\/\/docs.gravityforms.com\/gform-submission\/"},"wordCount":207,"commentCount":0,"publisher":{"@id":"https:\/\/docs.gravityforms.com\/#organization"},"articleSection":["JavaScript"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/docs.gravityforms.com\/gform-submission\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/docs.gravityforms.com\/gform-submission\/","url":"https:\/\/docs.gravityforms.com\/gform-submission\/","name":"gform.submission - Gravity Forms Documentation","isPartOf":{"@id":"https:\/\/docs.gravityforms.com\/#website"},"datePublished":"2025-06-11T15:37:49+00:00","dateModified":"2025-06-11T15:37:51+00:00","description":"The gform.submission object provides functions for managing form submissions with JavaScript. It includes methods for submitting a form, detecting the submission method, and preventing duplicate submissions.","breadcrumb":{"@id":"https:\/\/docs.gravityforms.com\/gform-submission\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.gravityforms.com\/gform-submission\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.gravityforms.com\/gform-submission\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.gravityforms.com\/"},{"@type":"ListItem","position":2,"name":"gform.submission"}]},{"@type":"WebSite","@id":"https:\/\/docs.gravityforms.com\/#website","url":"https:\/\/docs.gravityforms.com\/","name":"Gravity Forms Documentation","description":"","publisher":{"@id":"https:\/\/docs.gravityforms.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.gravityforms.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.gravityforms.com\/#organization","name":"Gravity Forms","url":"https:\/\/docs.gravityforms.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.gravityforms.com\/#\/schema\/logo\/image\/","url":"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2020\/01\/gravity-forms-2020-logo-stacked.png","contentUrl":"https:\/\/docs.gravityforms.com\/wp-content\/uploads\/2020\/01\/gravity-forms-2020-logo-stacked.png","width":392,"height":515,"caption":"Gravity Forms"},"image":{"@id":"https:\/\/docs.gravityforms.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/gravityforms","http:\/\/@gravityforms.com"]},{"@type":"Person","@id":"https:\/\/docs.gravityforms.com\/#\/schema\/person\/acf2ff624683e2d7264ba969921fd50e","name":"Dario","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/b04dae864801947724ed88af0a96d38fc6068202143a3524df343d2858de9023?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/b04dae864801947724ed88af0a96d38fc6068202143a3524df343d2858de9023?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/b04dae864801947724ed88af0a96d38fc6068202143a3524df343d2858de9023?s=96&d=mm&r=g","caption":"Dario"},"url":"https:\/\/docs.gravityforms.com\/author\/darion\/"}]}},"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/pdGaEa-bv7","_links":{"self":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/44213","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/users\/52"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/comments?post=44213"}],"version-history":[{"count":2,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/44213\/revisions"}],"predecessor-version":[{"id":44215,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/44213\/revisions\/44215"}],"wp:attachment":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/media?parent=44213"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/categories?post=44213"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/tags?post=44213"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}