函数文档

wp_get_network()

💡 云策文档标注

概述

wp_get_network() 是一个已弃用的 WordPress 函数,用于根据网络 ID 或网络对象检索网络信息。自 4.7.0 版本起,建议使用 get_network() 替代。

关键要点

  • 函数 wp_get_network() 在 WordPress 4.7.0 中被弃用,应改用 get_network()。
  • 参数 $network 可以是网络数据库行或网络 ID,为必需参数。
  • 返回值类型为 WP_Network 对象(如果找到网络信息)或 false(如果未找到)。
  • 内部实现调用了 get_network(),并在返回 null 时转换为 false。

代码示例

function wp_get_network( $network ) {
    _deprecated_function( __FUNCTION__, '4.7.0', 'get_network()' );

    $network = get_network( $network );
    if ( null === $network ) {
        return false;
    }

    return $network;
}

注意事项

  • 此函数自 4.7.0 版本起已弃用,新代码应避免使用,以保持兼容性和最佳实践。
  • 相关函数包括 get_network() 和 _deprecated_function(),分别用于检索网络数据和标记弃用函数。

📄 原文内容

Retrieves an object containing information about the requested network.

Description

{@internal In 4.6.0, converted to use get_network() }

See also

Parameters

$networkobject|intrequired
The network’s database row or ID.

Return

WP_Network|false Object containing network information if found, false if not.

Source

function wp_get_network( $network ) {
	_deprecated_function( __FUNCTION__, '4.7.0', 'get_network()' );

	$network = get_network( $network );
	if ( null === $network ) {
		return false;
	}

	return $network;
}

Changelog

Version Description
4.7.0 Deprecated. Use get_network()
3.9.0 Introduced.