Magento – add custom tab to customer adminhtml screen

adminhtml

I know this has been asked so many times before however I more so have a question.

I am copying the file

/app/code/core/Mage/Adminhtml/Block/Customer/Edit/Tabs.php

and putting it in

/app/code/local/Mage/Adminhtml/Block/Customer/Edit/Tabs.php

I then edit the Tabs.php to have a new tab however when I refresh my screen, I even logged out cleared my cache and logged back in Magento does not seem to read from the app/code/local/mage directory?

However if I make the same changes in the file located in the core folder my changes work? So why can I not more the file to the local file?

I am using Magento CE 1.9.1.0
Shouldn't I be able to copy any file into the local directory and as long as the folder structure is the same it should load it??

Best Answer

I think none of the other answers (at this time) does it 'the Magento way'. To know how to do it the Magento way, have a look at Magento's Billing Agreements. It adds a tab to the customer edit page as well.

First, app/design/adminhtml/default/default/layout/sales.xml:

<adminhtml_customer_edit>
    <reference name="customer_edit_tabs">
        <action method="addTab"><name>customer_edit_tab_agreements</name><block>sales/adminhtml_customer_edit_tab_agreement</block></action>
        ....
    </reference>
</adminhtml_customer_edit>

Now you wonder: I have no title or content! No problem. Have a look at the above referenced block Mage_Sales_Block_Adminhtml_Customer_Edit_Tab_Agreement (in app/code/core/Mage/Sales/Block/Adminhtml/Customer/Edit/Tab/Agreement.php). I don't think it's useful to copy/paste the entire file here, but all the magic is there, like getTabLabel(), getTabTitle() and canShowTab(). It extends Mage_Sales_Block_Adminhtml_Billing_Agreement_Grid because there's a grid in it, but you could also extend the more general Mage_Adminhtml_Block_Widget.

You didn't mention the use of your tab, but you can even create a whole layout and then reference it by name:

<adminhtml_customer_edit>
    <reference name="customer_edit_tabs">
        <block type="my_module/adminhtml_customer_edit_tab_nameoftab" name="mytab">
            ... add some blocks here ...
        </block>
        <action method="addTab"><name>mytab</name><block>mytab</block></action>
    </reference>
</adminhtml_customer_edit>

So here's what you need to do:

create your own module (you've probably already done that)
create a layout file in the adminhtml area to add the tab, specifying the block class
create the block in your module and create the functions required by the interface (Mage_Adminhtml_Block_Widget_Tab_Interface)

No need for event observers, no need for local overrides, no need for editing the core!

Related Solutions

Magento 1.8 Orders – Add Customer Email to Adminhtml Order Grid

Just copy Grid.php to app/code/local/Mage/Adminhtml/Block/Sales/Order/ Then append sales_flat_order table to collection

 protected function _prepareCollection()
    {
        $collection = Mage::getResourceModel($this->_getCollectionClass());
        $collection->getSelect()->join('sales_flat_order', 'main_table.entity_id = sales_flat_order.entity_id',array('customer_email'));
        $this->setCollection($collection);
        return parent::_prepareCollection();
    };

And a addColumn to _prepareColumns()

 $this->addColumn('customer_email', array(
    'header' => Mage::helper('sales')->__('Payment method'),
    'index' => 'customer_email',
    'filter_index' => 'sales_flat_order.customer_email',
    ));

More details can be find here.

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

Related Solutions

Magento 1.8 Orders – Add Customer Email to Adminhtml Order Grid

Magento Grid Inside Catalog Product Edit Tab

Related Topic