Skip to content

Taxonomy: Add a search_columns argument to WP_Term_Query.#12389

Open
tan7vir wants to merge 1 commit into
WordPress:trunkfrom
tan7vir:fix/32824-term-search-columns
Open

Taxonomy: Add a search_columns argument to WP_Term_Query.#12389
tan7vir wants to merge 1 commit into
WordPress:trunkfrom
tan7vir:fix/32824-term-search-columns

Conversation

@tan7vir

@tan7vir tan7vir commented Jul 2, 2026

Copy link
Copy Markdown

WP_Query supports a search_columns argument and a post_search_columns filter, but WP_Term_Query has no equivalent: term search is a hard-coded name/slug LIKE with 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:

  • Adds a search_columns query argument accepting name, slug, and description.
  • Adds a term_search_columns filter that mirrors WP_Query's post_search_columns (same ( $columns, $search_term, $query ) signature).

Default behaviour is unchanged: when search_columns is not provided, only name and slug are 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.php cover: defaults unchanged (description is not searched by default), opting into description, and the term_search_columns filter. The Tests_Term_Query suite passes (45/45) and the change is WPCS-clean.

Note on the single phpcs:ignore: the WordPress.DB.PreparedSQL.InterpolatedNotPrepared annotation follows the established core idiom (e.g. WP_Meta_Query and WP_Query) — the interpolated column name comes only from an internal whitelist (array_intersect against name/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_Query vs WP_Term_Query search 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.

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.
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

Hi there! 👋

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

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

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.

Unlinked Accounts

The 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.

@github-actions

github-actions Bot commented Jul 2, 2026

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

  • 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.

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