Changeset 62721

Timestamp:

07/14/2026 05:41:49 AM (6 weeks ago)

Author:

westonruter

Message:

Docs: Add specific types to WP_Network_Query properties.

Replace the generic array type in the docblocks for the $sql_clauses, $query_vars, $query_var_defaults, and $networks properties with specific types, including an array shape for $sql_clauses and WP_Network[]|int[] for $networks. Additionally, document the $found_networks and $max_num_pages counts as non-negative-int.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/11663.
Follow-up to r37894.

Props baikaresandeep007-1, westonruter.
See #64896.
Fixes #65118.

File:

• trunk/src/wp-includes/class-wp-network-query.php (modified) (6 diffs)

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

@@ -30 +30 @@
          *
          * @since 4.6.0
-         * @var array
+         * @var array{
+         *     select: string,
+         *     from: string,
+         *     where: array<string, string>,
+         *     groupby: string,
+         *     orderby: string,
+         *     limits: string
+         * }
          */
         protected $sql_clauses = array(
@@ -45 +52 @@
          *
          * @since 4.6.0
-         * @var array
+         * @var array<string, mixed>
          */
         public $query_vars;
@@ -53 +60 @@
          *
          * @since 4.6.0
-         * @var array
+         * @var array<string, mixed>
          */
         public $query_var_defaults;
@@ -61 +68 @@
          *
          * @since 4.6.0
-         * @var array
+         * @var WP_Network[]|int[]
          */
         public $networks;
@@ -70 +77 @@
          * @since 4.6.0
          * @var int
+         * @phpstan-var non-negative-int
          */
         public $found_networks = 0;
@@ -78 +86 @@
          * @since 4.6.0
          * @var int
+         * @phpstan-var non-negative-int
          */
         public $max_num_pages = 0;