Creating a drupal module patch

Search form Search. Error message The spam filter installed on this site is currently unavailable. Per site policy, we are unable to accept new submissions until that problem is resolved. Please try resubmitting the form in a couple of minutes. Create and Apply a Patch to a Drupal Module. From a terminal More information about text formats. The first thing you want to note is the file that needs to be changed. In this instance, we need to edit a module in Drupal's core. Please note that we are not hacking core - we are patching it.

The difference is that a hack is designed to permanent whereas with a patch, we hope that a future version of Drupal will fix this bug. I recommend keeping track of all the patches you apply to your site code. You could do something as simple as keeping a text file with a list of all the patches you have applied and their source. After you have found the patch, now you need to find the code that needs to be patched.

Let's assume you do not have a copy of your site code on your local computer. This means you need to find it on your server. The arrows indicate the folder where you will find Drupal's core modules. Open the file in a simple text editor. In the screen shot below, the file was opened in WordPad. Observe the highlighted line of code. This line matches the line of code with a minus in front of it see bold text in patch below. Notice in the screen shot below that the highlighted line of code is now different and matches the code next to the plus in the patch.

Save the file and upload it to the server, replacing the original file. Return to your site and try creating another user account and see if the error goes away.

If it does, consider posting your results on the issue so that the person who created the patch will know it worked. This will result in a warning on the status report page that a module is incompatible with the core version. Here is a complete example of what these dependencies would look like in our demo module's "info" file:. In this case we're telling Drupal that our module cannot be installed unless the core Node module is enabled and the contributed modules Webform and Devel Generate are enabled as well.

If you're contributing your module back to the community and you want DrupalCI to test module dependencies for your module, you'll need to list your module's dependencies in a composer.

See Add a composer. The other main key you may find in info files is configure. Use this only if your module needs to provide particular configuration settings that are exposed to the site administrators. The configure key in your module's info file specifies the route that will be used to navigate to the module's configuration settings form. In particular, Drupal. None of this metadata is required in a custom module you develop, but can be useful when troubleshooting during development.

In this tutorial, we looked at the main elements that make up info files for Drupal modules. This type of file is required in order for Drupal to recognize our code as a module, and to get it to show up on the module's listing on the Extend page. Additional metadata specifying the dependencies of our module, the route to the configuration form may also be added.

Skip to main content. Last updated March 5,