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

action=collection

(main | collection)
  • This module is internal or unstable. Its operation may change without notice.
  • This module requires read rights.
  • Source: Collection
  • License: GPL-2.0-or-later

API module for performing various operations on a wiki user's collection.

Specific parameter:
Other general parameters are available.
submodule

Submodule for performing various operations on a wiki user's collection.

addarticle
API module for adding a page to the collection
addcategory
API module for adding pages from a given category to a user's collection.
addchapter
API module for adding a chapter to the collection
clearcollection
API module for clearing the collection and the suggestions
getbookcreatorboxcontent
API submodule for grabbing the box content of the user's book creator box special page.
getcollection
API module for listing the current pages in a collection
getpopupdata
API module to get data and HTML to construct a popup
postcollection
API module for posting pages to a user's collection
removearticle
API module for removing a page from the collection
removeitem
API module for removing an item from the collection index-wise via the Special:Book page.
renamechapter
API module for renaming a chapter in the user's collection
setsorting
API module for reordering items in a collection
settitles
API module for setting the collection's title, subtitle, and settings
sortitems
API module to sort pages in a collection alphabetically. Pages within chapters are grouped and sorted together.
suggestarticleaction
API module to interact with suggestions
suggestundoarticleaction
API module to undo actions done from suggestarticleaction
This parameter is required.
One of the following values: addarticle, addcategory, addchapter, clearcollection, getbookcreatorboxcontent, getcollection, getpopupdata, postcollection, removearticle, removeitem, renamechapter, setsorting, settitles, sortitems, suggestarticleaction, suggestundoarticleaction
Example:
Submodule for performing various operations on a wiki user's collection.
api.php?action=collection&submodule=getcollection [open in sandbox]