Skip to content

Docs: Correct the $operator default for wp_filter_object_list() - #13245

Open
itzmekhokan wants to merge 1 commit into
WordPress:trunkfrom
itzmekhokan:fix/65933-filter-object-list-operator-docs
Open

Docs: Correct the $operator default for wp_filter_object_list()#13245
itzmekhokan wants to merge 1 commit into
WordPress:trunkfrom
itzmekhokan:fix/65933-filter-object-list-operator-docs

Conversation

@itzmekhokan

Copy link
Copy Markdown

wp_filter_object_list() documents its $operator default as 'AND', but the function signature declares $operator = 'and'.

The mismatch dates to the function's introduction in 3.0.0. Neither casing is wrong at runtime, since WP_List_Util::filter() uppercases the operator before validating it, so the patch corrects the documented default to 'and' and notes that the value is case-insensitive — the sentence that reconciles the uppercase operator names above it with the lowercase default.

wp_list_filter() and WP_List_Util::filter() already document 'AND' as both their default and their declared value, so they are left alone.

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

Use of AI Tools


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.

The DocBlock documented the default as 'AND', but the function signature
declares `$operator = 'and'`. Note that the value is case-insensitive,
which is why the uppercase operator names and the lowercase default are
both accurate.

Fixes #65933.
@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. 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 khokansardar.

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

@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