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

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

Retrieve user metadata.


Description 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 See also


Top ↑

Parameters Parameters

$user_id

(int) (Required) User ID

$meta_key

(string) (Optional) Metadata key.

Default value: ''


Top ↑

Return Return

(mixed)


Top ↑

Source Source

File: wp-includes/deprecated.php

2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
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;
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.0.0 Use get_user_meta()
2.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.