8

How do I find out which handles should I use when I want to customize a certain page?

For example, by searching online, I found out that checkout_onepage_index is the handle to modify the Checkout page. I don't know about this magic, but somehow somebody just know it and I want to know how the learn this magic.

<?xml version="1.0"?>
<layout>
    <checkout_onepage_index>
        <reference name="head"></reference>
    </checkout_onepage_index>
</layout>

How do I know what handles if let say I want to modify the success page instead? or the frontend order detail page? etc...?

5

You can add this to your controller action. It will show handles in more neat way than var_dump. Strange that this answer is not already on stack.

Zend_Debug::dump($this->getLayout()->getUpdate()->getHandles());
3

In the simplest case, layout handles represent frontName_controller_action.

So, in your example:

  • frontName is checkout for the Mage_Checkout module (as defined by its config.xml file in the <routers></routers> section).
  • controller is onepage for Mage_Checkout_OnepageController.
  • action is index for Mage_Checkout_OnepageController::indexAction()

Note that this is only the simplest case. Layout handles can be created/added in many other places and ways, such as the catalog logic (PRODUCT_TYPE_x layout handles for different product types).

A good way of finding layout handles to use is to check the files in design/frontend/base/default/layout - this directory stores all of the layout files of the base package/theme, and it has most (if not all) of the out of the box layout handles that you can utilize.

2
  • is frontName_controller_action just a conventions? I believed there are some handles which does not follow these pattern, is it true? – Yeo May 30 '15 at 7:15
  • Yup, that's just a convention for most controllers. And, yes, there are plenty of other layout handles, and you can even add your own. – Agop May 30 '15 at 17:03
3

We wrote down, how the handle is built (and many other things) here:

http://theslidesareonline.de/magento-in-30-minutes-en.pdf

and we wrote down a few layout handles which one should know, like customer_logged_in|out

Custom Action

Layout handle will be build with the NODE name!

<routers>
    <companyModule_frontend>
        <use>standard</use>
        <args>
            <module>Company_Module</module>
            <frontName>frontend</frontName>
        </args>
    </companyModule_frontend>
</routers>

Route: frontend// Layout Handle: companyModule_frontend_controllerName_actionName

Phtandard Layout-Handle

Fit


^ Magento uses only parts of the Layout-XML file, depending on the requested page. These parts are called layout handle. There are a few which are used every time, and others which are belonging to exactly one URL

The most important Layout-Handles which don't belong to a page:

  • (all pages)
  • (customer status)
  • (category w/o LN)
  • (category with LN)
  • (all categories)
  • (product detail page)

Special Layout-Handle

<PRODUCT\_TYPE\_(simple|configurable|grouped|virtual|downloadable|bundle{|giftcard})

Custom Layout handle

Easiest: add one with an observer

public function addMyOwnLayoutHandle(){
    Mage::app()->getLayout()->addHandle('my_own_handle');
}

than you can use in layout XML

<layout>
    <my_own_handle>
2

The convention is made this way because before loading the layout magento first search for the handle with this type of handle,so that it can find the template from the controller.But you can make your own custom handles


public function controllerActionLayoutLoadBefore(Varien_Event_Observer $observer) { /** @var $layout Mage_Core_Model_Layout */ $layout = $observer->getEvent()->getLayout();

        $id = Mage::app()->getRequest()->getParam('id');

        /* or */

        if($ourCoolObject = Mage::registry('our_cool_object'))
        {
            $id = $ourCoolObject->getId();
        }

        $layout->getUpdate()->addHandle('OUR_COOL_OBJECT_'.$id);
    }

By the way there are 5 type of handles briefed below and we are talking about the fourth one here.

default
STORE_bare_us
THEME_frontend_default_default
helloworld_index_index
customer_logged_out

For more info refer

http://alanstorm.com/layouts_blocks_and_templates

1

Magento 2

Quick way to do it is

  1. Go to page in question
  2. Go to page inspector tool in your browser
  3. Check class names on body tag. One of them is going to be the name of a corresponding layout handle.

Remember, body tag class names will typically contain dashes ' - ' as word separators, while the layout handle name you are searching for will have lower dashes ' _ ' instead. So make sure to replace ' - ' with ' _ ' during file search.

Examples:

Home page Magento 2 based home page. Showing classes on body tag in browser inspector tool

Cart page Magento 2 based cart page. Showing classes on body tag in browser inspector tool

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.