Short-circuits deleting 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:
delete_post_metadata
delete_comment_metadata
delete_term_metadata
delete_user_metadata
Parameters
$delete
null|bool- Whether to allow metadata deletion of 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.
$delete_all
bool- Whether to delete the matching metadata entries for all objects, ignoring the specified $object_id.
Default false.
Source
$check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.