registered_meta_key_exists( string $object_type, string $meta_key, string $object_subtype ): bool

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.

User Contributed Notes

You must log in before being able to contribute a note or feedback.