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_metadata
get_comment_metadata
get_term_metadata
get_user_metadata
Parameters
- $value
-
The value to return, either a single metadata value or an array of values depending on the value of
$single
. Default null. - $object_id
-
ID of the object metadata is for.
- $meta_key
-
Metadata key.
- $single
-
Whether to return only the first value of the specified
$meta_key
. - $meta_type
-
Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
Source
File: wp-includes/meta.php
Changelog
Version | Description |
---|---|
5.5.0 | Added the $meta_type parameter. |
3.1.0 | Introduced. |