$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.172

Twitter updates

  • ProcessWire 3.0.174 core updates: improvements to the new path/URL hooks and more— More
    12 March 2021
  • ProcessWire 3.0.173 adds several new requested features and this post focuses on one of my favorites: the ability to hook into and handle ProcessWire URLs, independent of pages— More
    5 March 2021
  • This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings— More
    5 February 2021

Latest news

  • ProcessWire Weekly #357
    In the 357th issue of ProcessWire Weekly we'll check out ProcessWire 3.0.174, some forum highlights, and more. Read on!
    Weekly.pw / 14 March 2021
  • ProcessWire 3.0.173 core updates: New URL hooks
    ProcessWire 3.0.173 adds several new requested features and this post focuses on one of my favorites: the ability to hook into and handle ProcessWire URLs, independent of pages.
    Blog / 5 March 2021
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani