Uh oh!
There was an error while loading. Please reload this page.
Tests: Use the modern PHPUnit stubbing and matcher shorthands - #13052
Open
Soean wants to merge 1 commit into
Open
Tests: Use the modern PHPUnit stubbing and matcher shorthands#13052Soean wants to merge 1 commit into
Soean wants to merge 1 commit into
Conversation
Replaces `will( $this->returnValue( … ) )` with `willReturn( … )` and drops a redundant `$this->equalTo()` wrapper from a `with()` call. Both are pure shorthands: `with()` wraps non-constraint arguments in `equalTo()` itself, and `willReturn()` has been available since PHPUnit 5.4, while the test suite requires 5.7.21 as a minimum. The `willReturn()` call in `PluralFormsTest::test_cache()` was originally written that way and switched to the long form in [41725] for compatibility with the PHPUnit versions supported at the time. That constraint no longer applies. The `$this->identicalTo()` matcher in the same block is deliberately left in place, as it asserts strict rather than loose equality. These were the last remaining occurrences of the legacy stub API in the test suite.
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
pento pushed a commit
that referenced
this pull request
Aug 15, 2026
Two test cases still used the legacy PHPUnit stub API. This replaces them with the modern shorthands, which are what the rest of the suite already uses.
`tests/phpunit/tests/pomo/pluralForms.php`
{{{
// Before
->will( $this->returnValue( 1 ) );
// After
->willReturn( 1 );
}}}
`tests/phpunit/tests/rest-api/rest-server.php`
{{{
// Before
->with( $this->equalTo( 400 ) );
// After
->with( 400 );
}}}
**Why this is safe**
`willReturn()` is a direct shorthand for `will( $this->returnValue() )` and has been available since PHPUnit 5.4. The test suite enforces a minimum of PHPUnit 5.7.21 in `tests/phpunit/includes/bootstrap.php`, so it is safe on every supported version, and the suite already contains 83 `willReturn()` calls.
`with()` wraps any non-`Constraint` argument in an `equalTo()` constraint itself, so passing `400` directly is identical in behaviour. The suite already has 43 `with()` calls that pass values directly.
Note on the first change: that line was originally written as `willReturn( 1 )` and switched to the long form in r41725 because of the PHPUnit versions supported back then. That constraint no longer applies, so this effectively reverts an obsolete workaround.
Developed in #13052.
Follow-up to r34928, r41725.
Props Soean.
See #65819.
git-svn-id: https://develop.svn.wordpress.org/trunk@63303 602fd350-edb4-49c9-b593-d223f7449a82markjaquith pushed a commit
to markjaquith/WordPress
that referenced
this pull request
Aug 16, 2026
Two test cases still used the legacy PHPUnit stub API. This replaces them with the modern shorthands, which are what the rest of the suite already uses.
`tests/phpunit/tests/pomo/pluralForms.php`
{{{
// Before
->will( $this->returnValue( 1 ) );
// After
->willReturn( 1 );
}}}
`tests/phpunit/tests/rest-api/rest-server.php`
{{{
// Before
->with( $this->equalTo( 400 ) );
// After
->with( 400 );
}}}
**Why this is safe**
`willReturn()` is a direct shorthand for `will( $this->returnValue() )` and has been available since PHPUnit 5.4. The test suite enforces a minimum of PHPUnit 5.7.21 in `tests/phpunit/includes/bootstrap.php`, so it is safe on every supported version, and the suite already contains 83 `willReturn()` calls.
`with()` wraps any non-`Constraint` argument in an `equalTo()` constraint itself, so passing `400` directly is identical in behaviour. The suite already has 43 `with()` calls that pass values directly.
Note on the first change: that line was originally written as `willReturn( 1 )` and switched to the long form in r41725 because of the PHPUnit versions supported back then. That constraint no longer applies, so this effectively reverts an obsolete workaround.
Developed in WordPress/wordpress-develop#13052.
Follow-up to r34928, r41725.
Props Soean.
See #65819.
Built from https://develop.svn.wordpress.org/trunk@63303
git-svn-id: http://core.svn.wordpress.org/trunk@62496 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two test cases still used the legacy PHPUnit stub API. This replaces them with the modern shorthands, which are what the rest of the suite already uses.
Description
tests/phpunit/tests/pomo/pluralForms.phptests/phpunit/tests/rest-api/rest-server.phpWhy this is safe
willReturn()is a direct shorthand forwill( $this->returnValue() )and has been available since PHPUnit 5.4. The test suite enforces a minimum of PHPUnit 5.7.21 intests/phpunit/includes/bootstrap.php, so it is safe on every supported version, and the suite already contains 83willReturn()calls.with()wraps any non-Constraintargument in anequalTo()constraint itself, so passing400directly is identical in behaviour. The suite already has 43with()calls that pass values directly.Note on the first change: that line was originally written as
willReturn( 1 )and switched to the long form in [41725] because of the PHPUnit versions supported back then. That constraint no longer applies, so this effectively reverts an obsolete workaround.Trac ticket: https://core.trac.wordpress.org/ticket/65819
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.