wpseek.com
A WordPress-centric search engine for devs and theme authors



get_metadata › WordPress Function

Since2.9.0
Deprecatedn/a
› get_metadata ( $meta_type, $object_id, $meta_key = '', $single = false )
Parameters: (4)
  • (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: Yes
  • (int) $object_id ID of the object metadata is for.
    Required: Yes
  • (string) $meta_key Optional. Metadata key. If not specified, retrieve all metadata for the specified object. Default empty string.
    Required: No
    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.
    Required: No
    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 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.
Defined at:
Codex:

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, get_commentdata, delete_metadata, get_theme_data, get_metadata_by_mid

Source 

function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
	$value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single );
	if ( ! is_null( $value ) ) {
		return $value;
	}

	return get_metadata_default( $meta_type, $object_id, $meta_key, $single );
}