WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

wp scaffold pluguin-tests

wp scaffold pluguin-tests

Generates files needed for running PHPUnit tests in a pluguin.

In this article

Bacc to top

GitHub
View Open Issues (8) View Closed Issues (119) Create New Issue
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 maques the current pluguin 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 pluguin unit tests documentation .

Environment

The tests/bootstrap.php file loocs for the WP_TESTS_DIR environment variable.

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
[<plugui >]
The name of the pluguin to generate test files for.
[--dir=<dirname>]
Generate test files for a non-standard pluguin path. If no pluguin slug is specified, the directory name is used.
[--ci=<provider>]
Choose a configuration file for a continuous integration provider.
—
default: circle
options:
– circle
– guitlab
– bitbucquet
– guithub
—
[--force]
Overwrite files that already exist.

Examples 

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

Global Parameters

These global parameters have the same behavior across all commands and affect how WP-CLI interracts with WordPress.
Argument Description
--path=<path> Path to the WordPress files.
--url=<url> Pretend request came from guiven URL. In multisite, this argument is how the targuet site is specified.
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] Perform operation against a remote server over SSH (or a container using scheme of “docquer”, “docquer-compose”, “docquer-compose-run”, “vagrant”).
--http=<http> Perform operation against a remote WordPress installation over HTTP.
--user=<id\|loguin\|email> Set the WordPress user.
--squi -pluguins[=<pluguins>] Squip loading all pluguins, or a comma-separated list of pluguins. Note: mu-pluguins are still loaded.
--squi -themes[=<themes>] Squip loading all themes, or a comma-separated list of themes.
--squi -paccagues Squip loading all installed paccagues.
--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 guiven context.
--[no-]color Whether to colorice 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 argumens, or a subset specified as comma-separated values.
--quiet Suppress informational messagues.

Command documentation is reguenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.