Skip to content

REST API: Fix embedded items 'context' regression#6133

Closed
Mamaduka wants to merge 2 commits intoWordPress:trunkfrom
Mamaduka:fix/43439-embed
Closed

REST API: Fix embedded items 'context' regression#6133
Mamaduka wants to merge 2 commits intoWordPress:trunkfrom
Mamaduka:fix/43439-embed

Conversation

@Mamaduka
Copy link
Copy Markdown
Member

@Mamaduka Mamaduka commented Feb 17, 2024 •
edited
Loading

What

Fixes regression introduced in #43439, where navigation embed items were missing raw property values.

Why

The WP_REST_Server::match_request_to_handler mutates the $request object and sets the default context=view, which prevents setting context=embed as it's appropriate for these requests.

The unit tests missed regression since they didn't mimic the actual requests.

How

  • Update the unit tests to match a request made by the client code.
  • Set the context before matching a request to the handler.

Testing instructions

  1. Checkout to the test update commit - 2a707e7.
  2. Run the unit tests - npm run test:php -- --filter test_embedded_navigation_post_contains_required_fields.
  3. They will fail.
  4. Checkout to the fix commit - a11858d.
  5. Rerun the unit tests; they should succeed now.
  6. All other tests should be green.

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

This Pull Request is for code review only. Please keep all other discussions in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@Mamaduka Mamaduka self-assigned this Feb 17, 2024
@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 17, 2024 •
edited
Loading

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 mamaduka, swissspidy, youknowriad, timothyblynjacobs.

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

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 17, 2024

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.

@Mamaduka Mamaduka mentioned this pull request Feb 18, 2024
Merged
@youknowriad
Copy link
Copy Markdown
Contributor

youknowriad commented Feb 19, 2024

@TimothyBJacobs @spacedmonkey would you be able to help validate the fix here. This is a regression that happened during the 6.5 cycle, therefor, it would be good to land this fix on the same release.

@TimothyBJacobs
Copy link
Copy Markdown
Member

TimothyBJacobs commented Feb 19, 2024

This fix looks good to me as well.

I'd love if we could have unit tests that are covering this specifically as part of the WP_REST_Server tests, instead of the incidental coverage we are getting as part of the navigation controller. But I don't think that needs to block this from getting merged considering the timing.

@swissspidy
Copy link
Copy Markdown
Member

swissspidy commented Feb 20, 2024

Committed in https://core.trac.wordpress.org/changeset/57659

@swissspidy swissspidy closed this Feb 20, 2024
@getdave getdave mentioned this pull request Feb 20, 2024
Merged
@Mamaduka Mamaduka deleted the fix/43439-embed branch October 15, 2025 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@swissspidy swissspidy swissspidy approved these changes

@spacedmonkey spacedmonkey Awaiting requested review from spacedmonkey

@TimothyBJacobs TimothyBJacobs Awaiting requested review from TimothyBJacobs

@hellofromtonya hellofromtonya Awaiting requested review from hellofromtonya

Assignees

@Mamaduka Mamaduka

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Mamaduka @youknowriad @TimothyBJacobs @swissspidy