Filter hook 'update_{$meta_type}_metadata'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into update_{$meta_type}_metadata
add_filter('update_{$meta_type}_metadata', 'my_custom_filter', 10, 5);

function my_custom_filter($check, $object_id, $meta_key, $meta_value, $prev_value) {
    // Your custom filtering logic here
    return $check;
}

Source Code Context

<?php
 236  	 * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.
 237  	 * @param mixed     $prev_value Optional. Previous value to check before updating.
 238  	 *                              If specified, only update existing metadata entries with
 239  	 *                              this value. Otherwise, update all entries.
 240  	 */
 241  	$check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value );
 242  	if ( null !== $check ) {
 243  		return (bool) $check;
 244  	}
 245  
 246  	// Compare existing value to new value if no prev value given and the key exists only once.

PHP Documentation

<?php
/**
	 * Short-circuits updating 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:
	 *
	 *  - `update_post_metadata`
	 *  - `update_comment_metadata`
	 *  - `update_term_metadata`
	 *  - `update_user_metadata`
	 *
	 * @since 3.1.0
	 *
	 * @param null|bool $check      Whether to allow updating 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 mixed     $prev_value Optional. Previous value to check before updating.
	 *                              If specified, only update existing metadata entries with
	 *                              this value. Otherwise, update all entries.
	 */