get_metadata


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

Parameters:
  • (string) meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
  • (int) object_id ID of the object metadata is for.
  • (string) meta_key Optional. Metadata key. If not specified, retrieve all metadata for the specified object. Default empty.
  • (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.
See:
Returns:
  • (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 string if a valid but non-existing object ID is passed.
Defined at:

Description

Retrieves the value of a metadata field for the specified object type and ID.If the meta field exists, a single value is returned if `$single` is true, or an array of values if it's false. If the meta field does not exist, the result depends on get_metadata_default(). By default, an empty string is returned if `$single` is true, or an empty array if it's false.

Related Functions

get_metadata_raw, delete_metadata, get_commentdata, get_theme_data, get_metadata_by_mid

Top Google Results

User discussions

wpseek mobile