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_metadata
  • add_comment_metadata
  • add_term_metadata
  • add_user_metadata

Parameters

$checknull|bool
Whether to allow adding metadata for the given type.
$object_idint
ID of the object metadata is for.
$meta_keystring
Metadata key.
$meta_valuemixed
Metadata value. Must be serializable if non-scalar.
$uniquebool
Whether the specified meta key should be unique for the object.

Source

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

Changelog

VersionDescription
3.1.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.