mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-04-28 08:50:46 +08:00
68 lines
3.1 KiB
Markdown
68 lines
3.1 KiB
Markdown
# wp scaffold plugin-tests
|
|
|
|
Generates files needed for running PHPUnit tests in a plugin.
|
|
|
|
The following files are generated by default:
|
|
|
|
* `phpunit.xml.dist` is the configuration file for PHPUnit.
|
|
* `.circleci/config.yml` is the configuration file for CircleCI. Use `--ci=<provider>` to select a different service.
|
|
* `bin/install-wp-tests.sh` configures the WordPress test suite and a test database.
|
|
* `tests/bootstrap.php` is the file that makes the current plugin active when running the test suite.
|
|
* `tests/test-sample.php` is a sample file containing the actual tests.
|
|
* `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules.
|
|
|
|
Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/misc/plugin-unit-tests/).
|
|
|
|
### ENVIRONMENT
|
|
|
|
The `tests/bootstrap.php` file looks for the WP_TESTS_DIR environment variable.
|
|
|
|
### OPTIONS
|
|
|
|
[<plugin>]
|
|
: The name of the plugin to generate test files for.
|
|
|
|
[\--dir=<dirname>]
|
|
: Generate test files for a non-standard plugin path. If no plugin slug is specified, the directory name is used.
|
|
|
|
[\--ci=<provider>]
|
|
: Choose a configuration file for a continuous integration provider.
|
|
\---
|
|
default: circle
|
|
options:
|
|
- circle
|
|
- gitlab
|
|
- bitbucket
|
|
- github
|
|
\---
|
|
|
|
[\--force]
|
|
: Overwrite files that already exist.
|
|
|
|
### EXAMPLES
|
|
|
|
# Generate unit test files for plugin 'sample-plugin'.
|
|
$ wp scaffold plugin-tests sample-plugin
|
|
Success: Created test files.
|
|
|
|
### 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. |
|
