Custom Modules | Modules | Drupal Tutorial

Introduction to Custom Modules

In Drupal, modules are used to extend the functionality of the platform. While Drupal comes with a rich set of built-in modules, creating custom modules allows developers to tailor functionality to their specific needs. This tutorial will guide you through the process of creating a custom module in Drupal from start to finish.

Setting Up Your Custom Module

To create a custom module, you first need to set up the directory structure. Navigate to the modules/custom directory in your Drupal installation (create the custom directory if it doesn't exist).

Directory Structure:

modules/custom/my_custom_module

Inside your custom module directory, create two files: my_custom_module.info.yml and my_custom_module.module.

Creating the Module Info File

The .info.yml file defines the module's metadata. Here is an example of how to create this file:

my_custom_module.info.yml:

name: 'My Custom Module'
type: module
description: 'A custom module for demonstrating module creation.'
core_version_requirement: ^8 || ^9
package: Custom

This file tells Drupal about your module, including its name, description, and compatibility with core versions.

Implementing Module Functionality

Next, you will add functionality to your module by editing the .module file. For example, you can implement a simple hook to display a message when the module is enabled.

my_custom_module.module:

function my_custom_module_enable() {
drupal_set_message(t('My Custom Module has been enabled!'));
}
?>

This code uses the drupal_set_message() function to output a message when the module is enabled.

Enabling Your Custom Module

After creating your module files, you can enable your custom module through the Drupal admin interface. Navigate to Admin > Extend, find 'My Custom Module' in the list, and enable it.

Alternatively, you can enable the module using Drush (a command-line shell for Drupal):

drush en my_custom_module

Testing Your Custom Module

After enabling your module, you should see a message displayed on your website indicating that the module has been enabled. You can test this by refreshing your site.

If everything is set up correctly, you will see a notification at the top of the page.

Conclusion

You've successfully created a custom module in Drupal! This basic example introduced you to the key components and steps involved in module creation. From here, you can explore adding more complex functionalities, such as defining routes, creating forms, or integrating with other Drupal components.

For more advanced features, refer to the official Drupal documentation.

Custom Modules Tutorial in Drupal