WP_User::__construct( int|string|stdClass|WP_User $id = 0, string $name = '', int $site_id = '' )
- Since
- 2.0.0
- Source
wp-includes/class-wp-user.php:128
Description
Retrieves the userdata and passes it to WP_User::init().
Compatibility
- 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
$idint|string|stdClass|WP_Useroptional- User's ID, a WP_User object, or a user object from the DB.Default:
0 $namestringoptional- User's usernameDefault:
'' $site_idintoptional- Optional Site ID, defaults to current site.Default:
''
Performance profile
How much work a call to WP_User::__construct() 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
- Trivial
- Scaling
- Constant
- Instructions
- 15–43
- Plugin surface
- None
- Called by
- 18
Touches nothing outside its own arguments.
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 65.
Nothing here hands control to plugin code.
18 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_User::__construct() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 15–29 | ->init() |
!($id instanceof) && !is_object($id) | 24–43 | ::get_data_by(), first_name() |
!($id instanceof) && !is_object($id) | 24–43 | ::get_data_by(), ->init() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 65 | 15–43 | 7 | |
| 8.5 | 65 | 15–43 | 7 | |
| 8.4 | 65 | 15–43 | 7 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 67 | 15–45 | 7 | |
| 8.2 | 67 | 15–45 | 7 | |
| 8.1 | 67 | 15–45 | 7 | |
| 7.4 | 67 | 15–45 | 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 · 3
- WP_User::init()Sets up object properties, including capabilities.
- WP_User::get_data_by()Returns only the main user fields.
- stdClass::__construct()
Used by · 18
- WP_REST_Comments_Controller::prepare_item_for_database()Prepares a single comment to be inserted into the database.
- WP_User_Query::query()Executes the query, with the current variables.
- attachment_submitbox_metadata()Displays non-editable attachment metadata in the publish meta box.
- clean_user_cache()Cleans all user caches.
- get_user_by()Retrieves user info by a given field.
- update_user_status()Update the status of a user in the database.
- user_can()Returns whether a particular user has the specified capability.
- user_can_for_site()Returns whether a particular user has the specified capability for a given site.
- wp_authenticate_cookie()Authenticates the user using the WordPress auth cookie.
- wp_delete_user()Delete user and optionally reassign posts and links to another user.
- wp_insert_user()Inserts a user into the database.
- wp_install()Installs the site.
Show all 18
- wp_install_defaults()Creates the initial content for a newly-installed site.
- wp_new_blog_notification()Notifies the site admin that the installation of WordPress is complete.
- wp_prepare_attachment_for_js()Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
- wp_revoke_user()Remove all capabilities from user.
- wp_set_current_user()Changes the current user by ID or name.
- wpmu_delete_user()Deletes a user and all of their posts from the network.
Source code
public function __construct( $id = 0, $name = '', $site_id = '' ) { global $wpdb; if ( ! isset( self::$back_compat_keys ) ) { $prefix = $wpdb->prefix; self::$back_compat_keys = array( 'user_firstname' => 'first_name', 'user_lastname' => 'last_name', 'user_description' => 'description', 'user_level' => $prefix . 'user_level', $prefix . 'usersettings' => $prefix . 'user-settings', $prefix . 'usersettingstime' => $prefix . 'user-settings-time', ); } if ( $id instanceof WP_User ) { $this->init( $id->data, $site_id ); return; } elseif ( is_object( $id ) ) { $this->init( $id, $site_id ); return; } if ( ! empty( $id ) && ! is_numeric( $id ) ) { $name = $id; $id = 0; } if ( $id ) { $data = self::get_data_by( 'id', $id ); } else { $data = self::get_data_by( 'login', $name ); } if ( $data ) { $this->init( $data, $site_id ); } else { $this->data = new stdClass(); } }Changelog
Introduced in 2.0.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$id retyped from int|string|stdClass|WP_User to int|string|object.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 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.