עזרה של MediaWiki API

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

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

action=block

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

חסימת משתמש.

פרמטרים ייעודיים:
זמינים פרמטרים כלליים אחרים.
user

איזה משתמש לחסום.

סוג: משתמש, בכל אחת מהצורות הבאות: שם משתמש, כתובת IP, טווח כתובות IP וגם מספר מזהה של משתמש (כגון "#12345")
userid
מיושן.

יש לציין user=#ID במקום.

סוג: מספר שלם
expiry

זמן תפוגה. יכול להיות יחסי (למשל 5 months או 2 weeks) או מוחלט (למשל 2014-09-18T12:34:56Z). אם זה מוגדר ל־infinite‏, indefinite, או never, החסימה לא תפוג לעולם.

ברירת המחדל: never
reason

סיבה לחסימה.

ברירת מחדל: (ריק)
anononly

לחסום משתמשים אלמוניים בלבד (דהיינו, השבתת עריכות אלמוניות מכתובת ה־IP הזאת)

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

מניעת יצירת חשבונות

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

חסימה אוטומטית גם של כתובת ה־IP האחרונה שהשתמש בה ושל כל כתובת IP שינסה להשתמש בה בעתיד.

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

למנוע ממשתמש לשלוח דואר אלקטרוני דרך הוויקי. (דורש את ההרשאה blockemail).

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

הסרת השם מיומן החסימות. (דורש את ההרשאה hideuser.)

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

לאפשר למשתמש לערוך את דף השיחה שלו או שלה (תלוי ב־$wgBlockAllowsUTEdit).

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

אם המשתמש כבר חסום, לדרוס את החסימה הנוכחית.

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

לעקוב אחרי דף המשתמש ודף השיחה של המשתמש או של כתובת ה־IP.

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

תגי שינוי שיחולו על הרשומה ביומן החסימה.

ערכים (מופרדים באמצעות "|" או or תו חלופי):
partial

חסימת משתמש מעריכת דפים או מרחבי שם מסוימים ולא מכל האתר.

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

רשימת כותרות שהמשתמש ייחסם מעריכתן. חל רק כאשר partial מוגדר ל־true.

סוג: כותרת דף
הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
המספר המרבי של הערכים הוא 10.
מקבל רק דפים שקיימים.
namespacerestrictions

רשימת מזהי מרחב שם שהמשתמש ייחסם מעריכתם. חל רק כאשר partial מוגדר ל־true.

ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
כדי לתת את כל הערכים, יש להשתמש ב־*.
token

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

הפרמטר הזה נדרש.
דוגמאות:
חסימת כתובת ה־IP‏ 192.0.2.5 לשלושה ימים עם סיבה.
api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [פתיחה בארגז חול]
חסימת המשתמש Vandal ללא הגבלת זמן עם סיבה, ומניעת יצירת חשבונות חדשים ושליחת דוא"ל.
api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [פתיחה בארגז חול]