Skip to content

Commit abc3bd1

Browse files
committed
fix: comments params and improve documentation
1 parent c2e0a55 commit abc3bd1

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

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

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,23 @@ class WP_Network_Query {
2121
* SQL for database query.
2222
*
2323
* @since 4.6.0
24-
* @var string
24+
* @var string SQL statement for the last performed network query.
2525
*/
2626
public $request;
2727

2828
/**
2929
* SQL query clauses.
3030
*
3131
* @since 4.6.0
32-
* @var array
32+
* @var array{
33+
* select: string,
34+
* from: string,
35+
* where: array,
36+
* groupby: string,
37+
* orderby: string,
38+
* limits: string
39+
* }
40+
* Associative array of SQL query clauses used to build the request.
3341
*/
3442
protected $sql_clauses = array(
3543
'select' => '',
@@ -44,39 +52,39 @@ class WP_Network_Query {
4452
* Query vars set by the user.
4553
*
4654
* @since 4.6.0
47-
* @var array
55+
* @var array<string, mixed> Query variables for the current query.
4856
*/
4957
public $query_vars;
5058

5159
/**
5260
* Default values for query vars.
5361
*
5462
* @since 4.6.0
55-
* @var array
63+
* @var array<string, mixed> Default values for query variables.
5664
*/
5765
public $query_var_defaults;
5866

5967
/**
6068
* List of networks located by the query.
6169
*
6270
* @since 4.6.0
63-
* @var array
71+
* @var WP_Network[]|int[] Array of WP_Network objects or network IDs, depending on 'fields' parameter.
6472
*/
6573
public $networks;
6674

6775
/**
6876
* The amount of found networks for the current query.
6977
*
7078
* @since 4.6.0
71-
* @var int
79+
* @var int Number of networks found for the current query.
7280
*/
7381
public $found_networks = 0;
7482

7583
/**
7684
* The number of pages.
7785
*
7886
* @since 4.6.0
79-
* @var int
87+
* @var int Number of pages of results for the current query.
8088
*/
8189
public $max_num_pages = 0;
8290

0 commit comments

Comments
 (0)