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:expuserdelete

Remove a user account for good, as the administration does; refuses the anonymous user, the administrator accounts, the user who acts and the last administrator (a dry run unless --apply).

Download as PDF

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

On this page

exp:expuserdelete

Remove a user account for good, as the administration does; refuses the anonymous user, the administrator accounts, the user who acts and the last administrator (a dry run unless --apply).

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

./console exp:expuserdelete --help
./console exp:user:delete --help
php bin/php/expuserdelete.php --help

Help text

Remove a user account for good
Removes the account's locations as the administration does; accounts are never moved to the
trash (the administration refuses that too), so the account, its settings and its sessions go.
The content the person created stays. Refused for the anonymous user, the user of
[UserSettings] UserCreatorID, the administrator account, the user who acts and the last enabled
administrator. To keep the account but stop its use, see exp:user:disable. Without --apply
nothing is removed.

./console exp:user:delete jane
./console exp:user:delete jane --apply

Options

OptionValueHelp
--applyMake the change; without it the command only lists what it would change (a dry run)
--dry-runThe default, kept for scripts that pass it: list what would change, change nothing
--asrequiredAct as this user (login, e-mail or id; default the user of [UserSettings] UserCreatorID); the audit records it as who did it
--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 ...).

Arguments: [user].


Generated by ./console exp:help:examples from bin/php/expuserdelete.php, kernel/private/classes/commands/expuserdelete.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