wppaste
WordPress

apply_filters( "add_{$meta_type}_metadata", null|bool $check, int $object_id, string $meta_key, mixed $meta_value, bool $unique )

Since
3.1.0
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

Compatibility

WordPress
since 3.1.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

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.

Where this hook fires · 1

  • wp-includes/meta.php:80add_metadata()

Source code

View on Trac View on GitHub 

	 * @param null|bool $check      Whether to allow adding metadata for the given type.	 * @param int       $object_id  ID of the object metadata is for.	 * @param string    $meta_key   Metadata key.	 * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.	 * @param bool      $unique     Whether the specified meta key should be unique for the object.	 */	$check = apply_filters( "add_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $unique );	if ( null !== $check ) {		return $check;	} 	if ( $unique && $wpdb->get_var(		$wpdb->prepare(

Changelog

Introduced in 3.1.0. One change between 6.7.7 and 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.9.7
Parameter $check retyped from null|bool to null|int|false.verified against source
3.1.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.7.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.