May 30, 2014: Added support for requiring a maximum character count as well.
Have you ever received a generic comment or question in a form submission and wondered if there was a way to discourage this type of response? We’ve whipped up a little snippet that you can use to encourage a more descriptive comment from users submitting your forms.
| <?php | |
| /** | |
| * Gravity Wiz // Require Minimum Character Limit for Gravity Forms | |
| * | |
| * Adds support for requiring a minimum number of characters for text-based Gravity Form fields. | |
| * | |
| * @version 1.0 | |
| * @author David Smith <david@gravitywiz.com> | |
| * @license GPL-2.0+ | |
| * @link https://gravitywiz.com/... | |
| * @copyright 2013 Gravity Wiz | |
| */ | |
| class GW_Minimum_Characters { | |
| public function __construct( $args = array() ) { | |
| // make sure we're running the required minimum version of Gravity Forms | |
| if( ! property_exists( 'GFCommon', 'version' ) || ! version_compare( GFCommon::$version, '1.7', '>=' ) ) | |
| return; | |
| // set our default arguments, parse against the provided arguments, and store for use throughout the class | |
| $this->_args = wp_parse_args( $args, array( | |
| 'form_id' => false, | |
| 'field_id' => false, | |
| 'min_chars' => 0, | |
| 'max_chars' => false, | |
| 'validation_message' => false, | |
| 'min_validation_message' => __( 'Please enter at least %s characters.' ), | |
| 'max_validation_message' => __( 'You may only enter %s characters.' ) | |
| ) ); | |
| extract( $this->_args ); | |
| if( ! $form_id || ! $field_id || ! $min_chars ) | |
| return; | |
| // time for hooks | |
| add_filter( "gform_field_validation_{$form_id}_{$field_id}", array( $this, 'validate_character_count' ), 10, 4 ); | |
| } | |
| public function validate_character_count( $result, $value, $form, $field ) { | |
| $char_count = strlen( $value ); | |
| $is_min_reached = $this->_args['min_chars'] !== false && $char_count >= $this->_args['min_chars']; | |
| $is_max_exceeded = $this->_args['max_chars'] !== false && $char_count > $this->_args['max_chars']; | |
| if( ! $is_min_reached ) { | |
| $message = $this->_args['validation_message']; | |
| if( ! $message ) | |
| $message = $this->_args['min_validation_message']; | |
| $result['is_valid'] = false; | |
| $result['message'] = sprintf( $message, $this->_args['min_chars'] ); | |
| } else if( $is_max_exceeded ) { | |
| $message = $this->_args['max_validation_message']; | |
| if( ! $message ) | |
| $message = $this->_args['validation_message']; | |
| $result['is_valid'] = false; | |
| $result['message'] = sprintf( $message, $this->_args['max_chars'] ); | |
| } | |
| return $result; | |
| } | |
| } | |
| # Configuration | |
| new GW_Minimum_Characters( array( | |
| 'form_id' => 524, | |
| 'field_id' => 1, | |
| 'min_chars' => 4, | |
| 'max_chars' => 5, | |
| 'min_validation_message' => __( 'Oops! You need to enter at least %s characters.' ), | |
| 'max_validation_message' => __( 'Oops! You can only enter %s characters.' ) | |
| ) ); |
How do I get started?
- This will work with even Gravity Forms v1.0 but that’s no excuse not to be running the latest version.
- Already have a license? Download Latest Gravity Forms
- Need a license? Buy Gravity Forms
- Copy and paste the snippet into your theme’s functions.php file.
- Once you have installed the snippet, you just need to configure the snippet for your Gravity form. See the usage instructions below.
Usage
| new GW_Minimum_Characters( array( | |
| 'form_id' => 524, | |
| 'field_id' => 1, | |
| 'min_chars' => 4, | |
| 'max_chars' => 5, | |
| 'min_validation_message' => __( 'Oops! You need to enter at least %s characters.' ), | |
| 'max_validation_message' => __( 'Oops! You can only enter %s characters.' ) | |
| ) ); |
Parameters
The form_id, field_id, and min_chars parameters are required. Incorrect values will cause the snippet to fail silently; no error message will be displayed.
- form_id (integer) (required) The form ID of your form.
- field_id (integer) (required) The field ID of the field that you would like to enable a minimum character limit.
- min_chars (integer) (required) The minimum character limit that you would like to apply to the field.
- validation_message (string) (optional) The validation message that you would like to display to the user when the minimum character limit is not reached.
- min_validation_message (string) (optional)
The validation message that you would like to display to the user when the minimum character limit is not reached. Added to better differentiate between the
validation_messageand themax_validation_messageparameters. - max_validation_message (string) (optional) The validation message that you would like to display to the user when the maxiumum character limit is exceeded.
Can I add this to more than one field per form?
You sure can! You can add this to as many fields on as many forms as you want. Simply copy and paste the configuration code listed above and update the values for your new form and field.
If you use it and like it, let us know. We’d love to hear the different reasons how you found this code useful!
Did this resource help you do something awesome with Gravity Forms? Then you'll absolutely love Gravity Perks; a suite of 29+ essential add-ons for Gravity Forms with support you can count on.
Well I needed to adapt this for my own use to support array-like fields (e.g. Address and Name)
So here you go, everybody: https://github.com/cliffordp/gf-gw-req-char-length
Gravity Wiz folks, feel free to co-own it with me, link it, etc. as you wish.
Thanks for sharing, Clifford!
Can the code be modified to count the characters in a specific field and the post the number to another form field?
This snippet could be used as the base for the PHP validation of that functionality; however, you would need to write a bit of JS to handle counting the characters and populating that count into another field on the frontend.
Hello Jonathan,
do you have a solution for the counting.
I have the same problem.
Thanks, Thomas
Is it possible to use this for the address fields? They are broken down into sub-ID’s and I haven’t been able to make it work for individual fields. When I apply it the whole address section (with the simple ID) it doesn’t seem to recognize that there are any characters anywhere. Am I doing it wrong, or will this just not work for the address field?
Hi Taylor, this script doesn’t support checking for input-specific character counts.
Hi
This was asked before but was not answered. Your code works great, however it only works based on form_id and field_id. I need this to go a step further, I need it to work on a cell id as well.
I want to be able to tell it which form id, which field id and which cell in that field id to apply the max/min rule.
Please help.
Hi Mellisa, we do not have plans to add support for List fields for this snippet. You might consider hiring a developer to add this enhancement via a service like Codeable.io.
I am getting this error when trying to activate the snippet:
The code snippet you are trying to save produced a fatal error on line 12:
Cannot redeclare class GW_Minimum_Characters
Hi,
is it possible to limit the characters in a special field for every form? Maybe with a parameter name for the input field?! We have dozens of forms and couldn’t built a function for all of them ;)
Hi Cray, this is certainly possible but would required customizing the snippet. Feel free to reach out to me for a quote: david at gravitywiz dot com
Hi,
Iam not really understanding in which File I have to copy this that I get minimum Characters?
Please provide me her.
Many THX
Hi Salvatore, this resource might help: https://gravitywiz.com/documentation/snippet-troubleshooting/
Hey David, I am getting a fatal error from this snippet. It looks like its coming from the validation messages.
Thanks, very helpful.
Glad to help. :)
Hi, is this possible to use on Gravity Forms list items, where each item should be limited. I attempted this using the list ID and it didnt work.
Not sure I understand your question?
I would like to constrain text input on list items in Gravity Forms. Where each item in the list is constrained to x amount of characters. When I attempt to use the plugin as you have shown, with the Id of the list and form id, it always returns an error. I assume this has to with the fact list inputs are dynamically created or are a set. Is it possible to set some parameters that would fix that?
try something of the sort:
http://pastie.org/private/o3gmr8ndxrs8exx6br2sjw
have you implemented this correctly? do you mind sharing the code if yes.
this is my problem too, i dont get how to implement this on list (Advanced Fields) .. :(
thanks.
I would to see something set up like this but instead of min & max characters, I would like to ban certain words such as a specific course name which requires a user to complete a paper application and not complete the online form.
Hi Lori, this is possible with the GP Comment Blacklist perk (available with Gravity Perks).
Could you please give an example, how to add the configuration values for more than one field ? I tried several ways but none seemed to work:
new GW_Minimum_Characters( array( ‘form_id’ => 2, ‘field_id’ => 12, ‘min_chars’ => 200, ‘form_id’ => 2, ‘field_id’ => 3, ‘min_chars’ => 40, ‘min_validation_message’ => __( ‘Oops! You need to enter at least %s characters.’ ) ) );
Hi Joern, you would create two “instances” of the GW_Minimum_Characters class. Here’s an example:
new GW_Minimum_Characters( array( 'form_id' => 2, 'field_id' => 12, 'min_chars' => 200, 'min_validation_message' => __( 'Oops! You need to enter at least %s characters.' ) ) );new GW_Minimum_Characters( array( 'form_id' => 2, 'field_id' => 3, 'min_chars' => 40, 'min_validation_message' => __( 'Oops! You need to enter at least %s characters.' ) ) );Hey David. I have the snippet exact, other than field id and form id.
Hey David, When I put in the code you’ve provided, I get a fatal error:
This is line 34: “new GW_Minimum_Characters( array(” Should I change that to something else? Sorry I’m not the best w/ php.
I’m getting a similar error: Fatal error: Class ‘GW_Minimum_Characters’ not found…
Hi Gisele, are you including the entire snippet as well as the configuration code?
Do you think there would be a way to make it where a field would have to be exactly a certain length. I know you could set ‘min_chars’ => 8, ‘max_chars’ => 8 and that would essentiall do what is needed. But what if you wanted the submission to be either 8 or 11 characters long. Do you think this Is this something that is possible?
Not really looking for the code to be written for me, but I am very new to gravity forms and php in general, and do not want to waste hours trying to figure it out if that gravity forms simply cannot handle that functionality.
Thanks for this tutorial. It is really insightful.
Hi Greg, this might be possible with this current snippet by instantiating the class twice with two different lengths. Example: http://pastie.org/9543690
If this doesn’t work, it would still be possible with some customization to the code (a.k.a Gravity Forms is capable of handling this with a small amount of modification).
Is there a similar function for limiting the max number of characters to be entered? I have tried ‘max_chars’ but doent seem to take?
We are hoping to control this via code and via the character limit on the front-end…
Hi Stan, I’ve updated the snippet above to now support setting a maximum number of characters. You can specify a “max_chars” and a “max_validation_message” once you’ve updated your copy of the snippet with the updated copy above.
I’d love to make this a perk (which would include a UI for managing this per field). If you’re interested in commissioning the development, get in touch.