راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی

این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده‌است.

مستندات و نمونه‌ها: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

list=categorymembers (cm)

(main | query | categorymembers)
  • این پودمان نیازمند اختیارات خواندن است.
  • This module can be used as a generator.
  • منبع: MediaWiki
  • مجوز: GPL-2.0-or-later

فهرست‌کردن همهٔ صفحه‌ها در یک ردهٔ مشخص‌شده.

پارامترها:
cmtitle

Which category to enumerate (required). Must include the رده: prefix. Cannot be used together with cmpageid.

cmpageid

Page ID of the category to enumerate. Cannot be used together with cmtitle.

نوع: عدد صحیح
cmprop

Which pieces of information to include:

ids
افزودن شناسه صفحه
title
Adds the title and namespace ID of the page.
sortkey
Adds the sortkey used for sorting in the category (hexadecimal string).
sortkeyprefix
Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
type
Adds the type that the page has been categorised as (page, subcat or file).
timestamp
Adds the timestamp of when the page was included.
مقدارهای (جداشده با | یا جایگزین‌های آن): ids، sortkey، sortkeyprefix، timestamp، title، type
پیش‌فرض: ids|title
cmnamespace

Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.

مقدارهای (جداشده با | یا جایگزین‌های آن): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15، 828، 829، 2300، 2301، 2302، 2303
برای تعیین همهٔ مقدارها از * استفاده کنید.
cmtype

Which type of category members to include. Ignored when cmsort=timestamp is set.

مقدارهای (جداشده با | یا جایگزین‌های آن): file، page، subcat
پیش‌فرض: page|subcat|file
cmcontinue

When more results are available, use this to continue.

cmlimit

The maximum number of pages to return.

نوع: عدد صحیح یا max
The value must be between ۱ and ۵۰۰.
پیش‌فرض: 10
cmsort

ویژگی برای مرتب‌سازی

یکی از مقدارهای زیر: sortkey، timestamp
پیش‌فرض: sortkey
cmdir

جهت مرتب شدن

یکی از مقدارهای زیر: asc، ascending، desc، descending، newer، older
پیش‌فرض: ascending
cmstart

Timestamp to start listing from. Can only be used with cmsort=timestamp.

نوع: برچسب زمان (قالب‌های مجاز)
cmend

Timestamp to end listing at. Can only be used with cmsort=timestamp.

نوع: برچسب زمان (قالب‌های مجاز)
cmstarthexsortkey

Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmendhexsortkey

Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmstartsortkeyprefix

Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.

cmendsortkeyprefix

Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.

cmstartsortkey
منسوخ‌شده.

جایش از cmstarthexsortkey استفاده کنید.

cmendsortkey
منسوخ‌شده.

Use cmendhexsortkey instead.