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

REST API: Terms: Respect taxonomy's default query args #7848

Conversation

ockham
Copy link
Contributor

@ockham ockham commented Nov 20, 2024

Port of WordPress/gutenberg#67154.

What

It is possible to supply a set of default query args to register_taxonomy() which will be used when querying a list of terms -- for example, orderby in order to specify how the resulting list of terms should be sorted. This PR makes it so that the list of terms returned by the Terms REST API controller respects that order if no post ID is included in the REST API request.

How

The controller's get_items() method has two code branches:

  1. If a post ID is given in the network request, get_items() uses wp_get_object_terms() to get the terms associated with the given post. That function already includes code to respect the default query args specified when the taxonomy was registered.
  2. If no post ID is given, it uses get_terms(), which does not respect the default query args.

This PR adds code to respect the default query args if no post ID is given.

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


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.

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.

@ockham ockham marked this pull request as ready for review November 25, 2024 10:54
Copy link

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 bernhard-reiter.

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

@ockham
Copy link
Contributor Author

ockham commented Nov 25, 2024

I'll go ahead and merge this per WordPress/gutenberg#67154 (review):

[T]he Core backport in #7848 also makes perfect sense. The REST controller should apply the taxonomy's default args.

@ockham
Copy link
Contributor Author

ockham commented Nov 25, 2024

Committed to Core in https://core.trac.wordpress.org/changeset/59458.

@ockham ockham closed this Nov 25, 2024
@ockham ockham deleted the update/terms-controller-respect-default-query-args branch November 25, 2024 11:15
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.

1 participant