Skip to main content

Blueprint

Index

Properties

Properties

optionalconstants

constants?: PHPConstants

PHP Constants to define on every request

optionaldescription

description?: string

Optional description. It doesn’t do anything but is exposed as a courtesy to developers who may want to document which blueprint file does what.

@deprecated

Use meta.description instead.

optionalextraLibraries

extraLibraries?: wp-cli[]

Extra libraries to preload into the Playground instance.

optionalfeatures

features?: { networking?: boolean }

Type declaration

  • optionalnetworking?: boolean

    Should boot with support for network request via wp_safe_remote_get?

optionallandingPage

landingPage?: string

The URL to navigate to after the blueprint has been run.

optionallogin

login?: boolean | { password: string; username: string }

User to log in as. If true, logs the user in as admin/password.

optionalmeta

meta?: { author: string; categories?: string[]; description?: string; title: string }

Optional metadata. Used by the Blueprints gallery at https://github.com/WordPress/blueprints

Type declaration

  • author: string

    A GitHub username of the author of this Blueprint.

  • optionalcategories?: string[]

    Relevant categories to help users find your Blueprint in the future Blueprints section on WordPress.org.

  • optionaldescription?: string

    A brief explanation of what your Blueprint offers.

  • title: string

    A clear and concise name for your Blueprint.

optionalphpExtensionBundles

phpExtensionBundles?: any
@deprecated

No longer used. Feel free to remove it from your Blueprint.

optionalplugins

plugins?: (string | FileReference)[]

WordPress plugins to install and activate

optionalpreferredVersions

preferredVersions?: { php: 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2 | 7.1 | 7.0 | latest; wp: string }

The preferred PHP and WordPress versions to use.

Type declaration

  • php: 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2 | 7.1 | 7.0 | latest

    The preferred PHP version to use. If not specified, the latest supported version will be used

  • wp: string

    The preferred WordPress version to use. If not specified, the latest supported version will be used

optionalsiteOptions

siteOptions?: Record<string, string> & { blogname?: string }

WordPress site options to define

optionalsteps

steps?: (undefined | null | string | false | StepDefinition)[]

The steps to run after every other operation in this Blueprint was executed.