Manual:createAndPromote.php
| MediaWiki version: | ≥ 1.7 |
| MediaWiki file: createAndPromote.php | |
|---|---|
| Location: | maintenance/ |
| Source code: | master • 1.42.3 • 1.41.4 • 1.39.10 |
| Classes: | CreateAndPromote |
Details
editcreateAndPromote.php is a maintenance script that creates a new user or modifies an existing user. For the corresponding user, the script can then grant additional rights (e.g. sysop, bureaucrat or bot rights) and change the user's password.
Since the script can be used not only to create new users, but also on existing users to promote them, and also to create a user without promoting them, the name createAndPromote.php is somewhat misleading.
This script cannot be used to remove user groups from users.
Options/Arguments
edit| Option | Description | Required? |
|---|---|---|
| <username> | The name of the user you want to create or modify and - depending on the other parameters - promote. The --force flag is required if a user with this name already exists. | Required |
| <password> | The password for the user. | Required |
| --bureaucrat | Add the account to the bureaucrat group | Optional |
| --sysop | Add the account to the sysop group | Optional |
| --bot | Add the account to the bot group | Optional |
| --interface-admin | Add the account to the interface-admin group | Optional |
| --custom-groups | Comma-separated list of groups to add the user to. This allows adding the user to any custom group. Since MW 1.27, a user is only added to a custom group, if this group actually exists according to $wgGroupPermissions and $wgRevokePermissions. Non-existing groups are ignored. |
Optional |
| --force | If account already exists, just grant it rights or change password. Do not create a new account in this case. | Optional |
| --help | Display help information for the script. | Optional |
Usage
edit| MediaWiki version: | ≤ 1.39 |
php maintenance/createAndPromote.php <username> [ <password>| --bureaucrat| --sysop| --bot| --interface-admin| --custom-groups group1,group2| --force ]
| MediaWiki version: | ≥ 1.40 |
php maintenance/run.php createAndPromote <username> [ <password>| --bureaucrat| --sysop| --bot| --interface-admin| --custom-groups group1,group2| --force ]
Terminal
$ php maintenance/createAndPromote.php WikiSysop mypassword --bureaucrat --sysop --custom-groups developer mywiki: Creating and promoting User:WikiSysop into sysop, bureaucrat... done.
This creates a new user called "WikiSysop", sets the password and adds the user to the bureaucrat group, the sysop group and to the custom developer group.