云策 WordPress 开发者社区

函数文档

registered_meta_key_exists()

查看官方原文 ↗
💡 云策文档标注

概述

registered_meta_key_exists() 函数用于检查指定的元键是否已注册到 WordPress 对象类型中。它基于 get_registered_meta_keys() 获取注册元键列表，并返回布尔值表示是否存在。

关键要点

  • 函数接受三个参数：$object_type（必需，对象类型如 'post'、'user' 等）、$meta_key（必需，元键名称）、$object_subtype（可选，对象子类型，默认为空字符串）。
  • 返回布尔值：如果元键已注册到指定对象类型（和可选的子类型），则返回 true；否则返回 false。
  • 该函数在 WordPress 4.6.0 中引入，并在 4.9.8 版本添加了 $object_subtype 参数。

代码示例

registered_meta_key_exists( $object_type, $meta_key, $object_subtype = '' ) {
    $meta_keys = get_registered_meta_keys( $object_type, $object_subtype );
    return isset( $meta_keys[ $meta_key ] );
}

注意事项

  • 函数依赖于 get_registered_meta_keys() 来获取注册元键列表，确保元键已通过 register_meta() 等函数正确注册。
  • 相关函数包括 get_registered_meta_keys()（获取注册元键列表）、unregister_meta_key()（取消注册元键）和 get_registered_metadata()（获取注册元数据）。
📄 原文内容

Checks if a meta key is registered.

Parameters

$object_typestringrequired
Type of object metadata is for. Accepts 'blog', 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
$meta_keystringrequired
Metadata key.
$object_subtypestringoptional
The subtype of the object type. Default empty string.

Return

bool True if the meta key is registered to the object type and, if provided, the object subtype. False if not.

Source

function registered_meta_key_exists( $object_type, $meta_key, $object_subtype = '' ) {
	$meta_keys = get_registered_meta_keys( $object_type, $object_subtype );

	return isset( $meta_keys[ $meta_key ] );
}

View all references View on Trac View on GitHub

Uses Description
get_registered_meta_keys()wp-includes/meta.php

Retrieves a list of registered metadata args for an object type, keyed by their meta keys.
Used by Description
unregister_meta_key()wp-includes/meta.php

Unregisters a meta key from the list of registered keys.
get_registered_metadata()wp-includes/meta.php

Retrieves registered metadata for a specified object.

Changelog

Version Description
4.9.8 The $object_subtype parameter was added.
4.6.0 Introduced.