Skip to main content

Blueprints Docs

tip

Check the Blueprints Gallery to explore real-world code examples of using WordPress Playground to launch a WordPress site with a variety of setups.

Hi! Welcome to WordPress Playground Blueprints documentation.

Blueprints are JSON files for setting up your very own WordPress Playground instance. This subsite (Blueprints Docs) is where you will find all the information you need to use Blueprints.

The WordPress Playground documentation is distributed across four separate hubs (subsites):

  • Documentation – Introduction to WP Playground, starter guides and your entry point to WP Playground Docs.
  • 👉 Blueprints (you're here) – Blueprints are JSON files for setting up your WordPress Playground instance. Learn about their possibilities from this Blueprints docs hub.
  • Developers – WordPress Playground was created as a programmable tool. Discover all the things you can do with it from your code in the Developers docs hub.
  • API Reference – All the APIs exposed by WordPress Playground

This docs hub is focused on Blueprints info and is divided into the following major sections:

  • Getting started with Blueprints: Quick Start Guide to setting up a WordPress Playground instance using Blueprint JSON files.

  • Tutorial - Blueprints 101 - Blueprints API crash course. The tutorial will guide you through the complete process of creating a blueprint that loads a theme and plugin (among other things).

  • Blueprint data Format: Blueprint JSON files define your Playground instance with various properties. This section highlights the key properties you need to know.

  • Using Blueprints: Learn in this section different ways to use Blueprints.

  • Steps: API Reference of all the available steps that can be set in a blueprint to run tasks such as login, plugin/theme activation, file operations, and more.

  • Examples: Compilation of Blueprint examples for various WordPress Playground setups, including installing themes/plugins, running PHP code, enabling features, and loading specific WordPress versions.

  • Troubleshoot and debug Blueprints: Tips and tools for troubleshooting and debugging Blueprints.