API:Options/ja

トークン
オプションを変更するにはオプション トークン (options token) が必要です. 以下のようにして取得できます:

オプションの変更
action=options を使用してオプションを変更できます.

While this API is primarily intended for changing options which are registered by MediaWiki core or extensions and available on Special:Preferences, since you can also use it to set arbitrary user options that can be used by user-scripts or external editors.

These arbitrary options have three limits imposed on them:
 * the key must start with the prefix
 * the length of the key must not be more than 255 bytes
 * the key must consist only of ASCII letters, numbers, hyphens and underscores (a-z, A-Z, 0-9, _, -)

There are currently no hard limits on the length or contents of the value, nor is there a limit on the number of user options you can set at once. You can even store a complex tree of data within a user option by encoding it as a JSON string.

パラメーター

 * token: 以前のリクエストで取得したトークン. 必ず末尾の  を   に urlencode するようにしてください.
 * reset: すべての設定をサイトの既定値にリセットします.
 * change: Pipe-separated list of changes, formatted name=value (e.g. skin=vector), value cannot contain pipe characters. Providing only names of options without equal sign (e.g. hideminor|skin) results in resetting them.
 * optionname: A name of a option which should have an optionvalue set.
 * optionvalue: A value of the option specified by the optionname, can contain pipe characters.

The change parameter cannot be used to set a value which contains a pipe character "|", as it is used by the API to separate options. If you need to set such a value (for example, a user signature) use an optionname & optionvalue pair.

例
注記: In this example, all parameters are passed in a GET request for the sake of simplicity. However, action=options requires POST requests; GET requests will cause an error.

起こりうるエラー
In addition to the usual stuff:
 * code: notloggedin
 * info: Anonymous users cannot change preferences
 * code: nochanges
 * info: No changes were requested

関連項目

 * API:Meta/ja - 既存のオプションの読み取りについて