get_usermeta( int $user_id, string $meta_key = '' ): mixed
- Since
- 2.0.0
- Source
wp-includes/deprecated.php:2277
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.
Compatibility
Deprecated in WordPress 3.0.0. Use get_user_meta()
- WordPress
- since 2.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$user_idint- User ID
$meta_keystringoptional- Metadata key. Default empty.Default:
''
Return value
mixed
Performance profile
How much work a call to get_usermeta() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 12–51
- Plugin surface
- None
- Called by
- 0
Reaches the database via ->get_col().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 72.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- cacheobject cache
wp_cache_get()called directly - sqldatabase query
->get_col()called directly - hookthird-party callbacks
do_action()one call below get_usermeta()
Further down the call graph this can also reach query, option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 7 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_usermeta() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12 | _deprecated_function() |
empty($meta_key) && empty($metas) | 30 | _deprecated_function(), ->prepare(), ->get_col() |
!empty($meta_key) && $user !== false && isset($user->meta_key) && empty($metas) | 33 | _deprecated_function(), wp_cache_get() |
empty($meta_key) && !empty($metas) | 36–37 | _deprecated_function(), ->prepare(), ->get_col(), array_map() |
!empty($meta_key) && $user !== false && isset($user->meta_key) && !empty($metas) | 39–40 | _deprecated_function(), wp_cache_get(), array_map() |
!empty($meta_key) && empty($metas) | 42–44 | _deprecated_function(), wp_cache_get(), ->prepare(), ->get_col() |
!empty($meta_key) && !empty($metas) | 48–51 | _deprecated_function(), wp_cache_get(), ->prepare(), ->get_col(), array_map() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 72 | 12–51 | 7 | |
| 8.5 | 72 | 12–51 | 7 | |
| 8.4 | 72 | 12–51 | 7 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 75 | 12–54 | 7 | |
| 8.2 | 75 | 12–54 | 7 | |
| 8.1 | 75 | 12–54 | 7 | |
| 7.4 | 75 | 12–54 | 7 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- wp_cache_get()Retrieves the cache contents from the cache by key and group.
Source code
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;}Changelog
Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.