WordPress开发手册:get_networks()

函数原型

get_networks( string|array $args = array() ): array|int

函数描述

是否弃用

未弃用

函数参数

$args
string|array
Optional

Array or string of arguments. See WP_Network_Query::parse_query() for information on accepted arguments.

More Arguments from WP_Network_Query::parse_query( … $query )

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: array()

函数返回值

函数位置

函数源码

function get_networks( $args = array() ) {
	$query = new WP_Network_Query();

	return $query->query( $args );
}

源码链接

WordPress
Github

变更日志