Skip to content

FIX: Add REST API filters to the Global Styles Revisions controller.#8062

Open
patil-vipul wants to merge 5 commits intoWordPress:trunkfrom
patil-vipul:fix/global-styles-revision-rest-api-filter
Open

FIX: Add REST API filters to the Global Styles Revisions controller.#8062
patil-vipul wants to merge 5 commits intoWordPress:trunkfrom
patil-vipul:fix/global-styles-revision-rest-api-filter

Conversation

@patil-vipul
Copy link
Copy Markdown

Summary

This PR adds two standard WordPress REST API filters to the Global Styles Revisions controller: rest_global_styles_revision_query and rest_prepare_global_styles_revision.
Currently, WP_REST_Global_Styles_Revisions_Controller lacks the standard WordPress REST filters, likely an oversight since other revision controllers include them.

Changes Proposed

  • Adds rest_global_styles_revision_query filter for query modification
  • Adds rest_prepare_global_styles_revision filter for response data modification

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


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.

Adds filter to modify query arguments for global styles revisions before the query is run.
Adds filter to modify global styles revision data before sending to API response.
@github-actions
Copy link
Copy Markdown

Hi @patil-vipul! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 30, 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 vipulpatil, antonvlasenko.

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

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.

@patil-vipul
Copy link
Copy Markdown
Author

@Mamaduka Can you take a look at this PR 🙇

@patil-vipul
Copy link
Copy Markdown
Author

@anton-vlasenko Can you look at this PR.

Copy link
Copy Markdown

@anton-vlasenko anton-vlasenko left a comment

Choose a reason for hiding this comment

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

This looks good to me.
However, since WP_REST_Global_Styles_Revisions_Controller has been updated to better support HEAD requests, I believe this PR should be updated accordingly to reflect those changes.
It would also be great to include some PHPUnit tests.

*
* Allows modification of the global styles revision right before it is returned.
*
* @since 6.7.2
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
* @since 6.7.2
* @since 6.9.0

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.

3 participants