magepsycho / magento2-easy-template-path-hints

magepsycho/magento2-easy-template-path-hints

Easy Template Path Hints for Magento 2

magento2-module Compatibility: 2.4.7-2.4.9 Code Quality: Fail Tests: N/A Security: Pass OSL-3.0

Magento 2 Easy Template Path Hints

Magento 2 Easy Template Path Hints

Packagist Version
Packagist Downloads
Supported Magento Versions
License

Overview

Magento 2 Easy Template Path Hints is used to enable the template path hints on the fly just by using query strings.

(This is a ported version of Easy Template Path Hints - Magento 1 for Magento 2)

Functionality

  • Turn on template path hints on the fly for frontend
  • Turn on template path hints on the fly for backend
  • Option to configure access code
  • Option to save settings in cookie

Installation

1 Using Composer

composer require magepsycho/magento2-easy-template-path-hints

2 Using Modman

modman init
modman clone [email protected]:MagePsycho/magento2-easy-template-path-hints.git

3 Using Zip File

  • Download the Extension Zip File
  • Extract & upload the files to /path/to/magento2/app/code/MagePsycho/Easypathhints/

After installation by either means, activate the extension with following steps

  1. Enable the module
php bin/magento module:enable MagePsycho_Easypathhints --clear-static-content
php bin/magento setup:upgrade
  1. Flush the store cache
php bin/magento cache:flush
  1. Deploy static content - in Production mode only
rm -rf pub/static/* var/view_preprocessed/*
php bin/magento setup:static-content:deploy
  1. Go to Admin > STORES > Configuration > MAGEPSYCHO > Easy Template Path Hints > Manage Settings

Usage

  1. Enable template path hints without access code:

  2. Enable template path hints with access code:

  3. Enable template path hints with cookie

Screenshot

Backend Settings

Frontend Demo

Changelog

Version 1.1.3 (2022-02-14)

  • Bumped the version for the sake of packagist release

Version 1.1.2 (2018-05-10)

  • Fixed wrong module path if installed via composer

Version 1.1.1 (2018-05-10)

  • Fixed template block class hints not showing

Version 1.1.0 (2017-06-16)

  • Refactored the code (Logger, Cookie, Config etc.)
  • Fixed template path hints not working for Magento versions 2.1.3+

Version 1.0.2 (2016-04-03)

  • Fixed template path hints for admin.
  • Refactored code.

Version 1.0.1 (2016-04-03)

  • Fixed relative XSD path of xml configurations.
  • Added modman file.
  • Refactored code.

Version 1.0.0 (2015-10-30)

  • Initial Release

Authors

  • Raj KB Twitter Follow

Contributors

Contributors

To Contribute

Any contribution to the development of Magento 2 Easy Template Path Hints is highly welcome.
The best possibility to provide any code is to open a pull request on GitHub.

Need Support?

If you encounter any problems or bugs, please create an issue on GitHub.

Please visit our store for more FREE / paid extensions OR contact us for customization / development services.

No changelog yet

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

Versions
Version Stability QA Status Compatibility Released
1.1.3 stable Fail Magento 2.4.7-2.4.9 Details 2022-02-14 08:51:11
1.1.0 stable Not tested Not yet tested Details 2017-06-17 12:14:46

No dependencies declared

This package's composer.json doesn't declare any required, suggested, replaced, or conflicting packages.

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 - Static Tests

Checks run directly against the module's source code, independent of any Magento or PHP version: coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity, and a security audit of its declared dependencies. Each runs once.

Static code-quality results
Tool Status Findings Summary
PHPCS Warning 43 43 warnings (ruleset: Magento2) — 32 auto-fixable with phpcbf
PHPMD Warning 3 3 rule violations (UnusedFormalParameter:3)
Cpd Pass 0
Composer validate Info 1 valid; 1 advisory note (composer validate --strict)
Composer audit Pass 0

Code Quality - PHPStan

PHPStan type-checks the module's PHP against a real Magento install (so framework and core-module symbols resolve) at the configured gate level. Because the available symbols differ between releases, it runs separately for each Magento and PHP version. The grid below shows the result for each pairing; select one to see its findings. This never affects compatibility.

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

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

More from magepsycho

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.