# $users

The `$users` object refers to a collection of users with or without Panel access. Like all collections, you can filter, modify, convert or check the users collection.

****

- Full class name: `Kirby\Cms\Users`
- Alias: `Users`
- Source: <https://github.com/getkirby/kirby/tree/5.5.3/src/Cms/Users.php#L28>

****

### $users

- [$users->__call()](https://getkirby.com/docs/reference/objects/cms/users/__call.md)
- [new Users()](https://getkirby.com/docs/reference/objects/cms/users/__construct.md)
- [$users->__debugInfo()](https://getkirby.com/docs/reference/objects/cms/users/__debug-info.md)
- [$users->__get()](https://getkirby.com/docs/reference/objects/cms/users/__get.md)
- [$users->__isset()](https://getkirby.com/docs/reference/objects/cms/users/__isset.md)
- [$users->__set()](https://getkirby.com/docs/reference/objects/cms/users/__set.md)
- [$users->__toString()](https://getkirby.com/docs/reference/objects/cms/users/__to-string.md)
- [$users->__unset()](https://getkirby.com/docs/reference/objects/cms/users/__unset.md)
- [$users->add()](https://getkirby.com/docs/reference/objects/cms/users/add.md)
- [$users->append()](https://getkirby.com/docs/reference/objects/cms/users/append.md)
- [$users->chunk()](https://getkirby.com/docs/reference/objects/cms/users/chunk.md)
- [$users->clone()](https://getkirby.com/docs/reference/objects/cms/users/clone.md)
- [$users->count()](https://getkirby.com/docs/reference/objects/cms/users/count.md)
- [$users->create()](https://getkirby.com/docs/reference/objects/cms/users/create.md)
- [$users->current()](https://getkirby.com/docs/reference/objects/cms/users/current.md)
- [$users->data()](https://getkirby.com/docs/reference/objects/cms/users/data.md)
- [$users->empty()](https://getkirby.com/docs/reference/objects/cms/users/empty.md)
- [$users->extend()](https://getkirby.com/docs/reference/objects/cms/users/extend.md)
- [Users::factory()](https://getkirby.com/docs/reference/objects/cms/users/factory.md)
- [$users->files()](https://getkirby.com/docs/reference/objects/cms/users/files.md)
- [$users->filter()](https://getkirby.com/docs/reference/objects/cms/users/filter.md)
- [$users->filterBy()](https://getkirby.com/docs/reference/objects/cms/users/filter-by.md)
- [$users->find()](https://getkirby.com/docs/reference/objects/cms/users/find.md)
- [$users->findBy()](https://getkirby.com/docs/reference/objects/cms/users/find-by.md)
- [$users->findByKey()](https://getkirby.com/docs/reference/objects/cms/users/find-by-key.md)
- [$users->first()](https://getkirby.com/docs/reference/objects/cms/users/first.md)
- [$users->flip()](https://getkirby.com/docs/reference/objects/cms/users/flip.md)
- [$users->get()](https://getkirby.com/docs/reference/objects/cms/users/get.md)
- [$users->getAttribute()](https://getkirby.com/docs/reference/objects/cms/users/get-attribute.md)
- [$users->getIterator()](https://getkirby.com/docs/reference/objects/cms/users/get-iterator.md)
- [$users->getMethod()](https://getkirby.com/docs/reference/objects/cms/users/get-method.md)
- [$users->group()](https://getkirby.com/docs/reference/objects/cms/users/group.md)
- [$users->groupBy()](https://getkirby.com/docs/reference/objects/cms/users/group-by.md)
- [$users->has()](https://getkirby.com/docs/reference/objects/cms/users/has.md)
- [$users->hasMethod()](https://getkirby.com/docs/reference/objects/cms/users/has-method.md)
- [$users->hydrate()](https://getkirby.com/docs/reference/objects/cms/users/hydrate.md)
- [$users->indexOf()](https://getkirby.com/docs/reference/objects/cms/users/index-of.md)
- [$users->initialize()](https://getkirby.com/docs/reference/objects/cms/users/initialize.md)
- [$users->intersection()](https://getkirby.com/docs/reference/objects/cms/users/intersection.md)
- [$users->intersects()](https://getkirby.com/docs/reference/objects/cms/users/intersects.md)
- [$users->isEmpty()](https://getkirby.com/docs/reference/objects/cms/users/is-empty.md)
- [$users->isEven()](https://getkirby.com/docs/reference/objects/cms/users/is-even.md)
- [$users->isNotEmpty()](https://getkirby.com/docs/reference/objects/cms/users/is-not-empty.md)
- [$users->isOdd()](https://getkirby.com/docs/reference/objects/cms/users/is-odd.md)
- [$users->join()](https://getkirby.com/docs/reference/objects/cms/users/join.md)
- [$users->key()](https://getkirby.com/docs/reference/objects/cms/users/key.md)
- [$users->keyOf()](https://getkirby.com/docs/reference/objects/cms/users/key-of.md)
- [$users->keys()](https://getkirby.com/docs/reference/objects/cms/users/keys.md)
- [$users->last()](https://getkirby.com/docs/reference/objects/cms/users/last.md)
- [$users->limit()](https://getkirby.com/docs/reference/objects/cms/users/limit.md)
- [Users::load()](https://getkirby.com/docs/reference/objects/cms/users/load.md)
- [$users->map()](https://getkirby.com/docs/reference/objects/cms/users/map.md)
- [$users->next()](https://getkirby.com/docs/reference/objects/cms/users/next.md)
- [$users->not()](https://getkirby.com/docs/reference/objects/cms/users/not.md)
- [$users->nth()](https://getkirby.com/docs/reference/objects/cms/users/nth.md)
- [$users->offset()](https://getkirby.com/docs/reference/objects/cms/users/offset.md)
- [$users->paginate()](https://getkirby.com/docs/reference/objects/cms/users/paginate.md)
- [$users->pagination()](https://getkirby.com/docs/reference/objects/cms/users/pagination.md)
- [$users->parent()](https://getkirby.com/docs/reference/objects/cms/users/parent.md)
- [$users->pluck()](https://getkirby.com/docs/reference/objects/cms/users/pluck.md)
- [$users->prepend()](https://getkirby.com/docs/reference/objects/cms/users/prepend.md)
- [$users->prev()](https://getkirby.com/docs/reference/objects/cms/users/prev.md)
- [$users->query()](https://getkirby.com/docs/reference/objects/cms/users/query.md)
- [$users->random()](https://getkirby.com/docs/reference/objects/cms/users/random.md)
- [$users->remove()](https://getkirby.com/docs/reference/objects/cms/users/remove.md)
- [$users->rewind()](https://getkirby.com/docs/reference/objects/cms/users/rewind.md)
- [$users->role()](https://getkirby.com/docs/reference/objects/cms/users/role.md)
- [$users->search()](https://getkirby.com/docs/reference/objects/cms/users/search.md)
- [$users->set()](https://getkirby.com/docs/reference/objects/cms/users/set.md)
- [$users->shuffle()](https://getkirby.com/docs/reference/objects/cms/users/shuffle.md)
- [$users->slice()](https://getkirby.com/docs/reference/objects/cms/users/slice.md)
- [$users->sort()](https://getkirby.com/docs/reference/objects/cms/users/sort.md)
- [Users::sortArgs()](https://getkirby.com/docs/reference/objects/cms/users/sort-args.md)
- [$users->sortBy()](https://getkirby.com/docs/reference/objects/cms/users/sort-by.md)
- [$users->toArray()](https://getkirby.com/docs/reference/objects/cms/users/to-array.md)
- [$users->toJson()](https://getkirby.com/docs/reference/objects/cms/users/to-json.md)
- [$users->toString()](https://getkirby.com/docs/reference/objects/cms/users/to-string.md)
- [$users->update()](https://getkirby.com/docs/reference/objects/cms/users/update.md)
- [$users->valid()](https://getkirby.com/docs/reference/objects/cms/users/valid.md)
- [$users->values()](https://getkirby.com/docs/reference/objects/cms/users/values.md)
- [$users->when()](https://getkirby.com/docs/reference/objects/cms/users/when.md)
- [$users->without()](https://getkirby.com/docs/reference/objects/cms/users/without.md)

## How to get a `$users` object

The users object is available via the `$kirby` object:

```php
$users = $kirby->users();
```

This will return a collection of all users of the site.

## Examples

With the `$users` object in place, you can now use all the methods of the class, for example:

### Get all admin users

```php
$admins = $users->filterBy('isAdmin');
```

### Fetch all values of a user field into an array

```php
$userEmails = $users->pluck('email');
```
This will return an array with all the email adresses of all users.

### Sort users

```php
$sorted = $users->sortBy('role');
```