Changeset 42165 for trunk/src/wp-includes/class-wp-comment-query.php

Timestamp:

11/13/2017 04:25:18 PM (7 years ago)

Author:

boonebgorges

Message:

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.

File:

• trunk/src/wp-includes/class-wp-comment-query.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-comment-query.php

@@ -223 +223 @@
      *     @type string       $search                    Search term(s) to retrieve matching comments for.
      *                                                   Default empty.
-     *     @type string       $status                    Comment status to limit results by. Accepts 'hold'
-     *                                                   (`comment_status=0`), 'approve' (`comment_status=1`),
-     *                                                   'all', or a custom comment status. Default 'all'.
+     *     @type string|array $status                    Comment stati to limit results by. Accepts an array
+     *                                                   or space/comma separate list of 'hold' (`comment_status=0`),
+     *                                                   'approve' (`comment_status=1`), 'all', or a custom
+     *                                                   comment status. Default 'all'.
      *     @type string|array $type                      Include comments of a given type, or array of types.
      *                                                   Accepts 'comment', 'pings' (includes 'pingback' and