Update docs to avoid recommending early return PHP "anti-pattern"

[getdave]

What?

Updates PHP in Gutenberg docs to avoid recommending a pattern that could cause problems for older versions of PHP.

See #58429 (comment).

Why?

#58429 (comment)

How?

Updates docs.

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/README.md

[github-actions]

Flaky tests detected in 1127a5d.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7713081919
📝 Reported issues:

• [Flaky Test] callbacks should run whenever the specified event is dispatched #58398 in /test/e2e/specs/interactivity/directive-on-window.spec.ts
• [Flaky Test] directives inside islands should not be hydrated twice #58332 in /test/e2e/specs/interactivity/tovdom-islands.spec.ts

[getdave]

Noting that some of the Fonts Library classes use this pattern.

#57688

[getdave]

Possible overlap/duplication with #58500

[anton-vlasenko]

This PR looks good to me, except for the small issue mentioned below. I don't think it duplicates anything.
Considering the ongoing work on implementing a slightly different approach as outlined in #58467, the documentation might need to be updated again soon.

However, updating the documentation is always a good idea, in my opinion.

[github-actions]

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 SVN

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

Props get_dave, antonvlasenko.

GitHub Merge commits

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: getdave <get_dave@git.wordpress.org>
Co-authored-by: anton-vlasenko <antonvlasenko@git.wordpress.org>

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

[anton-vlasenko]

I'm sorry for being too picky, but I have another request.
Could the documentation specify more clearly that the issue stems from the usage of the return operator, rather than the return early pattern as a whole?

I'm afraid this might be misunderstood as discouraging the entire return early pattern, which isn't the case, as early returns can improve code clarity as outlined here.

[getdave]

I'm sorry for being too picky, but I have another request.

Pickiness is never a bad thing when it comes to accurate documentation 😄 Thank you!

I've marked to auto-merge.

[anton-vlasenko]

LGTM!

[getdave]

PHPUnit failures are not related to this PR and have been fixed on trunk. Force merging this one as it's only a docs update.