get_{$meta_type}_metadata WordPress Filter Hook
The get_{$meta_type}_metadata hook is used to retrieve metadata for a specific {$meta_type} object. This hook can be used to get metadata for any {$meta_type} object, including posts, comments, and users.
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 name, $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_metadataget_comment_metadataget_term_metadataget_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
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Added the $meta_type parameter. |
| 3.1.0 | Introduced. |