函数文档

get_blog_status()

💡 云策文档标注

概述

get_blog_status() 函数用于获取指定博客的详细信息字段。它接受博客ID和字段名作为参数,返回对应的字段值,可能为布尔值、字符串或null。

关键要点

  • 参数:$id(整数,必需)指定博客ID;$pref(字符串,必需)指定要获取的字段名。
  • 返回值:返回字段值,类型为bool|string|null,若博客不存在或字段无效可能返回null。
  • 内部实现:首先尝试通过get_site()获取站点数据,如果失败则直接查询数据库。
  • 相关函数:与get_site()、wpdb::get_var()和wpdb::prepare()紧密相关。

代码示例

function get_blog_status( $id, $pref ) {
    global $wpdb;

    $details = get_site( $id );
    if ( $details ) {
        return $details->$pref;
    }

    return $wpdb->get_var( $wpdb->prepare( "SELECT %s FROM {$wpdb->blogs} WHERE blog_id = %d", $pref, $id ) );
}

注意事项

  • 此函数主要用于多站点环境,自WordPress MU 3.0.0版本引入。
  • 使用时应确保传入有效的博客ID和字段名,以避免数据库查询错误。
  • 返回值类型多样,调用时需进行适当的类型检查。

📄 原文内容

Gets a blog details field.

Parameters

$idintrequired
Blog ID.
$prefstringrequired
Field name.

Return

bool|string|null $value

Source

function get_blog_status( $id, $pref ) {
	global $wpdb;

	$details = get_site( $id );
	if ( $details ) {
		return $details->$pref;
	}

	return $wpdb->get_var( $wpdb->prepare( "SELECT %s FROM {$wpdb->blogs} WHERE blog_id = %d", $pref, $id ) );
}

Changelog

Version Description
MU (3.0.0) Introduced.