exp:expuserdelete

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

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)

Usage

./console exp:expuserdelete [options]
php bin/php/expuserdelete.php [options]
./console exp:user:delete [options]

Aliases

exp:user:delete

Help

The output of ./console help exp:expuserdelete (the script run with --help), without the standard options:

Usage: bin/php/expuserdelete.php [OPTION]... [USER]
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:
  --apply         Make the change; without it the command only lists what it would change (a dry run)
  --dry-run       The default, kept for scripts that pass it: list what would change, change nothing
  --as=VALUE      Act as this user (login, e-mail or id; default the user of [UserSettings] UserCreatorID); the audit records it as who did it
  --format=VALUE  text (default) or json (the machine output exp-user/1)

Options

Arguments

[user]

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/expuserdelete.php, kernel/private/classes/commands/expuserdelete.php

See also

Generated example: exp:expuserdelete

Added to the reference for Exponential 6.0.15.