get_(meta_type)_metadata_by_mid │ filter-hook │ WP 5.0.0

Short-circuits the return value when fetching a meta field by meta ID.

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:

• get_post_metadata_by_mid
• get_comment_metadata_by_mid
• get_term_metadata_by_mid
• get_user_metadata_by_mid

Usage

add_filter( 'get_(meta_type)_metadata_by_mid', 'wp_kama_get_meta_type_metadata_by_mid_filter', 10, 2 );

/**
 * Function for `get_(meta_type)_metadata_by_mid` filter-hook.
 * 
 * @param stdClass|null $value   The value to return.
 * @param int           $meta_id Meta ID.
 *
 * @return stdClass|null
 */
function wp_kama_get_meta_type_metadata_by_mid_filter( $value, $meta_id ){

	// filter...
	return $value;
}

$value(stdClass|null)

The value to return.

$meta_id(int)

Meta ID.

Changelog

Where the hook is called

$check = apply_filters( "get_{$meta_type}_metadata_by_mid", null, $meta_id );

Where the hook is used in WordPress

add_filter( 'get_term_metadata_by_mid', 'wp_check_term_meta_support_prefilter' );

add_filter( 'get_blog_metadata_by_mid', 'wp_check_site_meta_support_prefilter' );