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

Set up the approval of new accounts in a user group (default: new Editors wait for the Administrator users): the workflow event on content/publish before and the role that lets the requesters create such accounts…

Download as PDF

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

On this page

exp:adduserapproval

Set up the approval of new accounts in a user group (default: new Editors wait for the Administrator users): the workflow event on content/publish before and the role that lets the requesters create such accounts; --mode=section sets up the optional alternative, a section Staff with the plain approval event (both a dry run unless --apply).

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

./console exp:adduserapproval --help
php bin/php/adduserapproval.php --help

Help text

Set up the approval of new user accounts: the workflow "

Options

OptionValueHelp
--applyMake the changes, in either mode (the default is a dry run that lists them and changes nothing)
--dry-runThe default, kept for scripts that pass it: list what would be created and changed, change nothing
--moderequiredgroup (default: the event "Approve user accounts") or section (the section Staff and the plain approval event)
--staffrequired--mode=section: a group whose accounts go into the section Staff (default Administrator users and Editors), may be repeated
--exemptrequired--mode=section: a group whose members need no approval (default Administrator users), may be repeated
--requiredrequiredA group whose new accounts need approval (default Editors), may be repeated
--approversrequiredA group whose members approve (default Administrator users), may be repeated
--requestersrequiredA group that may create accounts in the required groups and waits for approval (default Editors), may be repeated
--no-roleDo not create or assign the requesters' role (the requesters have their policies already)
--admin-idrequiredThe user the workflow is created by (default 14)

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/adduserapproval.php, kernel/private/classes/commands/adduserapproval.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