Skip to content

code quality: remove unreachable break; from allsites case in network/sites.php #8956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

justlevine
Copy link

This PR removes an unreachable break; from the 'allblogs' -> 'delete' case in wp-admin/network/sites.php, as the line before exits entirely.

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.

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


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.

@justlevine justlevine changed the title code quality: remove unreachable break; from allsites case in `network/sites.php code quality: remove unreachable break; from allsites case in network/sites.php Jun 10, 2025
Copy link

github-actions bot commented Jun 10, 2025

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, johnbillion.

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

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.

@johnbillion
Copy link
Member

I believe this is a stylistic choice, so every case always has a break unless it intends to fall through. Whether or not that's documented or enforced in the coding standards I am not sure.

@justlevine
Copy link
Author

justlevine commented Jun 12, 2025

Whether or not that's documented or enforced in the coding standards I am not sure.

It's a PHPStan level-4 violation, so while there's 0 pressure to get this merged, whoever is deliberating on the stylistic argument should keep in mind that once we hit that level this will look like:

...
	require_once ABSPATH . 'wp-admin/admin-footer.php';
	exit;
break; // @phpstan-ignore deadCode.unreachable (Optional comment about how this was a stylistic choice )

	case 'spam':
...

PS: there are other parts of the codebase where a custom $this->exits(); will need a break; to prevent WPCS from reformatting the subsequent case statements. That's not the case here and won't be needed elsewhere either once PHPStan (annotations) are merged, and we can start using the @never type to indicate an exit.

E.g.

$this->bail( 'Cannot process elements after HEAD which reopen the HEAD element.' );
/*
* Do not leave this break in when adding support; it's here to prevent
* WPCS from getting confused at the switch structure without a return,
* because it doesn't know that `bail()` always throws.
*/
break;
/*

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.

2 participants