update_{$meta_type}_metadata WordPress Filter Hook
This hook is used to update metadata for a given meta type. The meta type can be post, comment, user, or any other type of metadata. The hook takes two arguments: the first is the meta type, and the second is the ID of the object to update.
apply_filters( "update_{$meta_type}_metadata", null|bool $check , int $object_id , string $meta_key , mixed $meta_value , mixed $prev_value ) #
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_metadataupdate_comment_metadataupdate_term_metadataupdate_user_metadata
Parameters
- $check
(null|bool)Whether to allow updating metadata for the given type.
- $object_id
(int)ID of the object metadata is for.
- $meta_key
(string)Metadata key.
- $meta_value
(mixed)Metadata value. Must be serializable if non-scalar.
- $prev_value
(mixed) 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
nullvalue (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
File: wp-includes/meta.php
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |