MediaWiki  1.23.12
api.php File Reference

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

Go to the source code of this file.


 $endtime = microtime( true )
if( $wgAPIRequestLog) $lb = wfGetLBFactory()
 $processor = new ApiMain( RequestContext::getMain(), $wgEnableWriteAPI )
 $starttime = microtime( true )
if(! $wgRequest->checkUrlExtension()) if(! $wgEnableAPI) $wgTitle = Title::makeTitle( NS_MAIN, 'API' )
 if (!function_exists('version_compare')||version_compare(phpversion(), '5.3.2')< 0)
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

$endtime = microtime( true )

Definition at line 96 of file api.php.

◆ $lb

◆ $processor

$processor = new ApiMain( RequestContext::getMain(), $wgEnableWriteAPI )

Definition at line 69 of file api.php.

◆ $starttime

$starttime = microtime( true )

Definition at line 46 of file api.php.

Referenced by EditPageTest\testAutoMerge().

◆ $wgTitle

◆ if

Initial value:
print "Can't create file\n"

Definition at line 37 of file api.php.

Referenced by TitleValue\__toString(), DatabaseLogEntry\getPerformer(), RCDatabaseLogEntry\getPerformer(), JSMinPlus\parseTree(), and RevisionStorageTest\setUp().


const MW_API true

Definition at line 34 of file api.php.

◆ try

Initial value:
wfRunHooks( 'ApiBeforeMain', array( &$processor ) )

Definition at line 72 of file api.php.

Definition: api.php:69
wfRunHooks( $event, array $args=array(), $deprecatedVersion=null)
Call hook functions defined in $wgHooks.
Definition: GlobalFunctions.php:4058
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.