Theme Export: Export the whole theme #39202
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
scruffian
requested review from
getdave,
MaggieCabrera,
mikachan,
pbking,
Mamaduka,
adamziel and
draganescu
scruffian
added
[Feature] Site Editor
|
Size Change: +9 B (0%) Total Size: 1.16 MB
ℹ️ View Unchanged
|
scruffian
changed the title
|
I think it is a very useful tool, of course. The question in my head is whether we want to have it as an always on option for any theme, and have their variations exportable as a fully bundled theme, or do we want this enabled only for "framework" style themes? The diff can also be exported as a child theme which requires the original. That would also be an option for a smaller default export. Ideally we should not change the lightness of themes and their self contained nature, so my take, in case of a full theme export, would be to not ignore any folder: a user importing will not go and run Alternatively, like #39194 suggests we could enable this only when a development flag is set to on. |
scruffian
force-pushed
the
update/whole-theme-export
branch
from
1df476f
to
08af4d0
Compare
My first thought is:
but you could also consider things like |
|
I added a filter to ignore all files within |
This was referenced Mar 10, 2022
|
This is very interesting! I think this might be a decent first approach. I also worry a bit about exporting all the templates, even if they haven't been edited. For many themes, that's probably totally fine, but I wonder if we should have an easy way to opt out of this feature if (for example) you're running a custom-made corporate theme. Also, if templates and styles have been updated, I wonder if we need to rename the theme and its slugs? Should that be a part of the export flow? I guess these issues exist no matter which export path we take though, so I'm not sure that they're specifically related to this PR. |
|
@kjellr yeah, these are all good questions and definitely something I want to keep iterating on in future PRs... |
jffng
reviewed
Mar 14, 2022
There was a problem hiding this comment.
I think this would be useful to theme developers, that way I can get a whole functioning theme and delete / rewrite / rename as necessary.
Like others have mentioned, having the ability to rename the theme, and choose exactly what to export, would be nice but could be addressed in a follow up.
| $zip->addFile( $file_path, $theme_name . '/' . $relative_path ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Load templates into the zip file. | ||
| $templates = gutenberg_get_block_templates(); | ||
| foreach ( $templates as $template ) { | ||
| $template->content = _remove_theme_attribute_in_block_template_content( $template->content ); |
There was a problem hiding this comment.
Template parts can also reference other template parts, is there a way to remove the theme attribute from those also?
| @@ -26,21 +43,46 @@ function gutenberg_generate_block_templates_export_file() { | |||
| $filename = get_temp_dir() . 'edit-site-export-' . $obscura . '.zip'; | |||
There was a problem hiding this comment.
Should the zip still be named this, or can it be the $theme_name?
There was a problem hiding this comment.
Yea, I second @jffng we should name the zip $theme_name IMO.
There was a problem hiding this comment.
I'll do this in a followup
draganescu
reviewed
Mar 14, 2022
| * @since 6.0.0 | ||
| * @return Bool Whether this file is in an ignored directory. | ||
| */ | ||
| function gutenberg_directory_ignored( $path ) { |
There was a problem hiding this comment.
Nitpick, could we name it gutenberg_is_directory_ignored
draganescu
approved these changes
Mar 14, 2022
scruffian
force-pushed
the
update/whole-theme-export
branch
from
6d9825e
to
1b02408
Compare
|
I created a PR to export the zip with the theme name: #39471 |
36 tasks
bph
added
the
Needs Dev Note
37 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
Following on from #39173 this is a proposal to export the whole theme in the zip, and simply update the templates and theme.json file.
This approach has the advantage that all of the necessary things to make the theme work are included by default. The downside is that the export can be very large, and its not so clear what files have diverged from the original theme.
I'm looking for feedback on this approach:
Testing Instructions
Types of changes
New feature (non-breaking change which adds functionality)
Checklist:
*.native.jsfiles for terms that need renaming or removal).