{"id":44274,"date":"2025-06-11T10:45:59","date_gmt":"2025-06-11T14:45:59","guid":{"rendered":"https:\/\/docs.gravityforms.com\/?p=44274"},"modified":"2025-06-11T10:47:12","modified_gmt":"2025-06-11T14:47:12","slug":"gform-adminutils","status":"publish","type":"post","link":"https:\/\/docs.gravityforms.com\/gform-adminutils\/","title":{"rendered":"gform.adminUtils"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"h-introduction\">Introduction<\/h2>\n\n\n\n<p>The <code>gform.adminUtils<\/code> object provides utility functions commonly used in the WordPress admin. These utilities can help handle unsaved changes warnings and extract query parameters from the URL.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-methods\">Methods<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-handleunsavedchanges\">handleUnsavedChanges()<\/h3>\n\n\n\n<p>Attaches a warning message when users attempt to leave the page with unsaved changes. This helps prevent data loss in custom admin interfaces or settings panels.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"h-usage\">Usage<\/h4>\n\n\n<div class=\"wp-block-syntaxhighlighter-code \"><pre class=\"brush: jscript; title: ; notranslate\" title=\"\">\ngform.adminUtils.handleUnsavedChanges();\n<\/pre><\/div>\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><thead><tr><th>Parameter<\/th><th>Type<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td><em>None<\/em><\/td><td>\u2014<\/td><td>This function does not require any parameters.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"h-examples\">Examples<\/h4>\n\n\n<div class=\"wp-block-syntaxhighlighter-code \"><pre class=\"brush: jscript; title: ; notranslate\" title=\"\">\ndocument.addEventListener(&#039;DOMContentLoaded&#039;, function () {\n    gform.adminUtils.handleUnsavedChanges();\n});\n<\/pre><\/div>\n\n\n<h3 class=\"wp-block-heading\" id=\"h-geturlparameter-name\">getUrlParameter(name)<\/h3>\n\n\n\n<p>Retrieves the value of a specific query parameter from the current URL. Useful for conditionally loading scripts or behavior based on page context.<\/p>\n\n\n<div class=\"wp-block-syntaxhighlighter-code \"><pre class=\"brush: jscript; title: ; notranslate\" title=\"\">\nconst formId = gform.adminUtils.getUrlParameter(&#039;id&#039;);\n<\/pre><\/div>\n\n\n<h4 class=\"wp-block-heading\" id=\"h-parameters\">Parameters<\/h4>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><thead><tr><th>Parameter<\/th><th>Type<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td><code><strong>name<\/strong><\/code><\/td><td>string<\/td><td>The name of the query parameter to retrieve.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"h-returns\">Returns<\/h4>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><thead><tr><th>Type<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td><strong><code>string|null<\/code><\/strong><\/td><td>The value of the parameter if found, or <code>null<\/code> if not present.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"h-examples-0\">Examples<\/h4>\n\n\n<div class=\"wp-block-syntaxhighlighter-code \"><pre class=\"brush: jscript; title: ; notranslate\" title=\"\">\nconst page = gform.adminUtils.getUrlParameter(&#039;page&#039;);\nif (page === &#039;gf_edit_forms&#039;) {\n    console.log(&#039;We are on the form editor page.&#039;);\n}\n<\/pre><\/div>\n\n\n<h2 class=\"wp-block-heading\" id=\"h-source-code\">Source Code<\/h2>\n\n\n\n<p>The\u00a0<code>gform.adminUtils<\/code>\u00a0object is defined in js\/gforms_hooks.js<\/p>\n","protected":false},"excerpt":{"rendered":"<p>The gform.adminUtils object provides utility functions commonly used in the WordPress admin. These utilities can help handle unsaved changes warnings and extract query parameters from the URL.<\/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-44274","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.adminUtils - Gravity Forms Documentation<\/title>\n<meta name=\"description\" content=\"The gform.adminUtils object provides utility functions commonly used in the WordPress admin. These utilities can help handle unsaved changes warnings and extract query parameters from the URL.\" \/>\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-adminutils\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"gform.adminUtils\" \/>\n<meta property=\"og:description\" content=\"The gform.adminUtils object provides utility functions commonly used in the WordPress admin. These utilities can help handle unsaved changes warnings and extract query parameters from the URL.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.gravityforms.com\/gform-adminutils\/\" \/>\n<meta property=\"og:site_name\" content=\"Gravity Forms Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2025-06-11T14:45:59+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-06-11T14:47:12+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\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-adminutils\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-adminutils\\\/\"},\"author\":{\"name\":\"Dario\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/person\\\/acf2ff624683e2d7264ba969921fd50e\"},\"headline\":\"gform.adminUtils\",\"datePublished\":\"2025-06-11T14:45:59+00:00\",\"dateModified\":\"2025-06-11T14:47:12+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-adminutils\\\/\"},\"wordCount\":134,\"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-adminutils\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-adminutils\\\/\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-adminutils\\\/\",\"name\":\"gform.adminUtils - Gravity Forms Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#website\"},\"datePublished\":\"2025-06-11T14:45:59+00:00\",\"dateModified\":\"2025-06-11T14:47:12+00:00\",\"description\":\"The gform.adminUtils object provides utility functions commonly used in the WordPress admin. These utilities can help handle unsaved changes warnings and extract query parameters from the URL.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-adminutils\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/docs.gravityforms.com\\\/gform-adminutils\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/gform-adminutils\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/docs.gravityforms.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"gform.adminUtils\"}]},{\"@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.adminUtils - Gravity Forms Documentation","description":"The gform.adminUtils object provides utility functions commonly used in the WordPress admin. These utilities can help handle unsaved changes warnings and extract query parameters from the URL.","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-adminutils\/","og_locale":"en_US","og_type":"article","og_title":"gform.adminUtils","og_description":"The gform.adminUtils object provides utility functions commonly used in the WordPress admin. These utilities can help handle unsaved changes warnings and extract query parameters from the URL.","og_url":"https:\/\/docs.gravityforms.com\/gform-adminutils\/","og_site_name":"Gravity Forms Documentation","article_published_time":"2025-06-11T14:45:59+00:00","article_modified_time":"2025-06-11T14:47:12+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","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/docs.gravityforms.com\/gform-adminutils\/#article","isPartOf":{"@id":"https:\/\/docs.gravityforms.com\/gform-adminutils\/"},"author":{"name":"Dario","@id":"https:\/\/docs.gravityforms.com\/#\/schema\/person\/acf2ff624683e2d7264ba969921fd50e"},"headline":"gform.adminUtils","datePublished":"2025-06-11T14:45:59+00:00","dateModified":"2025-06-11T14:47:12+00:00","mainEntityOfPage":{"@id":"https:\/\/docs.gravityforms.com\/gform-adminutils\/"},"wordCount":134,"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-adminutils\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/docs.gravityforms.com\/gform-adminutils\/","url":"https:\/\/docs.gravityforms.com\/gform-adminutils\/","name":"gform.adminUtils - Gravity Forms Documentation","isPartOf":{"@id":"https:\/\/docs.gravityforms.com\/#website"},"datePublished":"2025-06-11T14:45:59+00:00","dateModified":"2025-06-11T14:47:12+00:00","description":"The gform.adminUtils object provides utility functions commonly used in the WordPress admin. These utilities can help handle unsaved changes warnings and extract query parameters from the URL.","breadcrumb":{"@id":"https:\/\/docs.gravityforms.com\/gform-adminutils\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.gravityforms.com\/gform-adminutils\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.gravityforms.com\/gform-adminutils\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.gravityforms.com\/"},{"@type":"ListItem","position":2,"name":"gform.adminUtils"}]},{"@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-bw6","_links":{"self":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/44274","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=44274"}],"version-history":[{"count":7,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/44274\/revisions"}],"predecessor-version":[{"id":44329,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/44274\/revisions\/44329"}],"wp:attachment":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/media?parent=44274"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/categories?post=44274"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/tags?post=44274"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}