עזרה של MediaWiki API

זהו דף תיעוד של API שנוצר באופן אוטומטי.

תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API

action=options

(main | options)
  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

שינוי העדפות של המשתמש הנוכחי.

רק אפשרויות שמוגדרות בליבה או באחת מההרחבות המותקנות, או אפשרויות עם מפתחות עם התחילית "userjs-" (שמיועדות לשימוש תסריטי משתמשים) יכולות להיות מוגדרות.

פרמטרים:
reset

אתחול ההעדפות לבררות המחדל של האתר.

סוג: בוליאני (פרטים)
resetkinds

רשימת סוגי אפשרויות לאתחל כאשר מוגדרת האפשרות reset.

ערכים (מופרדים באמצעות "|"): registered, registered-multiselect, registered-checkmatrix, userjs, special, unused, all
ברירת מחדל: all
change

רשימת שינויים, בתסדיר name=value (למשל skin=vector). הערך אינו יכול להכיל תווי מקל (|). אם לא ניתן ערך, אפילו לא סימן שווה, למשל optionname|otheroption|...‎, האפשרות תאופס לערך בררת המחדל שלה.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
optionname

שם האפשרות שצריך להגדיר לערך שניתן ב־optionvalue.

optionvalue

ערך האפשרות שצוין ב־optionname, יכול להכיל תווי מקל.

token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
אתחול כל ההעדפות.
api.php?action=options&reset=&token=123ABC
לשנות את ההעדפות skin ו־hideminor.
api.php?action=options&change=skin=vector|hideminor=1&token=123ABC
לאתחל את כל ההעדפות ואז להגדיר את skin ואת nickname.
api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC