The power of Drupal lies with its modules. With thousands of core and contributed Drupal modules to choose from, Drupal developers can easily implement ones that meet their needs. But what if the requirements are very specific and you don’t have a module available for it? How can you customize a Drupal website for a client who has unique needs that just cannot be accomplished with core or contributed modules? Enter Custom modules.
Custom modules in Drupal 8 give you the flexibility to create new features and/or tweak existing features to accommodate a business’ unique and growing aspirations. Drupal 8 custom modules propels innovation and enhancements to help enterprises expand their horizons. This article should help you get started with creating your very own Drupal 8 module
Getting started with Module development in Drupal 8
Let’s now get started with creating a custom module in Drupal 8 in a few easy steps:
Step 1: Name the Drupal 8 Module
First, we need to create a custom module under ‘web/modules/custom’ folder. We will name the folder as welcome_module.
Some things that you should keep in mind before giving a machine name to your module are:
- It should not start with uppercase letters.
- There should not be any spaces between the words.
Step 2: Get noticed with the info.yml file
We have to create a yaml file with the machine name of our module for Drupal to be able recognize the module. I’ll create a yaml file like this welcome_module.info.yml.
Here is our welcome_module.info.yml file created under "welcome" directory we created in Step 1.
name: Welcome Module type: module description: 'First Custom Drupal 8 Module.' package: Custom version: 1.0 core: 8.x
name: Welcome Module (The name displayed on the modules list in Drupal)
type: module - (Declaring that this is a module or theme)
description: Custom Example Drupal 8 Module (Description of the module)
package: Custom - (Mentioning that this is a custom module)
version: 1.0 - (Module version)
core: 8.x - (Drupal version)
Step 3: Creating the routing file with routing.yml
Next step is to add a welcome_module.routing.yml file under the "welcome" directory:
welcome_module.welcome: path: '/welcome/page' defaults: _controller: '\Drupal\welcome_module\Controller \WelcomeController::welcome' _title: 'Welcome to My Module in Drupal 8' requirements: _permission: 'access content'
The first line is the route name [welcome_module.my_welcome].
Under path, we specify the URL path we want this route to register. This is the URL to the route.
Under defaults, we have two things: the _controller which references a method on the WelcomeController class and the default page title (_title).
Under requirements, we specify the permission of the accessing. User needs to have to be able to view the page.
Step 4: Adding a Controller
Create a folder "modules/custom/welcome_module/src/Controller". In this folder, create a file named "WelcomeController.php" with the following content:
Now Login to your Drupal site and enable your module. To check if it functions properly, visit the path you specified in your routing file, that is /welcome/page. If you get the ‘Page Not Found’ error, then clear the cache by navigating to admin->configuration->performance. Check again and it should function properly this time.
That’s it! You’ve successfully created your very first custom module in Drupal 8.
Finally, when you go to /welcome/page URL, you'll see Title “Welcome to My Module in Drupal 8" and markup “Welcome to our Website." text printed from our module.