Generates starter code for a theme based on _s.
See the Underscores website for more details.
- The slug for the new theme, used for prefixing functions.
- Activate the newly downloaded theme.
- Enable the newly downloaded theme for the entire network.
- What to put in the ‘Theme Name:’ header in ‘style.css’.
- What to put in the ‘Author:’ header in ‘style.css’.
- What to put in the ‘Author URI:’ header in ‘style.css’.
- Include stylesheets as SASS.
- Include WooCommerce boilerplate files.
- Overwrite files that already exist.
# Generate a theme with name "Sample Theme" and author "John Doe" $ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe" Success: Created theme 'Sample Theme'.
GLOBAL PARAMETERS GLOBAL PARAMETERS
These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
||Path to the WordPress files.|
||Pretend request came from given URL. In multisite, this argument is how the target site is specified.|
||Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “docker-compose-run”, “vagrant”).|
||Perform operation against a remote WordPress installation over HTTP.|
||Set the WordPress user.|
||Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded.|
||Skip loading all themes, or a comma-separated list of themes.|
||Skip loading all installed packages.|
||Load PHP file before running the command (may be used more than once).|
||Execute PHP code before running the command (may be used more than once).|
||Load WordPress in a given context.|
||Whether to colorize the output.|
||Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.|
||Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.|
||Suppress informational messages.|
Command documentation is regenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.