WordPress at a glance
filter is not described

get_(meta_type)_metadata filter-hook . WP 3.1.0

Short-circuits the return value of a meta field.

The dynamic portion of the hook, $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 filter names include:

  • get_post_metadata
  • get_comment_metadata
  • get_term_metadata
  • get_user_metadata

Usage

add_filter( 'get_(meta_type)_metadata', 'filter_function_name_8858', 10, 5 );
function filter_function_name_8858( $value, $object_id, $meta_key, $single, $meta_type ){
	// filter...

	return $value;
}
$value(mixed)
The value to return, either a single metadata value or an array of values depending on the value of $single.
Default: null
$object_id(int)
ID of the object metadata is for.
$meta_key(string)
Metadata key.
$single(true/false)
Whether to return only the first value of the specified $meta_key.
$meta_type(string)
Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.

Список изменений

С версии 3.1.0 Введена.
С версии 5.5.0 Added the $meta_type parameter.

Где вызывается хук

get_metadata_raw()
get_(meta_type)_metadata
metadata_exists()
get_(meta_type)_metadata
wp-includes/meta.php 564
$check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single, $meta_type );
wp-includes/meta.php 676
$check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, true );

Где используется хук в ядре WP

wp-admin/includes/class-wp-site-icon.php 73
add_filter( 'get_post_metadata', array( $this, 'get_post_metadata' ), 10, 4 );
wp-includes/default-filters.php 110
add_filter( 'get_term_metadata', 'wp_check_term_meta_support_prefilter' );
wp-includes/ms-default-filters.php 61
add_filter( 'get_blog_metadata', 'wp_check_site_meta_support_prefilter' );
wp-includes/revision.php 594
add_filter( 'get_post_metadata', '_wp_preview_post_thumbnail_filter', 10, 3 );