Short-circuits updating metadata of a specific type.

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 hook names include:

• update_post_metadata
• update_comment_metadata
• update_term_metadata
• update_user_metadata

Parameters

$checknull|bool

Whether to allow updating metadata for the given type.

$object_idint

ID of the object metadata is for.

$meta_keystring

Metadata key.

$meta_valuemixed

Metadata value. Must be serializable if non-scalar.

$prev_valuemixed

Previous value to check before updating.
If specified, only update existing metadata entries with this value. Otherwise, update all entries.

More Information

• This filter is applied before a metadata gets updated; it allows short-circuiting the updating of metadata of a specific type by returning a non-null value.
• The dynamic portion of the hook, $meta_type, refers to the meta object type. For example, if a ‘user’ metadata gets updated, the hook would be ‘update_user_metadata‘.
• The filter must return a null value (the value of $check) if the data is be saved to the database. If it returns anything else, the ‘update_metadata‘ function (and therefore the ‘update_{$meta_type}_metadata‘ filter) will return what the filter callbacks return.

Source

$check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value );

View all references View on Trac View on GitHub

Changelog