shockwavemk/magento2-module-templatehints

Show advanced information for blocks in Magento2 Frontend

Installs: 7 763

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 2

Open Issues: 0

Language:CSS

Type:magento2-module

v1.1.2 2017-01-10 06:51 UTC

This package is not auto-updated.

Last update: 2020-02-21 17:04:19 UTC


README

Introduction

templatehings-magento2-settings

The creation, modification and debugging of Magento 2 frontend templates can be supported by enabling the build in "Template Path Hints for Storefront" in Admin configuration of Magento 2.

Store > Configuration > Advanced > Developer > Debug > Enabled Template Path Hints for Storefront > Yes

The result are graphical enhanced frontend blocks with basic information about template pathes.

magento2-templatehints

This information is useful for template-designer and developers to create or modify Magento 2 features, but the information is provided is kept at a very low level:

Default Template-file behavior

Features

This Magento 2 "Templatehints" module addresses that point. New features are added to Template Path Hints functionality of Magento 2:

  • General information is displayed for each block

    • Template file
    • Block type
    • Name of block in layout
    • Module for block
    • Information about parent block
  • Cache information

  • Cache key of current block

  • Cache Tags of current block

  • Configured lifetime for current block

  • Cache key info string

  • Current status of current block in cache (found, disabled, not found)

Installation of the magento2 template path hints extension

Add the module to your composer file:

{

...

"require": { ...

"shockwavemk/magento2-module-templatehints": "dev-master",

... },

Add my packages server to your composer file:

{ "repositories": [ { "type": "composer", "url": "https://packages.martin-kramer.com" } ] }