函数文档

delete_term_meta()

💡 云策文档标注

概述

delete_term_meta() 函数用于从分类法中删除匹配条件的元数据。它基于 delete_metadata() 实现,专为分类法元数据操作设计。

关键要点

  • 函数用于删除分类法元数据,支持根据元键和可选元值进行匹配删除。
  • 输入时,元键和元值需要“转义斜杠”(slashed),这是出于历史原因。
  • 参数包括必需的 term_id(分类法 ID)和 meta_key(元键),以及可选的 meta_value(元值)。
  • 返回布尔值:成功时返回 true,失败时返回 false。
  • 自 WordPress 4.4.0 版本引入,是分类法元数据管理的重要函数。

代码示例

function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) {
    return delete_metadata( 'term', $term_id, $meta_key, $meta_value );
}

📄 原文内容

Removes metadata matching criteria from a term.

Description

For historical reasons both the meta key and the meta value are expected to be “slashed” (slashes escaped) on input.

Parameters

$term_idintrequired
Term 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.

Return

bool True on success, false on failure.

Source

function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) {
	return delete_metadata( 'term', $term_id, $meta_key, $meta_value );
}

Changelog

Version Description
4.4.0 Introduced.