WP_Network_Query::__construct( string|array $query =  )

Constructor.

Description

Sets up the network query, based on the query vars passed.

Parameters

$querystring|arrayoptional
Array or query string of network query parameters.
  • network__in int[]
    Array of network IDs to include.
  • network__not_in int[]
    Array of network IDs to exclude.
  • count bool
    Whether to return a network count (true) or array of network objects.
    Default false.
  • fields string
    Network fields to return. Accepts 'ids' (returns an array of network IDs) or empty (returns an array of complete network objects).
  • number int
    Maximum number of networks to retrieve. Default empty (no limit).
  • offset int
    Number of networks to offset the query. Used to build LIMIT clause.
    Default 0.
  • no_found_rows bool
    Whether to disable the SQL_CALC_FOUND_ROWS query. Default true.
  • orderby string|array
    Network status or array of statuses. Accepts 'id', 'domain', 'path', 'domain_length', 'path_length' and 'network__in'. Also accepts false, an empty array, or 'none' to disable ORDER BY clause. Default 'id'.
  • order string
    How to order retrieved networks. Accepts 'ASC', 'DESC'. Default 'ASC'.
  • domain string
    Limit results to those affiliated with a given domain.
  • domain__in string[]
    Array of domains to include affiliated networks for.
  • domain__not_in string[]
    Array of domains to exclude affiliated networks for.
  • path string
    Limit results to those affiliated with a given path.
  • path__in string[]
    Array of paths to include affiliated networks for.
  • path__not_in string[]
    Array of paths to exclude affiliated networks for.
  • search string
    Search term(s) to retrieve matching networks for.
  • update_network_cache bool
    Whether to prime the cache for found networks. Default true.

Default:''

Source

public function __construct( $query = '' ) {
	$this->query_var_defaults = array(
		'network__in'          => '',
		'network__not_in'      => '',
		'count'                => false,
		'fields'               => '',
		'number'               => '',
		'offset'               => '',
		'no_found_rows'        => true,
		'orderby'              => 'id',
		'order'                => 'ASC',
		'domain'               => '',
		'domain__in'           => '',
		'domain__not_in'       => '',
		'path'                 => '',
		'path__in'             => '',
		'path__not_in'         => '',
		'search'               => '',
		'update_network_cache' => true,
	);

	if ( ! empty( $query ) ) {
		$this->query( $query );
	}
}

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.