-
Notifications
You must be signed in to change notification settings - Fork 3k
docs: fix return type's array shape for WP_Speculation_Rules::jsonSerialize()
#8946
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
base: trunk
Are you sure you want to change the base?
docs: fix return type's array shape for WP_Speculation_Rules::jsonSerialize()
#8946
Conversation
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. |
Not sure if this warrants a 6.8.x commit, but I definitely don't think it's worth bothering to create a Trac ticket just to make that happen. |
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. |
@@ -230,7 +230,7 @@ public function has_rule( string $mode, string $id ): bool { | |||
* | |||
* @since 6.8.0 | |||
* | |||
* @return array<string, array<string, mixed>> Speculation rules data. | |||
* @return array<string, mixed[]> Speculation rules data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about array<string, array<int, mixed>>
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* @return array<string, mixed[]> Speculation rules data. | |
* @return array<string, array<int ,mixed>> Speculation rules data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(GH autoresolved that on commit - repoened)
This PR fixes the return type on
WP_Speculation_Rules::jsonSerialize()
to show that it returns anarray<string, mixed[]>
instead of the internal array having astring
key. This is due to the method's use ofarray_values()
to intentionally strip any keys.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.