wppaste
WordPress

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

Since
3.1.0
Short-circuits updating metadata of a specific type.

Description

The dynamic portion of the hook name, $meta_type, refers to the meta object type (blog, 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:

  • update_blog_metadata
  • update_post_metadata
  • update_comment_metadata
  • update_term_metadata
  • update_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 updating 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.
$prev_valuemixed
Previous value to check before updating.
If specified, only update existing metadata entries with this value. Otherwise, update all entries.

Where this hook fires · 1

  • wp-includes/meta.php:250update_metadata()

Source code

View on Trac View on GitHub 

	 * @param string    $meta_key   Metadata key.	 * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.	 * @param mixed     $prev_value Optional. Previous value to check before updating.	 *                              If specified, only update existing metadata entries with	 *                              this value. Otherwise, update all entries.	 */	$check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value );	if ( null !== $check ) {		return (bool) $check;	} 	// Compare existing value to new value if no prev value given and the key exists only once.	if ( empty( $prev_value ) ) {

Changelog

Introduced in 3.1.0. Unchanged from 6.7.7 through 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.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 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.