Mageplaza - Best of Magento 2 Extensions Store

Magento 2 Reward Points Magento 2 Search Magento 2 Gift Card Magento 2 FAQ
1 2 3 4

Magento 2 Module Development - Magento 2 Hello World Module

Magento 2 Module development or Magento 2 Hello World module trends is increasing rapidly while Magento release official version. That why we - Mageplaza - are wrong about a topic that introduces how to create a simple Hello World module in Magento 2
Magento 2 Module Development

As you know, the module is a directory that contains,blocks, controllers, models, helper etc - that are related to a specific business feature. In Magento 2, modules will be live in the app/codedirectory of a Magento installation, with this format:.app/code/<Vendor>/<ModuleName> Now we will follow this steps to create a simple module which works on Magento 2 and display.Hello World

Magento 2 Hello World module by Mageplaza.com

  • 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.

Step 1. Create a directory for the module like above format.

In this module, we will use forMageplaza Vendor name and forHelloWorld ModuleName. So we need to make this folder: app/code/Mageplaza/HelloWorld

Step 2. Declare module by using configuration file module.xml

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 of this file:
<?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="Mageplaza_HelloWorld" setup_version="1.0.0" />
</config>
In this file, we register a module with name andMageplaza_HelloWorld the version is.1.0.0

Step 3. Register module by registration.php

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__
);

Step 4. Enable the module

By finish above step, you have created an empty module. Now we will enable it in Magento environment. Before enabling the module, we must check to make sure Magento has recognized our module or not by entering 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 requires to check and upgrade module database. We need to run this comment:
php bin/magento setup:upgrade
Now you can check under thatStores -> Configuration -> Advanced -> Advanced the module is present.

Step 5. Create a Routers for the module.

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 id="standard">
        <route id="mageplaza" frontName="helloworld">
            <module name="Mageplaza_HelloWorld" />
        </route>
    </router>
</config>
After defining the route, the URL path to our module will be: http://example.com/helloworld/*

Step 6. Create controller and action.

In this step, we will create controller and action to display.Hello 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/Index/Display.php
And we will put this content:
<?php
namespace Mageplaza\HelloWorld\Controller\Index;

class Display extends \Magento\Framework\App\Action\Action
{
  public function __construct(
\Magento\Framework\App\Action\Context $context)
  {
    return parent::__construct($context);
  }

  public function execute()
  {
    echo 'Hello World';
    exit;
  }
}
If you have followed all above steps, you will see Hello World when opening the URL http://example.com/helloworld/index/display
Previous
Next Post »