MediaWiki  REL1_31
api.php File Reference

This file is the entry point for all API queries. More...

Go to the source code of this file.


if(! $processor instanceof ApiMain) catch(Exception $e) if( $processor) $endtime = microtime( true )
if( $wgAPIRequestLog) $mediawiki = new MediaWiki()
 $starttime = microtime( true )
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') if(! $wgEnableAPI) $wgTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/dummy title for API calls set in api.php' )
const MW_API true

Detailed Description

This file is the entry point for all API queries.

It begins by checking whether the API is enabled on this wiki; if not, it informs the user that s/he should set $wgEnableAPI to true and exits. Otherwise, it constructs a new ApiMain using the parameter passed to it as an argument in the URL ('?action=') and with write-enabled set to the value of $wgEnableWriteAPI as specified in LocalSettings.php. It then invokes "execute()" on the ApiMain object instance, which produces output in the format specified in the URL.

Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Definition in file api.php.

Variable Documentation

◆ $endtime

if (! $processor instanceof ApiMain) catch (Exception $e) if ($processor) $endtime = microtime( true )

Definition at line 98 of file api.php.

◆ $mediawiki

if ($wgAPIRequestLog) $mediawiki = new MediaWiki()

Definition at line 128 of file api.php.

◆ $starttime

◆ $wgTitle


const MW_API true

Definition at line 36 of file api.php.

◆ try

Initial value:

Definition at line 74 of file api.php.

This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
Allow the API to be used to perform write operations (page edits, rollback, etc.) when an authorised ...
Definition: DefaultSettings.php:8046