I want to know how to use layout.xml with event observer.

I want to show a message in footer when payment made successfully.

I know I have to use the event checkout_onepage_controller_success_action

How to use controller or layout.xml with event observer?

1 Answer 1


The event checkout_onepage_controller_success_action is triggered right before the layout is rendered, so you can still manipulate it.

The observer only receives the order id as a parameter, so you have to get the layout via app model:

$layout = Mage::app()->getLayout();

Now you can do your changes programmatically, like this:

$messageBlock = $layout->createBlock('core/template', 'payment_message_block');

If you use the controller_action_layout_load_before event, you can also load a custom layout handle like this, if on the success page:

if ($observer->getAction()->getFullActionName() === 'checkout_onepage_success') {
    $layout = $observer->getLayout();

which you can define in XML:

     <reference name="footer">
       <block type="core/template" name="payment_message_block" template="payment_message.phtml" />

Update: The footer block is cached, so we have to make sure that a different version is fetched from the cache if the message is present. For example:

$footer = $layout->getBlock('footer');
$footer->setCacheKey(sha1($footer->getCacheKey() . '-payment-message');

how to pass genrated data to phtml file? which i am showing

Reference your block by name and use setData(). For example:

$block = $layout->getBlock('payment_message_block')->setData('messsage', 'Hello');

And in the template:

echo $this->getData('message');
  • 1
    I'm not sure this works for the footer block. It would work for almost any other block, but when the cache is enabled, the footer is cached and it might not display the message.
    – Marius
    Commented Jan 27, 2016 at 11:20
  • Good point @Marius, if possible I'd try to use before_body_end which is not cached Commented Jan 27, 2016 at 11:25
  • Yep, that should work.
    – Marius
    Commented Jan 27, 2016 at 11:27
  • If it must be in footer for design reasons, I added a solution that changes the cache key. Commented Jan 27, 2016 at 11:30
  • that is why i am also confused because in layout nothing mention related to observer. which i was find before submit question here Commented Jan 27, 2016 at 11:51

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

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