honl / magento2-templatehints

honl/magento2-templatehints

H&O Magento 2 Advanced Template Hints module

  • Paul Hachmang - H&O
magento2-module QA: failed BSD-2-Clause
Viewing version 0.2.4. Latest version is 0.6.0. Switch to latest

H&O Magento 2 Advanced Template Hints module

[image: Overview]

Ho_Templatehints extends the default Magento template hints.

  • Easily accessible with with muscle memory ?ath=1.
  • Shows hints for Templates, AbstractBlocks (Blocks), Containers and UI Components.
  • No layout interference: Using css outline instead of borders of other HTML elements, so it doesn't f'up the layout.

[image: Usage $0]

Installation

composer require --dev honl/magento2-templatehints
php bin/magento module:enable Ho_Templatehints
php bin/magento setup:upgrade

Development installation (git enabled)

composer require --dev honl/magento2-templatehints "dev-master"
php bin/magento module:enable Ho_Templatehints
php bin/magento setup:upgrade

Configure PHPStorm, allow remote calls

[image: Setting up PHPStorm]

Usage

  1. Set your Magento 2 installation to developer mode (when in production mode make sure to add your IP-address in Developer Client Restrictions).
  2. Add ?ath=1 to your URL to activate.
  3. Open up your console in you Chrome/Firefox/Safari/IE devtools.
  4. hold (shift)
  5. Hover over the element you wish to inspect
  6. Voila! Hints everywhere!

Hints for hidden elements

You can't show hints for a hidden element, for that purpose there is hint($0):

//Select an element in the Elements panel in your devtools, it is now available with $0
hint($0)

[image: Console $0]

Inner Workings

The module adds an additional html-attribute to the outer most element of a layout element.

Credits

Inspiration from Aoe_TemplateHints and a lot of love from H&O.

Developer

This module was developed by the H&O team. Check out more about this module on the H&O website:
H&O Magento 2 Advanced Template hints module

No changelog yet

The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.

Versions
Version Stability QA Status Released
0.6.0 stable Fail 2025-01-22 15:22:21
0.5.0 stable Not tested 2023-07-27 07:49:20
0.4.0 stable Not tested 2023-06-05 07:21:12
0.3.0 stable Not tested 2022-05-17 19:49:01
0.2.5 stable Not tested 2020-04-17 12:50:20
0.2.4 stable Not tested 2019-08-06 09:23:02
0.2.3 stable Not tested 2017-11-24 13:36:30
0.2.2 stable Not tested 2017-06-22 13:57:28
0.2.1 stable Not tested 2016-07-18 19:56:38
0.2.0 stable Not tested 2016-06-13 21:55:24
0.1.0 stable Not tested 2016-06-09 22:10:44

Requires 1

Package Constraint
php ~7.3||~7.4||^8.1||~8.2

Replaces 1

Package Constraint
ho-nl/magento2-templatehints self.version

No QA results yet

QA pipelines haven't run for this version. Status appears here once the vendor publishes a tagged release that gets ingested.

License
BSD-2-Clause
Homepage
https://github.com/ho-nl/magento2-Ho_Templatehints
Authors
Make it pay

Turn an existing module into recurring revenue.

If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.