Manual:BlockUsers.php
| MediaWiki version: | ≥ 1.35 |
| MediaWiki file: blockUsers.php | |
|---|---|
| Location: | maintenance/ |
| Source code: | master • 1.43.1 • 1.42.6 • 1.39.12 |
| Classes: | BlockUsers |
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/run.php blockUsers [ <file>| --performer| --reason| --reblock| --expiry| --unblock| --allow-createaccount| --allow-email| --allow-talkedit| --disable-hardblock| --disable-autoblock ]
In MediaWiki version 1.39.12 and earlier, you must invoke maintenance scripts using
php maintenance/scriptName.php instead of php maintenance/run.php scriptName.Terminal
$ php maintenance/run.php blockUsers userlist.txt --performer "Foo" --reason "Vandalism" Blocking 'A' succeeded. Blocking ‘C’ succeeded. Blocking 'Bar' failed (There is no user by the name "Bar". Check your spelling.).
(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
- Manual:Block and unblock
- cleanupSpam.php
- Extension:GlobalBlocking
- BulkBlock Extension — an extension that allows administrators to easily block multiple users at once on a MediaWiki website.