update_archived()
云策文档标注
概述
update_archived() 函数用于更新特定博客的“archived”状态。它通过调用 update_blog_status() 实现，并返回更新后的状态值。
关键要点
- 函数接受两个参数：$id（博客ID，整数类型，必需）和 $archived（新状态，字符串类型，必需）。
- 函数内部调用 update_blog_status($id, 'archived', $archived) 来更新博客的 archived 字段。
- 函数返回更新后的 $archived 字符串值。
- 相关函数：update_blog_status()，位于 wp-includes/ms-blogs.php，用于更新博客的详细信息字段。
- 版本历史：自 MU (3.0.0) 版本引入。
原文内容
Updates the ‘archived’ status of a particular blog.
Parameters
$idintrequired-
Blog ID.
$archivedstringrequired-
The new status.
Source
function update_archived( $id, $archived ) {
update_blog_status( $id, 'archived', $archived );
return $archived;
}
Changelog
| Version | Description |
|---|---|
| MU (3.0.0) | Introduced. |