WP_REST_Application_Passwords_Controller::get_user( WP_REST_Request $request ): WP_User|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$requestWP_REST_Request

The request object.

Return value

WP_User|WP_Error

The WordPress user associated with the request, or a WP_Error if none found.

Performance profile

How much work a call to WP_REST_Application_Passwords_Controller::get_user() 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

Reaches the database via get_user_by().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

13–58

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 87.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

16

16 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below WP_REST_Application_Passwords_Controller::get_user()
• querycontent queryget_user_by()one call below WP_REST_Application_Passwords_Controller::get_user()

Further down the call graph this can also reach cache, serialize, option 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 · 20 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Application_Passwords_Controller::get_user() can have, taken from its control-flow graph on PHP 8.5.

Uses · 10

• wp_is_application_passwords_available()Checks if Application Passwords is globally available.
• __()Retrieves the translation of $text.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• wp_get_current_user()Retrieves the current user object.
• get_userdata()Retrieves user info by user ID.
• is_multisite()Determines whether Multisite is enabled.
• user_can()Returns whether a particular user has the specified capability.
• is_user_member_of_blog()Finds out whether a user is a member of a given blog.
• wp_is_application_passwords_available_for_user()Checks if Application Passwords is available for a specific user.
• WP_Error::__construct()Initializes the error.

Used by · 16

• WP_REST_Application_Passwords_Controller::create_item()Creates an application password.
• WP_REST_Application_Passwords_Controller::create_item_permissions_check()Checks if a given request has access to create application passwords.
• WP_REST_Application_Passwords_Controller::delete_item()Deletes an application password for a user.
• WP_REST_Application_Passwords_Controller::delete_item_permissions_check()Checks if a given request has access to delete a specific application password for a user.
• WP_REST_Application_Passwords_Controller::delete_items()Deletes all application passwords for a user.
• WP_REST_Application_Passwords_Controller::delete_items_permissions_check()Checks if a given request has access to delete all application passwords for a user.
• WP_REST_Application_Passwords_Controller::do_permissions_check()Performs a permissions check for the request.
• WP_REST_Application_Passwords_Controller::get_application_password()Gets the requested application password for a user.
• WP_REST_Application_Passwords_Controller::get_current_item()Retrieves the application password being currently used for authentication of a user.
• WP_REST_Application_Passwords_Controller::get_current_item_permissions_check()Checks if a given request has access to get the currently used application password for a user.
• WP_REST_Application_Passwords_Controller::get_item_permissions_check()Checks if a given request has access to get a specific application password.
• WP_REST_Application_Passwords_Controller::get_items()Retrieves a collection of application passwords.

Source code

View on Trac ↗View on GitHub ↗

681	protected function get_user( $request ) {682		if ( ! wp_is_application_passwords_available() ) {683			return new WP_Error(684				'application_passwords_disabled',685				__( 'Application passwords are not available.' ),686				array( 'status' => 501 )687			);688		}689 690		$error = new WP_Error(691			'rest_user_invalid_id',692			__( 'Invalid user ID.' ),693			array( 'status' => 404 )694		);695 696		$id = $request['user_id'];697 698		if ( 'me' === $id ) {699			if ( ! is_user_logged_in() ) {700				return new WP_Error(701					'rest_not_logged_in',702					__( 'You are not currently logged in.' ),703					array( 'status' => 401 )704				);705			}706 707			$user = wp_get_current_user();708		} else {709			$id = (int) $id;710 711			if ( $id <= 0 ) {712				return $error;713			}714 715			$user = get_userdata( $id );716		}717 718		if ( empty( $user ) || ! $user->exists() ) {719			return $error;720		}721 722		if ( is_multisite() && ! user_can( $user->ID, 'manage_sites' ) && ! is_user_member_of_blog( $user->ID ) ) {723			return $error;724		}725 726		if ( ! wp_is_application_passwords_available_for_user( $user ) ) {727			return new WP_Error(728				'application_passwords_disabled_for_user',729				__( 'Application passwords are not available for your account. Please contact the site administrator for assistance.' ),730				array( 'status' => 501 )731			);732		}733 734		return $user;735	}

Changelog

Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-application-passwords-controller.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.