unregister_post_meta()

💡 云策文档标注

概述

unregister_post_meta() 函数用于取消注册文章的自定义元键，适用于 WordPress 开发者管理元数据注册。它通过调用 unregister_meta_key() 实现，返回操作成功与否的布尔值。

函数参数：$post_type（字符串，必需）指定元键当前注册的文章类型，若为空字符串则表示跨所有现有文章类型注册；$meta_key（字符串，必需）指定要取消注册的元键。
返回值：成功时返回 true，若元键之前未注册则返回 false。
内部实现：基于 unregister_meta_key() 函数，针对 'post' 类型处理。
版本历史：自 WordPress 4.9.8 版本引入。

function unregister_post_meta( $post_type, $meta_key ) {
	return unregister_meta_key( 'post', $meta_key, $post_type );
}

📄 原文内容

Unregisters a meta key for posts.

$post_typestringrequired: Post type the meta key is currently registered for. Pass an empty string if the meta key is registered across all existing post types.
$meta_keystringrequired: The meta key to unregister.

bool True on success, false if the meta key was not previously registered.

function unregister_post_meta( $post_type, $meta_key ) {
	return unregister_meta_key( 'post', $meta_key, $post_type );
}

Uses	Description
unregister_meta_key()`wp-includes/meta.php`	Unregisters a meta key from the list of registered keys.

Version	Description
4.9.8	Introduced.