Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:expuserhygiene

The counts of Users > Hygiene: accounts per state (disabled, unactivated, pending, locked, never signed in, inactive, orphaned, duplicate logins and addresses), each with the command that lists them.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/expuserhygiene.md

On this page

exp:expuserhygiene

The counts of Users > Hygiene: accounts per state (disabled, unactivated, pending, locked, never signed in, inactive, orphaned, duplicate logins and addresses), each with the command that lists them.

Script bin/php/expuserhygiene.php, code in kernel/private/classes/commands/expuserhygiene.php. Run it from the installation root, as the user the web server runs as:

./console exp:expuserhygiene --help
./console exp:user:hygiene --help
php bin/php/expuserhygiene.php --help

Help text

The state of the accounts at a glance
Counts the accounts in each state of Users > Hygiene: all, enabled, disabled, unactivated, pending,
locked, never signed in, inactive (not signed in for --days days), orphaned, and logins and e-mail
addresses more than one account has; each with the exp:user:list command that lists them. Changes
nothing. Run it before a clean-up, and from a monitoring job with --format=json.

./console exp:user:hygiene
./console exp:user:hygiene --days=365 --format=json

Options

OptionValueHelp
--daysrequiredWith --state=inactive: not signed in for this many days (default 180)
--formatrequiredtext (default) or json (the machine output exp-user/1)

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).


Generated by ./console exp:help:examples from bin/php/expuserhygiene.php, kernel/private/classes/commands/expuserhygiene.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x