Jump to content

Manual:BlockUsers.php

From mediawiki.org
MediaWiki version:
1.35

Details

blockUsers.php file is a maintenance script to block or unblock a batch of users.

By default, all users are hard blocked, auto blocked from any current and subsequent IP addresses, email disabled, unable to write to their user page and unable to create further accounts with no expiry to this block. You can change these configuration through options.

Options/Arguments

Option/Argument Description Required?
<file> A file where each line contains the name of a user to be blocked. If not given, script reads from standard input Optional
--performer Username that will be shown in the log entries (does not need to be in the sysop group) Optional
--reason Reason for blocks. If empty, no reason will be shown in the logs Optional
--reblock Reblock users who are already blocked Optional
--expiry Expiry of the block (can be something like "1 week" or a timestamp) Optional
--unblock If this option is passed, script will unblock the users instead Optional
--allow-createaccount Allow account creation for blocked IPs Optional
--allow-email Allow blocked accounts to send emails Optional
--allow-talkedit The block user will be able to edit their own talk page Optional
--disable-hardblock Don't block logged in accounts from a blocked IP address Optional
--disable-autoblock Don't autoblock IP addresses used by the accounts Optional

Usage

php maintenance/blockUsers.php [ <file>| --performer| --reason| --reblock| --expiry| --unblock| --allow-createaccount| --allow-email| --allow-talkedit| --disable-hardblock| --disable-autoblock ]
Terminal

(This will block the users contained in the text file "userlist.txt")

If the filename is omitted, the script will expect a list of users on the standard input.

See also