$users API variable / Users class

Manages all users (User objects) in ProcessWire.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Users class also inherits all the methods and properties of: PagesType and Wire.

Show $var?             Show args?        

Common

NameReturnSummary 
$users->add($name)
UserAdd new User with the given name and return it.
$users->delete($user)
boolDelete the given User.
$users->find($selector)
PageArrayReturn the User(s) matching the the given selector query.
$users->get(string $selectorString)
Page NullPage nullGet the user by name, ID or selector string 
$users->getCurrentUser()
UserReturns the current user object 
$users->getGuestUser()
UserGet the 'guest' user account 
$users->save($user)
boolSave given User.
$users->setCurrentUser(User $user)
(nothing)Set the current system user (the $user API variable) 

For hooks

These methods are only useful for hooking and should not be called directly.

NameReturnSummary 
$users->added($user)
(nothing)Hook called just after a User is added
$users->deleteReady($user)
(nothing)Hook called before a User is deleted
$users->deleted($user)
(nothing)Hook called after a User is deleted
$users->saveReady(Page $page)
arrayHook called just before a user is saved
$users->saved($user, array $changes)
(nothing)Hook called after a User has been saved

Additional methods and properties

In addition to the methods and properties above, Users also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • New post: This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140— More
    6 September 2019
  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019
  • Core version 3.0.137 on the dev branch adds the ability to hook multiple methods at once, in a single call. This post details how it works and provides a useful example of how you might put it to use in your development environment— More
    2 August 2019

Latest news

  • ProcessWire Weekly #279
    This week in the 279th issue of ProcessWire Weekly we're going to introduce some of the latest third party modules out there, and highlight a brand new site of the week. Read on!
    Weekly.pw / 14 September 2019
  • ProcessWire 3.0.140 and FormBuilder v40
    This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140.
    Blog / 6 September 2019
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull