Home, MediaWiki Frontend API, JSDoc
MediaWiki Frontend API
This documentation describes the public API that user scripts, gadgets, skins, and extensions can use to interact with
MediaWiki
To interact with MediaWiki from outside a wiki, use the
Action API
The MediaWiki frontend API consists of
global variables
and
ResourceLoader modules
Get started
Write your first user script
Develop
extensions
and
skins
Explore the documentation
Browse namespaces and classes within the
MediaWiki base library
Manage dependencies
Load modules and scripts to use in your code.
mw.loader
Access wiki configuration
Get information about wikis, pages, and users. See the complete
list of configuration values
mw.config
Use the API
Interact with a wiki's API to query pages, edit pages, perform patrolling actions, and more.
mw.Api
— The
Action API
is a full-featured API that includes a complete set of actions and parameters. To try it out, visit
Special:ApiSandbox
on any wiki.
mw.Rest
— The
REST API
is a simplified API for performing basic read and write operations.
Integrate with wiki features
Hooks let you register and fire events that you can use to extend and enhance the behavior of MediaWiki.
mw.hook
global events
Format and parse system messages
Handle translatable text or HTML strings that are part of the MediaWiki interface.
mw.message
mw.language
Send notifications
Display pop-up notifications to users.
mw.notification
Interact with users
Get information about users, sessions, and user preferences.
mw.user
Interact with pages
Construct and parse page elements.
mw.Title
mw.Uri
Utilities
Get helpful methods for handling URLs, CSS, regular expressions, and more.
mw.util
Debugging and error reporting
Log errors, send deprecation warnings, and debug your code.
mw.Debug
mw.errorLogger
mw.log
Upstream
OOjs
— JavaScript library for working with objects
OOUI
— component-based JavaScript UI library
Contribute
Report a bug
using
Wikimedia Phabricator
JSDoc WMF theme
MediaWiki core