add_{$meta_type}_metadata WordPress Filter Hook
The add_{$meta_type}_metadata hook allows you to add metadata to a specific {$meta_type} object. This hook is called whenever an {$meta_type} object is created or updated.
apply_filters( "add_{$meta_type}_metadata", null|bool $check , int $object_id , string $meta_key , mixed $meta_value , bool $unique ) #
Short-circuits adding 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:
add_post_metadataadd_comment_metadataadd_term_metadataadd_user_metadata
Parameters
- $check
(null|bool)Whether to allow adding 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.
- $unique
(bool)Whether the specified meta key should be unique for the object.
Source
File: wp-includes/meta.php
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |