How do I create a simple Hello World module in Magento

Question

How can the following be accomplished in Magento?

Display a "Hello World" message using a controller/view/model approach. So, if I went to http://example.com/myController it would show the string 'Hello World'. Being able to show this string within the template of my website (for example, the header, footer, etc.) will be a bonus.
How do I add a method to this controller (or a new controller if necessary), which interacts with a model, and performs the query Select * FROM articles where id='10' and returns the row (containing the columns id, title, content) to the controller? And then use the controller to include a view, which would display this row. So going to http://example.com/myController/show_row (or something similar) would display the row within a view. (No need to be fancy, just a echo $row->id; or something similar would work.)

Any other information about Magento's code structure will also be very helpful.

User · Answer

A Magento Module is a group of directories containing blocks, controllers, helpers, and models that are needed to create a specific store feature. It is the unit of customization in the Magento platform. Magento Modules can be created to perform multiple functions with supporting logic to influence user experience and storefront appearance. It has a life cycle that allows them to be installed, deleted, or disabled. From the perspective of both merchants and extension developers, modules are the central unit of the Magento platform.

Declaration of Module

We have to declare the module by using the configuration file. As Magento 2 search for configuration module in etc directory of the module. So now we will create configuration file module.xml.

The code will look like this:

<?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="Cloudways_Mymodule" setup_version="1.0.0"></module> </config>

Registration of Module The module must be registered in the Magento 2 system by using Magento Component Registrar class. Now we will create the file registration.php in the module root directory:

app/code/Cloudways/Mymodule/registration.php

The Code will look like this:

?php
\Magento\Framework\Component\ComponentRegistrar::register(
\Magento\Framework\Component\ComponentRegistrar::MODULE,
'Cloudways_Mymodule',
__DIR__
);

Check Module Status After following the steps above, we would have created a simple module. Now we are going to check the status of the module and whether it is enabled or disabled by using the following command line:

php bin/magento module:status

php bin/magento module:enable Cloudways_Mymodule

Share your feedback once you have gone through complete process

User · Answer

First and foremost  I highly recommend you buy the PDF E-Book from PHP Architect  It s US 20  but is the only straightforward  Here s how Magento works  resource I ve been able to find  I ve also started writing Magento tutorials at my own website   Second  if you have a choice  and aren t an experienced programmer or don t have access to an experienced programmer  ideally in PHP and Java   pick another cart  Magento is well engineered  but it was engineered to be a shopping cart solution that other programmers can build modules on top of  It was not engineered to be easily understood by people who are smart  but aren t programmers   Third  Magento MVC is very different from the Ruby on Rails  Django  CodeIgniter  CakePHP  etc  MVC model that s popular with PHP developers these days  I think it s based on the Zend model  and the whole thing is very Java OOP-like  There s two controllers you need to be concerned about  The module frontName controller  and then the MVC controller   Fourth  the Magento application itself is built using the same module system you ll be using  so poking around the core code is a useful learning tactic  Also  a lot of what you ll be doing with Magento is overriding existing classes  What I m covering here is creating new functionality  not overriding  Keep this in mind when you re looking at the code samples out there   I m going to start with your first question  showing you how to setup a controller router to respond to a specific URL  This will be a small novel  I might have time later for the model template related topics  but for now  I don t  I will  however  briefly speak to your SQL question   Magento uses an EAV database architecture  Whenever possible  try to use the model objects the system provides to get the information you need  I know it s all there in the SQL tables  but it s best not to think of grabbing data using raw SQL queries  or you ll go mad   Final disclaimer  I ve been using Magento for about two or three weeks  so caveat emptor  This is an exercise to get this straight in my head as much as it is to help Stack nbsp Overflow   Create a module  All additions and customizations to Magento are done through modules  So  the first thing you ll need to do is create a new module  Create an XML file in app modules named as follows  cd  path to store app touch etc modules MyCompanyName HelloWorld xml    lt  xml version  1 0   gt   lt config gt        lt modules gt           lt MyCompanyName HelloWorld gt               lt active gt true lt  active gt               lt codePool gt local lt  codePool gt           lt  MyCompanyName HelloWorld gt        lt  modules gt   lt  config gt    MyCompanyName is a unique namespace for your modifications  it doesn t have to be your company s name  but that the recommended convention my magento  HelloWorld is the name of your module   Clear the application cache  Now that the module file is in place  we ll need to let Magento know about it  and check our work   In the admin application   Go to System- Cache Management Select Refresh from the All Cache menu Click Save Cache settings   Now  we make sure that Magento knows about the module   Go to System- Configuration Click Advanced In the  Disable modules output  setting box  look for your new module named  MyCompanyName HelloWorld    If you can live with the performance slow down  you might want to turn off the application cache while developing learning  Nothing is more frustrating then forgetting the clear out the cache and wondering why your changes aren t showing up   Setup the directory structure  Next  we ll need to setup a directory structure for the module  You won t need all these directories  but there s no harm in setting them all up now   mkdir -p app code local MyCompanyName HelloWorld Block mkdir -p app code local MyCompanyName HelloWorld controllers mkdir -p app code local MyCompanyName HelloWorld Model mkdir -p app code local MyCompanyName HelloWorld Helper mkdir -p app code local MyCompanyName HelloWorld etc mkdir -p app code local MyCompanyName HelloWorld sql   And add a configuration file  touch app code local MyCompanyName HelloWorld etc config xml   and inside the configuration file  add the following  which is essentially a  blank  configuration    lt  xml version  1 0   gt   lt config gt       lt modules gt           lt MyCompanyName HelloWorld gt               lt version gt 0 1 0 lt  version gt           lt  MyCompanyName HelloWorld gt       lt  modules gt   lt  config gt    Oversimplifying things  this configuration file will let you tell Magento what code you want to run   Setting up the router  Next  we need to setup the module s routers  This will let the system know that we re handling any URLs in the form of  http   example com magento index php helloworld   So  in your configuration file  add the following section    lt config gt   lt  --     -- gt       lt frontend gt           lt routers gt               lt  -- the  lt helloworld gt  tagname appears to be arbitrary  but by             convention is should match the frontName tag below-- gt               lt helloworld gt                   lt use gt standard lt  use gt                   lt args gt                       lt module gt MyCompanyName HelloWorld lt  module gt                       lt frontName gt helloworld lt  frontName gt                   lt  args gt               lt  helloworld gt           lt  routers gt       lt  frontend gt   lt  --     -- gt   lt  config gt    What you re saying here is  any URL with the frontName of helloworld      http   example com magento index php helloworld   should use the frontName controller MyCompanyName HelloWorld    So  with the above configuration in place  when you load the helloworld page above  you ll get a 404 page  That s because we haven t created a file for our controller  Let s do that now   touch app code local MyCompanyName HelloWorld controllers IndexController php   Now try loading the page  Progress  Instead of a 404  you ll get a PHP Magento exception  Controller file was loaded but class does not exist   So  open the file we just created  and paste in the following code  The name of the class needs to be based on the name you provided in your router    lt  php class MyCompanyName HelloWorld IndexController extends Mage Core Controller Front Action      public function indexAction            echo  We re echoing just to show that this is what s called  normally you d have some kind of redirect going on here             What we ve just setup is the module frontName controller   This is the default controller and the default action of the module  If you want to add controllers or actions  you have to remember that the tree first part of a Magento URL are immutable they will always go this way http   example com magento index php frontName controllerName actionName  So if you want to match this url  http   example com magento index php helloworld foo   You will have to have a FooController  which you can do this way    touch app code local MyCompanyName HelloWorld controllers FooController php    lt  php class MyCompanyName HelloWorld FooController extends Mage Core Controller Front Action      public function indexAction            echo  Foo Index Action              public function addAction            echo  Foo add Action              public function deleteAction            echo  Foo delete Action             Please note that the default controller IndexController and the default action indexAction can by implicit but have to be explicit if something come after it  So http   example com magento index php helloworld foo will match the controller FooController and the action indexAction and NOT the action fooAction of the IndexController  If you want to have a fooAction  in the controller IndexController you then have to call this controller explicitly like this way   http   example com magento index php helloworld index foo because the second part of the url is and will always be the controllerName  This behaviour is an inheritance of the Zend Framework bundled in Magento   You should now be able to hit the following URLs and see the results of your echo statements  http   example com magento index php helloworld foo http   example com magento index php helloworld foo add http   example com magento index php helloworld foo delete   So  that should give you a basic idea on how Magento dispatches to a controller  From here I d recommended poking at the existing Magento controller classes to see how models and the template layout system should be used

User · Answer

And    I suggest you to learn about system configuration   How to Show All Categories on System Configuration Field   Here I solved with a good example  It working  You can check and learn the flow of code   There are other too many examples also that you should learn

User · Answer

I ve been wrestling with Magento for the last month or so and I m still trying to figure it out  So this is a case of the blind leading the blind  There s little in the way of documentation and the forum wiki is chaotic at best  Not only that  but there are several solutions that are either outdated or far from optimal  I m not sure if you have a project or just trying to figure it out  but it s probably easier if you started with modifying existing functionality as opposed to creating something completely new  For that I d definately go with the  Recommended articles for developers  in the wiki  The new payment method one was a real eye-opener   For debugging I d definitely recommend using FirePHP and looking at your HTML source  when something goes wrong  The ole echo debug method doesn t really work all that well   The general architecture is so mind-numbingly complex  that even if I completely understood it  I d need to write a book to cover it  The best I can do is give you advice I wish someone had given me when I first started     Stay away from core files  Don t modify them  instead write your own module and override what you need   Magento uses config files consisting of XML to decide what it needs to do  In order to get it to run your own stuff as opposed to core functionality you need the correct xml  Unfortunately there is no guide on how to build you XML  you need to look at examples and do some serious testing  To complicate things the content of these files is largely case-sensitive  However if you master these you can override any part of the basic functionality which makes for a very powerful system   Magento uses methods like Mage  getModel  mymodel    Mage  getSingleton  mysingleton    Mage  helper  myhelper   to return objects of certain classes  It finds these by default in its core namespace  If you want it to use your own  you need to override these in your config xml file   The name of your classes must correspond to the folder they re in   A lot of the objects in Magento ultimately extend something called a Varien Object  This is a general purpose class  kind of like a swiss army knife  and its purpose in life is to allow you to define your own methods variables on the fly  For example you ll see it used as a glorified array to pass data from one method to another    During development make sure you caching is disabled  It ll make magento excruciatingly slow  but it ll save you a lot of head trauma  from banging it on your desk    You ll see  this being used a lot  It means a different class depending on what file you see it  get class  this  is your friend  especially in conjunction with FirePHP   Jot things down on paper  A lot  There are countless little factoids that you re gonna need 1-2 days after you encounter them   Magento loves OO  Don t be surprised if tracing a method takes you through 5-10 different classes   Read the designer s guide here  It s meant mostly for graphics designers  but you need it to understand where and why the output from your module will end up  For that don t forget to turn on  Template path hints  in the developer section of the admin panel   There s more  but I ll stop here before this turns into a dissertation

User · Answer

I will rather recommend Mage2Gen  this will help you generate the boilerplate and you can just focus on the core business logic  it just helps speed up the things

User · Answer

I was trying to make my module from magaplaza hello world tutorial, but something went wrong. I imported code of this module https://github.com/astorm/magento2-hello-world from github and it worked. from that module, i created it a categories subcategories ajax select drop downs Module. After installing it in aap/code directory of your magento2 installation follow this URL.. http://www.example.com/hello_mvvm/hello/world You can download its code from here https://github.com/sanaullahAhmad/Magento2_cat_subcat_ajax_select_dropdowns and place it in your aap/code folder. than run these commands...

php bin/magento setup:update
php bin/magento setup:static-content:deploy -f
php bin/magento c:c

Now you can check module functionality with following URL http://{{www.example.com}}/hello_mvvm/hello/world

[php] How do I create a simple 'Hello World' module in Magento?

The answer is

Examples related to php

Examples related to magento

Examples related to controller

Examples related to magento-1.9

Tags