WordPress.org

Make WordPress Core

Opened 2 years ago

Closed 9 months ago

Last modified 9 months ago

#41338 closed defect (bug) (fixed)

description of $status parameter in WP_Comment_Query::__construct() is incorrect

Reported by: pbiron Owned by: boonebgorges
Milestone: 5.1 Priority: normal
Severity: normal Version: 4.1
Component: Comments Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description

The description of the $status parameter suggests that only a single status can be provided.

However, WP_Comment_Query::get_comment_ids() treats it as an array of stati (either a true array or a space/comma separated list).

The description should be updated to reflect this.

Attachments (1)

41338.diff (1.5 KB) - added by pbiron 2 years ago.
fix description of $status parameter in WP_Comment_Query::construct()

Download all attachments as: .zip

Change History (12)

@pbiron
2 years ago

fix description of $status parameter in WP_Comment_Query::construct()

#1 @pbiron
2 years ago

  • Keywords has-patch added

#2 @pbiron
2 years ago

  • Focuses docs added

#3 @ocean90
2 years ago

  • Milestone changed from Awaiting Review to 5.0
  • Version changed from 4.9 to 4.1

Introduced in [30084].

#4 @boonebgorges
2 years ago

  • Owner set to boonebgorges
  • Resolution set to fixed
  • Status changed from new to closed

In 42165:

Correct documentation for status param of WP_Comment_Query.

The status parameter accepts an array or string/comma-separated list.

Introduced in [30084].

Props pbiron.
Fixes #41338.

#5 @johnbillion
12 months ago

  • Milestone changed from 5.0 to 5.0.1
  • Resolution fixed deleted
  • Status changed from closed to reopened

#6 @pento
10 months ago

  • Milestone changed from 5.0.1 to 5.0.2

#7 @pento
10 months ago

  • Milestone changed from 5.0.2 to 5.0.3

This ticket was mentioned in Slack in #core by audrasjb. View the logs.


10 months ago

#9 @audrasjb
10 months ago

  • Milestone changed from 5.0.3 to 5.1

Hi,

Per today's bug scrub, let's address this ticket in the next major, 5.1, scheduled in February.

#10 @SergeyBiryukov
9 months ago

  • Resolution set to fixed
  • Status changed from reopened to closed

Fixed in [42165], doesn't look like any additional changes are needed.

#11 @SergeyBiryukov
9 months ago

In 44412:

Docs: Fix typo in the description of status parameter of WP_Comment_Query.

See #41338.

Note: See TracTickets for help on using tickets.