WP_User::get_data_by( string $field, string|int $value ): object|false
- Since
- 3.3.0, 4.4.0
- Source
wp-includes/class-wp-user.php:203
Compatibility
- WordPress
- since 4.4.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
$fieldstring- The field to query against: Accepts 'id', 'ID', 'slug', 'email' or 'login'.
$valuestring|int- The field value.
Return value
object|false- Raw user object.
Performance profile
How much work a call to WP_User::get_data_by() 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
- 10–62
- Plugin surface
- None
- Called by
- 2
Reaches the database via ->get_row().
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 88.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- cacheobject cache
wp_cache_get()called directly - sqldatabase query
->get_row()called directly - hookthird-party callbacks
apply_filters()one call below WP_User::get_data_by()
Further down the call graph this can also reach option, serialize, query 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 · 14 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_User::get_data_by() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10–25 | none |
$user_id !== false | 23–30 | wp_cache_get() |
$user_id !== false | 27–38 | wp_cache_get(), wp_cache_get() |
$user_id !== false | 31–44 | sanitize_user(), wp_cache_get(), wp_cache_get() |
$user_id === false | 32–39 | ->prepare(), ->get_row() |
$user_id === false | 35–42 | ->prepare(), ->get_row(), update_user_caches() |
| always | 36–47 | wp_cache_get(), ->prepare(), ->get_row() |
| always | 39–50 | wp_cache_get(), ->prepare(), ->get_row(), update_user_caches() |
$user_id === false | 40–53 | sanitize_user(), wp_cache_get(), ->prepare(), ->get_row() |
$user_id !== false | 42–53 | wp_cache_get(), wp_cache_get(), ->prepare(), ->get_row() |
$user_id === false | 43–56 | sanitize_user(), wp_cache_get(), ->prepare(), ->get_row(), update_user_caches() |
$user_id !== false | 45–56 | wp_cache_get(), wp_cache_get(), ->prepare(), ->get_row(), update_user_caches() |
2 further outcomes, up to 62 instructions
$user_id !== false | 46–59 | sanitize_user(), wp_cache_get(), wp_cache_get(), ->prepare(), ->get_row() |
$user_id !== false | 49–62 | sanitize_user(), wp_cache_get(), wp_cache_get(), ->prepare(), ->get_row(), update_user_caches() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 88 | 10–62 | 13 | |
| 8.5 | 88 | 10–62 | 13 | |
| 8.4 | 88 | 10–62 | 13 | 4 fewer instructions than PHP 8.3 |
| 8.3 | 92 | 12–64 | 13 | |
| 8.2 | 92 | 12–64 | 13 | |
| 8.1 | 92 | 12–64 | 13 | 1 more instruction than PHP 7.4 |
| 7.4 | 91 | 12–64 | 13 |
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 · 3
- wp_cache_get()Retrieves the cache contents from the cache by key and group.
- sanitize_user()Sanitizes a username, stripping out unsafe characters.
- update_user_caches()Updates all user caches.
Used by · 2
- WP_User::__construct()Constructor.
- get_user_by()Retrieves user info by a given field.
Source code
public static function get_data_by( $field, $value ) { global $wpdb; // 'ID' is an alias of 'id'. if ( 'ID' === $field ) { $field = 'id'; } if ( 'id' === $field ) { // Make sure the value is numeric to avoid casting objects, for example, to int 1. if ( ! is_numeric( $value ) ) { return false; } $value = (int) $value; if ( $value < 1 ) { return false; } } else { $value = trim( $value ); } if ( ! $value ) { return false; } switch ( $field ) { case 'id': $user_id = $value; $db_field = 'ID'; break; case 'slug': $user_id = wp_cache_get( $value, 'userslugs' ); $db_field = 'user_nicename'; break; case 'email': $user_id = wp_cache_get( $value, 'useremail' ); $db_field = 'user_email'; break; case 'login': $value = sanitize_user( $value ); $user_id = wp_cache_get( $value, 'userlogins' ); $db_field = 'user_login'; break; default: return false; } if ( false !== $user_id ) { $user = wp_cache_get( $user_id, 'users' ); if ( $user ) { return $user; } } $user = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->users WHERE $db_field = %s LIMIT 1", $value ) ); if ( ! $user ) { return false; } update_user_caches( $user ); return $user; }Changelog
Introduced in 3.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$field parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-user.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.