Ajuda da API do MediaWiki
Esta é uma página de documentação da API do MediaWiki gerada automaticamente.
Documentação e exemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=options
- Este módulo requer direitos de leitura.
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Alterar as preferências do utilizador atual.
Só podem ser definidas as opções que estão registadas no núcleo do MediaWiki ou numa das extensões instaladas, ou opções cuja chave tem o prefixo userjs-
(que são supostas ser usadas por scripts de utilizador).
- reset
Reiniciar preferências para os valores por omissão do sítio.
- Tipo: booliano (detalhes)
- resetkinds
Lista dos tipos de opções a reiniciar quando a opção reset está definida.
- Valores (separados com | ou alternativas): all, registered, registered-checkmatrix, registered-multiselect, special, unused, userjs
- Valor por omissão: all
- change
Listas das alterações, na forma nome=valor (isto é, skin=vector). Se não for fornecido nenhum valor (nem sequer um sinal de igualdade), por exemplo, nomedaopção|outraopção|..., a opção será reiniciada para o seu valor por omissão. Se qualquer dos valores passados contém uma barra vertical (|), use um separador alternativo para valores múltiplos de forma a obter o comportamento correto.
- Separar os valores com | ou alternativas.
- O número máximo de valores é 50 (500 para clientes a quem são permitidos limites mais elevados).
- optionname
O nome da opção que deve ser configurada com o valor dado por optionvalue.
- optionvalue
O valor para a opção especificada por optionname.
- token
Uma chave "csrf" obtida de action=query&meta=tokens
- Este parâmetro é obrigatório.
- Reiniciar todas as preferências.
- api.php?action=options&reset=&token=123ABC [abrir na página de testes]
- Alterar as preferências skin e hideminor.
- api.php?action=options&change=skin=vector|hideminor=1&token=123ABC [abrir na página de testes]
- Reiniciar todas as preferências e depois definir skin e nickname.
- api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC [abrir na página de testes]