update_site_meta()
云策文档标注
概述
update_site_meta() 函数用于更新站点的元数据,基于 update_metadata() 实现,支持通过 $prev_value 参数进行条件更新。
关键要点
- 函数用于更新指定站点 ID 的元数据,若元数据不存在则自动添加。
- 参数包括 $site_id(站点 ID)、$meta_key(元数据键)、$meta_value(元数据值,非标量需可序列化)和可选的 $prev_value(用于检查的旧值)。
- 返回值:元数据不存在时返回 Meta ID,成功更新返回 true,失败或值未变返回 false。
- 出于历史原因,输入时元数据键和值需进行“斜杠转义”。
代码示例
function update_site_meta( $site_id, $meta_key, $meta_value, $prev_value = '' ) {
return update_metadata( 'blog', $site_id, $meta_key, $meta_value, $prev_value );
}
原文内容
Updates metadata for a site.
Description
Use the $prev_value parameter to differentiate between meta fields with the same key and site ID.
If the meta field for the site does not exist, it will be added.
For historical reasons both the meta key and the meta value are expected to be “slashed” (slashes escaped) on input.
Parameters
$site_idintrequired-
Site ID.
$meta_keystringrequired-
Metadata key.
$meta_valuemixedrequired-
Metadata value. Must be serializable if non-scalar.
$prev_valuemixedoptional-
Previous value to check before updating.
If specified, only update existing metadata entries with this value. Otherwise, update all entries. Default empty.
Source
function update_site_meta( $site_id, $meta_key, $meta_value, $prev_value = '' ) {
return update_metadata( 'blog', $site_id, $meta_key, $meta_value, $prev_value );
}
Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |