Themes: Try loading a playground instance for theme previews. #329
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
…cludes support for a theme bundling a preview-blueprint.json.
|
Merged. |
adamziel
pushed a commit
to WordPress/wordpress-playground
that referenced
this pull request
Jul 9, 2024
As part of working on Theme Previews for WordPress.org, I found myself needing to import Starter Content from themes into the playground site. After working up the PHP as a `runPHP` step (See WordPress/wordpress.org#329), similar to the `importWXR` step I felt that this might be useful to others, so I've converted it into a fully fledged playground Step. _This was also partially an exercise in understanding how Playground Steps work under the hood. If this is deemed to not be useful feature for Playground Core, that's OK, we can't add everything as a builtin option._ ## Implementation details This is modeled on the existing ImportWXR and runPHP steps, using some somewhat awkward PHP to simulate a Customizer save request, before using the Customizer import starter content to changeset function, and publish changeset functions to make the changes to the site. ~I imagine this could also be~ an option to toggle on `installTheme`, such as `installStarterContent: true`. _Option implemented_ This is the same as the user loading a playground instance with a theme, clicking customize, seeing the starter content, then clicking publish. (See the video at the end) ## Testing Instructions (or ideally a Blueprint) http://127.0.0.1:5400/website-server/#{%22steps%22:[{%22step%22:%22login%22,%22username%22:%22admin%22,%22password%22:%22password%22},{%22step%22:%22installTheme%22,%22themeZipFile%22:{%22resource%22:%22wordpress.org/themes%22,%22slug%22:%22twentytwenty%22},%22options%22:{%22importStarterContent%22:true}}]} ``` { "steps": [ { "step":"installTheme", "themeZipFile":{ "resource":"wordpress.org/themes", "slug":"twentytwenty" }, "options":{ "importStarterContent": true } } ] } ``` | Without Starter Content | With Starter Content | The manual process this automates | | --- | --- | --- | | <img width="1723" alt="Screenshot 2024-06-18 at 2 19 13 PM" src="https://github.com/WordPress/wordpress-playground/assets/767313/dc9182bd-d00f-4899-90c4-d88fd0102c4c"> | <img width="1728" alt="Screenshot 2024-06-18 at 2 18 16 PM" src="https://github.com/WordPress/wordpress-playground/assets/767313/cb26bb5d-6c23-4044-aafd-a545a1685678"> | <video src="https://github.com/WordPress/wordpress-playground/assets/767313/02230ee0-9d65-41c8-80a2-1f04e53d195d"></video> |
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 is a draft exploring whether using a playground instance for Theme Previews is viable.
This..
preview-blueprint.jsonstyle-variationsandpattern-previewplugins from wp-themes.com (Temporarily hosted in a github repo)pattern-previewneeds a page to exist, so that's also forced in, this works for most themes.Observations: