1
0
mirror of https://github.com/delight-im/PHP-Auth.git synced 2025-08-03 22:57:27 +02:00

Document return value of 'Auth#resetPassword' in README

This commit is contained in:
Marco
2020-04-20 21:02:57 +02:00
parent 2f772b00c8
commit 49c70eff41

View File

@@ -350,6 +350,8 @@ catch (\Delight\Auth\TooManyRequestsException $e) {
}
```
If you need the users ID or email address, e.g. for sending them a notification that their password has successfully been reset, just use the return value of `Auth#resetPassword`, which is an array containing two entries named `id` and `email`.
### Changing the current users password
If a user is currently logged in, they may change their password.