Twig debug output does not display all suggestions when an array of theme hooks is passed to #theme

It looks like all the new code handling for 🐛 Improve documentation of hook_theme_suggestions_HOOK_alter() Fixed has been reverted during a rebase and force push to the GitLab branch.

I'll work on properly porting this to the main (11.x) branch.

JohnAlbin → closed merge request !49

JohnAlbin → closed merge request !4621

Still working on this. The solutions in 🐛 Improve documentation of hook_theme_suggestions_HOOK_alter() Fixed and 📌 Refactor out theme hook suggestion building from ThemeManager::render() into a separate function. Fixed need to be refactored so they can work with this issue.

alexismmd → changed the visibility of the branch 2118743-twig-debug-output-updated-11-x to hidden.

@JohnAlbin about #225: I tried to rebase the MR according the documentation → , I'm sorry if I messed something up.

I needed to reroll the 10.x patch again, this time against 10.2.x, as it doesn't work anymore for that version.

In order to avoid to mess again, I'm attaching as .patch file, if it is good, should I rebase\or push on the MR request?

Some updates on MR to make it "green"

- "Refactor" for related refactor https://www.drupal.org/project/drupal/issues/2953921 📌 Refactor out theme hook suggestion building from ThemeManager::render() into a separate function. Fixed (i think also tried on #234 patch)
- Updates for the related refactor "regression" https://www.drupal.org/project/drupal/issues/3409982 🐛 [D10.2 regression] Theme suggestions cannot alter variables anymore Active
- Some updates for "invalid suggestions"
- Updates (forced sometimes) for tests to pass

In conclusion ...the MR got dirty (in its "moments") ... commits and merges
And, i think, it needs more than review ... maybe a "resume" ... and make it happen!!!

For now "Needs review" ... but it's "Needs work" (imho) ,,, still

This is a 10 year old issue that will improve DX / TX by a large margin. I'm favoring a community RTBC on this as we'll need theming system manager review on this and from there lets try to get this to the finish line and into the end zone ( a release ) while we have some momentum here.

Bhanu951 → changed the visibility of the branch 2118743-twig-debug-output-d10 to hidden.

Bhanu951 → changed the visibility of the branch 11.x to hidden.

Needs to merge 11.x and fix conflicts due to ✨ Make it more obvious that a Twig template is overridden Fixed

MR green again
Most of errors were from https://www.drupal.org/project/drupal/issues/3420709 ✨ Make it more obvious that a Twig template is overridden Fixed update .. mentioned in #241.
So updated the MR - put back things and fix tests

There also others changes missed in latest merges and rebases. I hope I covered them all.

Let's review again

• Has new and adjusted test coverage
• Passes all tests
• Conflicts are resolved.
• Code Quality hasn't changed.
• 11 years and counting, it's time

The Needs Review Queue Bot → tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.

MR updated - solved conflicts
so RTBC ... once more

I think we need a separate CR detailing the new variables that are going to be available ie.

+    // Add two read-only variables that help the template engine understand
+    // how the template was chosen from among all suggestions.
+    $variables['template_suggestions'] = $template_suggestions;
+    $variables['template_suggestion'] = $hook;

And specifically how they related to any existing variables, ie. theme_hook_original.

Also this is adding an info variable everywhere - this feels very generic and likely to be used elsewhere - is this necessary?

evilehk → changed the visibility of the branch 2118743-twig-debug-output to active.

vasike → changed the visibility of the branch 2118743-twig-debug-output to hidden.

metalbote → changed the visibility of the branch 2118743-twig-debug-output-d10 to active.

Re-rolled #234 for latest 10.2.6.

There was one conflict:

CONFLICT (modify/delete): core/modules/system/tests/src/Functional/Theme/TwigDebugMarkupTest.php deleted in 51703edde0 (Applying patch 231 from issue 2118743) and modified in HEAD.  Version HEAD of core/modules/system/tests/src/Functional/Theme/TwigDebugMarkupTest.php left in tree

But, just left the file in per HEAD.

We had to remove the latest patch from a project because it had some strange knock-on effect with Paragraphs module and the Paragraphs EE module, which is supposed to load a list or grid of Paragraphs inside a modal. After several hours of exploration and git bisect, it turns out that this patch was causing an issue where that modal never loads and instead the page reloads when clicking the "Add Paragraph" button. It looks like it may have something to do with how paragraphs_ee_field_widget_complete_form_alter() is implemented. Due to how elusive this bug became, we ran out of time and budget to keep pushing the investigation. If this patch lands as is, there may be more issues like this showing up in contrib land.

When applying 2118743-251.patch using Drupal 10.3.1 there was an error in the core/themes/engines/twig/twig.engine file. I have taken changes from 2118743-251.patch into the 10.3.x branch taking into consideration 2 latest commits from https://git.drupalcode.org/project/drupal/-/commits/10.3.x/core/themes/engines/twig/twig.engine - patch now applies successfully.

Please disregard the previous comment, the patch provided breaks the suggestions functionality and should not be used.

Are there any details on how the patch in #254 and earlier break the suggestions functionality? I applied it cleanly and did a diff between the HTML source pre- and post- patch. The only difference highlighted was that the patch removes the spaces between the dot and filenames in one case. I re-rolled the patch to fix that and then the only difference with the patch is that views suggestions show up in the HTML comments.

Line 1737 of the patch is missng a space:

$suggestion = '▪️ ' . strtr($suggestion, '_', '-') . $extension;

Fixed the patch to work for Drupal 11.1.1