Drupal7: Tip On Adding Code To Drupal Forms

7th April 2012 - 3 minutes read time

There are various different forms and modules in Drupal that allow for PHP code to be embedded into them. I have even talked about adding PHP code to forms in a previous post. These form elements can have their uses, modules like Views allow for PHP code to be run when collecting arguments which can allow for some advanced funcationality.

However, it can lead to problems. The code in the form is essentially outside of source control which means that anyone can mess about with the code and there is no way to revert changes or get back the code if the form save action failed for whatever reason.

One useful tip when using this functionality is to create a function that will run the needed code and then reduce the code entered into the form into a single return call. As an example, you would enter the following into the PHP code form.

<?php 
return mymodule_afunction/();

And then add the following to a module so that the function is accessible to the form code:

function mymodule_afunction() {
	return;
}

This means that the mymodule_afunction() function is now in source control, and any changes we need to make to the function can be done within in code, rather than within the form.

Thanks goes to Thomas Davis (@TEDavis) for telling about this tip at a the last NWDUG meetup.

form

Add new comment

The content of this field is kept private and will not be shown publicly.
CAPTCHA
This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.
1 + 0 =
Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.

Related Content

Drupal 9: Loading Configuration Entities Using Entity Query

11th December 2022

Whilst working on a module I found that I needed to do something that was difficult to find information for. I think part of that is because the solution is simpler than I was thinking, but it did cause me to get lost in source code and internet issues for a while.

Read more

DrupalCon Prague 2022

2nd October 2022

Last week I visited the city of Prague to attend the European DrupalCon 2022. The event was held between September 20th and 23rd, and was attended by over 1,200 people.

Read more

Drupal Testing Strategies

26th June 2022

Creating a Drupal site can be a complex process. Some people put together Drupal sites using a collection of different modules whilst others use Drupal as a framework and build the site using code.

Read more

Drupal 9: Creating A GET Form

4th July 2021

I've been building Drupal forms for a number of years so I'm quite familiar with to putting together a Drupal form using the FormBase class and the form API. When I attempted to create a GET form this week I realised that there is actually quite a bit to think about.

Read more

Drupal 9: Cascading Ajax Select Forms

14th February 2021

Tying together different select elements in a form is done with very little effort thanks to the ajax and states system built into Drupal 9. This means that any Drupal form can have a select element that shows and updates options into another select element within the same form.

Read more

Drupal 9: Integrating Flood Protection Into Forms

13th December 2020

Drupal's login forms are protected by a protection mechanism that prevents brute force attacks. This means that if an attacker attempts to repeatedly guess a user's password to gain entry to their account they will be blocked before being successful. This system has been a part of Drupal for many years and so is battle tested.

Read more