03-data-format.md

sidebar_position	title
1	Blueprint data Format

Blueprint data Format

A Blueprint can contain the following properties:

• landingPage (string): The URL to navigate to after the Blueprint has been run.
• preferredVersions: The preferred PHP and WordPress versions to use.
• steps: The steps to run.

Here's a Blueprint that uses all of them:

import BlueprintExample from '@site/src/components/Blueprints/BlueprintExample.mdx';

<BlueprintExample blueprint={{ "landingPage": "/wp-admin/", "preferredVersions": { "php": "7.4", "wp": "5.9" }, "phpExtensionBundles": ["kitchen-sink"], "features": { "networking": true }, "steps": [ { "step": "login", "username": "admin", "password": "password" } ] }} />

JSON Schema

JSON files can be tedious to write and easy to get wrong. To help with that, Playground provides a JSON schema file that you can use to get autocompletion and validation in your editor:

{
	"$schema": "https://playground.wordpress.net/blueprint-schema.json",
	"landingPage": "/wp-admin/",
	// ...
}

Preferred Versions

The preferredVersions property, unsurprisingly, declares the preferred of PHP and WordPress versions to use. It can contain the following properties:

• php (string): The preferred PHP version to use. Defaults to 'latest'. Only accepts major versions like "7.4" or "8.0". Minor versions like "7.4.1" are not supported.
• wp (string): The preferred WordPress version to use. Defaults to 'latest'. Only accepts major versions like "5.9" or "6.0". Minor versions like "5.9.1" are not supported.

PHP extensions

The phpExtensionBundles property is an array of PHP extension bundles to load. The following bundles are supported:

• kitchen-sink: Installs gd, mbstring, iconv, libxml, xml, dom, simplexml, xmlreader, xmlwriter

Features

The features property is used to enable or disable certain features of the Playground. It can contain the following properties:

• networking: Defaults to true. Enables or disables the networking support for Playground. If enabled, wp_safe_remote_get and similar WordPress functions will actually use fetch() to make HTTP requests. If disabled, they will immediately fail instead.