Template Path Hints

Template Path Hints are a diagnostic tool that adds notation with the path to each template that is used on the page. Template path hints can be enabled for either the storefront or the Admin.

Template Path Hints can be edited in Developer Mode only.

See Locate templates, layouts, and styles in the developer documentation.

Template Path Hints in Storefront

Step 1: Whitelist Your IP Address

Before using template path hints, add your IP address to the whitelist, so not to interfere with customers who are shopping in the store. When you are finished, make sure to clear the Magento cache to remove all hints from the store.

Developer Client Restrictions

Step 2: Enable Template Path Hints

  1. On the Admin sidebar, click Stores.

  2. Under Settings, choose Configuration.

  3. In the panel on the left under Advanced, choose Developer.

  4. Expand the Debug section. Then, do the following:

    Debug

    • To activate template path hints for the store, set Enabled Template Path Hints for Storefront to Yes.

    • To activate template path hints for the Admin, set Enabled Template Path Hints for Admin to Yes.

    • To include the names of blocks, set Add Block Names to Hints to Yes.

  5. When complete, click Save Config.

  6. When you are finished, return to the Admin to disable the hints and clear the cache.

Step 3: Clear the Cache

  1. On the Admin sidebar, click System.

  2. Under Tools, choose Cache Management.

  3. In the upper-right corner, click Flush Magento Cache.