honl / magento2-templatehints

honl/magento2-templatehints

H&O Magento 2 Advanced Template Hints module

  • Paul Hachmang - H&O
magento2-module Compatibility: 2.4.7-2.4.9 Code Quality: Fail Tests: N/A Security: Pass BSD-2-Clause

Are you the maintainer of honl?

Packagento pulls honl's Composer packages from the public registry so buyers can find them here.

Claim the namespace to take ownership, publish new releases directly, and start charging for premium versions.

Claim this namespace →

H&O Magento 2 Advanced Template Hints module

[image: Overview]

Ho_Templatehints extends the default Magento template hints.

  • Easily accessible 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 Compatibility Released
0.6.0 stable Fail Magento 2.4.7-2.4.9 Details 2025-01-22 15:22:21
0.5.0 stable Not tested Not yet tested Details 2023-07-27 07:49:20
0.4.0 stable Not tested Not yet tested Details 2023-06-05 07:21:12
0.3.0 stable Not tested Not yet tested Details 2022-05-17 19:49:01
0.2.5 stable Not tested Not yet tested Details 2020-04-17 12:50:20
0.2.4 stable Not tested Not yet tested Details 2019-08-06 09:23:02
0.2.3 stable Not tested Not yet tested Details 2017-11-24 13:36:30
0.2.2 stable Not tested Not yet tested Details 2017-06-22 13:57:28
0.2.1 stable Not tested Not yet tested Details 2016-07-18 19:56:38
0.2.0 stable Not tested Not yet tested Details 2016-06-13 21:55:24
0.1.0 stable Not tested Not yet tested Details 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

Compatibility

Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Pass Pass
2.4.8 Pass Pass
2.4.9 Pass Pass

Code Quality

Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. A phpcs finding can't make a module incompatible.

Static analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

Static analysis results
Tool Status Findings Summary
PHPCS Fail 10 1 error, 9 warnings (ruleset: Magento2) — 3 auto-fixable with phpcbf
PHPMD Warning 4 4 rule violations (MissingImport:3, ErrorControlOperator:1)
Cpd Pass 0
Composer validate Pass 0

PHPStan

Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 7 7
2.4.8 7 7
2.4.9 7 7

Tests

Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.

Unit tests

Unit tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Integration tests

Integration tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Security

Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan Pass 0
License
BSD-2-Clause
Homepage
https://github.com/ho-nl/magento2-Ho_Templatehints
Authors

More from honl

View vendor
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.