{"id":307285,"date":"2021-09-28T05:09:57","date_gmt":"2021-09-28T05:09:57","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=307285"},"modified":"2024-06-19T13:14:52","modified_gmt":"2024-06-19T13:14:52","slug":"add-custom-validation-in-the-input-field-in-the-system-xml","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/","title":{"rendered":"Add custom validation in the input field in the system.xml"},"content":{"rendered":"\n

Hello Friends!

In this blog, we will learn how we can add custom validation in a field by creating custom validation class from jquery in system.xml.<\/p>\n\n\n\n

To add custom validation in a store configuration field, please follow the below steps:

1. Create requirejs-config.js file inside the app\/code\/Vendor\/CustomModule\/view\/adminhtml\/ directory.<\/strong><\/p>\n\n\n\n

var config = {\n    config: {\n        mixins: {\n            'mage\/validation': {\n                'Vendor_CustomModule\/js\/store-config\/validator-rules-mixin': true\n            }\n        }\n    }\n};<\/pre>\n\n\n\n
2. Create validator-rules-mixin.js file inside the app\/code\/Vendor\/CustomModule\/view\/adminhtml\/web\/js\/store-config\/ directory.<\/strong><\/p>\n\n\n\n
define([\n 'jquery'\n], function ($) {\n    'use strict';\n    return function (target) {\n        $.validator.addMethod(\n            'validate-sixteen-digit',\n            function (value) {\n                console.log(value);\n                return !(value.length < 16);\n            },\n            $.mage.__('Please Enter 16 Digit Number.')\n        );\n        return target;\n    };\n});<\/pre>\n\n\n\n
3. Create system.xml file inside the app\/code\/Vendor\/CustomModule\/etc\/adminhtml\/ directory. And add the validation class ‘validate-sixteen-digit’ in ‘Aadhaar Number’ field.<\/strong><\/p>\n\n\n\n
<?xml version="1.0"?>\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="..\/..\/..\/Config\/etc\/system_file.xsd">\n    <system>\n        <tab id="vendorname" translate="label" sortOrder="10">\n            <label>VendorName<\/label>\n        <\/tab>\n        <section id="custommodule" translate="label" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">\n            <label>Custom Module Configuration<\/label>\n            <tab>vendorname<\/tab>\n            <resource>Vendor_CustomModule::config_blogs<\/resource>\n            <group id="general" translate="label" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">\n                <field id="aadhaarnumber" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">\n                    <label>Aadhaar Number<\/label>\n                    <validate>required-entry <em>validate-sixteen-digit<\/em><\/validate>\n                <\/field>\n            <\/group>\n        <\/section>\n    <\/system>\n<\/config><\/pre>\n\n\n\n
4. See the result in the below image.<\/strong><\/p>\n\n\n\n
\"validation\"<\/figure>\n\n\n\n
Hope this will be helpful. Thanks \ud83d\ude42

Previous Blog:<\/strong> Override Product Tier Prices in Magento 2<\/a>

Next Blog:<\/strong> Validate system.xml fields data when saving the configuration<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Hello Friends! In this blog, we will learn how we can add custom validation in a field by creating custom validation class from jquery in system.xml. To add custom validation in a store configuration field, please follow the below steps: 1. Create requirejs-config.js file inside the app\/code\/Vendor\/CustomModule\/view\/adminhtml\/ directory. 2. Create validator-rules-mixin.js file inside the app\/code\/Vendor\/CustomModule\/view\/adminhtml\/web\/js\/store-config\/ […]<\/a><\/p>\n","protected":false},"author":249,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[9121],"tags":[12112,12114,12113,12115,1907],"class_list":["post-307285","post","type-post","status-publish","format-standard","hentry","category-magento-2","tag-configuration-field-validation","tag-cuatom-validation","tag-custom-validation-class","tag-custom-validation-in-system-xml","tag-system-xml"],"yoast_head":"\nAdd custom validation in the input field in the system.xml - Webkul Blog<\/title>\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\/add-custom-validation-in-the-input-field-in-the-system-xml\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Add custom validation in the input field in the system.xml - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"Hello Friends! In this blog, we will learn how we can add custom validation in a field by creating custom validation class from jquery in system.xml. To add custom validation in a store configuration field, please follow the below steps: 1. Create requirejs-config.js file inside the app\/code\/Vendor\/CustomModule\/view\/adminhtml\/ directory. 2. Create validator-rules-mixin.js file inside the app\/code\/Vendor\/CustomModule\/view\/adminhtml\/web\/js\/store-config\/ [...]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/\" \/>\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=\"2021-09-28T05:09:57+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-06-19T13:14:52+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation-1200x548.png\" \/>\n<meta name=\"author\" content=\"Khushboo Sahu\" \/>\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=\"Khushboo Sahu\" \/>\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\/add-custom-validation-in-the-input-field-in-the-system-xml\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/\"},\"author\":{\"name\":\"Khushboo Sahu\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca\"},\"headline\":\"Add custom validation in the input field in the system.xml\",\"datePublished\":\"2021-09-28T05:09:57+00:00\",\"dateModified\":\"2024-06-19T13:14:52+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/\"},\"wordCount\":136,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation-1200x548.png\",\"keywords\":[\"configuration field validation\",\"cuatom validation\",\"custom validation class\",\"custom validation in system.xml\",\"system.xml\"],\"articleSection\":[\"Magento 2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/\",\"url\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/\",\"name\":\"Add custom validation in the input field in the system.xml - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation-1200x548.png\",\"datePublished\":\"2021-09-28T05:09:57+00:00\",\"dateModified\":\"2024-06-19T13:14:52+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation.png\",\"width\":1805,\"height\":825,\"caption\":\"validation\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add custom validation in the input field in the system.xml\"}]},{\"@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\/f94b8f53397bf85810761d76c98fadca\",\"name\":\"Khushboo Sahu\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"caption\":\"Khushboo Sahu\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/khushboo-sahu062\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Add custom validation in the input field in the system.xml - Webkul Blog","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\/add-custom-validation-in-the-input-field-in-the-system-xml\/","og_locale":"en_US","og_type":"article","og_title":"Add custom validation in the input field in the system.xml - Webkul Blog","og_description":"Hello Friends! In this blog, we will learn how we can add custom validation in a field by creating custom validation class from jquery in system.xml. To add custom validation in a store configuration field, please follow the below steps: 1. Create requirejs-config.js file inside the app\/code\/Vendor\/CustomModule\/view\/adminhtml\/ directory. 2. Create validator-rules-mixin.js file inside the app\/code\/Vendor\/CustomModule\/view\/adminhtml\/web\/js\/store-config\/ [...]","og_url":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2021-09-28T05:09:57+00:00","article_modified_time":"2024-06-19T13:14:52+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation-1200x548.png","type":"","width":"","height":""}],"author":"Khushboo Sahu","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Khushboo Sahu","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/"},"author":{"name":"Khushboo Sahu","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca"},"headline":"Add custom validation in the input field in the system.xml","datePublished":"2021-09-28T05:09:57+00:00","dateModified":"2024-06-19T13:14:52+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/"},"wordCount":136,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation-1200x548.png","keywords":["configuration field validation","cuatom validation","custom validation class","custom validation in system.xml","system.xml"],"articleSection":["Magento 2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/","url":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/","name":"Add custom validation in the input field in the system.xml - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation-1200x548.png","datePublished":"2021-09-28T05:09:57+00:00","dateModified":"2024-06-19T13:14:52+00:00","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/09\/validation.png","width":1805,"height":825,"caption":"validation"},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/add-custom-validation-in-the-input-field-in-the-system-xml\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Add custom validation in the input field in the system.xml"}]},{"@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\/f94b8f53397bf85810761d76c98fadca","name":"Khushboo Sahu","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","caption":"Khushboo Sahu"},"url":"https:\/\/webkul.com\/blog\/author\/khushboo-sahu062\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/307285","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\/249"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=307285"}],"version-history":[{"count":6,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/307285\/revisions"}],"predecessor-version":[{"id":448805,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/307285\/revisions\/448805"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=307285"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=307285"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=307285"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}