StartPlaygroundOptions
Index
Properties
optionalblueprint
optionalcorsProxy
optionaldisableProgressBar
optionalexperimentalBlueprintsV2Runner
Prefer experimental Blueprints v2 PHP runner instead of TypeScript steps
iframe
optionalmounts
optionalonBlueprintStepCompleted
optionalonBlueprintValidated
Type declaration
Parameters
blueprint: BlueprintV1Declaration
Returns void
optionalonClientConnected
Called when the playground client is connected, but before the blueprint steps are run.
Type declaration
Parameters
playground: PlaygroundClient
Returns void
optionalprogressTracker
remoteUrl
optionalscope
The string prefix used in the site URL served by the currently
running remote.html. E.g. for a prefix like /scope:playground/
,
the scope would be playground
. See the @php-wasm/scopes
package
for more details.
optionalshouldInstallWordPress
optionalsqliteDriverVersion
The version of the SQLite driver to use. Defaults to the latest development version.
Proxy URL to use for cross-origin requests.
For example, if corsProxy is set to "https://cors.wordpress.net/proxy.php", then the CORS requests to https://github.com/WordPress/wordpress-playground.git would actually be made to https://cors.wordpress.net/proxy.php?https://github.com/WordPress/wordpress-playground.git.
The Blueprints library will arbitrarily choose which requests to proxy. If you need to proxy every single request, do not use this option. Instead, you should preprocess your Blueprint to replace all cross-origin URLs with the proxy URL.