wppaste
WordPress

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

Since
2.9.0
Source
wp-includes/meta.php:574
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_typestring
Type of object metadata is for. Accepts '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.

Uses · 2

Used by · 9

Source

View on Trac View on GitHub 

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

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