函数文档

delete_post_meta_by_key()

💡 云策文档标注

概述

delete_post_meta_by_key() 函数用于删除所有匹配指定 meta key 的 post meta 数据。它基于 delete_metadata() 实现,返回删除操作是否成功。

关键要点

  • 参数 $post_meta_key 为必需字符串,指定要删除的 meta key。
  • 返回布尔值,表示 meta key 是否从数据库中成功删除。
  • 内部调用 delete_metadata('post', null, $post_meta_key, '', true) 执行删除操作。
  • 自 WordPress 2.3.0 版本引入。

代码示例

function delete_post_meta_by_key( $post_meta_key ) {
    return delete_metadata( 'post', null, $post_meta_key, '', true );
}

📄 原文内容

Deletes everything from post meta matching the given meta key.

Parameters

$post_meta_keystringrequired
Key to search for when deleting.

Return

bool Whether the post meta key was deleted from the database.

Source

function delete_post_meta_by_key( $post_meta_key ) {
	return delete_metadata( 'post', null, $post_meta_key, '', true );
}

Changelog

Version Description
2.3.0 Introduced.