Directory

Fix PHP fatal in rest_filter_response_fields when dealing with scalar values by xknown · Pull Request #6158 · WordPress/wordpress-develop · GitHub
Skip to content
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

Fix PHP fatal in rest_filter_response_fields when dealing with scalar values #6158

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from

Conversation

xknown
Copy link
Member

@xknown xknown commented Feb 22, 2024

rest_filter_response_fields() does not currently work if a given API endpoint returns an scalar value.

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


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.

`rest_filter_response_fields()` does not currently work if a given API
endpoint returns an scalar value.
Adds an `is_array()` check to make sure we are dealing with array based
collections.
Copy link

github-actions bot commented Feb 22, 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 xknown, timothyblynjacobs.

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.

Co-authored-by: Timothy Jacobs <timothy@ironbounddesigns.com>
@@ -898,7 +898,7 @@ function rest_filter_response_fields( $response, $server, $request ) {

$fields = wp_parse_list( $request['_fields'] );

if ( 0 === count( $fields ) ) {
if ( 0 === count( $fields ) || is_scalar( $data ) ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Is scalar desired or valid? If no, thinking it should also trigger an notice (doing it wrong or wp_trigger_error()) to alert the devs. (instead of silently returning the response)

Copy link
Member

Choose a reason for hiding this comment

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

A scalar is a valid return type from a REST API controller, so I don't think we need to warn on it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Aha good to know. Then yes, I agree, no need to warn.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants