函数文档

get_registered_meta_keys()

💡 云策文档标注

概述

get_registered_meta_keys() 函数用于检索指定对象类型及其子类型的已注册元数据参数列表,以元键为键名返回数组。该函数依赖于全局变量 $wp_meta_keys 来获取数据。

关键要点

  • 参数 $object_type 为必需,指定对象类型,如 'post'、'user'、'term' 等。
  • 参数 $object_subtype 为可选,指定对象子类型,默认为空字符串。
  • 返回值为数组,包含已注册的元数据参数,键名为元键。
  • 函数内部检查 $wp_meta_keys 数组结构,若未找到对应数据则返回空数组。
  • 相关函数包括 registered_meta_key_exists() 和 get_registered_metadata(),用于元数据管理。

代码示例

function get_registered_meta_keys( $object_type, $object_subtype = '' ) {
    global $wp_meta_keys;

    if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $object_type ] ) || ! isset( $wp_meta_keys[ $object_type ][ $object_subtype ] ) ) {
        return array();
    }

    return $wp_meta_keys[ $object_type ][ $object_subtype ];
}

注意事项

  • 该函数在 WordPress 4.6.0 版本引入,4.9.8 版本添加了 $object_subtype 参数。
  • 确保 $wp_meta_keys 全局变量已正确设置,否则可能返回空数组。

📄 原文内容

Retrieves a list of registered metadata args for an object type, keyed by their meta keys.

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.
$object_subtypestringoptional
The subtype of the object type. Default empty string.

Return

array[] List of registered metadata args, keyed by their meta keys.

Source

function get_registered_meta_keys( $object_type, $object_subtype = '' ) {
	global $wp_meta_keys;

	if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $object_type ] ) || ! isset( $wp_meta_keys[ $object_type ][ $object_subtype ] ) ) {
		return array();
	}

	return $wp_meta_keys[ $object_type ][ $object_subtype ];
}

Changelog

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