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, $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.
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
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
File: wp-includes/meta.php
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/update_meta_type_metadata