wpstarter/wp-testbench

A tool to set up a WordPress test environment for PHPUnit testing

Maintainers

Details

github.com/wpstarter/wp-testbench

Homepage

Source

Issues

Installs: 2 349

Dependents: 1

Suggesters: 0

Security: 0

Stars: 3

Watchers: 1

Forks: 1

Open Issues: 0

pkg:composer/wpstarter/wp-testbench

v1.0.2 2023-06-05 04:26 UTC

Requires

  • php: ^7.3|^8.0
  • ext-json: *
  • ext-mysqli: *
  • ext-readline: *

MIT b7046611da76d7a04faf33836aaa02230e15e559

testingphpunittestwordpressunit

This package is auto-updated.

Last update: 2025-10-05 10:03:29 UTC

README

WpTestbench is a tool used to set up a WordPress test environment for PHPUnit testing, in order to test your plugin.

Installation

Install testbench via composer

composer require wpstarter/wp-testbench --dev

Install WordPress

./vendor/bin/wp-testbench-install <db-name> <db-user> [db-pass] [db-host] [wp-version] [--skip-database-creation]

Update phpunit.xml

<phpunit 
    ...
    bootstrap="./vendor/wpstarter/wp-testbench/bootstrap.php"

>
    ...
    <php>
        <server name="WP_TESTBENCH_PLUGIN" value="your-plugin.php"/>
        ...
    </php>
</phpunit>

Custom wp-config.php

<phpunit>
    <php>
        <server name="WP_TESTBENCH_CONFIG" value="your-config.php"/>
    </php>
</phpunit>

That's all then you can run the PHPUnit test

./vendor/bin/phpunit