MediaWiki API help
Affiliate recommendation
Explore linguistics, Hebrew, and Bible study books 📚
Interested in how languages work? Discover books on linguistics, phonetics, grammar, etymology, semantics, Hebrew language studies, Biblical Hebrew, modern Hebrew, Bible study resources, commentaries, concordances, and the science of human language.
As an Amazon Associate I earn from qualifying purchases.
This is an auto-generated MediaWiki Action API documentation page.
action=options
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0-or-later
Change preferences of the current user.
Only options which are registered in core or in one of installed extensions, or options with keys prefixed with userjs- (intended to be used by user scripts), can be set.
- reset
Resets preferences to the site defaults.
- Type: boolean (details)
- resetkinds
List of types of options 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., optionname|otheroption|..., the option will be reset to its default value. 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 option that should be set to the value given by optionvalue.
- optionvalue
The value for the option specified by optionname. When optionname is set but optionvalue is omitted, the option will be reset to its default value.
- global
What to do if the option was set globally using the GlobalPreferences extension.
- ignore: Do nothing. The option remains with its previous value.
- override: Add a local override.
- update: Update the option globally.
- create: Set the option globally, overriding any local value.
- One of the following values: create, ignore, override, update
- Default: ignore
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Reset all preferences.
- api.php?action=options&reset=&token=123ABC [open in sandbox]
- Change skin and hideminor preferences.
- api.php?action=options&change=skin=vector|hideminor=1&token=123ABC [open in sandbox]
- Reset all preferences, then set skin and nickname.
- api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC [open in sandbox]