Settings Cheat Sheet

Alphabetically ordered:

Key Description Default value
autoload PHP file loaded before WP Starter its steps.
Path to the file, relative to root.		 ”./wpstarter-autoload.php”
cache-env Whether to cache env for WP requests. true
check-vcs-ignore Whether to check for VCS-ignored paths.
By default true, can be set to false to not do any check.
Can also be set to"ask", in which case WP Starter will ask user what to do.		 true
command-steps Objects steps of custom steps to add to be ran via WP Starter command.
Values must be steps FQCN, keys the step names, matching what Step::name() returns.
Given classes must be autoloadable.		 {}
content-dev-dir Source folder for “development content”.
Path to the folder, relative to root.		 ”./content-dev”
content-dev-op Operation to perform for “development content”
That is, plugins, themes, MU plugins, translations and dropins shipped with the project.
Valid values are “auto”, symlink”, “copy” and “none”.
Can also be set to"ask", in which case WP Starter will ask user what to do.		 “auto”
create-vcs-ignore-file Whether to check for VCS-ignore file if it does not exist.
By default true, can be set to false to not create it.
Can also be set to"ask", in which case WP Starter will ask user what to do.		 true
custom-steps Map of custom step names to custom step classes.
Classes must be autoloadable.		 null
db-check Determine if and how DB check is done.
By default true, can be set to false to not do any check, or to health to do a health check using mysqlcheck binary.		 true
dropins Array of dropins files to move to WP content folder.
Can be local paths or remote URLs.		 []
dropins-op Operation to perform for “dropins”
Valid values are “auto”, symlink”, “copy” and “none”.
Can also be set to"ask", in which case WP Starter will ask user what to do.		 “auto”
early-hook-file PHP file that adds callbacks to early hooks.
Path to the file, relative to root.		 null
env-bootstrap-dir Folder where to look for env bootstrap files.
Path to the folder, relative to root.		 null
env-dir Folder where to look for .env file.
Path to the folder, relative to root.		 ”./”
env-example How to deal with .env.example file. Can be:
- true (copy default example file to root)
- false (do nothing)
- path, relative to root, to example file to copy.
- "ask" (user will be asked what to do)		 true
env-file Name of the .env file.
Will be searched inside env-dir		 “.env”
install-wp-cli Whether to install WP CLI from phar if necessary. true
move-content Whether to move default themes and plugins
to project wp-content folder.
Can be set to"ask", in which case WP Starter will ask user what to do.		 false
prevent-overwrite Array of paths to preserve from overwrite.
Paths relative to root, might use glob patterns.
Can be set to"ask", in which case WP Starter will ask confirmation before each overwrite attempt.		 []
register-theme-folder Whether to register default themes.
Can be set to"ask", in which case WP Starter will ask user what to do.		 false
require-wp Whether to check for WP package being required. true
scripts Array of script to run before or after steps.
An object where key is in the format:
"pre-{$step}" or "post-{$step}"
and value is either a callback.
Callbacks must be autoloadable.		 []
skip-steps Array of step names to skip. []
templates-dir Folder where to look for custom templates.
Path relative to root.		 null
wp-cli-commands Array of WP CLI commands.
Can be a path to a PHP file returning the array of commands, or to a JSON file containing the array.
Paths relative to root.		 []
wp-cli-files Array of file paths to be passed to WP CLI eval file. Can be an array of objects with “file”, “args”, and “skip-wordpress” properties.
Paths relative to root.		 []
wp-version When require-wp is set to false this instruct WP Starter about the WP version that will be used with WP Starter. null

Next: Command-line Interface