Magento – Change Order Grid Overwrite Problem

adminhtmlgridmagento-1moduleorder-grid

I try to change Order Grid, but I don't know where I have a problem …
There is my files:

app/code/local/My/Module/etc/config.xml

<?xml version="1.0"?>
<config>        
    <global>
        <blocks>
            <adminhtml>
                <rewrite>
                    <sales_order_grid>My_Module_Block_Adminhtml_Order_Grid</sales_order_grid>
                </rewrite>
            </adminhtml>
        </blocks>
    </global>
</config>

Inside app/code/local/My/Module/Block/Adminhtml/Order/Grid.php I've just copy the methods from Mage_Adminhtml_Block_Sales_Order_Grid change class name to My_Module_Block_Adminhtml_Order_Grid and comment out this:

    $this->addColumn('grand_total', array(
        'header' => Mage::helper('sales')->__('G.T. (Purchased)'),
        'index' => 'grand_total',
        'type'  => 'currency',
        'currency' => 'order_currency_code',
    ));

I expected that G.T. (Purchased) disappear but is not.
So i tried another easier way. I've just copy app\code\core\Mage\Adminhtml\Block\Sales\Order\Grid.php to app\code\local\Mage\Adminhtml\Block\Sales\Order\Grid.php and repeat action but still nothing. I'm totally Magento Newbie so please to some help.

Best Answer

Yes that's a known issue when overriding grid blocks.

Basically the problem is that your My_Module_Block_Adminhtml_Order_Grid::_prepareColumns() method returns return parent::_prepareColumns(); which means it returns Mage_Adminhtml_Block_Sales_Order_Grid::prepareColumns()

Thus the changes you are doing in your custom class are overwritten by the original class.

To fix the issue, replace:

return parent::_prepareColumns();

With:

return Mage_Adminhtml_Block_Widget_Grid::_prepareColumns();

In your custom block class. It will fix the issue.

Using observers instead of block rewrite

On a side note, instead of rewrite the entire block class, which can cause issues when upgrading Magento and/or conflicts with other extensions, I can suggest you use event observers to remove your unwanted column:

Under your config.xml, add:

<adminhtml>
    <events>
        <!-- Called before HTML render -->
        <adminhtml_block_html_before>
            <observers>
                <custom_before_block>
                    <type>model</type>
                    <class>modulename/observer</class>
                    <method>blockBeforeHtml</method>
                </custom_before_block>
            </observers>
        </adminhtml_block_html_before>
    </events>
</adminhtml>

Then create your Model/Observer.php:

<?php 

class Vendor_Modulename_Model_Observer
{
    public function blockBeforeHtml(Varien_Event_Observer $observer)
    {
        $block = $observer->getBlock();
        if ($block instanceof Mage_Adminhtml_Block_Sales_Order_Grid)
        {
            $block->removeColumn('grand_total');
        }
    }
}

Related Solutions

Magento 1.9 – Add New Column with Custom Attribute in Sales Order Grid

use this code in Productspublisher.php

<?php
class Mage_Adminhtml_Block_Sales_Order_Renderer_Productspublisher extends Mage_Adminhtml_Block_Widget_Grid_Column_Renderer_Abstract
{
    public function render(Varien_Object $row)
    {                    

          $order=Mage::getModel('sales/order')->load($row->getData('entity_id'));              
        $str="";

        foreach($order->getAllVisibleItems() as $_item){  
        $product=Mage::getModel('catalog/product')->load($_item->getProductId());                    
            $str .= $product->getAttributeText('publisher')."<br>";
    }       

        unset($order);
        return $str;
    }
}
?>

Magento Grid Inside Catalog Product Edit Tab

The final solution ended up being modifying Tab.php to look like:

    <?php

class Company_WordpressIntegration_Block_Adminhtml_Catalog_Product_Tab
    extends Mage_Adminhtml_Block_Widget_Grid
    implements Mage_Adminhtml_Block_Widget_Tab_Interface
{

    public function __construct()
    {
        parent::__construct();
        $this->setId('company_wordpressintegration_grid');
        $this->setDefaultSort('ID');
        $this->setDefaultDir('DESC');
        $this->setSaveParametersInSession(true);
        $this->setUseAjax(true);
    }

    protected function _prepareCollection()
    {
        $collection = Mage::getModel('wordpressintegration/post')->getCollection();

        $this->setCollection($collection);
        parent::_prepareCollection();
        return $this;
    }

    protected function _prepareColumns()
    {
        $helper = Mage::helper('company_wordpressintegration');
        $currency = (string) Mage::getStoreConfig(Mage_Directory_Model_Currency::XML_PATH_CURRENCY_BASE);

        $this->addColumn('itemCheckbox', array(
            'index'     => 'ID',
            'type'      => 'checkbox',
            'width'     => 20,
            'sortable'  => false,
            'field_name' => 'map[]'
        ));

        $this->addColumn('ID', array(
            'header' => $helper->__('ID'),
            'index'  => 'ID'
        ));

        $this->addColumn('post_author', array(
            'header' => $helper->__('Author'),
            'index'  => 'post_author'
        ));

        $this->addColumn('post_date', array(
            'header' => $helper->__('Date'),
            'type'   => 'datetime',
            'index'  => 'post_date'
        ));

        $this->addColumn('post_title', array(
            'header' => $helper->__('Title'),
            'index'  => 'post_title'
        ));

        $this->addColumn('post_content', array(
            'header' => $helper->__('Content'),
            'index'  => 'post_content'
        ));

        $this->addColumn('post_status', array(
            'header' => $helper->__('Status'),
            'index'  => 'post_status'
        ));



        $this->addExportType('*/*/exportRelatedCsv', $helper->__('CSV'));
        $this->addExportType('*/*/exportRelatedExcel', $helper->__('Excel XML'));

        return parent::_prepareColumns();
    }

    public function getGridUrl()
    {
        return $this->getUrl('*/*/grid', array('_current'=>true));
    }


    /**
     * Retrieve the label used for the tab relating to this block
     *
     * @return string
     */
    public function getTabLabel()
    {
        return $this->__('Related Projects');
    }

    /**
     * Retrieve the title used by this tab
     *
     * @return string
     */
    public function getTabTitle()
    {
        return $this->__('Click here to view your custom tab content');
    }

    /**
     * Determines whether to display the tab
     * Add logic here to decide whether you want the tab to display
     *
     * @return bool
     */
    public function canShowTab()
    {
        return true;
    }

    /**
     * Stops the tab being hidden
     *
     * @return bool
     */
    public function isHidden()
    {
        return false;
    }

}

This negates the need for the additional grid and grid containers. Notice aside from the grid functions being moved into the tab file, the file now extends the grid, but continues to implement the tab interface.

Best Answer

Using observers instead of block rewrite

Related Solutions

Magento 1.9 – Add New Column with Custom Attribute in Sales Order Grid

Magento Grid Inside Catalog Product Edit Tab

Related Topic