get_user_metadata │ filter-hook │ WP 3.1.0

Short-circuits the return value of a meta field.

Possible filter names include:

• get_post_metadata
• get_comment_metadata
• get_term_metadata
• get_user_metadata

Usage

add_filter( 'get_user_metadata', 'wp_kama_get_user_metadata_filter', 10, 5 );

/**
 * Function for `get_user_metadata` filter-hook.
 * 
 * @param mixed  $value     The value to return, either a single metadata value or an array of values depending on the value of `$single`.
 * @param int    $object_id ID of the object metadata is for.
 * @param string $meta_key  Metadata key.
 * @param bool   $single    Whether to return only the first value of the specified `$meta_key`.
 * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
 *
 * @return mixed
 */
function wp_kama_get_user_metadata_filter( $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.

Changelog

Where the hook is called

$check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single, $meta_type );

Where the hook is used in WordPress