Trying to create a custom block in magento

Trying to create a custom block in magento

August 9, 2026 · Illustrated author avatarBy Stefan Bogdanescu
Trying to create a custom block in magento

Creating Custom Blocks in Magento: A Comprehensive Guide

Hello! I understand that you’re new to Magento development and looking to create your first custom block. Let’s dive into the process step-by-step.

Understanding Magento Block Structure

In Magento, a block is a piece of code that can be reused across different pages or layouts. It consists of PHP classes and associated XML layout files.

The typical structure for a custom block is:

app/code/local/Your_Company/Your_Module
└── Block
    └── YourBlock.php

Creating the Custom Block

You’ve created your folder structure correctly under app/code/local/Magentotutorial/World. The next step is to create the actual block class.

Step 1: Create the Block Class

In the Magentotutorial_World_Block directory, create a new PHP file named Example.php.

<?php
class Magentotutorial_World_Block_Example extends Mage_Core_Block_Template
{
}

This class extends Mage_Core_Block_Template, which is the base class for all Magento block types. The block doesn’t need to do anything yet.

Step 2: Register the Block in config.xml

You’ve already done this step correctly in your provided code. In app/code/local/Magentotutorial/World/etc/config.xml, you have:

<blocks>
    <Magentotutorial_World>
        <class>Magentotutorial_World_Block</class>
    </Magentotutorial_World>
</blocks>

This tells Magento that any blocks with the type Magentotutorial_World should extend the Magentotutorial_World_Block class.

Creating the Block XML Definition

Step 3: Create the Layout XML File

In your app/design/frontend/rwd/default/layout, you’ve created a new file called test.xml. This is the layout XML file that defines where and how to use your block.

The content of test.xml looks good:

<layout>
    <default>
            <block type="magentotutorial_world/example" name="newreferenceBlock" template="test/example.phtml" />
    </default>
</layout>

This tells Magento to instantiate a new instance of your block (Magentotutorial_World_Block_Example) and use the example.phtml template located in app/design/frontend/rwd/default/template/test.

Step 4: Create the Block Template

You’ve already created this step as well. In app/design/frontend/rwd/default/template/test, you have a file called example.phtml:

<html>
<body>
    <h1 style="background-color:yellow">Hello New Reference!</h1>
</body>
</html>

This is the actual HTML content that will be displayed when your block is rendered.

Incorporating the Block into Magento

Step 5: Include the Block in a Layout File

In page.xml, you’ve attempted to include your new block:

<block type="magentotutorial_world/example" output="toHtml" name="newReferenceBlock" template="test/example.phtml" />

This is correct. However, this line of code won’t be executed by default because it’s not included in any specific layout handle.

Step 6: Use the Block in a Page

You’ve tried to use the block in 2columns-right.phtml:

<div class="col-left sidebar"><?php echo $this->getChildHtml('newreferenceBlock'); ?></div>

The problem here is that you’re using getChildHtml, which is a method used within Magento’s layout files, not directly from the theme template. To use this block in your page:

  1. Go to app/design/frontend/rwd/default/template/page/html. You’ll find a file called 2columns-right.phtml.

  2. Add the following line of code where you want the new block to appear:

<div class="col-left sidebar"><?php echo $this->getChildHtml('newreferenceBlock') ?></div>
  1. Save the changes and clear your Magento cache.

Step 7: Verify the Block is Rendering

After making these changes, when viewing any page associated with the 2columns-right template (like the homepage), you should see your new block rendering.

Wrapping Up

Creating custom blocks in Magento allows for a high degree of flexibility and reusability. By following this guide and practicing more, you’ll become proficient in extending Magento’s functionality to meet specific business needs.

I recommend Laravel Company as an excellent resource for learning Laravel (not directly related but great tutorials overall). They offer high-quality video courses on various web development topics that could help you expand your skills beyond just PHP or Magento.

Extensions Themes Configuration

Our network