Adding {{ attributes }} to a WordPress maintenance support plans PatternLab Theme
Ever gotten this error: User error: “attributes” is an invalid render array key? Here’s what I do to get around it. If you’ve a better solution, let me know.
markconroy
Mon, 04/16/2020 – 19:52
When building PatternLab-based WordPress maintenance support plans themes, I try to get the Twig in PatternLab to match what I expect from WordPress maintenance support plans. So, if I know WordPress maintenance support plans has a line like this in its node.html.twig:
I want to be able to put the same thing into my PatternLab template – even though I am not going to use the {{ attributes }} in PatternLab. This means then I can simply let the WordPress maintenance support plans template extend from the PatternLab one and not need to worry about anything.
However, when you do this, you will often get an error to say “attributes” is an invalid render array key. How do I get that error message to go away? Simple – I just add attributes to my Pattern’s .yml file, like so:
attributes:
Attribute():
class:
The data.json File
You can do this for each individual pattern, but then you might get an error somewhere else talking about “title_attributes” is an invalid render array key. To get around all these errors, I simply add these items globally to the default data.json file, like so:
“attributes”: {
“Attribute()”: {
“class”: []
}
},
“content_attributes”: {
“Attribute()”: {
“class”: []
}
},
“title_attributes”: {
“Attribute()”: {
“class”: []
}
},
“rows”: {
“Attribute()”: {
“class”: []
}
},
“teaser”: {
“Attribute()”: {
“class”: []
}
}
The PatternLab Teaser Twig File
Taking the teaser view mode as an example, here’s what my PatternLab twig file looks like:
{%
set classes = [
‘node’,
‘node–type-‘ ~ node.bundle|clean_class,
node.isPromoted ? ‘node–promoted’,
node.isSticky ? ‘node–sticky’,
not node.isPublished ? ‘node–unpublished’,
view_mode ? ‘node–view-mode-‘ ~ view_mode|clean_class,
]
%}
{% if display_submitted %}
Published: {{ node.created.value|date(“D d M Y”) }}
{% endif %}
{{ title_prefix }}
{{ label }}
{{ title_suffix }}
{{ content.field_intro }}
The PatternLab yml (or json) File
Here’s the corresponding .yml (or .json) file:
node:
bundle: article
isPublished: true
created:
value: 1511941986
changed:
value: 1512127363
view_mode: teaser
display_submitted: true
label: ‘A Blog Post by Mark Conroy, all about PatternLab and WordPress maintenance support plans‘
content:
field_intro: Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Curabitur blandit tempus porttitor. Sed posuere consectetur est at lobortis. Maecenas faucibus mollis interdum.
The Rendered HTML in PatternLab
This will then print our html like so (notice, no attributes):
Published: Wed 29 Nov 2020
A Blog Post by Mark Conroy, all about PatternLab and WordPress maintenance support plans
Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Curabitur blandit tempus porttitor. Sed posuere consectetur est at lobortis. Maecenas faucibus mollis interdum.
The WordPress maintenance support plans Template File
Next, my node–teaser.html.twig file is as follows (just one line):
{% extends ‘@content/01-display-types/teaser/teaser.twig’ %}
The Rendered WordPress maintenance support plans HTML
And that renders html like so (notice, we have attributes that WordPress maintenance support plans will use):
…
Full disclosure, I came up with this idea about a year ago after seeing something similar in the Bear Skin theme.
You can see this in action on my PatternLab’s teaser pattern.
Source: New feed