函数文档

is_main_network()

💡 云策文档标注

概述

is_main_network() 函数用于判断指定网络是否为 WordPress 多站点安装中的主网络。在非多站点环境下,该函数始终返回 true。

关键要点

  • 参数 $network_id 可选,默认为 null,表示测试当前网络 ID。
  • 返回布尔值:如果 $network_id 是主网络或未启用多站点,则返回 true。
  • 函数内部逻辑:先检查 is_multisite(),若为 false 直接返回 true;否则比较 $network_id 与 get_main_network_id()。

代码示例

function is_main_network( $network_id = null ) {
	if ( ! is_multisite() ) {
		return true;
	}

	if ( null === $network_id ) {
		$network_id = get_current_network_id();
	}

	$network_id = (int) $network_id;

	return ( get_main_network_id() === $network_id );
}

注意事项

  • 相关函数包括 get_current_network_id()、get_main_network_id() 和 is_multisite()。
  • 该函数自 WordPress 3.7.0 版本引入。

📄 原文内容

Determines whether a network is the main network of the Multisite installation.

Parameters

$network_idintoptional
Network ID to test. Defaults to current network.

Default:null

Return

bool True if $network_id is the main network, or if not running Multisite.

Source

function is_main_network( $network_id = null ) {
	if ( ! is_multisite() ) {
		return true;
	}

	if ( null === $network_id ) {
		$network_id = get_current_network_id();
	}

	$network_id = (int) $network_id;

	return ( get_main_network_id() === $network_id );
}

Changelog

Version Description
3.7.0 Introduced.