函数文档

get_networks()

💡 云策文档标注

概述

get_networks() 函数用于检索网络列表,支持通过参数定制查询,返回 WP_Network 对象、网络 ID 或网络数量。

关键要点

  • 参数 $args 可选,可以是字符串或数组,用于指定查询条件,默认值为空数组。
  • 返回值根据查询参数变化:默认返回 WP_Network 对象列表;当 'fields' 设为 'ids' 时返回网络 ID 列表;当 'count' 作为查询变量时返回网络数量。
  • 内部实现基于 WP_Network_Query 类,调用其 query() 方法执行查询。
  • 该函数自 WordPress 4.6.0 版本引入,主要用于多站点环境。

代码示例

function get_networks( $args = array() ) {
    $query = new WP_Network_Query();
    return $query->query( $args );
}

注意事项

  • 参数详情需参考 WP_Network_Query::parse_query() 方法,以了解支持的查询参数。
  • 在多站点配置中,此函数常用于获取网络信息,例如在 ms-load_current_site_and_network() 等函数中使用。

📄 原文内容

Retrieves a list of networks.

Parameters

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

Default:array()

Return

array|int List of WP_Network objects, a list of network IDs when 'fields' is set to 'ids', or the number of networks when 'count' is passed as a query var.

Source

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

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

Changelog

Version Description
4.6.0 Introduced.