October 6, 2016: Fixed issue where top-level domains were not correctly validated. Props Robert!
May 24, 2016: Fixed issue where configured fields were validated on every page submission rather than only when the page that contains them was submitted.
September 30, 2015: Fixed issue where spaces after the email would cause validation to fail.
April 2, 2015: Fixed issue where if domain check was case-sensitive.
October 1, 2014: Added support for limiting by top-level domain (i.e. ".co.uk", ".edu", etc)
Want to ban users from entering test@test.com and spamming your registration form? Want to only allow users with your companies email address to signup (i.e. jane@yourcompany.com). This snippet will let you do both!
| <?php | |
| /** | |
| * Gravity Wiz // Gravity Forms // Email Domain Validator | |
| * | |
| * This snippets allows you to exclude a list of invalid domains or include a list of valid domains for your Gravity Form Email fields. | |
| * | |
| * @version 1.4 | |
| * @author David Smith <david@gravitywiz.com> | |
| * @license GPL-2.0+ | |
| * @link https://gravitywiz.com/banlimit-email-domains-for-gravity-form-email-fields/ | |
| */ | |
| class GW_Email_Domain_Validator { | |
| private $_args; | |
| function __construct($args) { | |
| $this->_args = wp_parse_args( $args, array( | |
| 'form_id' => false, | |
| 'field_id' => false, | |
| 'domains' => false, | |
| 'validation_message' => __( 'Sorry, <strong>%s</strong> email accounts are not eligible for this form.' ), | |
| 'mode' => 'ban' // also accepts "limit" | |
| ) ); | |
| // convert field ID to an array for consistency, it can be passed as an array or a single ID | |
| if($this->_args['field_id'] && !is_array($this->_args['field_id'])) | |
| $this->_args['field_id'] = array($this->_args['field_id']); | |
| $form_filter = $this->_args['form_id'] ? "_{$this->_args['form_id']}" : ''; | |
| add_filter("gform_validation{$form_filter}", array($this, 'validate')); | |
| } | |
| function validate($validation_result) { | |
| $form = $validation_result['form']; | |
| foreach($form['fields'] as &$field) { | |
| // if this is not an email field, skip | |
| if(RGFormsModel::get_input_type($field) != 'email') | |
| continue; | |
| // if field ID was passed and current field is not in that array, skip | |
| if($this->_args['field_id'] && !in_array($field['id'], $this->_args['field_id'])) | |
| continue; | |
| $page_number = GFFormDisplay::get_source_page( $form['id'] ); | |
| if( $page_number > 0 && $field->pageNumber != $page_number ) { | |
| continue; | |
| } | |
| if( GFFormsModel::is_field_hidden( $form, $field, array() ) ) { | |
| continue; | |
| } | |
| $domain = $this->get_email_domain($field); | |
| // if domain is valid OR if the email field is empty, skip | |
| if($this->is_domain_valid($domain) || empty($domain)) | |
| continue; | |
| $validation_result['is_valid'] = false; | |
| $field['failed_validation'] = true; | |
| $field['validation_message'] = sprintf($this->_args['validation_message'], $domain); | |
| } | |
| $validation_result['form'] = $form; | |
| return $validation_result; | |
| } | |
| function get_email_domain( $field ) { | |
| $email = explode( '@', rgpost( "input_{$field['id']}" ) ); | |
| return trim( rgar( $email, 1 ) ); | |
| } | |
| function is_domain_valid( $domain ) { | |
| $mode = $this->_args['mode']; | |
| $domain = strtolower( $domain ); | |
| foreach( $this->_args['domains'] as $_domain ) { | |
| $_domain = strtolower( $_domain ); | |
| $full_match = $domain == $_domain; | |
| $suffix_match = strpos( $_domain, '.' ) === 0 && $this->str_ends_with( $domain, $_domain ); | |
| $has_match = $full_match || $suffix_match; | |
| if( $mode == 'ban' && $has_match ) { | |
| return false; | |
| } else if( $mode == 'limit' && $has_match ) { | |
| return true; | |
| } | |
| } | |
| return $mode == 'limit' ? false : true; | |
| } | |
| function str_ends_with( $string, $text ) { | |
| $length = strlen( $string ); | |
| $text_length = strlen( $text ); | |
| if( $text_length > $length ) { | |
| return false; | |
| } | |
| return substr_compare( $string, $text, $length - $text_length, $text_length ) === 0; | |
| } | |
| } | |
| class GWEmailDomainControl extends GW_Email_Domain_Validator { } | |
| # Configuration | |
| new GW_Email_Domain_Validator( array( | |
| 'form_id' => 326, | |
| 'field_id' => 1, | |
| 'domains' => array( 'gmail.com', 'hotmail.com', '.co.uk' ), | |
| 'validation_message' => __( 'Oh no! <strong>%s</strong> email accounts are not eligible for this form.' ), | |
| 'mode' => 'limit' | |
| ) ); |
How do I install this snippet?
Easy peasy. Just copy and paste the code above into your theme's functions.php file.
How do I use this functionality?
All you need to do is create a new instance of the GWEmailDomainControl() class, populated with your specific details, like so:
| new GWEmailDomainControl(array( | |
| 'form_id' => 152, | |
| 'field_id' => 9, | |
| 'domains' => array('gmail.com', 'hotmail.com', 'test.com') | |
| )); |
By default, the form will “ban” the specified email domains; however, you can also limit by the specified domains by passing limit for the mode argument. The example below demonstrates this as well as how to apply the email domain control to two specific fields by passing an array of field IDs for the field_id argument:
| new GWEmailDomainControl(array( | |
| 'form_id' => 152, | |
| 'field_id' => 9, | |
| 'domains' => array('gmail.com', 'hotmail.com', 'test.com'), | |
| 'mode' => 'limit' | |
| )); |
To apply this functionality to ALL fields on a form, do not pass the field_id argument at all.
| new GWEmailDomainControl(array( | |
| 'form_id' => 152, | |
| 'domains' => array('gmail.com', 'hotmail.com', 'test.com') | |
| )); |
Here is a full list of available options:
| new GWEmailDomainControl(array( | |
| 'form_id' => 152, | |
| 'field_id' => 9, // multiple field IDs can be passed as an array: array(8,9) | |
| 'domains' => array('gmail.com', 'hotmail.com', 'test.com'), | |
| 'validation_message' => __('Oh no! <strong>%s</strong> email accounts are not eligible for this form.'), | |
| 'mode' => 'ban' // also accepts "limit" | |
| )); |
form_idThe form ID of the form you would like to apply this functionality to. If you want to apply the the same email domain control to all forms, simply do not pass theform_idargument at all.field_idThe field ID for which this email domain control should be applied. If you would like to apply the same control to multiple fields you can pass an array of field IDs:'field_id' => array(8,12,15). If you want this to apply to all fields on a form, simply do not pass thefield_idargument at all.domainsAn array of email domains that should be banned or limited to depending on whatmodeyou have set.validation_messageThe message which will be displayed below the email field if the submitted email contains an invalid domain. You can use%sanywhere in the message to output the invalid domain.modeBy default, this is set tobanwhich will mark any of the specified domains as invalid if they are submitted in the email field. You can also pass alimitmode. In this mode, the specified domains are the only valid domains. All other domains will be marked as invalid.
Did this resource help you do something awesome with Gravity Forms? Then you'll absolutely love Gravity Perks; a suite of 30+ essential add-ons for Gravity Forms with support you can count on.
Hi David! Thanks for this snippet! It does exactly what I want. One thing I noticed in testing though which maybe you could help with…When I entered a banned domain and submitted the form (located at the bottom of my page), the page reloaded and stayed at the top. So a user would not know their form didn’t get submitted unless they scrolled down. Any thoughts on this?
It sounds like your issue is simply that the page isn’t scrolling down for any validation error. See the docs for gform_confirmation_anchor for some suggestions on this. 🙂
Hey David! Great code and works well in Gravity Forms. I implemented it and it stops entries from populating in the Gravity Forms area.
Something odd: my HubSpot integration is still picking up that I have a new entry from test@test.com and sends me an email to notify me when I submit the form.
Any tips to stop this from happening? Thanks!
Strange. I’d expect HubSpot’s feeds to only be triggered when the form is submitted (like other feed add-ons). If enough users report this issue, we’ll dig in and see if it’s something we can address in the snippet.
Great snippet! Thanks a lot!
Glad to help, Karolina!
Hi. Is this still functioning? or is it dependent on anything else? The forms just continue to submit, unrestricted.
Hi Efficiency, yes, this is still working. There’s a chance you may not have installed it correctly. Try these troubleshooting steps: https://gravitywiz.com/documentation/snippet-troubleshooting/
Great snippet! Thanks so much for sharing :)
Glad to help. 🙂
Hi,
I want to translate the validation message with Loco Translate but for some reason it won’t translate the message.
Someone who have the same problem or a solution?
Thanks!
Can I just add this to ban email domains on ALL forms?
new GWEmailDomainControl(array( ‘domains’ => array(‘gmail.com’, ‘hotmail.com’, ‘test.com’) ));
Hi Paul, yes, that should work. :)
Hi there,
Does the ‘form_id’ accept an array as well? I only want to ban certain email domains on two of my forms…
Hi Caitlin, you will need to create multiple instances of the snippet. More details here: https://gravitywiz.com/documentation/apply-class-based-snippet-different-forms/