unregister_term_meta()
云策文档标注
概述
unregister_term_meta() 函数用于取消注册一个针对分类术语的元数据键。它通过调用 unregister_meta_key() 实现,并返回操作结果。
关键要点
- 函数用于取消注册分类术语的元数据键,确保元数据管理的一致性。
- 接受两个参数:$taxonomy(分类法名称,可为空字符串表示所有分类法)和 $meta_key(要取消注册的元数据键)。
- 返回布尔值:成功取消注册返回 true,如果元数据键未注册则返回 false。
- 内部实现基于 unregister_meta_key() 函数,指定对象类型为 'term'。
代码示例
function unregister_term_meta( $taxonomy, $meta_key ) {
return unregister_meta_key( 'term', $meta_key, $taxonomy );
}注意事项
- 在取消注册前,确保元数据键已通过 register_term_meta() 或其他方式注册,否则函数将返回 false。
- 传递空字符串作为 $taxonomy 参数可以取消注册跨所有现有分类法的元数据键。
- 此函数自 WordPress 4.9.8 版本引入,使用时需注意版本兼容性。
原文内容
Unregisters a meta key for terms.
Parameters
$taxonomystringrequired-
Taxonomy the meta key is currently registered for. Pass an empty string if the meta key is registered across all existing taxonomies.
$meta_keystringrequired-
The meta key to unregister.
Source
function unregister_term_meta( $taxonomy, $meta_key ) {
return unregister_meta_key( 'term', $meta_key, $taxonomy );
}
Changelog
| Version | Description |
|---|---|
| 4.9.8 | Introduced. |