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=gadgets (ga)
- This module requires read rights.
- Source: Gadgets
- Licence: GPL-2.0-or-later
Returns a list of gadgets used on this wiki.
Parameters:
- gaprop
What gadget information to get:
- id
- Internal gadget ID.
- metadata
- The gadget metadata.
- desc
- Gadget description transformed into HTML (can be slow, use only if really needed).
- Values (separate with | or alternative): desc, id, metadata
- Default: id|metadata
- gacategories
Gadgets from what categories to retrieve.
- Separate values with |.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- gaids
IDs of gadgets to retrieve.
- Separate values with |.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- gaallowedonly
List only gadgets allowed to current user.
- Type: boolean (details)
- gaenabledonly
List only gadgets enabled by current user.
- Type: boolean (details)
Examples:
- Get a list of gadgets along with their descriptions
- api.php?action=query&list=gadgets&gaprop=id|desc [open in sandbox]
- Get a list of gadgets with all possible properties
- api.php?action=query&list=gadgets&gaprop=id|metadata|desc [open in sandbox]
- Get a list of gadgets belonging to category "foo"
- api.php?action=query&list=gadgets&gacategories=foo [open in sandbox]
- Get information about gadgets "foo" and "bar"
- api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata [open in sandbox]
- Get a list of gadgets enabled by current user
- api.php?action=query&list=gadgets&gaenabledonly [open in sandbox]