{"id":378762,"date":"2023-04-28T13:37:37","date_gmt":"2023-04-28T13:37:37","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=378762"},"modified":"2023-04-28T14:10:09","modified_gmt":"2023-04-28T14:10:09","slug":"how-to-add-custom-validation-in-store-configuration-field","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/","title":{"rendered":"How to add custom validation in store configuration field"},"content":{"rendered":"\n

In this article, We will learn about how to add custom validation in store configuration field.<\/p>\n\n\n\n

First off, We will create a module.<\/p>\n\n\n\n

Step-1: Create requirejs-config.js in  app\/code\/Vendor\/Validation\/view\/adminhtml<\/h2>\n\n\n\n
var config = {\n    config: {\n        mixins: {\n            'mage\/validation': {\n                'Vendor_Validation\/js\/admin-config\/validator-rules-mixin': true\n            }\n        }\n    }\n};<\/pre>\n\n\n\n
Step-2: Create validator-rules-mixin.js in  app\/code\/Vendor\/Validation\/view\/adminhtml\/web\/js\/admin-config<\/h2>\n\n\n\n
define([\n    'jquery'\n   ], function ($) {\n       'use strict';\n       return function (target) {\n           $.validator.addMethod(\n               'validate-server-protocol',\n               function (value) {\n                  if(value.includes('http') || value.includes('https')) {\n                   return false;\n                  } else {\n                   return true;\n                  }\n               },\n               $.mage.__('Please enter server name without protocol')\n           );\n           return target;\n       };\n   });<\/pre>\n\n\n\n
Step-3: Create system.xml in app\/code\/Vendor\/Validation\/etc\/adminhtml and then add custom rule.<\/h2>\n\n\n\n
<?xml version="1.0"?>\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc\/system_file.xsd">\n    <system>\n        <group id="server_config" translate="label" type="text" sortOrder="2" showInDefault="1" showInWebsite="1" showInStore="1">\n        <field id="host_name" translate="label comment" type="text" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="0" >\n            <label>Host<\/label>\n            <comment>Ex: example.com<\/comment>\n            <validate>required-entry validate-server-protocol<\/validate>\n        <\/field>\n        <\/group>\n    <\/system>\n<\/config><\/pre>\n\n\n\n
\"storeConfig\"<\/figure>\n\n\n\n
Hope this will help you.<\/p>\n\n\n\n
Thanks \ud83d\ude42<\/p>\n","protected":false},"excerpt":{"rendered":"
In this article, We will learn about how to add custom validation in store configuration field. First off, We will create a module. Step-1: Create requirejs-config.js in  app\/code\/Vendor\/Validation\/view\/adminhtml Step-2: Create validator-rules-mixin.js in  app\/code\/Vendor\/Validation\/view\/adminhtml\/web\/js\/admin-config Step-3: Create system.xml in app\/code\/Vendor\/Validation\/etc\/adminhtml and then add custom rule. Hope this will help you. Thanks \ud83d\ude42<\/p>\n","protected":false},"author":379,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[9121],"tags":[2070],"class_list":["post-378762","post","type-post","status-publish","format-standard","hentry","category-magento-2","tag-magento2"],"yoast_head":"\nHow to add custom validation in store configuration field - Webkul Blog<\/title>\n<meta name=\"description\" content=\"how to add custom validation in store configuration field\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to add custom validation in store configuration field - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"how to add custom validation in store configuration field\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2023-04-28T13:37:37+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2023-04-28T14:10:09+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig-1200x434.png\" \/>\n<meta name=\"author\" content=\"Krishna Mohan\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Krishna Mohan\" \/>\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:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/\"},\"author\":{\"name\":\"Krishna Mohan\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/32da2f954b256b95b4c44ddeacca51b1\"},\"headline\":\"How to add custom validation in store configuration field\",\"datePublished\":\"2023-04-28T13:37:37+00:00\",\"dateModified\":\"2023-04-28T14:10:09+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/\"},\"wordCount\":81,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig-1200x434.png\",\"keywords\":[\"Magento2\"],\"articleSection\":[\"Magento 2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/\",\"url\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/\",\"name\":\"How to add custom validation in store configuration field - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig-1200x434.png\",\"datePublished\":\"2023-04-28T13:37:37+00:00\",\"dateModified\":\"2023-04-28T14:10:09+00:00\",\"description\":\"how to add custom validation in store configuration field\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig.png\",\"width\":1291,\"height\":467,\"caption\":\"storeConfig\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to add custom validation in store configuration field\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/32da2f954b256b95b4c44ddeacca51b1\",\"name\":\"Krishna Mohan\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/ff4d070d18606ffded6efe51b5703bf4b6a46b26b9e4db5e6ecfdbf023daab4c?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/ff4d070d18606ffded6efe51b5703bf4b6a46b26b9e4db5e6ecfdbf023daab4c?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Krishna Mohan\"},\"description\":\"Krishna, a Software Engineer, specializes in the Magento platform, delivering high-performance eCommerce solutions. Expertise spans custom development, system optimization, and seamless integration, driving innovation and enhancing business operations.\",\"url\":\"https:\/\/webkul.com\/blog\/author\/krishna-mohan439webkul-com\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to add custom validation in store configuration field - Webkul Blog","description":"how to add custom validation in store configuration field","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:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/","og_locale":"en_US","og_type":"article","og_title":"How to add custom validation in store configuration field - Webkul Blog","og_description":"how to add custom validation in store configuration field","og_url":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2023-04-28T13:37:37+00:00","article_modified_time":"2023-04-28T14:10:09+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig-1200x434.png","type":"","width":"","height":""}],"author":"Krishna Mohan","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Krishna Mohan","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/"},"author":{"name":"Krishna Mohan","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/32da2f954b256b95b4c44ddeacca51b1"},"headline":"How to add custom validation in store configuration field","datePublished":"2023-04-28T13:37:37+00:00","dateModified":"2023-04-28T14:10:09+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/"},"wordCount":81,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig-1200x434.png","keywords":["Magento2"],"articleSection":["Magento 2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/","url":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/","name":"How to add custom validation in store configuration field - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig-1200x434.png","datePublished":"2023-04-28T13:37:37+00:00","dateModified":"2023-04-28T14:10:09+00:00","description":"how to add custom validation in store configuration field","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/04\/storeConfig.png","width":1291,"height":467,"caption":"storeConfig"},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/how-to-add-custom-validation-in-store-configuration-field\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to add custom validation in store configuration field"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/32da2f954b256b95b4c44ddeacca51b1","name":"Krishna Mohan","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/ff4d070d18606ffded6efe51b5703bf4b6a46b26b9e4db5e6ecfdbf023daab4c?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/ff4d070d18606ffded6efe51b5703bf4b6a46b26b9e4db5e6ecfdbf023daab4c?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Krishna Mohan"},"description":"Krishna, a Software Engineer, specializes in the Magento platform, delivering high-performance eCommerce solutions. Expertise spans custom development, system optimization, and seamless integration, driving innovation and enhancing business operations.","url":"https:\/\/webkul.com\/blog\/author\/krishna-mohan439webkul-com\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/378762","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/379"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=378762"}],"version-history":[{"count":10,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/378762\/revisions"}],"predecessor-version":[{"id":378919,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/378762\/revisions\/378919"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=378762"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=378762"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=378762"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}