Read from the source of wp-self-test at v2.2.5.
GET
Namespace mmwp/v1, route /self-test/cases
Permission: Callback check_permission().
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
ids | array | [] | Case ids from the registered manifests. Empty for every case. | |
plugin | string | '' | Restrict to the cases of one registered plugin slug. |
Registered in src/Surfaces/Rest.php#L87(opens in a new tab).
GET
Namespace mmwp/v1, route /self-test/preview
Permission: Callback check_permission().
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
ids | array | [] | Case ids from the registered manifests. Empty for every case. | |
plugin | string | '' | Restrict to the cases of one registered plugin slug. |
Registered in src/Surfaces/Rest.php#L94(opens in a new tab).
POST
Namespace mmwp/v1, route /self-test/run
Permission: Callback check_permission().
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
ids | array | [] | Case ids from the registered manifests. Empty for every case. | |
plugin | string | '' | Restrict to the cases of one registered plugin slug. | |
cleanup | boolean | false | Remove the test data right after each case instead of keeping it for "Remove test data". | |
layer | string | '' | Run only the cases declaring this layer (rest, cli, ability, core, browser). |
Registered in src/Surfaces/Rest.php#L101(opens in a new tab).
POST
Namespace mmwp/v1, route /self-test/cleanup
Permission: Callback check_permission().
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
ids | array | [] | Case ids from the registered manifests. Empty for every case. | |
plugin | string | '' | Restrict to the cases of one registered plugin slug. |
Registered in src/Surfaces/Rest.php#L125(opens in a new tab).
GET
Namespace mmwp/v1, route /self-test/report
Permission: Callback check_permission().
Registered in src/Surfaces/Rest.php#L132(opens in a new tab).
GET
Namespace mmwp/v1, route /self-test/admin-menu
Permission: Callback check_permission().
Registered in src/Surfaces/Rest.php#L138(opens in a new tab).
POST
Namespace mmwp/v1, route /self-test/browser-login
Permission: Permission of the login exchange: the token is the credential. Callback check_login_token().
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
token | string | Yes | Single-use login token issued by the runner for the browser layer. |
Registered in src/Surfaces/Rest.php#L144(opens in a new tab).
Registered with the WordPress Abilities API (wp_register_ability()).
Writes
List self-test cases
The cases every registered plugin declares, with their plugin, category, the surfaces (rest/cli/ability) they cover, whether they can run on this site and whether an earlier run left test data behind.
Registered in src/Surfaces/Abilities.php#L98(opens in a new tab).
Writes
Preview self-test steps
The ordered steps each case would perform, without running anything.
Registered in src/Surfaces/Abilities.php#L106(opens in a new tab).
Writes
Run self-tests
Run the given cases (default: all), validate every surface and store the report. Creates test data on this site unless cleanup is true; pass confirm: true.
Registered in src/Surfaces/Abilities.php#L114(opens in a new tab).
Writes
Remove self-test data
Delete the test data left by earlier runs (default: every case with pending data). Pass confirm: true.
Registered in src/Surfaces/Abilities.php#L122(opens in a new tab).
Writes
Get the last self-test report
The report stored by the most recent run: summary counts and per-case checks.
Registered in src/Surfaces/Abilities.php#L131(opens in a new tab).