Skip to main content

Shorthands

You can specify some steps using a shorthand syntax. The following steps are currently supported:

login

Use

    "login": true,

Or

{
"step": "login",
"username": "admin",
"password": "password"
}

plugins

(replaces the installPlugin step)

Use

    "plugins": [
"hello-dolly",
"https://raw.githubusercontent.com/adamziel/blueprints/trunk/docs/assets/hello-from-the-dashboard.zip"
]

Or

[
{
"step": "installPlugin",
"pluginData": {
"resource": "wordpress.org/plugins",
"slug": "hello-dolly"
}
},
{
"step": "installPlugin",
"pluginData": {
"resource": "url",
"url": "https://raw.githubusercontent.com/adamziel/blueprints/trunk/docs/assets/hello-from-the-dashboard.zip"
}
}
]

siteOptions

Use

    "siteOptions": {
"blogname": "My first Blueprint"
}

Or

    "step": "setSiteOptions",
"options": {
"blogname": "My first Blueprint"
}

defineWpConfigConsts

(constants only)

Use

{
"step": "defineWpConfigConsts",
"consts": {
"WP_DISABLE_FATAL_ERROR_HANDLER": true,
"WP_DEBUG": true,
"WP_DEBUG_DISPLAY": true
}
}

Or

    {
"step": "defineWpConfigConsts",
"consts": {
"WP_DISABLE_FATAL_ERROR_HANDLER": true
}
},
{
"step": "defineWpConfigConsts",
"consts": {
"WP_DEBUG": true
}
},
{
"step": "defineWpConfigConsts",
"consts": {
"WP_DEBUG_DISPLAY": true
}
}

The shorthand syntax and the step syntax correspond to each other. Every step specified with the shorthand syntax is added to the top of the steps array in arbitrary order.

Which should you choose?
  • Use shorthands when brevity is your main concern.
  • Use explicit steps when you need more control over the execution order.