API:Extensions

This page is part of the MediaWiki API documentation.

Language:	English  • Deutsch

MediaWiki API

Quick overview:

• Quick start guide
• FAQ
• Formats
• Error reporting
• Restricting usage
• Authentication
  • Login
  • Logout
• Queries
  • Meta information
  • Properties
  • Lists
• Search suggestions
• Expanding templates and rendering
• Purging pages' caches
• Parameter information
• Changing wiki content
  • Create and edit pages
  • Move pages
  • Rollback
  • Delete pages
  • Restore deleted revisions
  • (Un)protect pages
  • (Un)block users
  • (Un)watch pages
  • Send e-mail
  • Patrol changes
  • Import pages
  • Change user group membership
  • Upload files
• Watchlist feed
• Extensions
• Using the API in MediaWiki and extensions
• Miscellaneous
• Implementation
• Client code

Creating API modules in extensions

Extensions can also add API modules. Create a new class that inherits ApiBase (for a top-level module), ApiQueryBase (for a non-generator submodule of action=query) or ApiQueryGeneratorBase (for a submodule of action=query with generator functionality) and implement the methods execute(), getAllowedParams(), getParamDescription(), getDescription() and getVersion(). Generator modules also need to implement executeGenerator().

When you've created your new class, you need to register it with the API by adding it to $wgAPIModules (top-level modules, selected using action=), $wgAPIPropModules (prop= modules), $wgAPIMetaModules (meta= modules) or $wgAPIListModules (list= modules), like this:

 // Register the ApiMyExt class as handler for action=myext
$wgAPIModules['myext'] = 'ApiMyExt';

It's possible to override core modules.

Extending core modules

Since MediaWiki 1.14, it's possible to extend core modules' functionality using the following hooks:

• APIGetAllowedParams to add or modify the module's parameter list
• APIGetParamDescription to add or modify the module's parameter descriptions
• APIAfterExecute to do something after the module has been executed (but before the result has been output)
  • Use APIQueryAfterExecute for prop=, list= and meta= modules
    • If the module is run in generator mode, APIQueryGeneratorAfterExecute will be called instead

List of extensions with API functionality

See API extensions for examples of extensions that add or extend to the API.