Create TemplateDiscovery for plugin managers to use

Open on Drupal.org →

Created on 16 August 2019, over 5 years ago

Updated 31 January 2023, almost 2 years ago

Problem/Motivation

#3064854: Allow Twig templates to use front matter for metadata support → introduced the ability for templates to provide metadata using front matter.

This can potentially allow plugin managers that associate plugin definitions with templates (examples: layouts, help_topics) to inline the plugin definition with the template itself. Otherwise, you would need to put definitions into separate files and discover them using YamlDiscovery.

Proposed resolution

Introduce a new TemplateDiscovery abstract class that can be extended to discover plugins from Twig templates.

Use the template filename as the plugin ID, and allow extending classes to define what to do with extracted FrontMatter metadata.

Remaining tasks

[Done] Create patch containing a new abstract class for Twig template-based plugin discovery.
[Done] Create a sample usage. Usage by Help Topics is on #3176735: Replace Drupal\help_topics\HelpTopicDiscovery with core/lib Twig discovery class → ; RTBC when this issue is finalized.
[Done] Create unit tests. These can be based on the unit tests for the existing help topics discovery class.
[Done] Review the patch with the new class and unit test.
Commit

User interface changes

None

API changes

New API will be introduced; no changes to existing APIs.

Data model changes

None

Release notes snippet

A new plugin discovery method has been added that discovers plugins in Twig templates. See https://www.drupal.org/node/3212845 → for more information.

📌 Task

Status

Needs review

Version

10.1 ✨

Component

Last updated about 13 hours ago

Maintained by
🇺🇸United States @effulgentsia
🇩🇪Germany @Fabianx
🇨🇦Canada @joelpittet
🇫🇮Finland @lauriii

Created by

🇺🇸United States markhalliwell

Live updates comments and jobs are added and updated live.

Theme System Modernization Initiative

blocker

Needs subsystem maintainer review
It is used to alert the maintainer(s) of a particular core subsystem that an issue significantly impacts their subsystem, and their signoff is needed (see the governance policy draft for more information). Also, if you use this tag, make sure the issue component is set to the correct subsystem. If an issue significantly impacts more than one subsystem, use needs framework manager review instead.

Plugin system

Incomplete comments

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment almost 2 years ago →
🇫🇷France andypost
fix cspell and combined example patch
Comment almost 2 years ago →
🇫🇷France andypost
fix phpstan and needs to add tests from #35
Comment almost 2 years ago →
System Message
The last submitted patch, 53: 3075427-53-with-usage.patch, failed testing. View results →
Status changed to Needs work over 1 year ago10:55am 17 October 2023
Comment over 1 year ago →
🇫🇷France andypost
Comment 5 months ago →
🇺🇸United States Kristen Pol Santa Cruz, CA, USA
This one has gone cold. Are people still interested in getting this in?
Comment 5 months ago →
🇫🇷France andypost
It needs subsystem manager review as it used by help module only
Comment 24 days ago →
🇺🇸United States Amber Himes Matz Portland, OR USA
@andypost -- Are you looking for a high-level overview of the approach in #53 from a Theme API subsystem maintainer before continuing work on it? Do you want me to ping maintainers in Slack to take a look, or do you want to make any updates to the patch first?

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024