WP_Application_Passwords::update_application_password() WordPress Method
This function updates an application password. It accepts two parameters: the password ID (an integer) and an array of data containing the new password (at minimum), the name, and the user ID. If the update is successful, the function will return the updated password array. Otherwise, it will return false.
WP_Application_Passwords::update_application_password( int $user_id, string $uuid, array $update = array() ) #
Updates an application password.
Parameters
- $user_id
(int)(Required)User ID.
- $uuid
(string)(Required)The password's UUID.
- $update
(array)(Optional)Information about the application password to update.
Default value: array()
Return
(true|WP_Error) True if successful, otherwise a WP_Error instance is returned on error.
Source
File: wp-includes/class-wp-application-passwords.php
public static function update_application_password( $user_id, $uuid, $update = array() ) { $passwords = static::get_user_application_passwords( $user_id ); foreach ( $passwords as &$item ) { if ( $item['uuid'] !== $uuid ) { continue; } if ( ! empty( $update['name'] ) ) { $update['name'] = sanitize_text_field( $update['name'] ); } $save = false; if ( ! empty( $update['name'] ) && $item['name'] !== $update['name'] ) { $item['name'] = $update['name']; $save = true; } if ( $save ) { $saved = static::set_user_application_passwords( $user_id, $passwords ); if ( ! $saved ) { return new WP_Error( 'db_error', __( 'Could not save application password.' ) ); } } /** * Fires when an application password is updated. * * @since 5.6.0 * * @param int $user_id The user ID. * @param array $item The updated app password details. * @param array $update The information to update. */ do_action( 'wp_update_application_password', $user_id, $item, $update ); return true; } return new WP_Error( 'application_password_not_found', __( 'Could not find an application password with that id.' ) ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.6.0 | Introduced. |