函数文档

delete_site_meta_by_key()

💡 云策文档标注

概述

delete_site_meta_by_key() 函数用于删除站点元数据中所有匹配指定键名的条目。它基于 delete_metadata() 实现,返回删除操作是否成功。

关键要点

  • 参数 $meta_key 为必需字符串,指定要删除的元数据键名
  • 返回布尔值,表示是否从数据库中成功删除该站点元数据键
  • 内部调用 delete_metadata('blog', null, $meta_key, '', true) 来执行删除操作
  • 自 WordPress 5.1.0 版本引入

代码示例

function delete_site_meta_by_key( $meta_key ) {
    return delete_metadata( 'blog', null, $meta_key, '', true );
}

📄 原文内容

Deletes everything from site meta matching meta key.

Parameters

$meta_keystringrequired
Metadata key to search for when deleting.

Return

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

Source

function delete_site_meta_by_key( $meta_key ) {
	return delete_metadata( 'blog', null, $meta_key, '', true );
}

Changelog

Version Description
5.1.0 Introduced.