Changeset 49672 for trunk/src/wp-includes/class-wp-user-query.php

Timestamp:

11/19/2020 06:22:02 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Document parameters that accept an array of integers using typed array notation.

While many of these parameters also technically accept an array of numerical strings, they are all ultimately cast to an array of integers. Documenting them as such assists developers in understanding the expected types.

See #51800, #41756

File:

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

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

@@ -155 +155 @@
          *                                             'BETWEEN', 'NOT BETWEEN', 'EXISTS', 'NOT EXISTS', 'REGEXP',
          *                                             'NOT REGEXP', or 'RLIKE'. Default '='.
-         *     @type array        $include             An array of user IDs to include. Default empty array.
-         *     @type array        $exclude             An array of user IDs to exclude. Default empty array.
+         *     @type int[]        $include             An array of user IDs to include. Default empty array.
+         *     @type int[]        $exclude             An array of user IDs to exclude. Default empty array.
          *     @type string       $search              Search keyword. Searches for possible string matches on columns.
          *                                             When `$search_columns` is left empty, it tries to determine which