Categories: Magento

How to create a module in Magento 2

Name: London Web Design & Development Company | The UK Web Design Company Ltd
Rating: 5

Creating a module in Magento 2 allows you to extend and customize the functionality of your Magento store. Here’s a step-by-step guide on how to create a module in Magento 2:

Step 1: Set up the module directory structure
In your Magento installation, navigate to the `app/code` directory. Inside the `code` directory, create a new directory with the vendor name (e.g., `VendorName`) and inside that, create a module directory (e.g., `ModuleName`). So the complete directory path will be `app/code/VendorName/ModuleName`.

Step 2: Create module configuration files
Inside the `ModuleName` directory, create the following directories and files:

– `etc/module.xml`: This file defines the module and its version. Create the `etc` directory inside the `ModuleName` directory, and inside the `etc` directory, create the `module.xml` file. Add the following content to the file:

“`xml
<?xml version=”1.0″?>
<config xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:noNamespaceSchemaLocation=”urn:magento:framework:Module/etc/module.xsd”>
<module name=”VendorName_ModuleName” setup_version=”1.0.0″/>
</config>
“`

Step 3: Register the module
Run the following command from the root directory of your Magento installation to register the module:

“`
php bin/magento setup:upgrade
“`

This command updates the configuration and registers the module in the Magento system.

Step 4: Create a basic module structure
Inside the `ModuleName` directory, create the following directories and files:

– `Block`: This directory will contain PHP classes responsible for generating output for the module.
– `Controller`: This directory will contain PHP classes responsible for handling module-related HTTP requests.
– `Model`: This directory will contain PHP classes responsible for handling business logic and interacting with the database.
– `view/frontend/layout`: This directory will contain XML layout files for the module’s frontend.
– `view/frontend/templates`: This directory will contain template files for the module’s frontend.

Step 5: Create a basic controller
Inside the `Controller` directory, create a new directory called `Index`. Inside the `Index` directory, create a file called `Index.php`. Add the following content to the file:

“`php
<?php
namespace VendorName\ModuleName\Controller\Index;

use Magento\Framework\App\Action\Action;
use Magento\Framework\App\Action\Context;
use Magento\Framework\View\Result\PageFactory;

class Index extends Action
{
protected $resultPageFactory;

public function __construct(Context $context, PageFactory $resultPageFactory)
{
$this->resultPageFactory = $resultPageFactory;
parent::__construct($context);
}

public function execute()
{
$resultPage = $this->resultPageFactory->create();
return $resultPage;
}
}
“`

This is a basic controller that returns a result page.

Step 6: Create a layout file
Inside the `view/frontend/layout` directory, create a file called `module_index_index.xml`. Add the following content to the file:

“`xml
<?xml version=”1.0″?>
<page xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” layout=”1column” xsi:noNamespaceSchemaLocation=”urn:magento:framework:View/Layout/etc/page_configuration.xsd”>
<body>
<referenceContainer name=”content”>
<block class=”Magento\Framework\View\Element\Template” name=”module_index_index” template=”VendorName_ModuleName::index.phtml” />
</referenceContainer>
</body>
</page>
“`

Step 7: Create a template file

Inside the `view/frontend/templates` directory, create a file called `index.phtml`. Add the following content to the file:

“`html
<h1>Welcome to my module!</h1>
“`

Step 8: Access the module
To access the module, open a web browser and enter the following URL:

“`
http://your-magento-store.com/module/index/index
“`

Replace `your-magento-store.com` with the URL of your Magento store.

You should see the “Welcome to my module!” message displayed.

Congratulations! You have created a basic module in Magento 2. You can now customise and extend the module according to your requirements by adding more controllers, models, blocks, layouts, and templates.

twdc

Next How to disable a module in Magento 2 »

Previous « How to Reindex in Magento 2