Extension:ShoutWiki API

From mediawiki.org
MediaWiki extensions manual
ShoutWiki API
Release status: beta
Implementation API
Description A collection of ShoutWiki-specific API modules
Author(s) Jack Phoenix
Latest version 0.7.0
MediaWiki >= 1.35.0
License Creative Commons Zero v1.0 Universal
Example ShoutWiki
Translate the ShoutWiki API extension if it is available at translatewiki.net

ShoutWiki API extension is a collection of ShoutWiki-specific API modules; it currently consists of only one module, "listwikis".


Warning Warning: This extension won't work on a vanilla MediaWiki install since it depends on ShoutWiki-specific code bits.
  • Download and move the extracted ShoutWikiAPI folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ShoutWikiAPI
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'ShoutWikiAPI' );
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.



  • api.php?action=query&list=listwikis — get a list of all wikis (in practise it gets the list in groups of 100 wikis per group)
  • api.php?action=query&list=listwikis&swdeleted=1 — also show deleted wikis
  • api.php?action=query&list=listwikis&swwid=177 — show only information about the wiki with the ID number 177
  • api.php?action=query&list=listwikis&swfrom=100&swto=150 — show the wikis with IDs from 100 to 150
  • api.php?action=query&list=listwikis&swfrom=10000&swto=15000&swlang=de — show the German (language code de) wikis that have an ID number between 10000 and 15000
  • api.php?action=query&list=listwikis&swcountonly=1 — show only the amount of wikis and nothing else (equivalent to the SQL query SELECT COUNT(*) FROM wiki_list WHERE wl_deleted = 0;)
  • api.php?action=query&list=listwikis&swdeleted=1&swcountonly=1 — show total amount of wikis, including deleted ones, and nothing else (equivalent to the SQL query SELECT COUNT(*) FROM wiki_list;)