Core Function

get_metadata()

get_metadata( mixed $meta_type, mixed $object_id, mixed $meta_key = '', mixed $single = false )

Retrieves the value of a metadata field for the specified object type and ID.

Parameters 4 required

Name / Type	Description
string	$meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table. Required
$object_id int	ID of the object metadata is for. Required
string	$meta_key Optional. Metadata key. If not specified, retrieve all metadata for the specified object. Default empty string. Required
bool	$single Optional. If true, return only the first value of the specified `$meta_key`. This parameter has no effect if `$meta_key` is not specified. Default false. Required

Return Value

(mixed)

mixed An array of values if `$single` is false. The value of the meta field if `$single` is true. False for an invalid `$object_id` (non-numeric, zero, or negative value), or if `$meta_type` is not specified. An empty array if a valid but non-existing object ID is passed and `$single` is false. An empty string if a valid but non-existing object ID is passed and `$single` is true. Note: Non-serialized values are returned as strings: - false values are returned as empty strings ('') - true values are returned as '1' - numbers (both integer and float) are returned as strings Arrays and objects retain their original type.

Function Information

Since Version

2.9.0

Source File

wp-includes/meta.php