How can I print the name of every template being rendered in HTML comments, when in devMode?

Question

Is there a plugin or setting that prints the name of every template being rendered in HTML comments? I noticed this type of feature in a Drupal project and it was useful for debugging.

This is useful if you add it to every template you make, but I'd like to be able to turn it on/off globally for all templates in dev mode: How can I make a template output its own filename?

score 12 · Accepted Answer · answered Oct 02 '18 at 15:54

12

So this sounded like a fun problem to solve... so I wrote the Template Comments plugin that does what you want:

This free plugin adds a HTML comment to demarcate {% block %}s and each Twig template that is included or extended.

answered Oct 02 '18 at 15:54

andrew.welch

11,551
22
31

Wow that's awesome! Thank you! I'll try it out on my next project! – missmatsuko Oct 03 '18 at 03:42
Lmk how it works for you. If you find any issues, file them on GitHub: https://github.com/nystudio107/craft-templatecomments/issues – andrew.welch Oct 03 '18 at 04:15

score 1 · Answer 2 · answered Oct 01 '18 at 05:17

1

I think the answer is "no". There is no config or existing plugin that adds the debugging information I want.

answered Oct 01 '18 at 05:17

missmatsuko

113
8

1

The answer is now "yes" (see above) :) – andrew.welch Oct 02 '18 at 21:16

How can I print the name of every template being rendered in HTML comments, when in devMode?

2 Answers2