apply_filters( "get_{$meta_type}_metadata", mixed $value, int $object_id, string $meta_key, bool $single, string $meta_type )

Short-circuits the return value of a meta field.

Description

The dynamic portion of the hook, $meta_type, refers to the meta object type (post, comment, term, user, or any other type with an associated meta table). Returning a non-null value will effectively short-circuit the function.

Possible filter names include:

  • get_post_metadata
  • get_comment_metadata
  • get_term_metadata
  • get_user_metadata

Parameters

$value

(mixed) The value to return, either a single metadata value or an array of values depending on the value of $single. Default null.

$object_id

(int) ID of the object metadata is for.

$meta_key

(string) Metadata key.

$single

(bool) Whether to return only the first value of the specified $meta_key.

$meta_type

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

More Information

The filter must return null if the data should be taken from the database. If it returns anything else, the get_metadata() function (and therefore the get_user_meta) will return what the filter returns.

Source

File: wp-includes/meta.php

View on Trac

Used By

Used By Description
wp-includes/meta.php: get_metadata_raw()

Retrieves raw metadata value for the specified object.
wp-includes/meta.php: metadata_exists()

Determines if a meta field with the given key exists for the given object ID.

Changelog

Version Description
5.5.0 Added the $meta_type parameter.
3.1.0 Introduced.

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