Override/Rewrite Magento core blocks and controllers

<?xml version="1.0"?>

<config>

    <modules>

        <CompanyName_Adminhtml>

            <active>true</active>

            <codePool>local</codePool>

        </CompanyName_Adminhtml>

    </modules>

</config>

<?xml version="1.0"?>

<config>

    <modules>

        <CompanyName_Adminhtml>

            <version>0.1.0</version>

        </CompanyName_Adminhtml>

    </modules>

    <global>

    <blocks>

        <adminhtml>

            <rewrite>

                <sales_shipment_grid>CompanyName_Adminhtml_Block_Sales_Shipment_Grid</sales_shipment_grid>

            </rewrite>

        </adminhtml>

    </blocks>

    <routers>

            <adminhtml>

           <rewrite>

                  <sales_shipment>

                      <from><![CDATA[#^/admin/sales_shipment/$#]]></from>

                      <to>/admin/sales_shipment/</to>

                  </sales_shipment>

            </rewrite>

       </adminhtml>

        </routers>

   </global>

    <admin>

        <routers>

            <adminhtml>

                <args>

                    <modules>

                        <CompanyName_Adminhtml before="Mage_Adminhtml">CompanyName_Adminhtml</CompanyName_Adminhtml>

                    </modules>

                </args>

            </adminhtml>

        </routers>

    </admin>

</config>

require_once("Mage/Adminhtml/controllers/Sales/ShipmentController.php");

class CompanyName_Adminhtml_Sales_ShipmentController extends Mage_Adminhtml_Sales_ShipmentController

{

  //controller methods goes here..

}

class CompanyName_Adminhtml_Block_Sales_Shipment_Grid extends Mage_Adminhtml_Block_Widget_Grid

{

  // block methods goes here..

}

25 Comments

• 
  Sharee Luthe November 25, 2011 at 11:48 pm

  Cool resource! Thanks for creating it. Keep going that way.

  Reply
• 
  Pauline January 16, 2012 at 3:11 am

  Love the blog

  Reply
• 
  Amit Maurya January 25, 2013 at 5:33 am

  Hey Kalpesh,

  Buddy, I want to make ordercontroller.php over ride of the admin panel.
  path is app/code/core/Mage/Adminhtml/controllers/sales/OrderController.php….

  Blocks are working fine but controller is not working … please post the solution as soon as possible.

  Thanks,
  Amit Maurya

  Reply
  • 
    kalpesh January 25, 2013 at 6:37 am

    Hi Amit, use this code in your custom module’s config.xml file:

    	<admin>
    	<routers>
    	<adminhtml>
    	<args>
    	<modules>
    	<Mymodule_Adminhtml before="Mage_Adminhtml">Mymodule_Adminhtml</Mymodule_Adminhtml>
    	</modules>
    	</args>
    	</adminhtml>
    	</routers>
    	</admin>

    Reply
• 
  Amit Maurya January 25, 2013 at 12:02 pm

  Hey kalpesh,

  Dude this controller is not loading…. can you fix this..

  Thanks for posting buddy

  Amit Maurya

  Reply
• 
  Merk February 27, 2013 at 7:32 am

  You just helped me with a extension i am working on thanks bro.

  Reply
• 
  Hardik March 2, 2013 at 10:11 am

  great work..

  Reply
• 
  SU July 18, 2013 at 10:25 am

  I want to override Mage/Adminhtml/controllers/Sales/OrderController.php. My module is app/code/local/MW/Adminhtml.

  In my config.xml I have put the following code.

  	<config>
  	<!-- Other configuration stuff -->
  	<admin>
  	<routers>
  	<adminhtml>
  	<args>
  	<modules>
  	<MW_Adminhtml before="Mage_Adminhtml">MW_Adminhtml</MW_Adminhtml>
  	</modules>
  	</args>
  	</adminhtml>
  	</routers>
  	</admin>
  	</config>

  controller is as follows.

  	require_once 'Mage/Adminhtml/controllers/Sales/OrderController.php';
  	class MW_Adminhtml_Sales_OrderController extends Mage_Adminhtml_Sales_OrderController
  	{
  	/*
  	some code
  	*/
  	}

  But still it loads the core controller class. What am I doing wrong here? Any help would be appreciated.

  EDITED by kalpesh.. for formatting the code

  Reply
  • 
    kalpesh July 19, 2013 at 11:45 am

    Your code seems fine. The next thing I would do is clear the cache, Mage::log(__FILE__) on the top of MW/Adminhtml/controllers/Sales/OrderController.php file to check if the file is getting called or not AND check the app/etc/modules/MW_Adminhtml.xml file to make sure the module is active. Also please check the path of your module, it should be app/code/local/MW/Adminhtml/controllers/Sales/OrderController.php and app/code/local/MW/Adminhtml/etc/config.xml

    Reply
    • 
      SU July 19, 2013 at 11:55 am

      I checked all the ways you mentioned. Then I removed all the things and created a new module and continued the same developing strategy. Now it works fine. I’m not sure what was missing in my code. Thank you so much Kalpesh. You are doing a great work. keep it up

      Reply
      • 
        kalpesh July 19, 2013 at 12:01 pm

        Glad to hear it worked for you!

        Reply
    • 
      yuva December 17, 2016 at 5:05 am

      I want to override Mage/Adminhtml/controllers/Sales/OrderController.php. My module is app/code/local/Globalecom/Ordercomment

      This is my config.xml
      app/code/local/Globalecom/Ordercomment/etc/config.xml

      Globalecom_OrderComment

      this is my controller file
      app/code/local/Globalecom/OrderComment/controllers/Sales/OrderController.php
      require_once ‘Mage/Adminhtml/controllers/Sales/OrderController.php’;
      class Globalecom_OrderComment_Sales_OrderController extends Mage_Adminhtml_Sales_OrderController
      {

      public function addCommentAction(){
      ……

      // get the login info of current user
      $_user = Mage::getSingleton(‘admin/session’);
      $user[’email’] = $_user->getUser()->getEmail();
      $user[‘firstname’] = $_user->getUser()->getFirstname();
      $user[‘lastname’] = $_user->getUser()->getLastname();

      $order->addStatusHistoryComment($data[‘comment’] . ” Added by {$user[‘firstname’]}”, $data[‘status’])
      ->setIsVisibleOnFront($visible)
      ->setIsCustomerNotified($notify);
      }
      }

      Kindly check it out

      Reply
  • 
    kalpesh July 19, 2013 at 11:51 am

    I would also check if Mage_Adminhtml is not overriden by other module as well. PHP, and hence Magento, doesn’t support Multiple Inheritance. So you may need to extend the module which is already overriding the Mage_Adminhtml module in order to get this work.

    Reply
    • 
      SU July 23, 2013 at 5:42 am

      Hi,
      It means if we want want to override an already overridden class, we need to extend the overriden class instead of core file.
      Eg:
      class A
      {
      // This is the core class
      }
      class B extends A
      {
      }
      If class C need to override class A
      it should be
      class C extends B
      {
      }

      right?

      Reply
      • 
        kalpesh July 23, 2013 at 1:23 pm

        yes you are right.

        Reply
• 
  kalpesh July 18, 2013 at 12:37 pm

  please put your XML code inside { code } tag. { code }the outer tags should be without spaces{ / code } .. E.g.

  this is code

  Reply
  • 
    SU July 19, 2013 at 3:54 am

    Sry Kalpesh,

    I tried to put the code here. But it’s not showing. I’ll put a mail to you.
    Thank you

    Reply
    • 
      kalpesh July 19, 2013 at 11:40 am

      Hi. I have edited your comment to format the code properly.

      Reply
      • 
        SU July 19, 2013 at 11:42 am

        Hi Kalpesh,

        Thank you for your response. I can’t figure out what am I doing wrong here? Can you point it out?

        Reply
• 
  preet December 24, 2015 at 6:58 am

  Fatal error: Call to a member function updateBackButtonUrl() on a non-object in /var/www/html/shipping/app/code/core/Mage/Adminhtml/controllers/Sales/Order/ShipmentController.php on line 135

  I want to override the sales_order_shipment_view.

  Please let me know how can I do this . It is really urgent.

  please help me.

  Reply
  • 
    kalpesh December 24, 2015 at 7:05 am

    To override sales_order_shipment_view block, I think you should instead do like this in your local module’s config.xml file (replace Namespace_Module_Block_Adminhtml_Shipment_View with your local module file path):

    	<blocks>
    	<adminhtml>
    	<rewrite>
    	<sales_order_shipment_view>Namespace_Module_Block_Adminhtml_Sales_Order_Shipment_View</sales_order_shipment_view>
    	</rewrite>
    	</adminhtml>
    	</blocks>

    Reply
    • 
      preet December 28, 2015 at 6:28 am

      hello kalpesh please help me, It is not working on my end , please check it and let me know how to solve this issue.

      Its very urgent!!!!

      Waiting for your reply…

      Reply
• 
  preet December 25, 2015 at 6:45 am

  config.xml

  0.1.0

  CompanyName_Adminhtml_Block_Adminhtml_Sales_Order_Shipment_View

  /admin/sales_shipment/

  CompanyName_Adminhtml

  app/code/local/CompanyName/Adminhtml/Block/Adminhtml/Sales/Order/Shipment/View.php

  <?php
  class CompanyName_Adminhtml_Block_Adminhtml_Sales_Order_Shipment_View extends Mage_Adminhtml_Block_Widget_Form_Container
  {
  // die("CompanyName_Adminhtml_Block_Sales_Shipment_Grid");
  }

  app/code/local/CompanyName/Adminhtml/controllers/Sales/ShipmentController.php
  <?php
  require_once("Mage/Adminhtml/controllers/Sales/ShipmentController.php");
  class CompanyName_Adminhtml_Sales_ShipmentController extends Mage_Adminhtml_Sales_ShipmentController
  {
  //controller methods goes here..
  }

  But still getting following error

  Fatal error: Call to a member function updateBackButtonUrl() on a non-object in /app/code/core/Mage/Adminhtml/controllers/Sales/Order/ShipmentController.php on line 135

  Reply
• 
  preet December 25, 2015 at 6:46 am

  config.xml

  0.1.0

  CompanyName_Adminhtml_Block_Adminhtml_Sales_Order_Shipment_View

  /admin/sales_shipment/

  CompanyName_Adminhtml

  Reply
  • 
    preet December 25, 2015 at 6:47 am

    ”

    0.1.0

    <!–

    CompanyName_Adminhtml_Block_Sales_Shipment_Grid

    –>

    CompanyName_Adminhtml_Block_Adminhtml_Sales_Order_Shipment_View

    /admin/sales_shipment/

    CompanyName_Adminhtml

    “

    Reply