Open main menu

MediaWiki β

Translate this page; This page contains changes which are not marked for translation.

Other languages:
العربية • ‎български • ‎català • ‎čeština • ‎dansk • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎galego • ‎עברית • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎سنڌي • ‎සිංහල • ‎тоҷикӣ • ‎ไทย • ‎Türkçe • ‎Tiếng Việt • ‎粵語 • ‎中文
Crystal Clear app display.png UsersUser hub Nuvola-inspired-terminal.svg System AdministratorsSysadmin hub Source code project 1171.svg DevelopersDeveloper hub

This is a high-level overview of MediaWiki development, including links to the key documents, resources and tools available to MediaWiki developers. It is written for skilled LAMP developers who have experience using MediaWiki.

  • If you want to use Wikimedia web APIs, visit Web APIs hub (work in progress).
  • If you want to contribute to developing Wikimedia software, see New Developers.
  • For an introductory guide to developing MediaWiki and MediaWiki extensions, read how to become a MediaWiki hacker.
  • If you want to collaborate with other third-party MediaWiki users, the MediaWiki Stakeholders' Group (MWStake) is a MediaWiki user group consisting of MediaWiki developers, system administrators, users, consultants, and hosting providers.

Contents

Overview

MediaWiki is the software that powers Wikipedia, its sister projects and thousands of wikis all over the world.

MediaWiki is written in the PHP programming language[1]. It uses jQuery as the client JavaScript library.

MediaWiki is primarily written for the LAMP platform[2] and runs on most operating systems. MediaWiki primarily uses the MySQL and MariaDB database servers.[3]

Development happens in an open source style[4], is largely coordinated online, and supported by the Wikimedia Foundation, though volunteer community developers play a huge part as well.

Key documents

Code, development and style


Debugging and testing


Architecture

Sub-systems

  • API – MediaWiki's API provides direct, high-level access to the data contained in the MediaWiki databases.
  • ContentHandler – MediaWiki's framework for supporting custom types of page content.
  • Database accessManual:Database access – an overview of using databases in MediaWiki, including a brief guide to the database abstraction layer.
  • Job queueManual:Job queue – MediaWiki's framework for processing long-running tasks asynchronously.
  • Messages APIManual:Messages API – MediaWiki's framework for providing localized application messages with PHP or JavaScript.

Extending MediaWiki

MediaWiki has been designed to allow for modification without changing the "core code". This makes it easy to update to a new version of MediaWiki without having to manually merge in old extension code changes. There are six main extension points that allow developers to change or extend what MediaWiki can do. The extension points are:

  • API – access the data and metadata of MediaWiki instances through its web API.
  • Hooks – every time a given event happens, do something.
  • Parser Functions – create a new command like: {{#if:...|...|...}}.
  • Skins – change the look and feel of MediaWiki.
  • Special Pages – add a new special page.
  • Tag Extensions – create a new tag like: <newtag>...</newtag>.
  • Extending wiki markup – add a parser hook to modify the content of wikitext.

Help for extension developers

Help for skin developers

Help for library code reuse

Third-party wiki uses

Notes

  1. Not all of MediaWiki is written in PHP. Some supporting tools are written in other languages, including batch files, shell scripts, makefiles and Python.
  2. MediaWiki runs on most platforms that can support PHP, however, the lack of certain utilities or operating system features may limit the functionality or performance of MediaWiki on non-LAMP platforms.
  3. MediaWiki has support for DBMS other than MySQL and MariaDB, including Oracle, PostgreSQL, SQLite, and Microsoft SQL Server.
  4. Developers are a mix of volunteers and paid staff (or contractors) for various organizations. For a full list of who works on the MediaWiki code, read the DevelopersDevelopers article.
  5. Browse the source code and revisions of code repositories at https://phabricator.wikimedia.org/diffusion/ or download the source code to your system by using Gerrit.