Taxonomy: Add a search_columns argument to WP_Term_Query.#12389
Conversation
Introduce an opt-in search_columns query argument and a matching term_search_columns filter for WP_Term_Query, mirroring the search_columns and post_search_columns support already in WP_Query. Term searches can now optionally match the term description in addition to the name and slug, making post and term search more consistent. Default behavior is unchanged: with no search_columns specified, only name and slug are searched. See #32824.
|
Hi there! 👋 Thank you for your contribution to WordPress! 💖 It looks like this is your first pull request to 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 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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @tan7vir. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe 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
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
WP_Querysupports asearch_columnsargument and apost_search_columnsfilter, butWP_Term_Queryhas no equivalent: term search is a hard-codedname/slugLIKEwith no way to also search the description or otherwise adjust the searched columns. This reconciles that inconsistency between post and term search.Changes to
WP_Term_Query:search_columnsquery argument acceptingname,slug, anddescription.term_search_columnsfilter that mirrorsWP_Query'spost_search_columns(same( $columns, $search_term, $query )signature).Default behaviour is unchanged: when
search_columnsis not provided, onlynameandslugare searched, and the generated SQL is identical to before. Because the default query is untouched, there is no additional cost for existing searches — the wider column set is strictly opt-in. (This is intended to address the performance concern raised earlier on the ticket: there is no change to default search behaviour.)New unit tests in
tests/phpunit/tests/term/query.phpcover: defaults unchanged (description is not searched by default), opting intodescription, and theterm_search_columnsfilter. TheTests_Term_Querysuite passes (45/45) and the change is WPCS-clean.Note on the single
phpcs:ignore: theWordPress.DB.PreparedSQL.InterpolatedNotPreparedannotation follows the established core idiom (e.g.WP_Meta_QueryandWP_Query) — the interpolated column name comes only from an internal whitelist (array_intersectagainstname/slug/description), never from user input, and all values are still passed through$wpdb->prepare().Trac ticket: https://core.trac.wordpress.org/ticket/32824
Use of AI Tools
AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 4.8
Used for: Analysing the
WP_QueryvsWP_Term_Querysearch implementations and the ticket history, drafting the implementation and unit tests, and running PHPUnit and PHPCS. All changes were reviewed, tested, and are owned by me.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.