Skip to content

Commit 27464e1

Browse files
committed
better explanation for redirects
1 parent 9fa887f commit 27464e1

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/Config/Auth.php

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,15 @@ class Auth extends BaseConfig
4141
* --------------------------------------------------------------------
4242
* Redirect URLs
4343
* --------------------------------------------------------------------
44-
* The default URL or a named route that a user will be redirected to
45-
* after various auth actions. If you need more flexibility you can
46-
* override the `getUrl()` method to apply any logic you may need.
44+
* The default URL that a user will be redirected to after various auth
45+
* auth actions. This can be either of the following:
46+
*
47+
* 1. An absolute URL. E.g. http://example.com OR https://example.com
48+
* 2. A named route that can be accessed using route_to() or url_to
49+
* 3. A URI path within the application. e.g 'admin', 'login', 'expath'
50+
*
51+
* If you need more flexibility you can override the `getUrl()` method
52+
* to apply any logic you may need.
4753
*/
4854
public array $redirects = [
4955
'register' => '/',

0 commit comments

Comments
 (0)