Home » Magento Extensions » Create new simple magento module “HelloWorld” in Magento

Create new simple magento module “HelloWorld” in Magento

Do you want to create a new page in Magento yourself ? or Do you want to create a new module in Magento yourself ? If yes, Then ok, just spend 10 minutes and follow the steps below .

Objectives: I will create a new page in Magento whose output will be “Hello World ! I am a Magento Guy..”.

Target: Create a new module called “HelloWorld”

Step 1: Module Declaration

Create app/etc/modules/M4U_HelloWorld.xml and write below code

<?xml version="1.0"?>
<config>
         <modules>
                <M4U_HelloWorld>
                        <active>true</active>
                        <codePool>local</codePool>
                </M4U_HelloWorld>
         </modules>
</config>

<?xml version="1.0"?>

<M4U_HelloWorld>

<codePool>local</codePool>

</M4U_HelloWorld>

</modules>

</config>

Step 2: Module Configuration

a. Create a controller class app/code/local/M4U/HelloWorld/controllers/IndexController.php

class M4U_HelloWorld_IndexController extends Mage_Core_Controller_Front_Action
{
    public function indexAction()
    {
     $this->loadLayout(array('default'));
     $this->renderLayout();
    }
}

class M4U_HelloWorld_IndexController extends Mage_Core_Controller_Front_Action

{

public function indexAction()

{

$this->loadLayout(array('default'));

$this->renderLayout();

}

b. Create a Block class app/code/local/M4U/HelloWorld/Block/HelloWorld.php

class M4U_HelloWorld_Block_HelloWorld extends Mage_Core_Block_Template
{
  // necessary methods
}

class M4U_HelloWorld_Block_HelloWorld extends Mage_Core_Block_Template

{

// necessary methods

}

c. create configuration xml in app/code/local/M4U/HelloWorld/etc/config.xml

<?xml version="1.0"?>
<config>
    <global>
        <modules>
                <m4u_helloworld>
                        <version>0.1.0</version>
                </m4u_helloworld>
        </modules>
    <blocks>
            <helloworld>
                <rewrite>
         <helloworld>M4U_HelloWorld_Block_HelloWorld</helloworld>
        </rewrite>
            </helloworld>
     </blocks>
 
        </global>
       <frontend>
                <routers>
                        <helloworld>
                                <use>standard</use>
                                <args>
                                      <module>M4U_HelloWorld</module>
                                      <frontName>helloworld</frontName>
                                </args>
                        </helloworld>
                </routers>
        <layout>
            <updates>
                <helloworld>
                      <file>helloworld.xml</file>
                </helloworld>
            </updates>
            </layout>
        </frontend>
</config>

<?xml version="1.0"?>

<m4u_helloworld>

</m4u_helloworld>

</modules>

<helloworld>M4U_HelloWorld_Block_HelloWorld</helloworld>

</rewrite>

</helloworld>

</blocks>

</global>

<use>standard</use>

<args>

<module>M4U_HelloWorld</module>

<frontName>helloworld</frontName>

</args>

</helloworld>

</routers>

<file>helloworld.xml</file>

</helloworld>

</updates>

</layout>

</frontend>

</config>

Define Frontend Template :

1. Define page layout in app/design/frontend/M4U/default/layout/helloworld.xml

N.B: Use default instead of M4U as template location if you use default design packages. Means create file inapp/design/frontend/default/default/layout/helloworld.xml

<?xml version="1.0"?>
 
    <layout version="0.1.0">
 
        <helloworld_index_index>
            <reference name="root">
                <action method="setTemplate"><template>page/1column.phtml</template></action>
            </reference>
            <reference name="content">
                <block type="helloworld/helloworld" name="hello" template="helloworld/helloworld.phtml"/>
            </reference>
        </helloworld_index_index>
 
    </layout>

<?xml version="1.0"?>

<helloworld_index_index>

<action method="setTemplate"><template>page/1column.phtml</template></action>

</reference>

</reference>

</helloworld_index_index>

</layout>

2. Create template file app/design/frontend/M4U/default/template/helloworld/helloworld.phtml and write down

N.B: Use default instead of M4U as template location if you use default design packages. Means create file in app/design/frontend/default/default/template/helloworld/helloworld.phtml

Hello World ! I am a Magento Guy..

Hey, new module is ready to run and hit browser with urlhttp://127.0.0.1/projectname/index.php/helloworld/

and see result.

That’s it……..

Is it easy or not ? what you think ?

Coder, Please at first try yourself.

About Brian Wilson

Brian is a freelance Magento developer with 5 years of experience with customizing Magento extensions, magento themes. He's interested in sharing Magento Tutorials to the community

20 comments

younsu cha
March 31, 2017 at 6:43 am

where is helloworld.phtml??

Reply
Remya
September 17, 2015 at 7:51 pm

Hello

I am using magneto 1.9 and have tried zillion times.Module is not working at my end.
i have cleared cache and everything. Still not helping.

Reply
Dhaval
July 15, 2015 at 8:33 am

Hello World not display in front-end in magento..all folder and sub-folder are create and create file in specific folder…please help me…

Reply
Fuad Abdul Jabbar
July 8, 2015 at 12:07 pm

Please Check your path… that code use default (base) layout directory. So move your layout to directory

Here is directory structure for the module -

\app\etc\modules\Company_Web.xml

\app\code\local\Company\Web\etc\config.xml

\app\code\local\Company\Web\controllers\IndexController.php

\app\design\frontend\base\default\layout\web.xml

\app\design\frontend\base\default\template\web\web.phtml

Fuad Abdul Jabbar
fuad_abd_jabbar@yahoo.co.id

Reply
sam
January 29, 2015 at 10:28 am

hello Brian

If you could help me in packaging this magento module to make extension it will be appreciated. thank you

Reply
- Brian Wilson
  January 30, 2015 at 10:35 am
  
  Hi Sam,
  I have an undated version of this tutorial, it includes the modules files, you can find it here. http://tutorialmagento.com/step-by-step-how-to-create-hello-world-basic-module-in-magento
  Hope this helps
  
  Reply
Burning question
December 9, 2014 at 2:41 pm

I followed your instructions to the letter, im using magento version 1.9.1.0, and i cant get the module to display, it’s listed in advanced tab for disabling or enabling(it’s enabled) but it’s not showing.

Any advice?

Thanks.

Reply
- code78
  January 2, 2015 at 12:00 am
  
  I’m using 1.9 and made copy pasted directly from here to files just to test this but it just does not work… Examples for php files are missing but not working anyways … result is always :
  
  Whoops, our bad…
  
  The page you requested was not found, and we have a fine guess why.
  
  If you typed the URL directly, please make sure the spelling is correct.
  If you clicked on a link to get here, the link is outdated.
  
  Need to take a look when more fresh
  
  Reply
Ian Herzog
September 11, 2014 at 12:36 pm

I got it working when I go to http://www.mysite.com/frontname

If I want to have this module appear in the content section of the product view page what do I need to add/change?

I tried adding another node to the layout xml file and changed to but that didn’t work. What am I missing?

Reply
Neeraj
August 6, 2014 at 10:56 am

Does it works on magento 1.9.0.1 version?

Reply
- Yagendra
  August 25, 2014 at 5:15 am
  
  Yes, This Will Work in 1.9.0.1 version….
  
  Reply
- Ta Duc
  February 9, 2015 at 6:40 pm
  
  You have to refresh your cache data
  
  Reply
Srinivas
July 23, 2014 at 5:43 am

Hello Brian,

It took little more than your 10min to get this working as i am new to magento and php, but this is shortest and best tutorial i have found.

Thanks you very much it cut short my learning time.

cheers,
Srinivas

Reply
- Brian Wilson
  July 24, 2014 at 7:45 am
  
  Hi Srinivas, It’s great to know that my article helps you out!
  
  Reply
Sony AK
July 5, 2014 at 7:21 am

Hi Brian,
Still confusing for me. I am using Magento 1.9.0.1 and I am looking a super simple tutorial to create blank template and become a home page.

E.g I have this:

Hellow World!

and I want use this fucking super simple layout to become my home page layout on Magento 1.9.0.1 to display nothing.

please help

Reply
- Brian Wilson
  July 5, 2014 at 1:22 pm
  
  Hi, regarding template, you may follow this series
  http://tutorialmagento.com/magento-theme-development-tutorial-for-designer-part-1
  Hope this helps
  
  Reply
  - Sony AK
    July 7, 2014 at 3:02 am
    
    Thanks Brian Will read that…
    
    Reply
Robert
May 19, 2014 at 2:34 pm

Does not work. Shows 404.

Reply
- Hello
  May 30, 2014 at 7:03 am
  
  clear catch and check again…………..its work perfect
  
  Reply
- Ripping my Hair Out
  July 22, 2014 at 8:03 pm
  
  Does not work, tried this and Alan Storms tutorial on Hello World. I’m not sure why. The tutorial probably works, but I think there is some setting on my site that is stopping this! AHHHHHHHHHHHH I HATE MAGENTO SOMETIMES
  
  Reply