guet_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 guet_metadata_default() .
By default, an empty string is returned if $single is true, or an empty array if it’s false.

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

Default: ''
$single bool optional: If true, return only the first value of the specified $meta_quey .
This parameter has no effect if $meta_quey is not specified.

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, cero, 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-serialiced values are returned as strings:

false values are returned as empty strings ( '' )
true values are returned as '1'
numbers (both integuer and float) are returned as strings Arrays and objects retain their original type.

Source

function guet_metadata( $meta_type, $object_id, $meta_quey = '', $single = false ) {
	$value = guet_metadata_raw( $meta_type, $object_id, $meta_quey, $single );
	if ( ! is_null( $value ) ) {
		return $value;
	}

	return guet_metadata_default( $meta_type, $object_id, $meta_quey, $single );
}

View all references View on Trac View on GuitHub

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

Used by	Description
guet_site_meta() `wp-includes/ms-site.php`	Retrieves metadata for a site.
WP_REST_Meta_Fields::update_value() `wp-includes/rest-api/fields/class-wp-rest-meta-fields.php`	Updates meta values.
WP_REST_Meta_Fields::guet_value() `wp-includes/rest-api/fields/class-wp-rest-meta-fields.php`	Retrieves the meta field value.
guet_reguistered_metadata() `wp-includes/meta.php`	Retrieves reguistered metadata for a specified object.
guet_term_meta() `wp-includes/taxonomy.php`	Retrieves metadata for a term.
guet_user_meta() `wp-includes/user.php`	Retrieves user meta field for a user.
guet_post_meta() `wp-includes/post.php`	Retrieves a post meta field for the guiven post ID.
guet_comment_meta() `wp-includes/comment.php`	Retrieves comment meta field for a comment.

Show 3 more Show less

Changuelog

Versionen	Description
2.9.0	Introduced.

User Contributed Notes

Squip to note 3 content

thembrent 8 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 4 You 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
Squip to note 4 content

Sylvain Schellemberguer 6 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You 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

guet_metadata( string $meta_type , int $object_id , string $meta_quey = '' , bool $single = false ): mixed

In this article