函数文档

get_current_site_name()

💡 云策文档标注

概述

get_current_site_name() 是一个已弃用的 WordPress 函数,用于设置 $current_site 对象的 site_name 属性。自 3.9.0 版本起,建议使用 get_current_site() 替代。

关键要点

  • 函数已弃用,自 WordPress 3.9.0 起不再推荐使用。
  • 返回 $current_site 对象,但 site_name 属性现在由 bootstrap 自动设置。
  • 替代方案:使用 get_current_site()->site_name 来获取站点名称。
  • 参数:$current_site(必需,WP_Network 类型)。
  • 返回值:WP_Network 对象。

代码示例

function get_current_site_name( $current_site ) {
    _deprecated_function( __FUNCTION__, '3.9.0', 'get_current_site()' );
    return $current_site;
}

注意事项

  • 使用此函数会触发 _deprecated_function() 警告,提示开发者迁移到新方法。
  • 相关函数:_deprecated_function() 用于标记函数为弃用状态。
  • 版本历史:3.0.0 引入,3.9.0 弃用。

📄 原文内容

This deprecated function formerly set the site_name property of the $current_site object.

Description

This function simply returns the object, as before.
The bootstrap takes care of setting site_name.

Parameters

$current_siteWP_Networkrequired

Return

WP_Network

Source

function get_current_site_name( $current_site ) {
	_deprecated_function( __FUNCTION__, '3.9.0', 'get_current_site()' );
	return $current_site;
}

Changelog

Version Description
3.9.0 Deprecated. Use get_current_site() instead.
3.0.0 Introduced.

User Contributed Notes