Easy-to-follow video tutorials help you learn software, creative, and business skills.Become a member

Creating custom form validation

From: Drupal 7 Custom Module Development

Video: Creating custom form validation

The Drupal form API provides a mechanism for a number of common validations. These include required fields, which I've demonstrated, and also includes ensuring that the value given to a select form element is actually in the domain of available options. It even provides cross-site request forgery protection without any additional form elements. With that said, the complexity of the checks don't go much beyond these options and the error messages are minimal at best. Fortunately Drupal provides a mechanism for customizing the form validation.

Creating custom form validation

The Drupal form API provides a mechanism for a number of common validations. These include required fields, which I've demonstrated, and also includes ensuring that the value given to a select form element is actually in the domain of available options. It even provides cross-site request forgery protection without any additional form elements. With that said, the complexity of the checks don't go much beyond these options and the error messages are minimal at best. Fortunately Drupal provides a mechanism for customizing the form validation.

Before I continue, I will recommend that you would enable the devel module. Devel is a contributed module that consists of a suite of modules for assisting module developers with the helper functions and the other debugging information. I utilize it on a regular basis in my development environment, with a caveat of it should never be installed in production and care should be taken not to deploy code to production, with debugging output. Enable the devel module by going to Modules, scrolling down to DEVELOPMENT, clicking ENABLED next to Devel.

Then Save configuration. If the devel module is not listed, please download it and install it from drupal.org. Drupal form validators are standardized callback functions. The function name is the same as the form creation with the addition of underscore validate. Drupal will automatically look for a function that matches this naming pattern and use it if it exists. If a function doesn't exist, there are no consequences other than the lack of custom validation. Return to the IDE and create a new docblock for the form validator.

There is no actual hook form validate, but the Drupal form API allows forms to be validated as if there were; validates Wind Farm admin settings. Next create a new function beneath the docblock called function windfarms_admin_settings_form_validate, which takes two parameters; the form and the form_state passed by reference. Let's get some introspection into the form state itself.

It's a large array containing over a dozen keys. To quickly display the contents of the form state upon form validation, I will leverage one of the helper functions from the develop module called DPM which stands for Drupal Print Message. DPM displays a variable to the message area of the page, dpm form_state, save and return to the browser. Go to configuration, scroll to Wind Farms Settings, let's create a bad value here and submit the form.

The sanitize values are stored in the values array; the debugging information shows the contents of form state. Click Array and you can see the contents. The sanitize values are stored in values. DPM is very useful for determining array structures and values, return to the IDE. I'm going to be a little bit more specific about what DPM is displaying to make it easier to see what's going on. So DPM form state values; in particular the sanitize response from the user is contained in key values in the form state arrays, so I'll be using values for both validation and submission handling.

To add a validation to a form, perform whatever logic that is needed. If the logic fails then, call function form_set_error. Form set error takes two parameters; the first is the name of the element that has a problem, and the second is a translated string that contains the error message. I will demonstrate validation using the text field for latitude and longitude which has a specific format maximum and minimum values. First, I'll do some setup to improve readability. I will use a regular expression to check the format of the sign degrees.

Optionally, there can be a period. If so then it must be followed by at least one digit. Regular expression for validating signed degrees, signed_degree_regex = the start of the regular expression and optionally plus or minus followed by at least one digit.

Then optionally a period followed by one or more digits, make that optional, and then the end of the expression. Next, since the submitted values have rather long names and are located in the nested array I'm going to assign a shorter variable name to their values. Shorthand for long array names; lat = form_ state values windfarms_default_center_lat.

And long is set to form_state values windfarms_default_center_long. The first checks I will perform are on the format of the latitude and longitude using regular expressions I just wrote. I'll start with a comment. Validate latitude and longitude format. Then a simple if statement, if a regular expression does not match if not, preg_match signed_degree_regex and latitude call form _set_error.

The first parameter is the name of the form element that is failed and the second is a string passed through the t function; form_set_ error windfarms_default_center_lat and the t function, Invalid latitude must be a signed degree. Create a second variation for longitude.

The logic stays the same but the names and message are slightly different. Next, validate the latitude and longitude values. Each value must be between negative -180 and positive +180. Validate latitude and longitude values. If not -180 <= lat && lat <= 180.

form_set_error windfarms_default_center_lat, and the message Latitude must be between -180 and 180. And we'll do the same for the longitude. Long, long, long and Longitude, save the file and return to the browser.

Ensure that the form validation fails by putting invalid values into latitude and leave longitude empty. Note the contextual accurate messages. Longitude field is required and the invalid latitude message. Change the latitude and longitude to valid values that are different than the default. So I'm going to set to 1 and 2 then click Save. The DPM output is on top from the validation but the latitude and longitude have mysteriously gone back to their defaults.

Why is that? By default on a failed form validation, the form rebuilds and is displayed to the user with their input. If the form passes validation then the form is not rebuilt. In the next segment, I will describe how to handle a successful form submission.

Show transcript

This video is part of

Image for Drupal 7 Custom Module Development
Drupal 7 Custom Module Development

24 video lessons · 5392 viewers

Jon Peck
Author

 

Start learning today

Get unlimited access to all courses for just $25/month.

Become a member
Sometimes @lynda teaches me how to use a program and sometimes Lynda.com changes my life forever. @JosefShutter
@lynda lynda.com is an absolute life saver when it comes to learning todays software. Definitely recommend it! #higherlearning @Michael_Caraway
@lynda The best thing online! Your database of courses is great! To the mark and very helpful. Thanks! @ru22more
Got to create something yesterday I never thought I could do. #thanks @lynda @Ngventurella
I really do love @lynda as a learning platform. Never stop learning and developing, it’s probably our greatest gift as a species! @soundslikedavid
@lynda just subscribed to lynda.com all I can say its brilliant join now trust me @ButchSamurai
@lynda is an awesome resource. The membership is priceless if you take advantage of it. @diabetic_techie
One of the best decision I made this year. Buy a 1yr subscription to @lynda @cybercaptive
guys lynda.com (@lynda) is the best. So far I’ve learned Java, principles of OO programming, and now learning about MS project @lucasmitchell
Signed back up to @lynda dot com. I’ve missed it!! Proper geeking out right now! #timetolearn #geek @JayGodbold
Share a link to this course

What are exercise files?

Exercise files are the same files the author uses in the course. Save time by downloading the author's files instead of setting up your own files, and learn by following along with the instructor.

Can I take this course without the exercise files?

Yes! If you decide you would like the exercise files later, you can upgrade to a premium account any time.

Become a member Download sample files See plans and pricing

Please wait... please wait ...
Upgrade to get access to exercise files.

Exercise files video

How to use exercise files.

Learn by watching, listening, and doing, Exercise files are the same files the author uses in the course, so you can download them and follow along Premium memberships include access to all exercise files in the library.


Exercise files

Exercise files video

How to use exercise files.

For additional information on downloading and using exercise files, watch our instructional video or read the instructions in the FAQ.

This course includes free exercise files, so you can practice while you watch the course. To access all the exercise files in our library, become a Premium Member.

Are you sure you want to mark all the videos in this course as unwatched?

This will not affect your course history, your reports, or your certificates of completion for this course.


Mark all as unwatched Cancel

Congratulations

You have completed Drupal 7 Custom Module Development.

Return to your organization's learning portal to continue training, or close this page.


OK
Become a member to add this course to a playlist

Join today and get unlimited access to the entire library of video courses—and create as many playlists as you like.

Get started

Already a member?

Become a member to like this course.

Join today and get unlimited access to the entire library of video courses.

Get started

Already a member?

Exercise files

Learn by watching, listening, and doing! Exercise files are the same files the author uses in the course, so you can download them and follow along. Exercise files are available with all Premium memberships. Learn more

Get started

Already a Premium member?

Exercise files video

How to use exercise files.

Ask a question

Thanks for contacting us.
You’ll hear from our Customer Service team within 24 hours.

Please enter the text shown below:

The classic layout automatically defaults to the latest Flash Player.

To choose a different player, hold the cursor over your name at the top right of any lynda.com page and choose Site preferencesfrom the dropdown menu.

Continue to classic layout Stay on new layout
Exercise files

Access exercise files from a button right under the course name.

Mark videos as unwatched

Remove icons showing you already watched videos if you want to start over.

Control your viewing experience

Make the video wide, narrow, full-screen, or pop the player out of the page into its own window.

Interactive transcripts

Click on text in the transcript to jump to that spot in the video. As the video plays, the relevant spot in the transcript will be highlighted.

Are you sure you want to delete this note?

No

Your file was successfully uploaded.

Thanks for signing up.

We’ll send you a confirmation email shortly.


Sign up and receive emails about lynda.com and our online training library:

Here’s our privacy policy with more details about how we handle your information.

Keep up with news, tips, and latest courses with emails from lynda.com.

Sign up and receive emails about lynda.com and our online training library:

Here’s our privacy policy with more details about how we handle your information.

   
submit Lightbox submit clicked
Terms and conditions of use

We've updated our terms and conditions (now called terms of service).Go
Review and accept our updated terms of service.