Skip to content

Conversation

@justlevine
Copy link

Trac ticket: https://core.trac.wordpress.org/ticket/52217

This PR fixes several instances of WP_Site_Health_Auto_Updates::test_*() potentially returning void instead of their documented return types.

Since these methods are public for some reason, null is used to represent a passed test for backwards-compatibility with the coersion of the previously-returned voids. Previous usage of false is preserved.

While this issue was surfaced via PHPStan in #7619 (trac: https://core.trac.wordpress.org/ticket/61175 ), it can be remediated independently of that ticket.


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.

…thods.

Since these methods are public, `null` is used to represent a passed test for backwards-compatibility with a coreced void. Previous usage of `false` is preserved.
@github-actions
Copy link

github-actions bot commented Oct 29, 2024

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props justlevine, apermo.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link

Test using WordPress Playground

The 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

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link

@apermo apermo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment.

From a technical point of view all good, just the doc thing feels wrong.

@SergeyBiryukov
Copy link
Member

Thanks for the PR! Merged in r59340.

@justlevine justlevine deleted the fix/explicit-returns-WP_Site_Health_Auto_Updates branch November 4, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants