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

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

Description

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.

See also

Parameters

$meta_type

(string) (Required) Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.

$object_id

(int) (Required) ID of the object metadata is for.

$meta_key

(string) (Optional) Metadata key. If not specified, retrieve all metadata for the specified object.

Default value: ''

$single

(bool) (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 value: false

Return

(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.

Source

File: wp-includes/meta.php 

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 );
}

Uses

Uses Description
wp-includes/meta.php: get_metadata_default()

Retrieves default metadata value for the specified meta key and object.
wp-includes/meta.php: get_metadata_raw()

Retrieves raw metadata value for the specified object.

Used By

Used By Description
wp-includes/ms-site.php: get_site_meta()

Retrieves metadata for a site.
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: WP_REST_Meta_Fields::update_multi_meta_value()

Updates multiple meta values for an object.
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: WP_REST_Meta_Fields::update_meta_value()

Updates a meta value for an object.
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: WP_REST_Meta_Fields::update_value()

Updates meta values.
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: WP_REST_Meta_Fields::get_value()

Retrieves the meta field value.
wp-includes/meta.php: get_registered_metadata()

Retrieves registered metadata for a specified object.
wp-includes/taxonomy.php: get_term_meta()

Retrieves metadata for a term.
wp-includes/user.php: get_user_meta()

Retrieve user meta field for a user.
wp-includes/post.php: get_post_meta()

Retrieves a post meta field for the given post ID.
wp-includes/comment.php: get_comment_meta()

Retrieve comment meta field for a comment.

Changelog

Version Description
2.9.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_metadata