Core Class

WP_Site_Query

 class WP_Site_Query
// Constructor: function Object() { [native code] }

Core class used for querying sites.

Methods 9 methods

Method / Return	Description
__construct() void	Sets up the site query, based on the query vars passed. Parameters: $query: mixed
parse_query() void	Parses arguments passed to the site query with default query parameters. Parameters: $query: mixed
query() (WP_Site[]	Sets up the WordPress query for retrieving sites. Parameters: $query: mixed
get_sites() (WP_Site[]	Retrieves a list of sites matching the query vars.
get_site_ids() (int	Used internally to get a list of site IDs matching the query vars.
set_found_sites() void	Populates found_sites and max_num_pages properties for the current query
get_search_sql() string	Used internally to generate an SQL string for searching across multiple columns. Parameters: $search: mixed, $columns: mixed
parse_orderby() (string	Parses and sanitizes 'orderby' keys passed to the site query. Parameters: $orderby: mixed
parse_order() string	Parses an 'order' query variable and cast it to 'ASC' or 'DESC' as necessary. Parameters: $order: mixed

Property / Type	Description
$request mixed public	No description available.
$sql_clauses mixed public	No description available.
$meta_query mixed public	No description available.
$meta_query_clauses mixed public	No description available.
$date_query mixed public	No description available.
$query_vars mixed public	No description available.
$query_var_defaults mixed public	No description available.
$sites mixed public	No description available.
$found_sites mixed public	No description available.
$max_num_pages mixed public	No description available.

Since Version

4.6.0

Source File

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