WP_Application_Passwords::update_application_password( int $user_id, string $uuid, array $update = array() ): true|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

$user_idint

User ID.

$uuidstring

The password's UUID.

$updatearrayoptional

Information about the application password to update.Default: array()

• $uuidstring

  The unique identifier for the application password.

• $app_idstring

  A UUID provided by the application to uniquely identify it.

• $namestring

  The name of the application password.

• $passwordstring

  A one-way hash of the password.

• $createdint

  Unix timestamp of when the password was created.

• $last_usedint|null

  The Unix timestamp of the GMT date the application password was last used.

• $last_ipstring|null

  The IP address the application password was last used by.

Return value

true|WP_Error

True if successful, otherwise a WP_Error instance is returned on error.

Performance profile

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

17–48

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

Plugin surface

1 hook

Third-party callbacks on 'wp_update_application_password' run inside this call, and their cost is not bounded by anything here.

Called by

1

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

What it touches

• hookthird-party callbacksdo_action()called directly

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

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

Hooks and filters fired · 1

One hook fires while WP_Application_Passwords::update_application_password() runs, in this order:

1. 1
   do_action( wp_update_application_password )actionline 319 (+48 into the body)

   Fires when an application password is updated.

Uses · 6

• sanitize_text_field()Sanitizes a string from user input or from the database.
• __()Retrieves the translation of $text.
• do_action()Calls the callback functions that have been added to an action hook.
• static::get_user_application_passwords()
• static::set_user_application_passwords()
• WP_Error::__construct()Initializes the error.

Used by · 1

• WP_REST_Application_Passwords_Controller::update_item()Updates an application password.

Source code

View on Trac ↗View on GitHub ↗

271	public static function update_application_password( $user_id, $uuid, $update = array() ) {272		$passwords = static::get_user_application_passwords( $user_id );273 274		foreach ( $passwords as &$item ) {275			if ( $item['uuid'] !== $uuid ) {276				continue;277			}278 279			if ( ! empty( $update['name'] ) ) {280				$update['name'] = sanitize_text_field( $update['name'] );281			}282 283			$save = false;284 285			if ( ! empty( $update['name'] ) && $item['name'] !== $update['name'] ) {286				$item['name'] = $update['name'];287				$save         = true;288			}289 290			if ( $save ) {291				$saved = static::set_user_application_passwords( $user_id, $passwords );292 293				if ( ! $saved ) {294					return new WP_Error( 'db_error', __( 'Could not save application password.' ) );295				}296			}297 298			/**299			 * Fires when an application password is updated.300			 *301			 * @since 5.6.0302			 * @since 6.8.0 The password is now hashed using wp_fast_hash() instead of phpass.303			 *              Existing passwords may still be hashed using phpass.304			 *305			 * @param int   $user_id The user ID.306			 * @param array $item    {307			 *     The updated application password details.308			 *309			 *     @type string      $uuid      The unique identifier for the application password.310			 *     @type string      $app_id    A UUID provided by the application to uniquely identify it.311			 *     @type string      $name      The name of the application password.312			 *     @type string      $password  A one-way hash of the password.313			 *     @type int         $created   Unix timestamp of when the password was created.314			 *     @type int|null    $last_used The Unix timestamp of the GMT date the application password was last used.315			 *     @type string|null $last_ip   The IP address the application password was last used by.316			 * }317			 * @param array $update  The information to update.318			 */319			do_action( 'wp_update_application_password', $user_id, $item, $update );320 321			return true;322		}323 324		return new WP_Error( 'application_password_not_found', __( 'Could not find an application password with that id.' ) );325	}

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.9.7 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.