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=wikidesign
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: WikiDesign
- License: MIT
Set, reset or configure a WikiDesign slot for this wiki.
- slot
The design slot to change.
- This parameter is required.
- One of the following values: background, favicon, header, logo
- command
Whether to set the slot from a supplied image, reset it to the farm default, or configure its settings.
- One of the following values: configure, reset, set
- Default: set
- file
File contents, for a multipart/form-data upload.
- Must be posted as a file upload using multipart/form-data.
- url
URL to fetch the image from (copy upload; must be enabled and the host allowed).
- filekey
Key of a previously stashed upload to use as the image.
- enabled
For command=configure: whether the slot is enabled (logo/favicon; for header/background, enabled=0 means mode=off).
- Type: boolean (details)
- mode
For command=configure (header/background): which layer the slot shows — off, image or color (image and color are mutually exclusive).
- One of the following values: color, image, off
- color
For command=configure (header/background): a CSS colour, or empty to clear.
- opacity
For command=configure (header/background): colour layer opacity, 0–1.
- height
For command=configure (header): the header strip height as a CSS length.
- comment
Comment or edit summary recorded with the change.
- Default: (empty)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Set the background slot from an uploaded file.
- api.php?action=wikidesign&command=set&slot=background&file=&token=123ABC [open in sandbox]
- Reset the logo slot to the farm default.
- api.php?action=wikidesign&command=reset&slot=logo&token=123ABC [open in sandbox]
- Enable the header slot and give it a colour.
- api.php?action=wikidesign&command=configure&slot=header&enabled=1&color=%231f6f8b&token=123ABC [open in sandbox]