Document the UserLoggedIn event
authorTim Düsterhus <duesterhus@woltlab.com>
Wed, 13 Oct 2021 09:26:57 +0000 (11:26 +0200)
committerGitHub <noreply@github.com>
Wed, 13 Oct 2021 09:26:57 +0000 (11:26 +0200)
docs/migration/wsc54/php.md

index 89a6d6f9d3a451295be6c7d148a2c62d00021855..9928e8de48b2c61bdf898198cb3ff2ddce7ea6f1 100644 (file)
@@ -253,6 +253,20 @@ final class ValueDumpListener
 
 See [WoltLab/WCF#4000](https://github.com/WoltLab/WCF/pull/4000) and [WoltLab/WCF#4265](https://github.com/WoltLab/WCF/pull/4265) for details.
 
+## Authentication
+
+The [`UserLoggedIn`](https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/authentication/event/UserLoggedIn.class.php) event was added.
+You should fire this event if you implement a custom login process (e.g. when adding additional external authentication providers).
+
+Example:
+
+```php
+EventHandler::getInstance()->fire(
+    new UserLoggedIn($user)
+);
+```
+
+See [WoltLab/WCF#4356](https://github.com/WoltLab/WCF/pull/4356) for details.
 
 ## Embedded Objects in Comments