{"id":42921,"date":"2025-03-18T13:19:03","date_gmt":"2025-03-18T17:19:03","guid":{"rendered":"https:\/\/docs.gravityforms.com\/?p=42921"},"modified":"2025-03-18T13:37:53","modified_gmt":"2025-03-18T17:37:53","slug":"settings-api-basics","status":"publish","type":"post","link":"https:\/\/docs.gravityforms.com\/settings-api-basics\/","title":{"rendered":"Basics Of The Settings API"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"h-introduction\">Introduction<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">The <a target=\"_blank\" rel=\"noreferrer noopener\" href=\"\/category\/developers\/php-api\/add-on-framework\">Add-On Framework<\/a> includes a Settings API that can be used to create form and plugin settings pages. The API provides the mechanisms for rendering field UIs and saving values automatically. It supports standard field types like radio buttons, text boxes and checkboxes and also custom field types.<\/p>\n\n\n\n<p class=\"has-background wp-block-paragraph\" style=\"background-color:#f5955221\"><strong>Note:<\/strong> In order to use the Settings API, your class must extend one of the <a href=\"\/category\/developers\/php-api\/add-on-framework\/classes\/\" target=\"_blank\" rel=\"noreferrer noopener\">GFAddon<\/a> Classes.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-field-type-examples\">Field Type Examples<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">See <a target=\"_blank\" rel=\"noreferrer noopener\" href=\"https:\/\/docs.gravityforms.com\/field-types\/\">this list of standard Field Types<\/a> for detail and implementation examples of the various field types offered through this API.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>The Settings API provides the mechanisms for rendering field UIs and saving values automatically.<\/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":[],"_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":"","jetpack_post_was_ever_published":false,"cf_checklist_status":[]},"categories":[317],"tags":[19457],"class_list":["post-42921","post","type-post","status-publish","format-standard","hentry","category-settings-api","tag-settings-api-resources","wpautop"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v28.8 (Yoast SEO v28.8) - https:\/\/yoast.com\/product\/yoast-seo-premium-wordpress\/ -->\n<title>Basics Of The Settings API - Gravity Forms Documentation<\/title>\n<meta name=\"description\" content=\"The Settings API provides the mechanisms for rendering field UIs and saving values automatically.\" \/>\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\/settings-api-basics\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Basics Of The Settings API\" \/>\n<meta property=\"og:description\" content=\"The Settings API provides the mechanisms for rendering field UIs and saving values automatically.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.gravityforms.com\/settings-api-basics\/\" \/>\n<meta property=\"og:site_name\" content=\"Gravity Forms Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2025-03-18T17:19:03+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-18T17:37:53+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\\\/settings-api-basics\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/settings-api-basics\\\/\"},\"author\":{\"name\":\"Dario\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#\\\/schema\\\/person\\\/acf2ff624683e2d7264ba969921fd50e\"},\"headline\":\"Basics Of The Settings API\",\"datePublished\":\"2025-03-18T17:19:03+00:00\",\"dateModified\":\"2025-03-18T17:37:53+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/settings-api-basics\\\/\"},\"wordCount\":95,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#organization\"},\"keywords\":[\"settings-api-resources\"],\"articleSection\":[\"Settings API\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/docs.gravityforms.com\\\/settings-api-basics\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/settings-api-basics\\\/\",\"url\":\"https:\\\/\\\/docs.gravityforms.com\\\/settings-api-basics\\\/\",\"name\":\"Basics Of The Settings API - Gravity Forms Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/#website\"},\"datePublished\":\"2025-03-18T17:19:03+00:00\",\"dateModified\":\"2025-03-18T17:37:53+00:00\",\"description\":\"The Settings API provides the mechanisms for rendering field UIs and saving values automatically.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/settings-api-basics\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/docs.gravityforms.com\\\/settings-api-basics\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/docs.gravityforms.com\\\/settings-api-basics\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/docs.gravityforms.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Basics Of The Settings API\"}]},{\"@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":"Basics Of The Settings API - Gravity Forms Documentation","description":"The Settings API provides the mechanisms for rendering field UIs and saving values automatically.","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\/settings-api-basics\/","og_locale":"en_US","og_type":"article","og_title":"Basics Of The Settings API","og_description":"The Settings API provides the mechanisms for rendering field UIs and saving values automatically.","og_url":"https:\/\/docs.gravityforms.com\/settings-api-basics\/","og_site_name":"Gravity Forms Documentation","article_published_time":"2025-03-18T17:19:03+00:00","article_modified_time":"2025-03-18T17:37:53+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\/settings-api-basics\/#article","isPartOf":{"@id":"https:\/\/docs.gravityforms.com\/settings-api-basics\/"},"author":{"name":"Dario","@id":"https:\/\/docs.gravityforms.com\/#\/schema\/person\/acf2ff624683e2d7264ba969921fd50e"},"headline":"Basics Of The Settings API","datePublished":"2025-03-18T17:19:03+00:00","dateModified":"2025-03-18T17:37:53+00:00","mainEntityOfPage":{"@id":"https:\/\/docs.gravityforms.com\/settings-api-basics\/"},"wordCount":95,"commentCount":0,"publisher":{"@id":"https:\/\/docs.gravityforms.com\/#organization"},"keywords":["settings-api-resources"],"articleSection":["Settings API"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/docs.gravityforms.com\/settings-api-basics\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/docs.gravityforms.com\/settings-api-basics\/","url":"https:\/\/docs.gravityforms.com\/settings-api-basics\/","name":"Basics Of The Settings API - Gravity Forms Documentation","isPartOf":{"@id":"https:\/\/docs.gravityforms.com\/#website"},"datePublished":"2025-03-18T17:19:03+00:00","dateModified":"2025-03-18T17:37:53+00:00","description":"The Settings API provides the mechanisms for rendering field UIs and saving values automatically.","breadcrumb":{"@id":"https:\/\/docs.gravityforms.com\/settings-api-basics\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.gravityforms.com\/settings-api-basics\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.gravityforms.com\/settings-api-basics\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.gravityforms.com\/"},{"@type":"ListItem","position":2,"name":"Basics Of The Settings API"}]},{"@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_shortlink":"https:\/\/wp.me\/pdGaEa-bah","jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/42921","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=42921"}],"version-history":[{"count":3,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/42921\/revisions"}],"predecessor-version":[{"id":42924,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/posts\/42921\/revisions\/42924"}],"wp:attachment":[{"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/media?parent=42921"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/categories?post=42921"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.gravityforms.com\/wp-json\/wp\/v2\/tags?post=42921"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}