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

Timestamp:

11/19/2020 06:22:02 PM (5 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-site-query.php (modified) (2 diffs)

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

@@ -115 +115 @@
      *     Optional. Array or query string of site query parameters. Default empty.
      *
-     *     @type array        $site__in               Array of site IDs to include. Default empty.
-     *     @type array        $site__not_in           Array of site IDs to exclude. Default empty.
+     *     @type int[]        $site__in               Array of site IDs to include. Default empty.
+     *     @type int[]        $site__not_in           Array of site IDs to exclude. Default empty.
      *     @type bool         $count                  Whether to return a site count (true) or array of site objects.
      *                                                Default false.
@@ -136 +136 @@
      *     @type int          $network_id             Limit results to those affiliated with a given network ID. If 0,
      *                                                include all networks. Default 0.
-     *     @type array        $network__in            Array of network IDs to include affiliated sites for. Default empty.
-     *     @type array        $network__not_in        Array of network IDs to exclude affiliated sites for. Default empty.
+     *     @type int[]        $network__in            Array of network IDs to include affiliated sites for. Default empty.
+     *     @type int[]        $network__not_in        Array of network IDs to exclude affiliated sites for. Default empty.
      *     @type string       $domain                 Limit results to those affiliated with a given domain. Default empty.
      *     @type array        $domain__in             Array of domains to include affiliated sites for. Default empty.