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

$valuemixed

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

$object_idint

ID of the object metadata is for.

$meta_keystring

Metadata key.

$singlebool

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

$meta_typestring

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

$check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single, $meta_type );

View all references View on Trac View on GitHub

Changelog