get_usermeta( int $user_id, string $meta_key = '' )

This function has been deprecated. Use get_user_meta() instead.

Retrieve user metadata.

Description

If $user_id is not a number, then the function will fail over with a ‘false’ boolean return value. Other returned values depend on whether there is only one item to be returned, which be that single item type. If there is more than one metadata value, then it will be list of metadata values.

See also

Parameters

$user_id

(int) (Required) User ID

$meta_key

(string) (Optional) Metadata key.

Default value: ''

Return

(mixed)

Source

File: wp-includes/deprecated.php 

function get_usermeta( $user_id, $meta_key = '' ) {
	_deprecated_function( __FUNCTION__, '3.0.0', 'get_user_meta()' );
	global $wpdb;
	$user_id = (int) $user_id;

	if ( !$user_id )
		return false;

	if ( !empty($meta_key) ) {
		$meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key);
		$user = wp_cache_get($user_id, 'users');
		// Check the cached user object.
		if ( false !== $user && isset($user->$meta_key) )
			$metas = array($user->$meta_key);
		else
			$metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) );
	} else {
		$metas = $wpdb->get_col( $wpdb->prepare("SELECT meta_value FROM $wpdb->usermeta WHERE user_id = %d", $user_id) );
	}

	if ( empty($metas) ) {
		if ( empty($meta_key) )
			return array();
		else
			return '';
	}

	$metas = array_map('maybe_unserialize', $metas);

	if ( count($metas) == 1 )
		return $metas[0];
	else
		return $metas;
}

Uses

Uses Description
wp-includes/cache.php: wp_cache_get()

Retrieves the cache contents from the cache by key and group.
wp-includes/functions.php: _deprecated_function()

Mark a function as deprecated and inform when it has been used.
wp-includes/wp-db.php: wpdb::get_col()

Retrieves one column from the database.
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution.

Changelog

Version Description
3.0.0 Use get_user_meta()
2.0.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_usermeta