A WordPress-centric search engine for devs and theme authors

delete_{$meta_type}_metadata › WordPress Filter Hooks

apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all )
Parameters: (5)
  • (null|bool) $delete Whether to allow metadata deletion of the given type.
    Required: Yes
  • (int) $object_id ID of the object metadata is for.
    Required: Yes
  • (string) $meta_key Metadata key.
    Required: Yes
  • (mixed) $meta_value Metadata value. Must be serializable if non-scalar.
    Required: Yes
  • (bool) $delete_all Whether to delete the matching metadata entries for all objects, ignoring the specified $object_id. Default false.
    Required: Yes
Defined at:

Short-circuits deleting metadata of a specific type.

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


$check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );