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

Description

Parameters

$meta_typestring

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

$object_idint

ID of the object metadata is for.

$meta_keystringoptional

Metadata key. If not specified, retrieve all metadata for the specified object. Default empty string.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.Default: 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 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.

Uses · 2

• get_metadata_raw()Retrieves raw metadata value for the specified object.
• get_metadata_default()Retrieves default metadata value for the specified meta key and object.

Used by · 9

• WP_REST_Meta_Fields::get_value()Retrieves the meta field value.
• WP_REST_Meta_Fields::update_value()Updates meta values.
• get_comment_meta()Retrieves comment meta field for a comment.
• get_post_meta()Retrieves a post meta field for the given post ID.
• get_registered_metadata()Retrieves registered metadata for a specified object.
• get_site_meta()Retrieves metadata for a site.
• get_term_meta()Retrieves metadata for a term.
• get_user_meta()Retrieves user meta field for a user.
• wp_get_footnotes_from_revision()Gets the footnotes field from the revision for the revisions screen.

Source

View on Trac ↗View on GitHub ↗

601function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {602	$value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single );603	if ( ! is_null( $value ) ) {604		return $value;605	}606 607	return get_metadata_default( $meta_type, $object_id, $meta_key, $single );608}

History

Introduced in 2.9.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/meta.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.