FANDOM


This page describes key files and directories in the MediaWiki source code. For more detailed information, see the class, file and comprehensive references auto-generated from the MediaWiki source code using doxygen



Access points Edit

See also: Special:Version#Entry point URLs

Bulbgraph Note: This list can be generated automatically by running: git grep -l /includes/WebStart.php.[AP 1][AP 2]



These are the files that a browser may reach when using the wiki. All of them are located in the root directory of the wiki, and each of them is paired with a .php5 wrapper, for web servers that require the .php5 extension to execute scripts with the PHP5 engine.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



  1. Except thumb_handler.php, which is a simple wrapper around thumb.php and thus does not have to re-include WebStart.php
  2. That command also returns mw-config/index.php, but unlike the other files, it is not intended for repeated use during normal wiki operation; in other words, it is not an access point to reach wiki resources, but a one-off script to launch the configuration process of a newly installed wiki.



/cache/ Edit

Default location for the file cache, if enabled (by setting $wgUseFileCache = true; — the default is false.). This location can be customized using $wgFileCacheDirectory.



/docs/ Edit

Contains various text files that should help you understand the most important parts of the code of MediaWiki.



/extensions/ Edit

Mediawiki extensions are distributed separately from the core code.

Installing an extension entails copying its files into this directory, and enabling it by following the extension's own installation instructions (usually editing the LocalSettings.php file).

In current versions a set of several extensions is distributed with a fresh MediaWiki install.



/includes/ Edit

This directory stores common include files needed by MediaWiki.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/actions/ Edit

This directory contains the Action classes, which handle the different actions which can be performed on pages (e.g. view, delete, edit, etc.). All these classes extend the Action, FormlessAction or FormAction classes. Some of them are just stubs which call methods in the Article or EditPage classes to do the actual work.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/api/ Edit

This directory contains the code for the MediaWiki API. See API:Main page. The most important files are:



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/cache/ Edit

This directory contains files with code relating to MediaWiki's caching mechanisms.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/context/ Edit

This directory contains a few classes related to (request) contexts. As of MediaWiki 1.18 the context of a request is encapsulated inside a RequestContext instance which implements IContextSource. A context is a way of grouping the parts of a request together. This reduces the need for globals. See Manual:RequestContext for more information.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/db/ Edit

This directory contains the code for database support. Database.php provides MediaWiki's database abstraction layer.



/includes/diff/ Edit

This directory contains the standard MediaWiki difference engine. A difference engine computes the difference between two texts. Whether this difference engine is used or some external diff tool, depends on the $wgExternalDiffEngine setting.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/job/ Edit

Files related to the job queue. Each job class for a specific type of job derives from the Job class and has to implement a run() method which does the actual job.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/logging/ Edit

Some files related to logging the events which happen on a Wiki. This directory was introduced in MW 1.19. Some of the files were already present in olders versions, in the includes/ directory.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/media/ Edit

This directory contains files for handling several media formats, mostly images.



/includes/normal/ Edit

This directory contains some Unicode normalization routines. See includes/normal/README for more information.



/includes/objectcache/ Edit

Files related to MediaWiki's caching mechanisms. The files in this directory provide the possibility to store objects in PHP accelerators, in memcached, in a database or in DBA files.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/parser/ Edit

The MediaWiki parser, which transforms wikitext to HTML, can be found here together with related files. The most interesting files in this directory:



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/resourceloader/ Edit

Files related to ResourceLoader, a JavaScript/CSS delivery optimizing system for MediaWiki.



/includes/search/ Edit

This directory contains the code to implement the possibility of searching a wiki using one the possible backends.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/includes/specials/ Edit

This directory contains the code and classes for the standard special pages. All special page classes derive from class SpecialPage (defined in includes/SpecialPage.php). Special pages which come with extension are located in their respective extensions directories. See also Manual:Special pages.



/includes/upload/ Edit

Files providing the backend of MediaWiki's file upload feature.



File Description Wiki docs

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry

Manual:Code/Entry



/images/ Edit

If uploads are enabled in the wiki, files will be put in subdirectories under this directory. See Manual:Image administration#Folders for more details.



/languages/ Edit

This directory contains files used for localization and internationalization. For a quick overview, see Language in MediaWiki.



Manual:Code/Entry
File Description Wiki docs



/maintenance/ Edit

This directory contains maintenance scripts that must be run from a command line interface.



See Manual:Maintenance scripts for an overview of those scripts.



/mw-config/ Edit

Entry point for the Config script (the helper script that helps setting up a newly installed wiki). The actual code of the installer is located at /includes/installer/.



/resources/ Edit

This directory contains JavaScript and CSS resources used by MediaWiki, including jQuery



/serialized/ Edit

Location for serialized objects (database entries converted into files -- see Serialization for more information). The database tables that contain serialized data are listed at Manual:Serialization.



/skins/ Edit

This directory contain all skins classes, JavaScripts, CSS and some images used by that skins. See Manual:Skins.



/tests/ Edit

Contains various (unit)test related files, including:



Language: English

 

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.