delete_{$meta_type}_metadata WordPress Filter Hook
The delete_{$meta_type}_metadata WordPress hook is called when metadata of a specific type is deleted from a WordPress object. This hook can be used to perform cleanup operations when metadata is deleted. For example, if you are storing metadata in a custom table, you can use this hook to delete the corresponding row from the table.
apply_filters( "delete_{$meta_type}_metadata", null|bool $delete , int $object_id , string $meta_key , mixed $meta_value , bool $delete_all ) #
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_metadatadelete_comment_metadatadelete_term_metadatadelete_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
File: wp-includes/meta.php
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |