WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#30111 closed enhancement (fixed)

Default argument documentation for WP_Comment_Query

Reported by: boonebgorges Owned by: DrewAPicture
Milestone: 4.1 Priority: normal
Severity: normal Version:
Component: Query Keywords: has-patch
Focuses: docs Cc:

Description

Attached patch adds documentation for WP_Comment_Query default arguments.

Attachments (3)

30111.patch (5.7 KB) - added by boonebgorges 5 years ago.
30111.2.patch (5.9 KB) - added by boonebgorges 5 years ago.
30111.3.patch (6.4 KB) - added by DrewAPicture 5 years ago.

Download all attachments as: .zip

Change History (10)

@boonebgorges
5 years ago

This ticket was mentioned in Slack in #bots by arkonisus. View the logs.


5 years ago

#2 @DrewAPicture
5 years ago

  • Owner set to DrewAPicture
  • Status changed from new to reviewing

#3 @DrewAPicture
5 years ago

In 30110:

Update the changelog for WP_Comment_Query::query() to reflect two more new arguments added in [30096].

[30096] introduced the type__in and type__not_in arguments. See #30111 for documentation on those new arguments.

Fixes #12668.

#4 @DrewAPicture
5 years ago

  • Keywords needs-patch added; has-patch removed

@boonebgorges: Care to add the type__in and type__not_in parameters to your patch?

#5 @boonebgorges
5 years ago

  • Keywords has-patch added; needs-patch removed

Avec plaisir. Attached for your review.

#6 @DrewAPicture
5 years ago

In 30280:

Document default arguments for WP_Comment_Query class as a hash notation.

Props boonebgorges, DrewAPicture.
See #30111.

#7 @DrewAPicture
5 years ago

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

In 30281:

Cross-reference WP_Comment_Query::query() as the location for finding information on default arguments for WP_Comment_Query.

Also updates the return types on get_comments() and get_approved_comments(), as an integer can also be returned if the $count argument is true.

Fixes #30111.

Note: See TracTickets for help on using tickets.