-
Notifications
You must be signed in to change notification settings - Fork 439
[Docs] Document Symfony apps in Playground without WordPress #3766
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
8925642
Document Playground as a generic PHP runtime
adamziel 1b19033
Address PHP framework docs review feedback
adamziel 30326c1
[Docs] Parse Symfony demo output with HTML API
adamziel 82543b6
[Docs] Cache-bust Symfony demo ZIP
adamziel 44cf9ba
Show selected PHP snippet text and shorten Symfony sample
adamziel fe1fac6
Load local PHP snippet script in docs dev
adamziel 6a65185
Document HTML API in Symfony snippet helper
adamziel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| --- | ||
| title: Run PHP frameworks in Playground | ||
| slug: /guides/php-frameworks | ||
| description: Use WordPress Playground as a browser-based PHP runtime for frameworks and apps that are not WordPress. | ||
| sidebar_class_name: navbar-build-item | ||
| --- | ||
|
|
||
| import { PhpCodeSnippetExample } from '@site/src/components/PhpCodeSnippetLiveExample'; | ||
|
|
||
| # Run PHP frameworks in Playground | ||
|
|
||
| WordPress Playground is also a browser-based PHP runtime. WordPress is the | ||
| most common app it boots, but a Blueprint can skip the WordPress download, | ||
| write any PHP files into the virtual filesystem, and run a framework such as | ||
| Symfony. | ||
|
|
||
| This guide shows the shape of that setup. Use it when you want a shareable demo, | ||
| a docs example, or a quick compatibility check for a PHP app that does not need | ||
| a server, database, Node.js, Sass, or a local Composer install. | ||
|
|
||
| ## What changes when you skip WordPress | ||
|
|
||
| Set `preferredVersions.wp` to `false` in a Blueprint, or `wp="none"` on a | ||
| `<php-snippet>`. Playground still downloads PHP, mounts a writable filesystem, | ||
| runs Blueprint steps, and supports networking when `features.networking` is | ||
| `true`. It just does not download or boot WordPress. | ||
|
|
||
| That makes Playground useful for generic PHP examples: | ||
|
|
||
| - PHP libraries that need a real filesystem. | ||
| - Framework demos that can run behind `public/index.php`. | ||
| - Documentation snippets that should execute in the browser. | ||
| - Reproducible bug reports for PHP code that is not WordPress-specific. | ||
|
|
||
| ## Try a Symfony app | ||
|
|
||
| The example below uses a Blueprint to download and unzip a bundled Symfony app | ||
| into `/app`. Then a `<php-snippet>` boots the Symfony kernel and renders the | ||
| dashboard route. The app's Composer dependencies include the WordPress HTML API, | ||
| so the snippet can read the `<h1>` with `WP_HTML_Processor` without installing or | ||
| booting WordPress. | ||
|
|
||
| <PhpCodeSnippetExample name="symfonyBlueprint" /> | ||
|
|
||
| Here is the complete embed: | ||
|
|
||
| <!-- prettier-ignore-start --> | ||
|
|
||
| ```html | ||
| <script type="module" src="https://playground.wordpress.net/php-code-snippet.js"></script> | ||
|
|
||
| <script id="symfony-blueprint" type="application/json"> | ||
| { | ||
| "features": { | ||
| "networking": true | ||
| }, | ||
| "steps": [ | ||
| { | ||
| "step": "unzip", | ||
| "zipFile": { | ||
| "resource": "url", | ||
| "url": "https://wordpress.github.io/blueprints/blueprints/symfony-package-radar/symfony-package-radar.zip?v=html-api-2026-06-08" | ||
| }, | ||
| "extractToPath": "/app" | ||
| } | ||
| ] | ||
| } | ||
| </script> | ||
|
|
||
| <php-snippet name="run-symfony.php" wp="none" blueprint="symfony-blueprint"> | ||
| <script type="application/x-php"> | ||
| <?php | ||
| require '/app/symfony-package-radar/vendor/autoload.php'; | ||
|
|
||
| use App\Kernel; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
|
|
||
| $kernel = new Kernel( 'prod', false ); | ||
| $request = Request::create( '/' ); | ||
| $response = $kernel->handle( $request ); | ||
|
|
||
| $page_title = get_first_h1_text( $response->getContent() ); | ||
|
|
||
| echo 'HTTP ' . $response->getStatusCode() . PHP_EOL; | ||
| echo 'Symfony page: ' . $page_title . PHP_EOL; | ||
| echo 'WordPress installed: '; | ||
| echo file_exists( '/wordpress/wp-load.php' ) ? 'yes' : 'no'; | ||
|
|
||
| $kernel->terminate( $request, $response ); | ||
|
|
||
| /** | ||
| * The app's Composer dependencies include the WordPress HTML API, so the | ||
| * snippet can read the <h1> with WP_HTML_Processor without installing or | ||
| * booting WordPress. | ||
| */ | ||
| function get_first_h1_text( string $html ): string { | ||
| $processor = WP_HTML_Processor::create_fragment( $html ); | ||
| if ( ! $processor->next_tag( 'H1' ) ) { | ||
| return 'unknown'; | ||
| } | ||
|
|
||
| $text = ''; | ||
| while ( $processor->next_token() ) { | ||
| if ( 'H1' === $processor->get_tag() && $processor->is_tag_closer() ) { | ||
| break; | ||
| } | ||
| if ( '#text' === $processor->get_token_type() ) { | ||
| $text .= $processor->get_modifiable_text(); | ||
| } | ||
| } | ||
|
|
||
| return trim( $text ); | ||
| } | ||
| </script> | ||
| <script type="text/expected-output"> | ||
| HTTP 200 | ||
| Symfony page: Symfony Playground | ||
| WordPress installed: no | ||
| </script> | ||
| </php-snippet> | ||
| ``` | ||
|
|
||
| <!-- prettier-ignore-end --> | ||
|
|
||
| The same app is also available as a full Playground page: | ||
|
|
||
| [Open the Symfony Package Radar demo](https://playground.wordpress.net/?blueprint-url=https%3A%2F%2Fwordpress.github.io%2Fblueprints%2Fblueprints%2Fsymfony-package-radar%2Fblueprint.json) | ||
|
|
||
| ## Package the app as a ZIP | ||
|
|
||
| For framework demos, prefer a ZIP that already contains `vendor/`. That keeps | ||
| the Playground startup path short and avoids asking every visitor to wait for | ||
| Composer, Git, and package registry downloads. The Symfony demo uses that path to | ||
| bundle both Symfony and a Composer-installed copy of the WordPress HTML API; it | ||
| still does not include a WordPress install. | ||
|
|
||
| For snippets or CLI runs, a small Blueprint can install the app into `/app` with | ||
| one step: | ||
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://playground.wordpress.net/blueprint-schema.json", | ||
| "landingPage": "/symfony-package-radar/public/index.php", | ||
| "preferredVersions": { | ||
| "php": "8.4", | ||
| "wp": false | ||
| }, | ||
| "features": { | ||
| "networking": true | ||
| }, | ||
| "steps": [ | ||
| { | ||
| "step": "unzip", | ||
| "zipFile": { | ||
| "resource": "bundled", | ||
| "path": "./symfony-package-radar.zip" | ||
| }, | ||
| "extractToPath": "/app" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Use `bundled` resources when the ZIP ships next to `blueprint.json`, or use a | ||
| `url` resource when the ZIP is hosted separately. See [Blueprint bundles](/blueprints/bundles) | ||
| for packaging details. | ||
|
|
||
| For a full-page Playground website, use a Blueprint like the gallery demo. It | ||
| adds a tiny router at the Playground document root so the Symfony `public/` | ||
| directory can respond to browser requests. | ||
|
|
||
| ## Keep the demo browser-friendly | ||
|
|
||
| A Playground-hosted framework demo works best when it: | ||
|
|
||
| - Does not require a long-running background process. | ||
| - Stores generated files under the virtual filesystem. | ||
| - Avoids native extensions that are not compiled into PHP.wasm. | ||
| - Avoids frontend build steps at runtime. | ||
| - Keeps network calls optional or resilient, because browsers may require CORS | ||
| proxying for third-party services. | ||
|
|
||
| Those constraints still leave plenty of room for real framework behavior: | ||
| controllers, routing, dependency injection, templates, forms, HTTP clients, and | ||
| plain PHP libraries all work when their PHP dependencies are available. |
This file contains hidden or 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
This file contains hidden or 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
9 changes: 6 additions & 3 deletions
9
packages/docs/site/src/components/PhpCodeSnippetLiveExample.tsx
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.