Repository files navigation

Magento 2 Module development orMagento 2 Hello World Simple Module trends is increase rapidly while Magento release official version. That why we -Mageplaza - are wring about a topic that introduces how to create a simpleHello World module in Magento 2.As you know, the module is a directory that containsblocks, controllers, models, helper, etc - that are related to a specific business feature. In Magento 2, modules will be live inapp/code directory of a Magento installation, with this format:app/code/<Vendor>/<ModuleName>. Now we will follow this steps to create a simple module which work on Magento 2 and displayHello World.

• Step 1: Create a directory for the module like above format.
• Step 2: Declare module by using configuration file module.xml
• Step 3: Register module by registration.php
• Step 4: Enable the module
• Step 5: Create a Routers for the module.
• Step 6: Create controller and action.

In this module, we will useMageplaza for Vendor name andHelloWorld for ModuleName. So we need to make this folder:app/code/Mageplaza/HelloWorld

Magento 2 looks for configuration information for each module in that module’s etc directory. We need to create folder etc and add module.xml:

app/code/Mageplaza/HelloWorld/etc/module.xml

And the content for this file:

<?xml version="1.0"?><configxmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">    <modulename="Mageplaza_HelloWorld"setup_version="1.0.0" /></config>

In this file, we register a module with nameMageplaza_HelloWorld and the version is1.0.0.

All Magento 2 module must be registered in the Magento system through the magento ComponentRegistrar class. This file will be placed in module root directory.In this step, we need to create this file:

app/code/Mageplaza/HelloWorld/registration.php

And it’s content for our module is:

\Magento\Framework\Component\ComponentRegistrar::register(    \Magento\Framework\Component\ComponentRegistrar::MODULE,    'Mageplaza_HelloWorld',    __DIR__);

By finish above step, you have created an empty module. Now we will enable it in Magento environment.Before enable the module, we must check to make sure Magento has recognize our module or not by enter the following at the command line:

php bin/magento module:status

If you follow above step, you will see this in the result:

List of disabled modules:Mageplaza_HelloWorld

This means the module has recognized by the system but it is still disabled. Run this command to enable it:

php bin/magento module:enable Mageplaza_HelloWorld

The module has enabled successfully if you saw this result:

The following modules has been enabled:- Mageplaza_HelloWorld

This’s the first time you enable this module so Magento require to check and upgrade module database. We need to run this comment:

php bin/magento setup:upgrade

Now you can check underStores -> Configuration -> Advanced -> Advanced that the module is present.

In the Magento system, a request URL has the following format:

http://example.com/<router_name>/<controller_name>/<action_name>

The Router is used to assign a URL to a corresponding controller and action. In this module, we need to create a route for frontend area. So we need to add this file:

app/code/Mageplaza/HelloWorld/etc/frontend/routes.xml

And content for this file:

<?xml version="1.0"?><config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">    <router>        <route frontName="helloworld">            <module name="Mageplaza_HelloWorld" />        </route>    </router></config>

After define the route, the URL path to our module will be:http://example.com/helloworld/*

In this step, we will create controller and action to displayHello World.Now we will choose the url for this action. Let assume that the url will be:http://example.com/helloworld/index/display

So the file we need to create is:

app/code/Mageplaza/HelloWorld/Controller/Index/Display.php

And we will put this content:

<?phpnamespaceMageplaza\HelloWorld\Controller\Index;class Displayextends \Magento\Framework\App\Action\Action{publicfunction__construct(\Magento\Framework\App\Action\Context$context)  {returnparent::__construct($context);  }publicfunctionexecute()  {echo'Hello World';exit;  }}

If you have followed all above steps, you will seeHello World when open the urlhttp://example.com/helloworld/index/display