mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-04-25 15:08:55 +08:00
62 lines
2.7 KiB
Markdown
62 lines
2.7 KiB
Markdown
# wp scaffold underscores
|
|
|
|
Generates starter code for a theme based on _s.
|
|
|
|
See the [Underscores website](https://underscores.me/) for more details.
|
|
|
|
### OPTIONS
|
|
|
|
<slug>
|
|
: The slug for the new theme, used for prefixing functions.
|
|
|
|
[\--activate]
|
|
: Activate the newly downloaded theme.
|
|
|
|
[\--enable-network]
|
|
: Enable the newly downloaded theme for the entire network.
|
|
|
|
[\--theme_name=<title>]
|
|
: What to put in the 'Theme Name:' header in 'style.css'.
|
|
|
|
[\--author=<full-name>]
|
|
: What to put in the 'Author:' header in 'style.css'.
|
|
|
|
[\--author_uri=<uri>]
|
|
: What to put in the 'Author URI:' header in 'style.css'.
|
|
|
|
[\--sassify]
|
|
: Include stylesheets as SASS.
|
|
|
|
[\--woocommerce]
|
|
: Include WooCommerce boilerplate files.
|
|
|
|
[\--force]
|
|
: Overwrite files that already exist.
|
|
|
|
### EXAMPLES
|
|
|
|
# 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
|
|
|
|
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
|
|
|
|
| **Argument** | **Description** |
|
|
|:----------------|:-----------------------------|
|
|
| `--path=<path>` | Path to the WordPress files. |
|
|
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
|
|
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
|
|
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
|
|
| `--user=<id\|login\|email>` | Set the WordPress user. |
|
|
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
|
|
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
|
|
| `--skip-packages` | Skip loading all installed packages. |
|
|
| `--require=<path>` | Load PHP file before running the command (may be used more than once). |
|
|
| `--exec=<php-code>` | Execute PHP code before running the command (may be used more than once). |
|
|
| `--context=<context>` | Load WordPress in a given context. |
|
|
| `--[no-]color` | Whether to colorize the output. |
|
|
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
|
|
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
|
|
| `--quiet` | Suppress informational messages. |
|