עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=options
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
שינוי העדפות של המשתמש הנוכחי.
רק אפשרויות שמוגדרות בליבה או באחת מההרחבות המותקנות, או אפשרויות עם מפתחות עם התחילית "userjs-" (שמיועדות לשימוש תסריטי משתמשים) יכולות להיות מוגדרות.
- reset
אתחול ההעדפות לברירות המחדל של האתר.
- סוג: בוליאני (פרטים)
- resetkinds
רשימת סוגי אפשרויות לאתחל כאשר מוגדרת האפשרות reset.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): all, registered, registered-checkmatrix, registered-multiselect, special, unused, userjs
- ברירת המחדל: all
- change
רשימת שינויים, בתסדיר name=value (למשל skin=vector). אם לא ניתן ערך, אפילו לא סימן שווה, למשל optionname|otheroption|..., האפשרות תאופס לערך ברירת המחדל שלה. אם ערך מועבר כלשהו מכיל את תו הקו הניצב (|), יש להשתמש במפריד ערכים מרובים חלופי בשביל פעולה נכונה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- optionname
שם האפשרות שצריך להגדיר לערך שניתן ב־optionvalue.
- optionvalue
ערך האפשרות שצוין ב־optionname. כש־optionname מוגדר אך optionvalue מושמט, האפשרות תאופס לערך ברירת המחדל שלה.
- global
מה לעשות אם האפשרות הוגדרה גלובלית באמצעות ההרחבה GlobalPreferences.
- ignore: לא לעשות כלום. האפשרות נשארת עם הערך הקודם שלה.
- override: להוסיף עקיפה מקומית.
- update: לעדכן את האפשרות באופן גלובלי.
- אחד מהערכים הבאים: ignore, override, update
- ברירת המחדל: ignore
- 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 [פתיחה בארגז חול]