Magento – Remove Admin Menu Item When Module Disabled

menumodule

I developing magento module which creates menu in admin panel. But when I disable it I would like not to show it. I saw this question : Possible to hide admin menu if custom module is disabled? I added the code to my module file (to see if this method is working) in my adminhtml.xml

<config>
    <menu>
    <depends>
         <config>payment/checkmo/active</config>
        </depends>

and then went to System->Configuration->Payment methods and disabled payment method Check/money order ?

What did I do wrong? What config path should be to check if my module is enabled ?

Thanks in advance.

Best Answer

Your code appears to be one level too far up in the xml it should look as follows:

<config>
    <menu>
        <menu-type> <!-- e.g. <catalog> -->
            <depends>
                <config>payment/checkmo/active</config>
            </depends>
        </menu-type>
    </menu>
<config>

Note the missing menu-type node from your original code snippet.

If you look into the database table core_config_data for the path you will see that the entry is set to 1 when the module is disabled from the advanced tab. This means that the code that normally works for the menu will sadly not work for disabling modules via the admin config section and will in fact disable the menu item when the module is active.

The best suggestion would be to do the disable on the main module active flag and then change the module to active/inactive via the xml file under app/etc/modules. The following will remove the menu item when Example_Module is disabled.

<depends>
    <module>Example_Module</module>
</depends>

Related Solutions

Magento 1 – How to Hide Admin Menu if Custom Module is Disabled

There's a good article by Ecomdev that gives an example of how you can do this with the 'depends' functionality. Search for 'depends' on that page and it will demonstrate how to use a config value. e.g.

<depends>
    <config>payment/checkmo/active</config>
</depends>

The menu item will only show if the check payment method is active.

http://www.ecomdev.org/2010/10/28/defining-acl-resources-custom-and-admin-menu-in-magento.html

Navigation Menu Issue – page.xml Not Calling Overridden Class in Magento 1.9

While I haven't analysed your post in detail, the first thing I spot when looking through the above is you are declaring your rewrite incorrectly, Page should instead be page. This string does not match the module name i.e. the Page in Mage_Page, it instead matches the string used when declaring the resource in the module you are rewriting, so in this case in the config.xml for the Mage_Page core module:

...
<blocks>
    <page> <!-- this is the string to match -->
        <class>Mage_Page_Block</class>
    </page>
</blocks>
...

By referencing page the match against module Mage_Page is determined by inspecting the global config (which is basically one massive xml file containing all the config.xml files for all modules). The rest of the string is determined according to the class name so html_topmenu maps to class Mage_Page_Block_Html_Topmenu being the class the rewrite will apply to.

For your extra question, yes you can override any layout file or template by declaring a layout file for your module. Inside this you can declare any layout changes you want including changing templates for blocks and these changes will take priority over core layout files as your module will always load after all core modules.

Best Answer

Related Solutions

Magento 1 – How to Hide Admin Menu if Custom Module is Disabled

Navigation Menu Issue – page.xml Not Calling Overridden Class in Magento 1.9

Related Topic