wppaste
WordPress

WP_Application_Passwords::record_application_password_usage( int $user_id, string $uuid ): true|WP_Error

Since
5.6.0
Source
wp-includes/class-wp-application-passwords.php:336
Records that an application password has been used.

Compatibility

WordPress
since 5.6.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.
$uuidstring
The password's UUID.

Return value

true|WP_Error
True if the usage was recorded, a WP_Error if an error occurs.

Performance profile

How much work a call to WP_Application_Passwords::record_application_password_usage() 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
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
16–41

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

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

What one call costs · 4 distinct outcomes

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

WhenInstructionsCalls it makes
always16–17::get_user_application_passwords(), __()
!$passwords && $uuid === false20::get_user_application_passwords(), time()
!$passwords && $uuid === false34::get_user_application_passwords(), time(), time(), ::set_user_application_passwords()
!$passwords && $uuid === false41::get_user_application_passwords(), time(), time(), ::set_user_application_passwords(), __()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 54 instructions, 16–41 executed per call, 5 branches. The work does not change between versions.

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 · 4

  • __()Retrieves the translation of $text.
  • static::get_user_application_passwords()
  • static::set_user_application_passwords()
  • WP_Error::__construct()Initializes the error.

Used by · 1

Source code

View on Trac View on GitHub 

	public static function record_application_password_usage( $user_id, $uuid ) {		$passwords = static::get_user_application_passwords( $user_id ); 		foreach ( $passwords as &$password ) {			if ( $password['uuid'] !== $uuid ) {				continue;			} 			// Only record activity once a day.			if ( $password['last_used'] + DAY_IN_SECONDS > time() ) {				return true;			} 			$password['last_used'] = time();			$password['last_ip']   = $_SERVER['REMOTE_ADDR']; 			$saved = static::set_user_application_passwords( $user_id, $passwords ); 			if ( ! $saved ) {				return new WP_Error( 'db_error', __( 'Could not save application password.' ) );			} 			return true;		} 		// Specified application password not found!		return new WP_Error( 'application_password_not_found', __( 'Could not find an application password with that id.' ) );	}

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 7.1.0 tag, from src/wp-includes/class-wp-application-passwords.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.