MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=globalpreferences
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: GlobalPreferences
- License: GPL-2.0-or-later
Change global preferences of the current user.
Only preferences registered for the current wiki can be changed locally.
- reset
Reset global preferences. Removes all, or, depending on the value of the
resetkinds
parameter, some types of global preferences and make them not global anymore.- Type: boolean (details)
- resetkinds
List of types of preferences to reset when the reset option is set.
- Values (separate with | or alternative): all, registered, registered-checkmatrix, registered-multiselect, special, unused, userjs
- Default: all
- change
List of changes, formatted name=value (e.g. skin=vector). If no value is given (not even an equals sign), e.g., preferencename|otherpreference|..., the preference will be made non-global. If any value passed contains the pipe character (|), use the alternative multiple-value separator for correct operation.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- optionname
The name of the preference that should be set to the value given by optionvalue.
- optionvalue
The value for the preference specified by optionname.
- global
(no description)
- One of the following values: ignore, override, update
- Default: ignore
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Make a single preference non-global.
- api.php?action=globalpreferences&change=skin=&token=123ABC [open in sandbox]
- Make all preferences non-global.
- api.php?action=globalpreferences&reset=&token=123ABC [open in sandbox]
- Change skin and hideminor preferences.
- api.php?action=globalpreferences&change=skin=vector|hideminor=1&token=123ABC [open in sandbox]