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

Twitter updates

  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019
  • New ProcessWire main site rebuild ready for preview— More
    4 January 2019
  • Happy Holidays! This latest master version of ProcessWire contains hundreds of new additions, fixes, optimizations and more. This post covers all the highlights— More
    21 December 2018

Latest news

  • ProcessWire Weekly #245
    In the 245th issue of ProcessWire Weekly we're going to focus on some new documentation additions made just this week, cover a couple of new third party modules from Bernhard Baumrock, and introduce a magnificent new travel website called Uncover Colombia. Read on!
    Weekly.pw / 19 January 2019
  • ProcessWire 3.0.124 and new website launched
    In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124.
    Blog / 11 January 2019
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer