get_metadata() – Function | Developer.WordPress.org

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.

Parameters

$meta_typestringrequired: Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
$object_idintrequired: ID of the object metadata is for.
$meta_keystringoptional: Metadata key. If not specified, retrieve all metadata for the specified object.
Default:''
$singlebooloptional: 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

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

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

View all references View on Trac View on GitHub

Uses	Description
get_metadata_default()`wp-includes/meta.php`	Retrieves default metadata value for the specified meta key and object.
get_metadata_raw()`wp-includes/meta.php`	Retrieves raw metadata value for the specified object.

Used by	Description
get_site_meta()`wp-includes/ms-site.php`	Retrieves metadata for a site.
WP_REST_Meta_Fields::update_multi_meta_value()`wp-includes/rest-api/fields/class-wp-rest-meta-fields.php`	Updates multiple meta values for an object.
WP_REST_Meta_Fields::update_meta_value()`wp-includes/rest-api/fields/class-wp-rest-meta-fields.php`	Updates a meta value for an object.
WP_REST_Meta_Fields::update_value()`wp-includes/rest-api/fields/class-wp-rest-meta-fields.php`	Updates meta values.
WP_REST_Meta_Fields::get_value()`wp-includes/rest-api/fields/class-wp-rest-meta-fields.php`	Retrieves the meta field value.
get_registered_metadata()`wp-includes/meta.php`	Retrieves registered metadata for a specified object.
get_term_meta()`wp-includes/taxonomy.php`	Retrieves metadata for a term.
get_user_meta()`wp-includes/user.php`	Retrieves user meta field for a user.
get_post_meta()`wp-includes/post.php`	Retrieves a post meta field for the given post ID.
get_comment_meta()`wp-includes/comment.php`	Retrieves comment meta field for a comment.

Show 5 more Show less

Changelog

Version	Description
2.9.0	Introduced.

User Contributed Notes

Skip to note 3 content

thenbrent 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

If the meta value does not exist and true == $single the function will return an empty string (''). If false == $single an empty array is returned.

If ! is_numeric( $user_id ) or ! absint( $user_id ), boolean false is returned.

Log in to add feedback
Skip to note 4 content

Sylvain Schellenberger 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Example of returned array for post metadatas :
```
array (
  '_pingme' => array (
    0 => '1',
  ),
  '_encloseme' => array (
    0 => '1',
  ),
  'custom key 1' => array (
    0 => 'custom value 1',
    1 => 'custom value 2',
  ),
  'custom key 2' => array (
    0 => 'custom value 3',
  ),
)
```
Log in to add feedback

get_metadata( string $meta_type, int $object_id, string $meta_key = ”, bool $single = false ): mixed

In this article

Description

See also

Parameters

Return

Source

Changelog

User Contributed Notes