This repository was archived by the owner on Sep 24, 2018. It is now read-only.
Add ?{taxonomy}_exclude= query parameter to posts
#2756
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This mirrors our existing support for `?{taxonomy}=` filtering in the
posts controller (which allows querying for only records with are
associated with any of the provided term IDs for the specified taxonomy)
by adding an equivalent `_exclude` variant to list IDs of terms for which
associated posts should NOT be returned.
For categories _e.g._, `/wp/v2/posts?categories[]=7&categories[]=9` would
return a post in categories 7 _or_ 9; this PR adds support for the inverse
query `?categories_exclude[]=7&categories_exclude[]=9`, meaning "only
return posts that are associated with neither category 7 or category 9."
`{term base}_exclude` is supported for any taxonomy registered with the API,
and is set within the same loop inside the controller as the existing term
include parameters.
While using the existing categories filter with a negative number was
considered ([see slack discussion][slack-disc]), `{base}_exclude` maintains
more consistency with other exclusion filters present in the API such as
`parent_exclude` (and is much easier to implement, to boot).
[slack-disc]: https://wordpress.slack.com/archives/core-restapi/p1475525429004981
Contributor
Author
|
@WP-API/amigos #reviewmerge |
joehoyle
approved these changes
Oct 6, 2016
?{taxonomy}_exclude= query parameter?{taxonomy}_exclude= query parameter to posts
kadamwhite
added a commit
that referenced
this pull request
Oct 11, 2016
PR #2756 added an `_exclude` complement to every registered taxonomy query parameter method, e.g. `categories_exclude`, to permit an API consumer to list an array of term IDs with which returned posts should NOT be associated. However, that PR omitted the important step of registering the parameters on the schema! This PR does so.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This mirrors our existing support for
?{taxonomy}=filtering in the posts controller (which allows querying for only records with are associated with any of the provided term IDs for the specified taxonomy) by adding an equivalent_excludevariant to list IDs of terms for which associated posts should NOT be returned.For categories e.g.,
/wp/v2/posts?categories[]=7&categories[]=9would return a post in categories 7 or 9; this PR adds support for the inverse query?categories_exclude[]=7&categories_exclude[]=9, meaning "only return posts that are associated with neither category 7 or category 9."{term base}_excludeis supported for any taxonomy registered with the API, and is set within the same loop inside the controller as the existing term include parameters.While using the existing categories filter with a negative number was considered (see slack discussion),
{base}_excludemaintains more consistency with other exclusion filters present in the API such asparent_exclude(and is much easier to implement, to boot).