update_{$meta_type}_metadata_by_mid WordPress Filter Hook
This hook is used to update metadata for a given meta type. It takes two parameters, the first being the meta ID of the object to update, and the second being an array of key => value pairs of the metadata to update. This hook is useful for programmatically updating metadata values for a given object. For example, you could use this hook to update the value of a custom field for a post or user.
apply_filters( "update_{$meta_type}_metadata_by_mid", null|bool $check , int $meta_id , mixed $meta_value , string|false $meta_key ) #
Short-circuits updating metadata of a specific type by meta ID.
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_by_mid
update_comment_metadata_by_mid
update_term_metadata_by_mid
update_user_metadata_by_mid
Parameters
- $check
(null|bool)Whether to allow updating metadata for the given type.
- $meta_id
(int)Meta ID.
- $meta_value
(mixed)Meta value. Must be serializable if non-scalar.
- $meta_key
(string|false)Meta key, if provided.
Source
File: wp-includes/meta.php
Changelog
Version | Description |
---|---|
5.0.0 | Introduced. |