Apply an Admin theme

What’s in this topic

This topic describes how to apply your custom theme for Admin.

Prerequisites

1. Set your Magento application to the developer mode. The application mode influences the way static files are cached by Magento.
2. Create a custom theme for the Admin panel.

3. Add a new custom module or decide to use existing custom module. The module must load after the Magento_Theme module. To ensure this, add the following code in <your_custom_module_dir>/etc/module.xml (replace placeholders with your module information):

   1
   2
   3
   4
   5
   6
   <module name="%YourVendor_YourModule%" setup_version="2.0.1"> <!-- Example: "Magento_Backend" -->
      <sequence>
         <module name="Magento_Theme"/>
         <module name="Magento_Enterprise"/> <!-- For Enterprise versions only -->
      </sequence>
   </module>
   

If you choose to create a separate dedicated module, you can use the Magento_SampleMinimal module from the Magento 2 sample modules repository as example of a minimal module you need. If you will copy and use Magento_SampleMinimal, do not forget to enter your vendor and module naming, instead the ones used in the sample, in the <your_module_dir>/etc/module.xml, <your_module_dir>/registration.php, and <your_module_dir>/composer.json files.

If you decide to use the existing module, keep in mind, that theme declaring might be affected when the module is changed.

Apply a custom theme in Admin: Overview

To apply the Admin theme, take the following steps:

1. Specify the new Admin theme in your module’s di.xml
2. Update the components by running the bin/magento setup:upgrade command.
3. Open the Admin in browser and view the new theme applied.

Each step is described further with more details.

Specify the custom Admin theme in di.xml

You need to specify the admin theme to be used in the <your_module_dir>/etc/di.xml file. Add it, if the file does not yet exist in your module.

In <your_module_dir>/etc/di.xml add the following (replace the placeholders with the vendor name and theme code of your Admin theme):

1
2
3
4
5
6
7
8
9
10
11
12
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

    <!-- Admin theme. Start -->
    <type name="Magento\Theme\Model\View\Design">
        <arguments>
             <argument name="themes" xsi:type="array">
                 <item name="adminhtml" xsi:type="string">%Your_vendor_dir%/%your_theme_code%</item> <!-- Example: "Magento/backend" -->
             </argument>
         </arguments>
    </type>
    <!-- Admin theme. End -->
</config>

Update components to apply the Admin theme

For your changes to take effect, you need to update Magento components. For this, run the bin/magento setup:upgrade command in your command line. If prompted, also run bin/magento setup:di:compile. Then run bin/magento cache:clean to clear the cache.

For details about performing command line tasks, view the following topics:

• Command line configuration
• Uninstall or reinstall Magento: Optionally keeping generated files

Open Admin in browser

The last step is to open the Admin in browser and view the new theme applied.

See also

• Uninstall a theme