Add support for custom templates in FSE themes #27778
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
youknowriad
added
[Feature] Full Site Editing
[Type] Experimental
youknowriad
requested review from
spacedmonkey and
TimothyBJacobs
as code owners
youknowriad
added
the
[Feature] Themes
|
Size Change: -317 B (0%) Total Size: 1.28 MB
ℹ️ View Unchanged
|
|
This sounds great. It might require some alignment with how the default template types are structured: gutenberg/lib/full-site-editing/default-template-types.php Lines 16 to 19 in 5425353 As of today it's:
It looks like i18n support would need to be handled as well. |
|
Wonderful. The exiting feature is called "Page Templates", referring to the fact that you can only use these when editing pages. It seems to make sense to rename from that since you could create a fresh new "Single" or "Archive" template with one of the custom ones as a starting point. But at the same time, "Custom Templates" may not be the best word, as they are still technically bundled with the theme with all the other templates stored in the I know the term is only used in the code, but is there a better term for it? "Additional templates"? "Unattached templates"? "Optional"? |
|
I don't hold strong a opinion on the naming. The only places where this is used right now is |
|
I like "Templates". |
Custom templates are by default assigned only to pages, but you can specify they should be made available to other post types: https://developer.wordpress.org/themes/template-files-section/page-template-files/#creating-page-templates-for-specific-post-types I'm not sure we should use just "Templates" since all the other files (or posts in |
|
"Supplementary Templates" is accurate, but is a bit long and doesn't roll off the tongue. "Extra Templates" may be best then? |
|
I'm confused, why not just page templates or custom templates? |
|
I wouldn't object to either of those. But here's my reasoning.
|
Not for anything, for different post types if so specified. I think it's important to have some continuity and not add to the burden of concepts. |
|
Page Templates would probably be for for the SEO then. |
|
Ok so I updated to use "postTemplates" as a config key and used the format suggested by @gziolo |
17 tasks
youknowriad
force-pushed
the
add/support-custom-templates
branch
from
cb46ad0 to
a19fca1
Compare
mtias
reviewed
Dec 21, 2020
| * @param WP_Post $post The post being edited, provided for context, or null. | ||
| * @return array (Maybe) modified page templates array. | ||
| */ | ||
| function gutenberg_load_fse_page_templates( $templates, $theme, $post ) { |
There was a problem hiding this comment.
not blocking, but we should start dropping the "fse" term in functions, etc, to something more general like load_block_page_templates
mtias
approved these changes
Dec 21, 2020
This was referenced Dec 21, 2020
This was referenced Jan 11, 2021
This was referenced Feb 3, 2021
swissspidy
reviewed
Feb 5, 2021
Comment on lines
+41
to
+42
| add_filter( 'theme_post_templates', 'gutenberg_load_block_page_templates', 10, 3 ); | ||
| add_filter( 'theme_page_templates', 'gutenberg_load_block_page_templates', 10, 3 ); |
There was a problem hiding this comment.
@youknowriad What about other post types? IMO the generic theme_templates filter should be used here.
Why was WordPress uses the term "post template" internally (see |
|
I think "post" can become quite confusing (particularly for a more user facing API, which building a theme is) because we already have templates that apply to the content of a post (on a CPT). Page signals more clearly it is applying beyond the content (the page template for a post type makes sense). Also the fact these templates are by default only available for post type = page. The fact that internally everything is a post doesn't necessarily mean, in my opinion, we should call something like menus postMenus on more surface level APIs. In any case, perhaps |
9 tasks
34 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This brings the "custom templates" feature from classic themes to FSE themes. While in classic themes, this is done by adding a comment at the top of the template file, this can't be done for FSE themes since they are just HTML files.
(it might change later but let's do with what we have now)
So in order to support these, developers need to:
about.html/custom.html... to theblock-templatesfolder.customTemplatesproperty to the root level oftheme.jsonlike soand that's it. The templates will show up in the template picker on the sidebar of the editor.
In terms of UI and integration with the template mode, we can do a lot more than the old select box. We can show a preview for templates and offer a modal or something like that for folks to pick from... We'd need some design thinking and explorations there. This PR just sets the technical requirements to make it work.