Build a WordPress Playground Blueprint

Playground Blueprints let anyone launch a WordPress demo in a single click, with a theme, plugins, and even content. This guide explains how to create a Blueprint and ship it to a gallery where people share their blueprints for others to use and learn from.

Steps

  1. Explore existing blueprints. Open a few at wordpress.github.io/blueprints to see how they work — tap any one to load a temporary WordPress instance.

  2. Work through the tutorial. Follow Build your first blueprint. By the end, you’ll have a working blueprint.json that installs a theme, plugins, and content.

  3. Decide what to build. Look at the Blueprint Gallery source files to see how others have structured their submissions. Check to see what’s already there, and find inspiration for what you’d like to share.

  4. Build your own blueprint. Pick something you find interesting — a pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party. you want to showcase, a theme setup worth sharing, a testing environment you’d find useful — and create a blueprint.json for it using the official tutorial: Build your first blueprint.

  5. Test your blueprint. Paste the JSONJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML. into the Playground Builder. Make sure the site loads and works as expected.

  6. Prepare your submission folder. Follow the contributing guidelines. Your folder needs a blueprint.json with the required metadata (title and author), plus any static files your blueprint references (WXR, ZIP, images, etc.).

  7. Submit a pull request. Add your folder under blueprints/your-blueprint-name/ in the WordPress/blueprints repository.

Contribution checklist

  • Blueprint runs in WordPress Playground without errors
  • blueprint.json includes the required metadata (title and author)
  • Submission folder contains the blueprint and all referenced files
  • Pull request submitted to the WordPress/blueprints repository

What happens next

A Playground team member will review your PR. They may ask for changes or flag missing files. You’ll also get a test link generated from your PR to verify your blueprint works. If you don’t hear back within a week, ask in #metaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress.-playground.

After your first blueprint is merged, consider creating a Blueprint for a community theme or plugin — or explore other ways to contribute to WordPress Playground.

Help

Stuck? Check the getting help guide, then ask in #playground.

Further reading:
Gallery contributing guidelines
Create a demo with Playground — 27-minute video walkthrough
Blueprint Steps API Reference
Blueprint Resources API Reference
The Blueprint Gallery announcement — background on the gallery initiative

Build
Beginner-friendly project

New here? Get set up with accounts, community basics, and info on badges.