MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
list=pageswithprop (pwp)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0-or-later
List all pages using a given page property.
Parameters:
- pwppropname
Page property for which to enumerate pages (action=query&list=pagepropnames returns page property names in use).
- This parameter is required.
- pwpprop
Which pieces of information to include:
- ids
- Adds the page ID.
- title
- Adds the title and namespace ID of the page.
- value
- Adds the value of the page property.
- Values (separate with | or alternative): ids، title، value
- Default: ids|title
- pwpcontinue
When more results are available, use this to continue.
- pwplimit
The maximum number of pages to return.
- Type: integer or max
- The value must be between 1 and 500.
- Default: 10
- pwpdir
In which direction to sort.
- One of the following values: ascending، descending
- Default: ascending
Examples:
- List the first 10 pages using
{{DISPLAYTITLE:}}. - api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value [open in sandbox]
- Get additional information about the first 10 pages using
__NOTOC__. - api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info [open in sandbox]