API:Parameter information

From MediaWiki.org
Jump to: navigation, search
Translate this page; This page contains changes which are not marked for translation.

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎français • ‎Հայերեն • ‎日本語 • ‎Nederlands • ‎polski • ‎português • ‎română • ‎русский • ‎sicilianu • ‎سنڌي • ‎中文
This page is part of the MediaWiki action API documentation.

MediaWiki action API

v · d · e

Obtaining parameter information[edit]

You can obtain information about modules and their parameters through action=paraminfo.

Parameters[edit]

  • modules: A list of top-level module names (value of the action parameter) or submodules such as query+siteprop.
  • helpformat: Format of help strings. Possible values: html, wikitext, raw, none. (Default: none) 1.25+
  • querymodules: A list of query module names (value of the prop, meta or list parameter). Use modules=query+module instead. (Deprecated in 1.25)
  • mainmodule: Get information about the main (top-level) module as well. Use modules=main instead. Type: bool 1.15+ (Deprecated in 1.25)
  • pagesetmodule: Get information about the pageset module (providing titles and friends) as well. Use modules=query instead. Type: bool 1.15+ (Deprecated in 1.25)
  • formatmodules: List of format module names (value of format parameter). Use modules=format instead. Possible values: see Data formats. 1.19+ (Deprecated in 1.25)

Example[edit]

Getting information about action=parseAPI:Expanding_templates_and_rendering#parse, prop=infoAPI:Info query submodule, and a bogus query module:




action=paraminfo

(main | paraminfo)

Obtain information about API modules.

Parameters:
modules

List of module names (values of the action and format parameters, or main). Can specify submodules with a +, or all submodules with +*, or all submodules recursively with +**.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
helpformat

Format of help strings.

One of the following values: html, wikitext, raw, none
Default: none
querymodules
Deprecated.

List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.

Values (separate with | or alternative): abusefilters, abuselog, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, allrevisions, alltransclusions, allusers, authmanagerinfo, babel, backlinks, betafeatures, blocks, categories, categoryinfo, categorymembers, centralnoticelogs, checkuser, checkuserlog, codecomments, codepaths, coderevisions, codetags, contributors, deletedrevisions, deletedrevs, duplicatefiles, embeddedin, extdistbranches, extdistrepos, extlinks, extracts, exturlusage, featureusage, filearchive, filerepoinfo, fileusage, flowinfo, gadgetcategories, gadgets, globalallusers, globalblocks, globalgroups, globalusage, globaluserinfo, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, languagestats, links, linkshere, linterrors, linterstats, logevents, mapdata, messagecollection, messagegroups, messagegroupstats, messagetranslations, mmsites, mostviewed, mystashedfiles, notifications, oath, pageimages, pagepropnames, pageprops, pageswithprop, pageterms, pageviews, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, references, revisions, search, siteinfo, siteviews, stashimageinfo, tags, templates, threads, tokens, transcludedin, transcodestatus, unreadnotificationpages, usercontribs, userinfo, users, videoinfo, watchlist, watchlistraw, wbentityusage, wblistentityusage, wikibase, wikisets
Maximum number of values is 50 (500 for bots).
mainmodule
Deprecated.

Get information about the main (top-level) module as well. Use modules=main instead.

pagesetmodule
Deprecated.

Get information about the pageset module (providing titles= and friends) as well.

formatmodules
Deprecated.

List of format module names (value of format parameter). Use modules instead.

Values (separate with | or alternative): json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm

Possible errors[edit]

None.