48 $this->mParams[
'async'] = ( $this->mParams[
'async'] &&
49 $this->
getConfig()->get(
'EnableAsyncUploads' ) );
51 $this->mParams[
'file'] =
$request->getFileName(
'file' );
52 $this->mParams[
'chunk'] =
$request->getFileName(
'chunk' );
55 if ( !$this->mParams[
'filekey'] && $this->mParams[
'sessionkey'] ) {
56 $this->mParams[
'filekey'] = $this->mParams[
'sessionkey'];
63 } elseif ( !isset( $this->mUpload ) ) {
64 $this->
dieDebug( __METHOD__,
'No upload module set' );
75 $status = $this->mUpload->fetchFile();
81 if ( $this->mParams[
'chunk'] ) {
83 if ( $this->mParams[
'filesize'] > $maxSize ) {
86 if ( !$this->mUpload->getTitle() ) {
89 } elseif ( $this->mParams[
'async'] && $this->mParams[
'filekey'] ) {
92 wfDebug( __METHOD__ .
" about to verify\n" );
99 if ( !$this->mParams[
'stash'] ) {
100 $permErrors = $this->mUpload->verifyTitlePermissions(
$user );
101 if ( $permErrors !==
true ) {
116 if (
$result[
'result'] ===
'Success' ) {
117 $imageinfo = $this->mUpload->getImageInfo( $this->
getResult() );
122 $this->mUpload->cleanupTempFile();
131 if ( $warnings && !$this->mParams[
'ignorewarnings'] ) {
134 } elseif ( $this->mParams[
'chunk'] ) {
137 } elseif ( $this->mParams[
'stash'] ) {
161 if ( $warnings && count( $warnings ) > 0 ) {
162 $result[
'warnings'] = $warnings;
179 $result[
'warnings'] = $warnings;
195 if ( $warnings && count( $warnings ) > 0 ) {
196 $result[
'warnings'] = $warnings;
200 $chunkPath =
$request->getFileTempname(
'chunk' );
201 $chunkSize =
$request->getUpload(
'chunk' )->getSize();
202 $totalSoFar = $this->mParams[
'offset'] + $chunkSize;
203 $minChunkSize = $this->
getConfig()->get(
'MinUploadChunkSize' );
206 if ( $totalSoFar > $this->mParams[
'filesize'] ) {
211 if ( $totalSoFar != $this->mParams[
'filesize'] && $chunkSize < $minChunkSize ) {
212 $this->
dieWithError( [
'apierror-chunk-too-small', Message::numParam( $minChunkSize ) ] );
215 if ( $this->mParams[
'offset'] == 0 ) {
218 $filekey = $this->mParams[
'filekey'];
224 $this->
dieWithError(
'apierror-stashfailed-nosession',
'stashfailed' );
225 } elseif ( $progress[
'result'] !==
'Continue' || $progress[
'stage'] !==
'uploading' ) {
226 $this->
dieWithError(
'apierror-stashfailed-complete',
'stashfailed' );
229 $status = $this->mUpload->addChunk(
230 $chunkPath, $chunkSize, $this->mParams[
'offset'] );
233 'offset' => $this->mUpload->getOffset(),
241 if ( $totalSoFar == $this->mParams[
'filesize'] ) {
242 if ( $this->mParams[
'async'] ) {
246 [
'result' =>
'Poll',
247 'stage' =>
'queued',
'status' => Status::newGood() ]
250 Title::makeTitle(
NS_FILE, $filekey ),
252 'filename' => $this->mParams[
'filename'],
253 'filekey' => $filekey,
260 $status = $this->mUpload->concatenateChunks();
265 [
'result' =>
'Failure',
'stage' =>
'assembling',
'status' =>
$status ]
273 $result[
'warnings'] = $warnings;
279 $this->mUpload->stash->removeFile( $filekey );
280 $filekey = $this->mUpload->getStashFile()->getFileKey();
289 'result' =>
'Continue',
290 'stage' =>
'uploading',
291 'offset' => $totalSoFar,
292 'status' => Status::newGood(),
295 $result[
'result'] =
'Continue';
296 $result[
'offset'] = $totalSoFar;
317 $isPartial = (bool)$this->mParams[
'chunk'];
319 $status = $this->mUpload->tryStashFile( $this->
getUser(), $isPartial );
325 }
catch ( Exception
$e ) {
326 $debugMessage =
'Stashing temporary file failed: ' . get_class(
$e ) .
' ' .
$e->getMessage();
327 wfDebug( __METHOD__ .
' ' . $debugMessage .
"\n" );
329 $e, [
'wrap' =>
new ApiMessage(
'apierror-stashexception',
'stashfailed' ) ]
334 $stashFile =
$status->getValue();
335 $data[
'filekey'] = $stashFile->getFileKey();
337 $data[
'sessionkey'] = $data[
'filekey'];
338 return $data[
'filekey'];
341 if (
$status->getMessage()->getKey() ===
'uploadstash-exception' ) {
344 list( $exceptionType, $message ) =
$status->getMessage()->getParams();
345 $debugMessage =
'Stashing temporary file failed: ' . $exceptionType .
' ' . $message;
346 wfDebug( __METHOD__ .
' ' . $debugMessage .
"\n" );
350 if ( $failureMode !==
'optional' ) {
371 $data[
'invalidparameter'] = $parameter;
374 $sv = StatusValue::newGood();
375 foreach ( $errors
as $error ) {
377 $msg->setApiData( $msg->getApiData() + $data );
393 $sv = StatusValue::newGood();
394 foreach (
$status->getErrors()
as $error ) {
396 if ( $moreExtraData ) {
397 $msg->setApiData( $msg->getApiData() + $moreExtraData );
415 if ( !$this->mParams[
'chunk'] ) {
417 'filekey',
'file',
'url' );
421 if ( $this->mParams[
'filekey'] && $this->mParams[
'checkstatus'] ) {
424 $this->
dieWithError(
'api-upload-missingresult',
'missingresult' );
425 } elseif ( !$progress[
'status']->isGood() ) {
428 if ( isset( $progress[
'status']->value[
'verification'] ) ) {
431 if ( isset( $progress[
'status']->value[
'warnings'] ) ) {
434 $progress[
'warnings'] = $warnings;
437 unset( $progress[
'status'] );
439 if ( isset( $progress[
'imageinfo'] ) ) {
440 $imageinfo = $progress[
'imageinfo'];
441 unset( $progress[
'imageinfo'] );
455 if ( is_null( $this->mParams[
'filename'] ) ) {
456 $this->
dieWithError( [
'apierror-missingparam',
'filename' ] );
459 if ( $this->mParams[
'chunk'] ) {
462 if ( isset( $this->mParams[
'filekey'] ) ) {
463 if ( $this->mParams[
'offset'] === 0 ) {
464 $this->
dieWithError(
'apierror-upload-filekeynotallowed',
'filekeynotallowed' );
468 $this->mUpload->continueChunks(
469 $this->mParams[
'filename'],
470 $this->mParams[
'filekey'],
474 if ( $this->mParams[
'offset'] !== 0 ) {
475 $this->
dieWithError(
'apierror-upload-filekeyneeded',
'filekeyneeded' );
479 $this->mUpload->initialize(
480 $this->mParams[
'filename'],
484 } elseif ( isset( $this->mParams[
'filekey'] ) ) {
493 $this->mUpload->initialize(
494 $this->mParams[
'filekey'], $this->mParams[
'filename'], !$this->mParams[
'async']
496 } elseif ( isset( $this->mParams[
'file'] ) ) {
500 if ( $this->mParams[
'async'] ) {
501 $this->
dieWithError(
'apierror-cannot-async-upload-file' );
505 $this->mUpload->initialize(
506 $this->mParams[
'filename'],
509 } elseif ( isset( $this->mParams[
'url'] ) ) {
524 $this->mUpload->
initialize( $this->mParams[
'filename'],
525 $this->mParams[
'url'] );
538 $permission = $this->mUpload->isAllowed(
$user );
540 if ( $permission !==
true ) {
541 if ( !
$user->isLoggedIn() ) {
542 $this->
dieWithError( [
'apierror-mustbeloggedin', $this->
msg(
'action-upload' ) ] );
545 $this->
dieStatus( User::newFatalPermissionDeniedStatus( $permission ) );
549 if (
$user->isBlocked() ) {
554 if (
$user->isBlockedGlobally() ) {
563 $verification = $this->mUpload->verifyUpload();
576 switch ( $verification[
'status'] ) {
584 'illegal-filename',
null, [
'filename' => $verification[
'filtered'] ]
608 'filetype' => $verification[
'finalExt'],
609 'allowed' => array_values( array_unique( $this->
getConfig()->
get(
'FileExtensions' ) ) )
611 $extensions = array_unique( $this->
getConfig()->
get(
'FileExtensions' ) );
613 'filetype-banned-type',
615 Message::listParam( $extensions,
'comma' ),
616 count( $extensions ),
621 if ( isset( $verification[
'blacklistedExt'] ) ) {
622 $msg[1] = Message::listParam( $verification[
'blacklistedExt'],
'comma' );
623 $msg[4] = count( $verification[
'blacklistedExt'] );
624 $extradata[
'blacklisted'] = array_values( $verification[
'blacklistedExt'] );
627 $msg[1] = $verification[
'finalExt'];
631 $this->
dieWithError( $msg,
'filetype-banned', $extradata );
637 $details = array_merge( [ $msg->getKey() ], $msg->getParams() );
639 $details = $verification[
'details'];
642 $msg->setApiData( $msg->getApiData() + [
'details' => $details ] );
647 $msg = $verification[
'error'] ===
'' ?
'hookaborted' : $verification[
'error'];
648 $this->
dieWithError( $msg,
'hookaborted', [
'details' => $verification[
'error'] ] );
651 $this->
dieWithError(
'apierror-unknownerror-nocode',
'unknown-error',
652 [
'details' => [
'code' => $verification[
'status'] ] ] );
665 $warnings = $this->mUpload->checkWarnings();
675 if ( isset( $warnings[
'duplicate'] ) ) {
678 foreach ( $warnings[
'duplicate']
as $dupe ) {
679 $dupes[] = $dupe->getName();
682 $warnings[
'duplicate'] = $dupes;
685 if ( isset( $warnings[
'exists'] ) ) {
686 $warning = $warnings[
'exists'];
687 unset( $warnings[
'exists'] );
689 $localFile = isset( $warning[
'normalizedFile'] )
690 ? $warning[
'normalizedFile']
692 $warnings[$warning[
'warning']] = $localFile->getName();
695 if ( isset( $warnings[
'no-change'] ) ) {
697 $file = $warnings[
'no-change'];
698 unset( $warnings[
'no-change'] );
700 $warnings[
'nochange'] = [
701 'timestamp' =>
wfTimestamp( TS_ISO_8601, $file->getTimestamp() )
705 if ( isset( $warnings[
'duplicate-version'] ) ) {
708 foreach ( $warnings[
'duplicate-version']
as $dupe ) {
710 'timestamp' =>
wfTimestamp( TS_ISO_8601, $dupe->getTimestamp() )
713 unset( $warnings[
'duplicate-version'] );
716 $warnings[
'duplicateversions'] = $dupes;
730 switch ( get_class(
$e ) ) {
731 case 'UploadStashFileNotFoundException':
732 $wrap =
'apierror-stashedfilenotfound';
734 case 'UploadStashBadPathException':
735 $wrap =
'apierror-stashpathinvalid';
737 case 'UploadStashFileException':
738 $wrap =
'apierror-stashfilestorage';
740 case 'UploadStashZeroLengthFileException':
741 $wrap =
'apierror-stashzerolength';
743 case 'UploadStashNotLoggedInException':
745 [
'apierror-mustbeloggedin', $this->
msg(
'action-upload' ) ],
'stashnotloggedin'
747 case 'UploadStashWrongOwnerException':
748 $wrap =
'apierror-stashwrongowner';
750 case 'UploadStashNoSuchKeyException':
751 $wrap =
'apierror-stashnosuchfilekey';
754 $wrap = [
'uploadstash-exception', get_class(
$e ) ];
757 return StatusValue::newFatal(
771 if ( is_null( $this->mParams[
'text'] ) ) {
772 $this->mParams[
'text'] = $this->mParams[
'comment'];
776 $file = $this->mUpload->getLocalFile();
784 $this->mParams[
'watchlist'], $file->getTitle(),
'watchdefault'
787 if ( !$watch && $this->mParams[
'watchlist'] ==
'preferences' && !$file->exists() ) {
795 if ( $this->mParams[
'watch'] ) {
799 if ( $this->mParams[
'tags'] ) {
807 if ( $this->mParams[
'async'] ) {
809 if ( $progress && $progress[
'result'] ===
'Poll' ) {
810 $this->
dieWithError(
'apierror-upload-inprogress',
'publishfailed' );
814 $this->mParams[
'filekey'],
815 [
'result' =>
'Poll',
'stage' =>
'queued',
'status' => Status::newGood() ]
818 Title::makeTitle(
NS_FILE, $this->mParams[
'filename'] ),
820 'filename' => $this->mParams[
'filename'],
821 'filekey' => $this->mParams[
'filekey'],
822 'comment' => $this->mParams[
'comment'],
823 'tags' => $this->mParams[
'tags'],
824 'text' => $this->mParams[
'text'],
833 $status = $this->mUpload->performUpload( $this->mParams[
'comment'],
834 $this->mParams[
'text'], $watch, $this->
getUser(), $this->mParams[
'tags'] );
842 $result[
'filename'] = $file->getName();
843 if ( $warnings && count( $warnings ) > 0 ) {
844 $result[
'warnings'] = $warnings;
885 'ignorewarnings' =>
false,
910 'checkstatus' =>
false,
922 'action=upload&filename=Wiki.png' .
923 '&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC'
924 =>
'apihelp-upload-example-url',
925 'action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC'
926 =>
'apihelp-upload-example-filekey',
931 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Upload';
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
This abstract class implements many basic API functions, and is the base of all API classes.
const PARAM_DEPRECATED
(boolean) Is the parameter deprecated (will show a warning)?
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
getMain()
Get the main module.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
getErrorFormatter()
Get the error formatter.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
getResult()
Get the result object.
getWatchlistValue( $watchlist, $titleObj, $userOption=null)
Return true if we're to watch the page, false if not, null if no change.
getModuleName()
Get the name of the module being executed by this instance.
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
dieBlocked(Block $block)
Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die wit...
requireOnlyOneParameter( $params, $required)
Die if none or more than one of a certain set of parameters is set and not false.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Extension of Message implementing IApiMessage.
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
performStash( $failureMode, &$data=null)
Stash the file and add the file key, or error information if it fails, to the data.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
checkPermissions( $user)
Checks that the user has permissions to perform this upload.
dieRecoverableError( $errors, $parameter=null)
Throw an error that the user can recover from by providing a better value for $parameter.
verifyUpload()
Performs file verification, dies on error.
UploadBase UploadFromChunks $mUpload
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
transformWarnings( $warnings)
handleStashException( $e)
Handles a stash exception, giving a useful error to the user.
getHelpUrls()
Return links to more detailed help pages about the module.
dieStatusWithCode( $status, $overrideCode, $moreExtraData=null)
Like dieStatus(), but always uses $overrideCode for the error code, unless the code comes from IApiMe...
isWriteMode()
Indicates whether this module requires write mode.
getWarningsResult( $warnings)
Get Warnings Result.
getContextResult()
Get an upload result based on upload context.
getChunkResult( $warnings)
Get the result of a chunk upload.
getExamplesMessages()
Returns usage examples for this module.
selectUploadModule()
Select an upload module and set it to mUpload.
getStashResult( $warnings)
Get Stash Result, throws an exception if the file could not be stashed.
needsToken()
Returns the token type this module requires in order to execute.
performUpload( $warnings)
Perform the actual upload.
checkVerification(array $verification)
Performs file verification, dies on error.
mustBePosted()
Indicates whether this module must be called with a POST request.
getApiWarnings()
Check warnings.
Assemble the segments of a chunked upload.
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
getUser()
Get the User object.
getConfig()
Get the Config object.
exportSession()
Export the resolved user IP, HTTP headers, user ID, and session ID.
getContext()
Get the base IContextSource object.
static singleton( $wiki=false)
Upload a file from the upload stash into the local file repo.
UploadBase and subclasses are the backend of MediaWiki's file uploads.
static getSessionStatus(User $user, $statusKey)
Get the current status of a chunked upload (used for polling)
static isEnabled()
Returns true if uploads are enabled.
const WINDOWS_NONASCII_FILENAME
static getMaxUploadSize( $forType=null)
Get the MediaWiki maximum uploaded file size for given type of upload, based on $wgMaxUploadSize.
static isThrottled( $user)
Returns true if the user has surpassed the upload rate limit, false otherwise.
const MIN_LENGTH_PARTNAME
static setSessionStatus(User $user, $statusKey, $value)
Set the current status of a chunked upload (used for polling)
Implements uploading from chunks.
Implements regular file uploads.
Implements uploading from previously stored file.
Implements uploading from a HTTP resource.
initialize( $name, $url)
Entry point for API upload.
static isAllowedHost( $url)
Checks whether the URL is for an allowed host The domains in the whitelist can include wildcard chara...
static isAllowedUrl( $url)
Checks whether the URL is not allowed.
static isEnabled()
Checks if the upload from URL feature is enabled.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
the array() calling protocol came about after MediaWiki 1.4rc1.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
returning false will NOT prevent logging $e
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php