delete_site_meta()
云策文档标注
概述
delete_site_meta() 函数用于从站点中删除匹配指定条件的元数据。它基于站点 ID、元数据键和可选的元数据值来移除数据,并返回操作成功与否的布尔值。
关键要点
- 函数基于站点 ID 和元数据键删除元数据,可选元数据值用于精确匹配。
- 输入时,元数据键和值需要“转义斜杠”(slashed),这是出于历史原因。
- 返回值为布尔类型:成功时返回 true,失败时返回 false。
- 该函数内部调用 delete_metadata(),指定对象类型为 'blog'。
代码示例
function delete_site_meta( $site_id, $meta_key, $meta_value = '' ) {
return delete_metadata( 'blog', $site_id, $meta_key, $meta_value );
}注意事项
- 非标量元数据值必须是可序列化的。
- 如果提供元数据值,则只删除键和值都匹配的行,这有助于避免删除具有相同键的重复元数据。
原文内容
Removes metadata matching criteria from a site.
Description
You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.
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 name.
$meta_valuemixedoptional-
Metadata value. If provided, rows will only be removed that match the value.
Must be serializable if non-scalar. Default empty.
Source
function delete_site_meta( $site_id, $meta_key, $meta_value = '' ) {
return delete_metadata( 'blog', $site_id, $meta_key, $meta_value );
}
Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |