Skip to content

19653 - Allow meta queries to keep objects without a given meta key - #15951

Open
sawfly wants to merge 1 commit into
WordPress:trunkfrom
sawfly:19653-Order-by-meta-field-improvement
Open

sawfly wants to merge 1 commit into
WordPress:trunkfrom
sawfly:19653-Order-by-meta-field-improvement

Conversation

@sawfly

@sawfly sawfly commented Nov 12, 2026

Copy link
Copy Markdown

Allows meta queries to keep objects that have no value for a given meta key, e.g. when ordering by a meta field.

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

What

  • New exclude_empty meta query clause argument and meta_exclude_empty query var. Both default to true, so current behavior is unchanged.
  • When false, the meta table is LEFT JOINed with the key condition in the ON clause. With a value, the WHERE becomes ( id IS NULL OR <value condition> ).
  • Key-restricted joins are never shared with sibling clauses, so OR relations stay correct.
  • Only honored for compare_key = / EXISTS / IN. Ignored for compare => 'NOT EXISTS'.
  • Documented in WP_Meta_Query and in the WP_Query, WP_User_Query, WP_Comment_Query, WP_Term_Query and WP_Site_Query docblocks.

Why the old patch was replaced

The 2013 patch only swapped INNER for LEFT JOIN. It kept meta_key = 'foo' in WHERE, which still filtered out the rows with no meta.

Testing

21 new tests in tests/query/metaQuery.php and tests/meta/query.php (--group 19653). They cover:

  • default behavior and ordering by meta_value / meta_value_num
  • combining with meta_query, multiple LEFT-joined clauses with named orderby, and OR / nested relations
  • IN keys and the cases where the flag is ignored
  • WP_User_Query
  • the generated SQL

Notes

  • With ASC, objects without the meta sort first because MySQL orders NULLs first (see comment Patch for track ticket 42724 #10). Sorting them last could be a follow-up.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude (Antropic)
Model(s): Opus 5.5
Used for: Refreshing patch, writing code, generating PR description. Code was reviewed and tested 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.

@github-actions

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.

Core Committers: Use this line as a base for the props when committing in SVN:

Props sawf1y.

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


Props Bot commands

You can trigger Props Bot actions by commenting on this PR:

  • @propsbot add <username> to give props to a GitHub user. Requires write access.
  • @propsbot remove <username> to leave a user out of the props. Requires write access.
  • @propsbot refresh to refresh this list. Adding the props-bot label works too.

@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

  • 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