Edit Site: Fix template lookup #22954
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
ockham
added
[Type] Bug
|
Size Change: 0 B Total Size: 1.13 MB ℹ️ View Unchanged
|
epiqueras
requested changes
Jun 5, 2020
vindl
approved these changes
Jun 8, 2020
lib/template-loader.php
Outdated
| // `index.html` block template. We create one so that people that are trying to access the editor are greeted | ||
| // with a blank page rather than an error. | ||
| if( ! $current_template_post && ( is_admin() || defined( 'REST_REQUEST' ) ) ) { | ||
| // 'index' is the ultimate fallback template. If even this template doesn't exist, we create an empty one for it. |
There was a problem hiding this comment.
This seems like it has already been covered in the above comment.
There was a problem hiding this comment.
Good spot, thanks! I'll remove this line.
epiqueras
approved these changes
Jun 8, 2020
|
e2e tests are still failing 😕
I'll try a rebase. |
Co-authored-by: Enrique Piqueras <epiqueras@users.noreply.github.com>
ockham
force-pushed
the
fix/edit-site-no-template-found-error
branch
from
47b321a
to
4852ce3
Compare
oandregal
pushed a commit
that referenced
this pull request
Jun 9, 2020
## Description This PR fixes two issues with template lookup: ### 1. Templates with `index.html` block template fallback When using a theme that came with an `index.html` but not with a `front-page.html` block template, the site editor would show the following `Notice: Undefined index: front-page in /var/www/html/wp-content/plugins/gutenberg/lib/edit-site-page.php on line 162`. The reason is that I was setting the wrong key here: https://github.com/WordPress/gutenberg/blob/710373b254fbcd15d524afdeb31da0d93c4defd4/lib/edit-site-page.php#L158 This would use the name of the template that was _found_, not the name of the key that was looked for. So if we're looking up `front-page`, but don't find any template, and [thus fall](https://github.com/WordPress/gutenberg/blob/710373b254fbcd15d524afdeb31da0d93c4defd4/lib/template-loader.php#L226) back to `index`, the template will be stored under the `index` key, rather than the front-end one. The fix for this is to use the template we were looking for as key (rather than the name of the template we actually found). ### 2. Templates without `index.html` block template fallback When using a theme that doesn't come with any block templates at all, we need to provide a blank `index` template when the user first opens the site editor (see [discussion](#22893 (comment))). Co-authored-by: Enrique Piqueras <epiqueras@users.noreply.github.com>
7 tasks
|
👋 Just noting that this will be backported to Gutenberg 8.3 release as part of #23026 |
oandregal
pushed a commit
that referenced
this pull request
Jun 10, 2020
- Edit Site: fix template lookup. #22954 - Fix for FSE template parts: #23050 - Fix link color style rule. #23025 - Fix for link color: it needs to be opt-in. #23049 - Revert "Image Block: add caption field to placeholder" #23027 - Cover padding: reset button + hook namespace + improve visualizer #23041 - Fix failing 'Build artifacts' CI job (by updating `package-lock.json`): #23052
12 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.
Description
This PR fixes two issues with template lookup:
1. Templates with
index.htmlblock template fallbackWhen using a theme that came with an
index.htmlbut not with afront-page.htmlblock template, the site editor would show the followingNotice: Undefined index: front-page in /var/www/html/wp-content/plugins/gutenberg/lib/edit-site-page.php on line 162.The reason is that I was setting the wrong key here:
gutenberg/lib/edit-site-page.php
Line 158 in 710373b
This would use the name of the template that was found, not the name of the key that was looked for. So if we're looking up
front-page, but don't find any template, and thus fall back toindex, the template will be stored under theindexkey, rather than the front-end one.The fix for this is to use the template we were looking for as key (rather than the name of the template we actually found).
2. Templates without
index.htmlblock template fallbackWhen using a theme that doesn't come with any block templates at all, we need to provide a blank
indextemplate when the user first opens the site editor (see discussion).How has this been tested?
wp_templateCPTs (neither published norauto-drafts) from previous Site Editor runs. (It's best to start with a fresh install, i.e.npx wp-env clean all && npx wp-env start. Careful, this will wipe your WordPress install's data!)/wp-admin/admin.php?page=gutenberg-experimentsmust not be ticked. (Make sure the "Full Site Editing" checkbox is ticked -- since it also gets reset after a wipe.)theme-experimentsrepo (see thewp-envREADME).Open question
Upon running
I see a sleuth of
indextemplateauto-drafts. I was hoping that only one would be created 😕 -- maybe my newly added logic is still buggy.Types of changes
Bug fix. Fixes #22800.
Checklist: