Try/saving to theme files #40385
Closed
Try/saving to theme files #40385
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
ca0cc07 to
33fdb62
Compare
|
Size Change: +36 B (0%) Total Size: 1.23 MB
ℹ️ View Unchanged
|
draganescu
commented
Apr 18, 2022
lib/compat/wordpress-6.1/class-gutenberg-rest-edit-site-export-controller.php
Show resolved
Hide resolved
lib/compat/wordpress-6.1/class-gutenberg-rest-edit-site-export-controller.php
Outdated
Show resolved
Hide resolved
packages/edit-site/src/components/header/theme-udpdater/index.js
Outdated
Show resolved
Hide resolved
packages/edit-site/src/components/header/theme-udpdater/index.js
Outdated
Show resolved
Hide resolved
packages/edit-site/src/components/header/theme-udpdater/index.js
Outdated
Show resolved
Hide resolved
33fdb62 to
dc33b3d
Compare
c6f1562 to
bd72aed
Compare
|
Simplified the API code as I don't have a good grasp of how child themes would need to be handled here, but this can be added once this is not a draft anymore. For now to not be a draft I need to:
|
…e code from zip export
bd72aed to
66f25aa
Compare
Is it better to use this than the standard |
scruffian
reviewed
May 3, 2022
| return $filename; | ||
| } | ||
|
|
||
| function gutenberg_export_theme_json() { |
There was a problem hiding this comment.
should we move this to a different file?
scruffian
reviewed
May 3, 2022
| @@ -172,6 +173,7 @@ export default function Header( { | |||
|
|
|||
| <div className="edit-site-header_end"> | |||
| <div className="edit-site-header__actions"> | |||
| <ThemeUpdater /> | |||
There was a problem hiding this comment.
I think this was better in the sidebar, like you had it before
scruffian
reviewed
May 3, 2022
lib/compat/wordpress-6.1/class-gutenberg-rest-edit-site-export-controller.php
Show resolved
Hide resolved
scruffian
reviewed
May 3, 2022
lib/compat/wordpress-6.1/class-gutenberg-rest-edit-site-export-controller.php
Outdated
Show resolved
Hide resolved
scruffian
reviewed
May 3, 2022
lib/compat/wordpress-6.1/class-gutenberg-rest-edit-site-export-controller.php
Show resolved
Hide resolved
scruffian
reviewed
May 3, 2022
| return $template; | ||
| } | ||
|
|
||
| function clear_user_customizations() { |
There was a problem hiding this comment.
I wonder if we already have something that does this.
There was a problem hiding this comment.
Can we use this?
There was a problem hiding this comment.
Not right now as it returns a buggy canReset which is always true. You can see that the reset menu item in the global styles panel is always active. But I'll see.
|
Should we add some tests? |
|
When I save to theme files I see this message more than once: |
|
The workflow when editing is slightly cumbersome:
Would it be possible to give users the option to save changes directly to files without needing the intermediary step? Maybe we could add the button to the save sidebar panel? |
|
@scruffian I've been thinking about either one of these paths:
But I am not sure which way to go. Either way, I could enable the header button even if the theme templates and parts are none dirty and so the intermediary step could be gone. |
|
@mtias it would be good to get some design input here. Are you able to help or suggest someone who could? |
carlomanf
reviewed
May 3, 2022
Yes, definitely. I usually like to have |
scruffian
reviewed
May 4, 2022
| $global_styles_controller->update_item( $update_request ); | ||
|
|
||
| // delete global styles transients | ||
| delete_transient( 'global_styles' ); |
There was a problem hiding this comment.
I think this is obsolete.
scruffian
reviewed
May 4, 2022
| // delete global styles transients | ||
| delete_transient( 'global_styles' ); | ||
| delete_transient( 'global_styles_' . get_stylesheet() ); | ||
| delete_transient( 'gutenberg_global_styles' ); |
There was a problem hiding this comment.
I think this is obsolete.
scruffian
reviewed
May 4, 2022
| const customTemplates = filter( templates, customSourceFilter ); | ||
| const customTemplateParts = filter( templateParts, customSourceFilter ); | ||
|
|
||
| const unModifiedTheme = |
There was a problem hiding this comment.
This condition also needs to check for changes to Global Styles.
scruffian
reviewed
May 4, 2022
| } | ||
|
|
||
| foreach ( $user_customisations['template_parts'] as $template_part ) { | ||
| $fileToUpdate = get_template_directory() . '/parts/' . |
There was a problem hiding this comment.
In older themes this is called block-template-parts. I don't think we necessarily need to account for that, but it is a limitation.
scruffian
reviewed
May 4, 2022
| $user_customisations = $this->get_user_customisations(); | ||
|
|
||
| foreach ( $user_customisations['templates'] as $template ) { | ||
| $fileToUpdate = get_template_directory() . '/templates/' . |
There was a problem hiding this comment.
In older themes this is called block-templates. I don't think we necessarily need to account for that, but it is a limitation.
scruffian
reviewed
May 4, 2022
| // the result in an HTML comment". | ||
| // This reverses that escaping for saving back to files. | ||
| // @see `wp-includes/blocks.php` | ||
| $template->content = str_replace( '\\u002d\\u002d', '--', $template->content ); |
There was a problem hiding this comment.
We took the decision not to do this when exporting the theme. If we're happy doing it here then I think we should also do the same for export.
There was a problem hiding this comment.
Indeed from #39576 looks like we should leave these encodings in place.
There was a problem hiding this comment.
Hmm the devex of working with code like this
{"bottom":"var(\u002d\u002dwp\u002d\u002dcustom\u002d\u002dspacing\u002d\u002dsmall, 1.25rem)"}}}}
is awful so we need to not do it.
There was a problem hiding this comment.
I agree, but if that's what we think we should make the same change in the export.
scruffian
reviewed
May 4, 2022
lib/compat/wordpress-6.1/class-gutenberg-rest-edit-site-export-controller.php
Show resolved
Hide resolved
…folder path, checks edit_themes cap, refactoring, batch check for file and folder permissions
|
@draganescu Can you tell me how I can use/test this with wp-env? The "Update Theme" button shows up in TT2, but I have no permissions to edit theme files. So I press the button and it gives me the error that the file permissions are not set correctly. And btw, for a manually added theme (skatepark) via config it actually does not give an error, it says "theme files exported" or something like that, and then it immediately resets to the original state so that does not seem to work. This is my modded config. {
"core": "WordPress/WordPress",
"plugins": [ "." ],
"themes": [ "./test/emptytheme", "/home/user/websites/s.com/web/app/themes/skatepark" ],
"config": { "ENABLE_THEME_SAVING": true },
"env": {
"tests": {
"mappings": {
"wp-content/plugins/gutenberg": ".",
"wp-content/mu-plugins": "./packages/e2e-tests/mu-plugins",
"wp-content/plugins/gutenberg-test-plugins": "./packages/e2e-tests/plugins",
"wp-content/themes/gutenberg-test-themes": "./packages/e2e-tests/themes"
}
}
}
} |
|
I figured out the reset messup, it actually DOES work for the manually provided theme folder it is just that the theme uses the |
|
@nextgenthemes for wpenv the only way is to use an outside linked theme, like you did with skatepark.
That actually looks like it is working :) To test have skatepark active, make a easily visible change, click update theme then open the template or part in a text editor and see if it did really change. |
|
I will close this in accordance with the details here #39194 (comment) |
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.
What?
Closes #39194
Why?
To allow the site editor to behave like a traditional visual builder. A theme can be exported, but when developing from scratch a better devx is to update your theme's files with the changes made via the site editor.
How?
The following updates are needed:
themeDevModebased on a newwp-config.phpconstantTHEME_DEV_MODETesting Instructions
define( 'ENABLE_THEME_SAVING', true );to yourwp-config.phpScreenshots or screencast
More menu
update-theme-more-menu.mp4
Editor header
update-theme-header.mp4
Work in progress, known problems
Based heavily on the create-block-theme plugin's implementation of this similar concept by @pbking