API:Categorymembers

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page API:Categorymembers and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎polski • ‎русский • ‎中文 • ‎日本語
Версия MediaWiki:
1.11

GET-запрос на перечисление страниц, относящихся к данной категории.

Документация по API


list=categorymembers (cm)

(main | query | categorymembers)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

List all pages in a given category.

Parameters:
cmtitle

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

cmpageid

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

Type: integer
cmprop

Which pieces of information to include:

ids
Adds the page ID.
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.
Values (separate with | or alternative): ids, sortkey, sortkeyprefix, timestamp, title, type
Default: 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.

Note: Due to miser mode, using this may result in fewer than cmlimit results returned before continuing; in extreme cases, zero results may be returned.

Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 90, 91, 92, 93, 100, 101, 102, 103, 104, 105, 106, 107, 486, 487, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303, 2600, 5500, 5501
To specify all values, use *.
cmtype

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

Values (separate with | or alternative): file, page, subcat
Default: page|subcat|file
cmcontinue

When more results are available, use this to continue.

cmlimit

The maximum number of pages to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
cmsort

Property to sort by.

One of the following values: sortkey, timestamp
Default: sortkey
cmdir

In which direction to sort.

One of the following values: asc, ascending, desc, descending, newer, older
Default: ascending
cmstart

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

Type: timestamp (allowed formats)
cmend

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

Type: timestamp (allowed formats)
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
Deprecated.

Use cmstarthexsortkey instead.

cmendsortkey
Deprecated.

Use cmendhexsortkey instead.

Пример 1: Список из двадцати страниц в указанной категории

GET-запрос

Ответ

Пример кода

Пример 2: Получение последних десяти статей, добавленных в категорию

GET-запрос

Ответ

Пример кода

Пример 3. Получить десять подкатегорий указанной категории

GET-запрос

Ответ

Следующие подкатегории (если их больше 10) можно продолжить, используя параметр cmcontinue из предыдущего ответа.

Пример кода

Возможные ошибки

Код Информация
cmnotitle Параметр cmtitle обязателен.
cminvalidcategory Введённое вами название категории некорректно.
cmbadcontinue Некорректный параметр continue. Вы должны передать значение, возвращённое предыдущим запросом.

История параметров

  • v1.24: Устарели cmstartsortkey, cmendsortkey
  • v1.18: Введены cmstartsortkeyprefix, cmendsortkeyprefix
  • v1.17: Введены sortkeyprefix, type
  • v1.14: Введены cmstartsortkey, cmendsortkey
  • v1.12: Введены cmtype,cmstart, cmend, cmdir

См. также

  • API:Allpages - перечисляет все страницы, соответствующие определенным критериям
  • API:Categories - перечисляет категории, связанные со страницей
  • API:Allcategories - перечисляет все категории в Вики