Manual:Index.php: Difference between revisions
Appearance
Content deleted Content added
Waldyrious (talk | contribs) normalize documentation around "access point" rather than "entry point" nomenclature (see mailarchive:wikitech-l/2013-March/067409.html) |
No edit summary |
||
Line 1: | Line 1: | ||
{{MW file|index.php}} |
{{MW file|index.php}} |
||
''' |
'''aIndex.php''' is the main access point for a MediaWiki site. The other main access point is [[Manual:api.php|api.php]] which handles requests for the MediaWiki [[API]]. |
||
== Actions taken== |
== Actions taken== |
Revision as of 14:30, 14 August 2014
MediaWiki file: index.php | |
---|---|
Location: | / |
Source code: | master • 1.42.3 • 1.41.4 • 1.39.10 |
Classes: | Find code • Find documentation |
aIndex.php is the main access point for a MediaWiki site. The other main access point is api.php which handles requests for the MediaWiki API.
Actions taken
Most requests result in the following actions in index.php
:
- First, it includes WebStart.php (SVN), which includes LocalSettings.php and Setup.php (SVN).
- Next it instantiates a MediaWiki object called $mediaWiki which is defined in Wiki.php.
- It then checks the maxlag parameter, which may cause the request to be rejected.
- It calls the function
MediaWiki::checkInitialQueries()
in Wiki.php, which creates a Title object depending of the title and action parameters from the URL. - If ajax is enabled and the
action
parameter is set toajax
, then an AjaxDispatcher object will be created to handle that request and the script will stop after that. - Otherwise some globals are stored in $mediaWiki to be used in the next steps.
- It calls
MediaWiki::initialize()
which does most of the work of the request. - Then
MediaWiki::finalCleanup()
is called. That function does the deferred updates, runs jobs from the queue depending on $wgJobRunRate and outputs the HTML by callingOutputPage::output()
. - Finally,
MediaWiki::restInPeace()
is called to log profiling data.
Version 1.18 and higher
As of MediaWiki version 1.18, some of the startup logic has been moved from index.php, and index.php performs the following actions:
- Check the version of PHP and if its not 5.2.3 or higher, display an error.
- Include WebStart.php (SVN), which in turn includes LocalSettings.php, Setup.php (SVN) and some other files.
- Instantiate a MediaWiki object called $mediaWiki, which is defined in Wiki.php.
- Call
$mediaWiki->run()
.