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

Twitter updates

  • New post: Version 3.0.135 of ProcessWire on the dev branch focuses on some .htaccess updates, adds clarity to debug mode, and improves upon the installer— More
    5 July 2019
  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019
  • New post: This week we’ll take a look at 3 different WEBP image strategies that you can use in ProcessWire 3.0.132+. Then we’ll dive into a major update for the Google Client API module, and finish up by outlining some useful new updates in FormBuilder— More
    31 May 2019

Latest news

  • ProcessWire Weekly #270
    This week in the 270th issue of ProcessWire Weekly we're going to cover the SearchEngine module, feature some recent support forum highlights, and introduce a brand new site of the week. Read on!
    Weekly.pw / 13 July 2019
  • ProcessWire 3.0.135 core updates
    Version 3.0.135 of ProcessWire on the dev branch focuses on .htaccess updates, adds additional layers of security, adds clarity to debug mode, and improves upon the installer.
    Blog / 3 July 2019
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK