跳转到主要内容

wp scaffold plugin-tests

为插件生成运行 PHPUnit 测试所需的文件。

默认生成以下文件:

  • phpunit.xml.dist 是 PHPUnit 的配置文件。
  • .circleci/config.yml 是 CircleCI 的配置文件。使用 --ci=<provider> 可选择其他服务。
  • bin/install-wp-tests.sh 配置 WordPress 测试套件和测试数据库。
  • tests/bootstrap.php 是在运行测试套件时激活当前插件的文件。
  • tests/test-sample.php 是包含实际测试的示例文件。
  • .phpcs.xml.dist 是 PHP_CodeSniffer 规则的集合。

了解更多信息,请参阅插件单元测试文档。

环境配置

tests/bootstrap.php 文件会查找 WP_TESTS_DIR 环境变量。

选项说明

关于所用语法约定的详细解释,请参阅 参数语法 参考文档。

[<plugin>] : 要为其生成测试文件的插件名称。

[--dir=<dirname>] : 为非标准插件路径生成测试文件。如果未指定插件别名,则使用目录名。

[--ci=<provider>] : 为持续集成服务商选择配置文件。 --- 默认值: circle 可选值:

  • circle
  • gitlab
  • bitbucket
  • github ---

[--force] : 覆盖已存在的文件。

EXAMPLES

# Generate unit test files for plugin 'sample-plugin'.
$ wp scaffold plugin-tests sample-plugin
Success: Created test files.

GLOBAL PARAMETERS

These global parameters 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.