diff options
Diffstat (limited to 'docs/users.md')
| -rw-r--r-- | docs/users.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/users.md b/docs/users.md index 5473910..d20ea24 100644 --- a/docs/users.md +++ b/docs/users.md @@ -28,6 +28,17 @@ echo 'Full name: '.$user->firstName.' '.$user->lastName."\n"; ?> ``` +## Getting All Users + +You can use the `findUsers` method on the `Gatekeeper` class to get a list (returnes a `UserCollection`) of the current users: + +```php +$users = Gatekeeper::findUsers(); + +// You can then slice it up how you need, like getting the first three +$shortUserList = $users->slice(1, 3); +``` + ## Creating Users To create a user, you only need to provide the user details to the `register` method: |