3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'PageContentSave',
14 'PageContentSaveComplete', 'ArticleDelete'.
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle( $article ) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ( $wgReverseTitle ) {
41 wfReverseTitle( $article );
44 if ( $wgCapitalizeTitle ) {
45 wfCapitalizeTitle( $article );
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle( $article ) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ( $wgReverseTitle ) {
59 wfReverseTitle( $article );
62 if ( $wgCapitalizeTitle ) {
63 wfCapitalizeTitle( $article );
66 # code to actually show the article goes here
68 if ( $wgNotifyArticle ) {
69 wfNotifyArticleShow( $article );
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle( $article ) {
78 if ( Hooks::run( 'ArticleShow', array( &$article ) ) ) {
80 # code to actually show the article goes here
82 Hooks::run( 'ArticleShowComplete', array( &$article ) );
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle( $article ) {
100 function reverseForExport( $article ) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array( 'someFunction', $someData );
143 $wgHooks['EventName'][] = array( 'someFunction' ); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array( $object, 'someMethod' );
147 $wgHooks['EventName'][] = array( $object, 'someMethod', $someData );
148 $wgHooks['EventName'][] = array( $object ); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction( $param1, $param2 )
157 someFunction( $someData, $param1, $param2 )
160 $object->onEventName( $param1, $param2 )
162 $object->someMethod( $param1, $param2 )
163 # object with method and data
164 $object->someMethod( $someData, $param1, $param2 )
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'TimStarling' );
174 $wgHooks['PageContentSaveComplete'][] = array( 'ircNotify', 'brion' );
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * No return value (or null): the hook has operated successfully. Previously,
182 true was required. This is the default since MediaWiki 1.23.
183 * "some string": an error occurred; processing should stop and the error
184 should be shown to the user
185 * false: the hook has successfully done the work necessary and the calling
188 The last result would be for cases where the hook function replaces the main
189 functionality. For example, if you wanted to authenticate users to a custom
190 system (LDAP, another PHP program, whatever), you could do:
192 $wgHooks['UserLogin'][] = array( 'ldapLogin', $ldapServer );
194 function ldapLogin( $username, $password ) {
199 Returning false makes less sense for events where the action is complete, and
200 will normally be ignored.
202 Note that none of the examples made use of create_function() as a way to
203 attach a function to a hook. This is known to cause problems (notably with
204 Special:Version), and should be avoided when at all possible.
208 A calling function or method uses the Hooks::run() function to run the hooks
209 related to a particular event, like so:
215 if ( Hooks::run( 'ArticleProtect', array( &$this, &$wgUser ) ) ) {
216 # protect the article
217 Hooks::run( 'ArticleProtectComplete', array( &$this, &$wgUser ) );
222 Hooks::run() returns true if the calling function should continue processing
223 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
224 error occurred, or one of the hooks handled the action already). Checking the
225 return value matters more for "before" hooks than for "complete" hooks.
227 Hooks::run() was added in MediaWiki 1.18, before that the global function
228 wfRunHooks must be used, which was deprecated in MediaWiki 1.25.
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can be changed)
232 into the hook code. Also note that earlier versions of wfRunHooks took a
233 variable number of arguments; the array() calling protocol came about after
236 ==Events and parameters==
238 This is a list of known events and parameters; please add to it if you're going
239 to add events to the MediaWiki code.
241 'AbortAutoAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
242 Return false to cancel automated local account creation, where normally
243 authentication against an external auth plugin would be creating a local
245 $user: the User object about to be created (read-only, incomplete)
246 &$abortMsg: out parameter: name of error message to be displayed to user
248 'AbortAutoblock': Return false to cancel an autoblock.
249 $autoblockip: The IP going to be autoblocked.
250 &$block: The block from which the autoblock is coming.
252 'AbortDiffCache': Can be used to cancel the caching of a diff.
253 &$diffEngine: DifferenceEngine object
255 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
256 $editor: The User who made the change.
257 $title: The Title of the page that was edited.
258 $rc: The current RecentChange object.
260 'AbortLogin': DEPRECATED! Create a PreAuthenticationProvider instead.
261 Return false to cancel account login.
262 $user: the User object being authenticated against
263 $password: the password being submitted, not yet checked for validity
264 &$retval: a LoginForm class constant to return from authenticateUserData();
265 default is LoginForm::ABORTED. Note that the client may be using a machine
266 API rather than the HTML user interface.
267 &$msg: the message identifier for abort reason (new in 1.18, not available
270 'AbortNewAccount': DEPRECATED! Create a PreAuthenticationProvider instead.
271 Return false to cancel explicit account creation.
272 $user: the User object about to be created (read-only, incomplete)
273 &$msg: out parameter: HTML to display on abort
274 &$status: out parameter: Status object to return, replaces the older $msg param
276 Create the object with Status::newFatal() to ensure proper API error
277 messages are returned when creating account through API clients.
279 'AbortTalkPageEmailNotification': Return false to cancel talk page email
281 $targetUser: the user whom to send talk page email notification
282 $title: the page title
284 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
285 $name: name of the action
286 &$form: HTMLForm object
287 $article: Article object
289 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
290 Allows to change the fields on the form that will be generated.
291 $name: name of the action
292 &$fields: HTMLForm descriptor array
293 $article: Article object
295 'AddNewAccount': DEPRECATED! Use LocalUserCreated.
296 After a user account is created.
297 $user: the User object that was created. (Parameter added in 1.7)
298 $byEmail: true when account was created "by email" (added in 1.12)
300 'AddNewAccountApiForm': Allow modifying internal login form when creating an
302 $apiModule: the ApiCreateAccount module calling
303 $loginForm: the LoginForm used
305 'AddNewAccountApiResult': Modify API output when creating a new account via API.
306 $apiModule: the ApiCreateAccount module calling
307 $loginForm: the LoginForm used
308 &$result: associative array for API result data
310 'AfterBuildFeedLinks': Executed in OutputPage.php after all feed links (atom, rss,...)
311 are created. Can be used to omit specific feeds from being outputted. You must not use
312 this hook to add feeds, use OutputPage::addFeedLink() instead.
313 &$feedLinks: Array of created feed links
315 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
316 before OutputPage::sendCacheControl() and final ob_end_flush() which
317 will send the buffered output to the client. This allows for last-minute
318 modification of the output within the buffer by using ob_get_clean().
319 $output: The OutputPage object where output() was called
321 'AfterImportPage': When a page import is completed.
322 $title: Title under which the revisions were imported
323 $foreignTitle: ForeignTitle object based on data provided by the XML file
324 $revCount: Number of revisions in the XML file
325 $sRevCount: Number of successfully imported revisions
326 $pageInfo: associative array of page information
328 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
329 just before adding its HTML to parser output.
330 $parser: Parser object that called the hook
331 $ig: Gallery, an object of one of the gallery classes (inheriting from
333 &$html: HTML generated by the gallery
335 'AlternateEdit': Before checking if a user can edit a page and before showing
336 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
337 $editPage: the EditPage object
339 'AlternateEditPreview': Before generating the preview of the page when editing
340 ( EditPage::getPreviewText() ).
341 Return false and set $previewHTML and $parserOutput to output custom page
343 $editPage: the EditPage object
344 &$content: the Content object for the text field from the edit page
345 &$previewHTML: Text to be placed into the page for the preview
346 &$parserOutput: the ParserOutput object for the preview
348 'AlternateUserMailer': Called before mail is sent so that mail could be logged
349 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
350 the regular method of sending mail. Return a string to return a php-mail-error
351 message containing the error. Returning true will continue with sending email
353 $headers: Associative array of headers for the email
354 $to: MailAddress object or array
356 $subject: Subject of the email
357 $body: Body of the message
359 'APIAfterExecute': After calling the execute() method of an API module. Use
360 this to extend core API modules.
361 &$module: Module object
363 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
364 &$main: ApiMain object
366 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
367 authenticate and authorize API clients before executing the module. Return
368 false and set a message to cancel the request.
369 $module: Module object
371 &$message: API usage message to die with, as a message key or array
372 as accepted by ApiBase::dieUsageMsg.
374 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
375 processing request parameters. Return false to let the request fail, returning
376 an error message or an <edit result="Failure"> tag if $resultArr was filled.
377 Unlike for example 'EditFilterMergedContent' this also being run on undo.
378 Since MediaWiki 1.25, 'EditFilterMergedContent' can also return error details
379 for the API and it's recommended to use it instead of this hook.
380 $editPage: the EditPage object
381 $text: the text passed to the API. Note that this includes only the single
382 section for section edit, and is not necessarily the final text in case of
383 automatically resolved edit conflicts.
384 &$resultArr: data in this array will be added to the API result
386 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
387 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
388 this hook may cancel the hook to signal that the item is not viewable in the
390 $row: A row of data from ContribsPager. The set of data returned by
391 ContribsPager can be adjusted by handling the ContribsPager::reallyDoQuery
393 $context: An IContextSource implementation.
394 &$feedItem: Set this to a FeedItem instance if the callback can handle the
395 provided row. This is provided to the hook as a null, if it is non null then
396 another callback has already handled the hook.
398 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
399 highlighting, add output to $context->getOutput() and return false.
400 $context: An IContextSource.
401 $text: Text to be highlighted.
402 $mime: MIME type of $text.
403 $format: API format code for $text.
405 'APIGetAllowedParams': Use this hook to modify a module's parameters.
406 &$module: ApiBase Module object
407 &$params: Array of parameters
408 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
410 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
411 Use this hook to modify a module's description.
412 &$module: ApiBase Module object
413 &$desc: String description, or array of description strings
415 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
416 $module: ApiBase Module object
417 &$msg: Array of Message objects
419 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages
421 Use this hook to modify a module's parameter descriptions.
422 &$module: ApiBase Module object
423 &$desc: Array of parameter descriptions
425 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter
427 $module: ApiBase Module object
428 &$msg: Array of arrays of Message objects
430 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
431 $module: ApiBase Module object
432 &$help: Array of HTML strings to be joined for the output.
433 $options: Array Options passed to ApiHelp::getHelp
434 &$tocData: Array If a TOC is being generated, this array has keys as anchors in
435 the page and values as for Linker::generateTOC().
437 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
438 module manager. Can be used to conditionally register API modules.
439 $moduleManager: ApiModuleManager Module manager instance
441 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
442 an exception is thrown during API action execution.
443 $apiMain: Calling ApiMain instance.
444 $e: Exception object.
446 'ApiMakeParserOptions': Called from ApiParse and ApiExpandTemplates to allow
447 extensions to adjust the ParserOptions before parsing.
448 $options: ParserOptions object
449 $title: Title to be parsed
450 $params: Parameter array for the API module
451 $module: API module (which is also a ContextSource)
452 &$reset: Set to a ScopedCallback used to reset any hooks after the parse is done.
453 &$suppressCache: Set true if cache should be suppressed.
455 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
456 can alter or append to the array.
457 &$results: array with integer keys to associative arrays. Keys in associative
459 - title: Title object.
460 - redirect from: Title or null.
461 - extract: Description for this result.
462 - extract trimmed: If truthy, the extract will not be trimmed to
463 $wgOpenSearchDescriptionLength.
464 - image: Thumbnail for this result. Value is an array with subkeys 'source'
465 (url), 'width', 'height', 'alt', 'align'.
466 - url: Url for the given title.
468 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
469 module manager. Can be used to conditionally register API query modules.
470 $moduleManager: ApiModuleManager Module manager instance
472 'APIQueryAfterExecute': After calling the execute() method of an
473 action=query submodule. Use this to extend core API modules.
474 &$module: Module object
476 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
477 an action=query submodule. Use this to extend core API modules.
478 &$module: Module object
479 &$resultPageSet: ApiPageSet object
481 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
482 Use this hook to add custom tokens to prop=info. Every token has an action,
483 which will be used in the intoken parameter and in the output
484 (actiontoken="..."), and a callback function which should return the token, or
485 false if the user isn't allowed to obtain it. The prototype of the callback
486 function is func($pageid, $title), where $pageid is the page ID of the page the
487 token is requested for and $title is the associated Title object. In the hook,
488 just add your callback to the $tokenFunctions array and return true (returning
489 false makes no sense).
490 &$tokenFunctions: array(action => callback)
492 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes
494 Use this hook to add custom tokens to list=recentchanges. Every token has an
495 action, which will be used in the rctoken parameter and in the output
496 (actiontoken="..."), and a callback function which should return the token, or
497 false if the user isn't allowed to obtain it. The prototype of the callback
498 function is func($pageid, $title, $rc), where $pageid is the page ID of the
499 page associated to the revision the token is requested for, $title the
500 associated Title object and $rc the associated RecentChange object. In the
501 hook, just add your callback to the $tokenFunctions array and return true
502 (returning false makes no sense).
503 &$tokenFunctions: array(action => callback)
505 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
506 Use this hook to add custom tokens to prop=revisions. Every token has an
507 action, which will be used in the rvtoken parameter and in the output
508 (actiontoken="..."), and a callback function which should return the token, or
509 false if the user isn't allowed to obtain it. The prototype of the callback
510 function is func($pageid, $title, $rev), where $pageid is the page ID of the
511 page associated to the revision the token is requested for, $title the
512 associated Title object and $rev the associated Revision object. In the hook,
513 just add your callback to the $tokenFunctions array and return true (returning
514 false makes no sense).
515 &$tokenFunctions: array(action => callback)
517 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
518 sites general information.
519 $module: the current ApiQuerySiteInfo module
520 &$results: array of results, add things here
522 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
523 sites statistics information.
524 &$results: array of results, add things here
526 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
527 action=query&meta=tokens. Note that most modules will probably be able to use
528 the 'csrf' token instead of creating their own token types.
529 &$salts: array( type => salt to pass to User::getEditToken() or array of salt
530 and key to pass to Session::getToken() )
532 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
533 Use this hook to add custom token to list=users. Every token has an action,
534 which will be used in the ustoken parameter and in the output
535 (actiontoken="..."), and a callback function which should return the token, or
536 false if the user isn't allowed to obtain it. The prototype of the callback
537 function is func($user) where $user is the User object. In the hook, just add
538 your callback to the $tokenFunctions array and return true (returning false
540 &$tokenFunctions: array(action => callback)
542 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
543 should have its own entry in the $apis array and have a unique name, passed as
544 key for the array that represents the service data. In this data array, the
545 key-value-pair identified by the apiLink key is required.
546 &$apis: array of services
548 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
549 Use this hook to extend action=tokens with new token types.
550 &$tokenTypes: supported token types in format 'type' => callback function
551 used to retrieve this type of tokens.
553 'Article::MissingArticleConditions': Before fetching deletion & move log entries
554 to display a message of a non-existing page being deleted/moved, give extensions
555 a chance to hide their (unrelated) log entries.
556 &$conds: Array of query conditions (all of which have to be met; conditions will
557 AND in the final query)
558 $logTypes: Array of log types being queried
560 'ArticleAfterFetchContent': DEPRECATED! Use ArticleAfterFetchContentObject
562 After fetching content of an article from the database.
563 &$article: the article (object) being loaded from the database
564 &$content: the content (string) of the article
566 'ArticleAfterFetchContentObject': After fetching content of an article from the
568 &$article: the article (object) being loaded from the database
569 &$content: the content of the article, as a Content object
571 'ArticleConfirmDelete': Before writing the confirmation form for article
573 $article: the article (object) being deleted
574 $output: the OutputPage object
575 &$reason: the reason (string) the article is being deleted
577 'ArticleContentOnDiff': Before showing the article content below a diff. Use
578 this to change the content in this area or how it is loaded.
579 $diffEngine: the DifferenceEngine
580 $output: the OutputPage object
582 'ArticleContentViewCustom': Allows to output the text of the article in a
583 different format than wikitext. Note that it is preferable to implement proper
584 handing for a custom data type using the ContentHandler facility.
585 $content: content of the page, as a Content object
586 $title: title of the page
587 $output: reference to $wgOut
589 'ArticleDelete': Before an article is deleted.
590 &$wikiPage: the WikiPage (object) being deleted
591 &$user: the user (object) deleting the article
592 &$reason: the reason (string) the article is being deleted
593 &$error: if the deletion was prohibited, the (raw HTML) error message to display
595 &$status: Status object, modify this to throw an error. Overridden by $error
597 $suppress: Whether this is a suppression deletion or not (added in 1.27)
599 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
600 $title: Title of the article that has been deleted.
601 $outputPage: OutputPage that can be used to append the output.
603 'ArticleDeleteComplete': After an article is deleted.
604 &$wikiPage: the WikiPage that was deleted
605 &$user: the user that deleted the article
606 $reason: the reason the article was deleted
607 $id: id of the article that was deleted
608 $content: the Content of the deleted page
609 $logEntry: the ManualLogEntry used to record the deletion
611 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
613 &$wikiPage: WikiPage (object) of the user talk page
614 $recipient: User (object) who's talk page was edited
616 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
617 article has been changed.
618 &$wikiPage: the WikiPage (object)
619 &$editInfo: data holder that includes the parser output ($editInfo->output) for
620 that page after the change
621 $changed: bool for if the page was changed
623 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
624 recentchanges table, return false to not delete old entries.
625 &$wikiPage: WikiPage (object) being modified
627 'ArticleFromTitle': when creating an article object from a title object using
628 Wiki::articleFromTitle().
629 &$title: Title (object) used to create the article object
630 &$article: Article (object) that will be returned
631 $context: IContextSource (object)
633 'ArticleInsertComplete': DEPRECATED! Use PageContentInsertComplete.
634 After a new article is created.
635 $wikiPage: WikiPage created
636 $user: User creating the article
638 $summary: Edit summary/comment
639 $isMinor: Whether or not the edit was marked as minor
640 $isWatch: (No longer used)
641 $section: (No longer used)
642 $flags: Flags passed to WikiPage::doEditContent()
643 $revision: New Revision of the article
645 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
646 $targetTitle: target title (object)
647 $destTitle: destination title (object)
649 'ArticlePageDataAfter': After loading data of an article from the database.
650 &$wikiPage: WikiPage (object) whose data were loaded
651 &$row: row (object) returned from the database server
653 'ArticlePageDataBefore': Before loading data of an article from the database.
654 &$wikiPage: WikiPage (object) that data will be loaded
655 &$fields: fields (array) to load from the database
657 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
658 $wikiPage: the WikiPage being saved
659 $popts: parser options to be used for pre-save transformation
661 'ArticleProtect': Before an article is protected.
662 &$wikiPage: the WikiPage being protected
663 &$user: the user doing the protection
664 $protect: Set of restriction keys
665 $reason: Reason for protect
667 'ArticleProtectComplete': After an article is protected.
668 &$wikiPage: the WikiPage that was protected
669 &$user: the user who did the protection
670 $protect: Set of restriction keys
671 $reason: Reason for protect
673 'ArticlePurge': Before executing "&action=purge".
674 &$wikiPage: WikiPage (object) to purge
676 'ArticleRevisionUndeleted': After an article revision is restored.
677 &$title: the article title
678 $revision: the revision
679 $oldPageID: the page ID of the revision when archived (may be null)
681 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
682 revisions of an article.
683 $title: Title object of the article
684 $ids: Ids to set the visibility for
686 'ArticleRollbackComplete': After an article rollback is completed.
687 $wikiPage: the WikiPage that was edited
688 $user: the user who did the rollback
689 $revision: the revision the page was reverted back to
690 $current: the reverted revision
692 'ArticleSave': DEPRECATED! Use PageContentSave instead.
693 Before an article is saved.
694 $wikiPage: the WikiPage (object) being saved
695 $user: the user (object) saving the article
696 $text: the new article text
697 $summary: the article summary (comment)
702 'ArticleSaveComplete': DEPRECATED! Use PageContentSaveComplete instead.
703 After an article has been updated.
704 $wikiPage: WikiPage modified
705 $user: User performing the modification
707 $summary: Edit summary/comment
708 $isMinor: Whether or not the edit was marked as minor
709 $isWatch: (No longer used)
710 $section: (No longer used)
711 $flags: Flags passed to WikiPage::doEditContent()
712 $revision: New Revision of the article
713 $status: Status object about to be returned by doEditContent()
714 $baseRevId: the rev ID (or false) this edit was based on
716 'ArticleUndelete': When one or more revisions of an article are restored.
717 &$title: Title corresponding to the article restored
718 $create: Whether or not the restoration caused the page to be created (i.e. it
719 didn't exist before).
720 $comment: The comment associated with the undeletion.
721 $oldPageId: ID of page previously deleted (from archive table)
723 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
724 $pageArchive: the PageArchive object
725 &$logEntry: ManualLogEntry object
726 $user: User who is performing the log action
728 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
729 the user is redirected back to the page.
730 $article: the article
731 &$sectionanchor: The section anchor link (e.g. "#overview" )
732 &$extraq: Extra query parameters which can be added via hooked functions
734 'ArticleViewCustom': DEPRECATED! Use ArticleContentViewCustom instead.
735 Allows to output the text of the article in a different format than wikitext.
736 Note that it is preferable to implement proper handing for a custom data type
737 using the ContentHandler facility.
738 $text: text of the page
739 $title: title of the page
740 $output: reference to $wgOut
742 'ArticleViewFooter': After showing the footer section of an ordinary page view
743 $article: Article object
744 $patrolFooterShown: boolean whether patrol footer is shown
746 'ArticleViewHeader': Before the parser cache is about to be tried for article
748 &$article: the article
749 &$pcache: whether to try the parser cache or not
750 &$outputDone: whether the output for this page finished or not. Set to
751 a ParserOutput object to both indicate that the output is done and what
752 parser output was used.
754 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
755 redirect was followed.
756 &$article: target article (object)
758 'AuthChangeFormFields': After converting a field information array obtained
759 from a set of AuthenticationRequest classes into a form descriptor; hooks
760 can tweak the array to change how login etc. forms should look.
761 $requests: array of AuthenticationRequests the fields are created from
762 $fieldInfo: field information array (union of all AuthenticationRequest::getFieldInfo() responses).
763 &$formDescriptor: HTMLForm descriptor. The special key 'weight' can be set
764 to change the order of the fields.
765 $action: one of the AuthManager::ACTION_* constants.
767 'AuthManagerLoginAuthenticateAudit': A login attempt either succeeded or failed
768 for a reason other than misconfiguration or session loss. No return data is
769 accepted; this hook is for auditing only.
770 $response: The MediaWiki\Auth\AuthenticationResponse in either a PASS or FAIL state.
771 $user: The User object being authenticated against, or null if authentication
772 failed before getting that far.
773 $username: A guess at the user name being authenticated, or null if we can't
776 'AuthPluginAutoCreate': DEPRECATED! Use the 'LocalUserCreated' hook instead.
777 Called when creating a local account for an user logged in from an external
778 authentication method.
779 $user: User object created locally
781 'AuthPluginSetup': DEPRECATED! Extensions should be updated to use AuthManager.
782 Update or replace authentication plugin object ($wgAuth). Gives a chance for an
783 extension to set it programmatically to a variable class.
784 &$auth: the $wgAuth object, probably a stub
786 'AutopromoteCondition': Check autopromote condition for user.
787 $type: condition type
790 &$result: result of checking autopromote condition
792 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
793 certain title are fetched.
795 $title: title of the page to which backlinks are sought
796 &$conds: query conditions
798 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
802 'BadImage': When checking against the bad image list. Change $bad and return
803 false to override. If an image is "bad", it is not rendered inline in wiki
804 pages or galleries in category pages.
805 $name: Image name being checked
806 &$bad: Whether or not the image is "bad"
808 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
809 custom HTML after the section. Any uses of the hook need to handle escaping.
810 $template: BaseTemplate
811 $portlet: string portlet name
814 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
815 and returning it for the skin to output. You can add items to the toolbox while
816 still letting the skin make final decisions on skin-specific markup conventions
818 &$sk: The BaseTemplate base skin template
819 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
820 BaseTemplate::makeListItem for details on the format of individual items
821 inside of this array.
823 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
824 "noarticletext-nopermission" at Article::showMissingArticle().
825 $article: article object
827 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
828 override how the redirect is output by modifying, or by returning false, and
829 letting standard HTTP rendering take place.
830 ATTENTION: This hook is likely to be removed soon due to overall design of the
832 $context: IContextSource object
833 &$redirect: string URL, modifiable
835 'BeforeInitialize': Before anything is initialized in
836 MediaWiki::performRequest().
837 &$title: Title being used for request
839 &$output: OutputPage object
841 $request: WebRequest object
842 $mediaWiki: Mediawiki object
844 'BeforePageDisplay': Prior to outputting a page.
845 &$out: OutputPage object
848 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
849 override how the redirect is output by modifying, or by returning false and
850 taking over the output.
851 $out: OutputPage object
852 &$redirect: URL, modifiable
853 &$code: HTTP code (eg '301' or '302'), modifiable
855 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
856 $parser: Parser object
858 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
859 as a key then the file will appear as a broken thumbnail.
860 &$descQuery: query string to add to thumbnail URL
862 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
863 $parser: Parser object
864 $title: title of the template
865 &$skip: skip this template and link it?
866 &$id: the id of the revision being parsed
868 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
869 &$parser: Parser object
870 &$ig: ImageGallery object
872 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
874 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
875 to a newly created user account.
876 &$injected_html: Any HTML to inject after the "logged in" message of a newly
879 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
880 normalizations have been performed, except for the $wgMaxImageArea check.
882 &$params: Array of parameters
883 &$checkImageAreaHookResult: null, set to true or false to override the
884 $wgMaxImageArea check result.
886 'BitmapHandlerTransform': before a file is transformed, gives extension the
887 possibility to transform it themselves
888 $handler: BitmapHandler
890 &$scalerParams: Array with scaler parameters
891 &$mto: null, set to a MediaTransformOutput
893 'BlockIp': Before an IP address or user is blocked.
894 &$block: the Block object about to be saved
895 &$user: the user _doing_ the block (not the one being blocked)
896 &$reason: if the hook is aborted, the error message to be returned in an array
898 'BlockIpComplete': After an IP address or user is blocked.
899 $block: the Block object that was saved
900 $user: the user who did the block (not the one being blocked)
902 'BookInformation': Before information output on Special:Booksources.
903 $isbn: ISBN to show information for
904 $output: OutputPage object in use
906 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
907 to be able to access the wiki via HTTPS.
908 $ip: The IP address in human-readable form
909 &$canDo: This reference should be set to false if the client may not be able
912 'CanonicalNamespaces': For extensions adding their own namespaces or altering
914 Note that if you need to specify namespace protection or content model for
915 a namespace that is added in a CanonicalNamespaces hook handler, you
916 should do so by altering $wgNamespaceProtection and
917 $wgNamespaceContentModels outside the handler, in top-level scope. The
918 point at which the CanonicalNamespaces hook fires is too late for altering
919 these variables. This applies even if the namespace addition is
920 conditional; it is permissible to declare a content model and protection
921 for a namespace and then decline to actually register it.
922 &$namespaces: Array of namespace numbers with corresponding canonical names
924 'CategoryAfterPageAdded': After a page is added to a category.
925 $category: Category that page was added to
926 $wikiPage: WikiPage that was added
928 'CategoryAfterPageRemoved': After a page is removed from a category.
929 $category: Category that page was removed from
930 $wikiPage: WikiPage that was removed
932 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
933 &$catpage: CategoryPage instance
935 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
936 in a Category page. Gives extensions the opportunity to batch load any
937 related data about the pages.
938 $type: The category type. Either 'page', 'file' or 'subcat'
939 $res: Query result from DatabaseBase::select()
941 'CategoryViewer::generateLink': Before generating an output link allow
942 extensions opportunity to generate a more specific or relevant link.
943 $type: The category type. Either 'page', 'img' or 'subcat'
944 $title: Title object for the categorized page
945 $html: Requested html content of anchor
946 &$link: Returned value. When set to a non-null value by a hook subscriber
947 this value will be used as the anchor instead of Linker::link
949 'ChangeAuthenticationDataAudit': Called when user changes his password.
950 No return data is accepted; this hook is for auditing only.
951 $req: AuthenticationRequest object describing the change (and target user)
952 $status: StatusValue with the result of the action
954 'ChangePasswordForm': DEPRECATED! Use AuthChangeFormFields or security levels.
955 For extensions that need to add a field to the ChangePassword form via the
957 &$extraFields: An array of arrays that hold fields like would be passed to the
960 'ChangesListInitRows': Batch process change list rows prior to rendering.
961 $changesList: ChangesList instance
962 $rows: The data that will be rendered. May be a ResultWrapper instance or
965 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
966 &$changesList: ChangesList instance.
967 &$articlelink: HTML of link to article (already filled-in).
968 &$s: HTML of row that is being constructed.
969 &$rc: RecentChange instance.
970 $unpatrolled: Whether or not we are showing unpatrolled changes.
971 $watched: Whether or not the change is watched by the user.
973 'ChangesListSpecialPageFilters': Called after building form options on pages
974 inheriting from ChangesListSpecialPage (in core: RecentChanges,
975 RecentChangesLinked and Watchlist).
976 $special: ChangesListSpecialPage instance
977 &$filters: associative array of filter definitions. The keys are the HTML
978 name/URL parameters. Each key maps to an associative array with a 'msg'
979 (message key) and a 'default' value.
981 'ChangesListSpecialPageQuery': Called when building SQL query on pages
982 inheriting from ChangesListSpecialPage (in core: RecentChanges,
983 RecentChangesLinked and Watchlist).
984 $name: name of the special page, e.g. 'Watchlist'
985 &$tables: array of tables to be queried
986 &$fields: array of columns to select
987 &$conds: array of WHERE conditionals for query
988 &$query_options: array of options for the database request
989 &$join_conds: join conditions for the tables
990 $opts: FormOptions for this request
992 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
993 removed from all revisions and log entries to which it was applied). This gives
994 extensions a chance to take it off their books.
995 $tag: name of the tag
996 &$status: Status object. Add warnings to this as required. There is no point
997 setting errors, as the deletion has already been partly carried out by this
1000 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
1001 from the UI (Special:Tags) or via the API. You could use this hook if you want
1002 to reserve a specific "namespace" of tags, or something similar.
1003 $tag: name of the tag
1004 $user: user initiating the action
1005 &$status: Status object. Add your errors using `$status->fatal()` or warnings
1006 using `$status->warning()`. Errors and warnings will be relayed to the user.
1007 If you set an error, the user will be unable to create the tag.
1009 'ChangeTagCanDelete': Tell whether a change tag should be able to be
1010 deleted from the UI (Special:Tags) or via the API. The default is that tags
1011 defined using the ListDefinedTags hook are not allowed to be deleted unless
1012 specifically allowed. If you wish to allow deletion of the tag, set
1013 `$status = Status::newGood()` to allow deletion, and then `return false` from
1014 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
1015 out custom deletion actions.
1016 $tag: name of the tag
1017 $user: user initiating the action
1018 &$status: Status object. See above.
1020 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
1021 uses are in active use.
1022 &$tags: list of all active tags. Append to this array.
1024 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
1025 $collationName: Name of the collation in question
1026 &$collationObject: Null. Replace with a subclass of the Collation class that
1027 implements the collation given in $collationName.
1029 'ConfirmEmailComplete': Called after a user's email has been confirmed
1031 $user: user (object) whose email is being confirmed
1033 'ContentAlterParserOutput': Modify parser output for a given content object.
1034 Called by Content::getParserOutput after parsing has finished. Can be used
1035 for changes that depend on the result of the parsing but have to be done
1036 before LinksUpdate is called (such as adding tracking categories based on
1038 $content: The Content to render
1039 $title: Title of the page, as context
1040 $parserOutput: ParserOutput to manipulate
1042 'ContentGetParserOutput': Customize parser output for a given content object,
1043 called by AbstractContent::getParserOutput. May be used to override the normal
1044 model-specific rendering of page content.
1045 $content: The Content to render
1046 $title: Title of the page, as context
1047 $revId: The revision ID, as context
1048 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1049 the output can only depend on parameters provided to this hook function, not
1051 $generateHtml: boolean, indicating whether full HTML should be generated. If
1052 false, generation of HTML may be skipped, but other information should still
1053 be present in the ParserOutput object.
1054 &$output: ParserOutput, to manipulate or replace
1056 'ContentHandlerDefaultModelFor': Called when the default content model is
1057 determined for a given title. May be used to assign a different model for that
1059 $title: the Title in question
1060 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
1062 'ContentHandlerForModelID': Called when a ContentHandler is requested for
1063 a given content model name, but no entry for that model exists in
1065 $modeName: the requested content model name
1066 &$handler: set this to a ContentHandler object, if desired.
1068 'ContentModelCanBeUsedOn': Called to determine whether that content model can
1069 be used on a given page. This is especially useful to prevent some content
1070 models to be used in some special location.
1071 $contentModel: ID of the content model in question
1072 $title: the Title in question.
1073 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
1074 Handler functions that modify $ok should generally return false to prevent
1075 further hooks from further modifying $ok.
1077 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1078 &$pager: Pager object for contributions
1079 &$queryInfo: The query for the contribs Pager
1081 'ContribsPager::reallyDoQuery': Called before really executing the query for My
1083 &$data: an array of results of all contribs queries
1084 $pager: The ContribsPager object hooked into
1085 $offset: Index offset, inclusive
1086 $limit: Exact query limit
1087 $descending: Query direction, false for ascending, true for descending
1089 'ContributionsLineEnding': Called before a contributions HTML line is finished
1090 $page: SpecialPage object for contributions
1091 &$ret: the HTML line
1092 $row: the DB row for this line
1093 &$classes: the classes to add to the surrounding <li>
1095 'ContributionsToolLinks': Change tool links above Special:Contributions
1096 $id: User identifier
1097 $title: User page title
1098 &$tools: Array of tool links
1100 'ConvertContent': Called by AbstractContent::convert when a conversion to
1101 another content model is requested.
1102 Handler functions that modify $result should generally return false to disable
1103 further attempts at conversion.
1104 $content: The Content object to be converted.
1105 $toModel: The ID of the content model to convert to.
1106 $lossy: boolean indicating whether lossy conversion is allowed.
1107 &$result: Output parameter, in case the handler function wants to provide a
1108 converted Content object. Note that $result->getContentModel() must return
1111 'CustomEditor': When invoking the page editor
1112 Return true to allow the normal editor to be used, or false if implementing
1113 a custom editor, e.g. for a special namespace, etc.
1114 $article: Article being edited
1115 $user: User performing the edit
1117 'DatabaseOraclePostInit': Called after initialising an Oracle database
1118 $db: the DatabaseOracle object
1120 'DeletedContribsPager::reallyDoQuery': Called before really executing the query
1121 for Special:DeletedContributions
1122 Similar to ContribsPager::reallyDoQuery
1123 &$data: an array of results of all contribs queries
1124 $pager: The DeletedContribsPager object hooked into
1125 $offset: Index offset, inclusive
1126 $limit: Exact query limit
1127 $descending: Query direction, false for ascending, true for descending
1129 'DeletedContributionsLineEnding': Called before a DeletedContributions HTML line
1131 Similar to ContributionsLineEnding
1132 $page: SpecialPage object for DeletedContributions
1133 &$ret: the HTML line
1134 $row: the DB row for this line
1135 &$classes: the classes to add to the surrounding <li>
1137 'DiffRevisionTools': Override or extend the revision tools available from the
1138 diff view, i.e. undo, etc.
1139 $newRev: Revision object of the "new" revision
1140 &$links: Array of HTML links
1141 $oldRev: Revision object of the "old" revision (may be null)
1142 $user: Current user object
1144 'DiffViewHeader': Called before diff display
1145 $diff: DifferenceEngine object that's calling
1146 $oldRev: Revision object of the "old" revision (may be null/invalid)
1147 $newRev: Revision object of the "new" revision
1149 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1151 &$article: article (object) being viewed
1152 &$oldid: oldid (int) being viewed
1154 'DoEditSectionLink': DEPRECATED! Use SkinEditSectionLinks instead.
1155 Override the HTML generated for section edit links
1156 $skin: Skin object rendering the UI
1157 $title: Title object for the title being linked to (may not be the same as
1158 the page title, if the section is included from a template)
1159 $section: The designation of the section being pointed to, to be included in
1160 the link, like "§ion=$section"
1161 $tooltip: The default tooltip. Escape before using.
1162 By default, this is wrapped in the 'editsectionhint' message.
1163 &$result: The HTML to return, prefilled with the default plus whatever other
1164 changes earlier hooks have made
1165 $lang: The language code to use for the link in the wfMessage function
1167 'EditFilter': Perform checks on an edit
1168 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1169 $text: Contents of the edit box
1170 $section: Section being edited
1171 &$error: Error message to return
1172 $summary: Edit summary for page
1174 'EditFilterMerged': DEPRECATED! Use EditFilterMergedContent instead.
1175 Post-section-merge edit filter.
1176 $editor: EditPage instance (object)
1177 $text: content of the edit box
1178 &$error: error message to return
1179 $summary: Edit summary for page
1181 'EditFilterMergedContent': Post-section-merge edit filter.
1182 This may be triggered by the EditPage or any other facility that modifies page
1183 content. Use the $status object to indicate whether the edit should be allowed,
1184 and to provide a reason for disallowing it. Return false to abort the edit, and
1185 true to continue. Returning true if $status->isOK() returns false means "don't
1186 save but continue user interaction", e.g. show the edit form.
1187 $status->apiHookResult can be set to an array to be returned by api.php
1188 action=edit. This is used to deliver captchas.
1189 $context: object implementing the IContextSource interface.
1190 $content: content of the edit box, as a Content object.
1191 $status: Status object to represent errors, etc.
1192 $summary: Edit summary for page
1193 $user: the User object representing the user whois performing the edit.
1194 $minoredit: whether the edit was marked as minor by the user.
1196 'EditFormInitialText': Allows modifying the edit form when editing existing
1198 $editPage: EditPage object
1200 'EditFormPreloadText': Allows population of the edit form when creating
1202 &$text: Text to preload with
1203 &$title: Title object representing the page being created
1205 'EditPage::attemptSave': Called before an article is
1206 saved, that is before WikiPage::doEditContent() is called
1207 $editpage_Obj: the current EditPage object
1209 'EditPage::attemptSave:after': Called after an article save attempt
1210 $editpage_Obj: the current EditPage object
1211 $status: the resulting Status object
1212 $resultDetails: Result details array
1214 'EditPage::importFormData': allow extensions to read additional data
1216 $editpage: EditPage instance
1217 $request: Webrequest
1218 return value is ignored (should always return true)
1220 'EditPage::showEditForm:fields': allows injection of form field into edit form
1221 Return value is ignored (should always return true)
1222 &$editor: the EditPage instance for reference
1223 &$out: an OutputPage instance to write to
1225 'EditPage::showEditForm:initial': before showing the edit form
1226 Return false to halt editing; you'll need to handle error messages, etc.
1227 yourself. Alternatively, modifying $error and returning true will cause the
1228 contents of $error to be echoed at the top of the edit form as wikitext.
1229 Return true without altering $error to allow the edit to proceed.
1230 &$editor: EditPage instance (object)
1231 &$out: an OutputPage instance to write to
1233 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1234 but for the read-only 'view source' variant of the edit form.
1235 Return value is ignored (should always return true)
1236 $editor: EditPage instance (object)
1237 &$out: an OutputPage instance to write to
1239 'EditPage::showStandardInputs:options': allows injection of form fields into
1240 the editOptions area
1241 Return value is ignored (should always be true)
1242 $editor: EditPage instance (object)
1243 $out: an OutputPage instance to write to
1244 &$tabindex: HTML tabindex of the last edit check/button
1246 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1247 when there's an edit conflict. Return false to halt normal diff output; in
1248 this case you're responsible for computing and outputting the entire "conflict"
1249 part, i.e., the "difference between revisions" and "your text" headers and
1251 &$editor: EditPage instance
1252 &$out: OutputPage instance
1254 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1255 textarea in the edit form.
1256 &$editpage: The current EditPage object
1257 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1258 &$tabindex: HTML tabindex of the last edit check/button
1260 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1262 &$editpage: The current EditPage object
1263 &$checks: Array of edit checks like "watch this page"/"minor edit"
1264 &$tabindex: HTML tabindex of the last edit check/button
1266 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1267 textarea in the edit form.
1268 &$toolbar: The toolbar HTMl
1270 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1271 contribution/copyright notice.
1272 $title: title of page being edited
1273 &$msg: localization message name, overridable. Default is either
1274 'copyrightwarning' or 'copyrightwarning2'.
1276 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1277 "Show changes". Note that it is preferable to implement diff handling for
1278 different data types using the ContentHandler facility.
1279 $editPage: EditPage object
1280 &$newtext: wikitext that will be used as "your version"
1282 'EditPageGetDiffText': DEPRECATED! Use EditPageGetDiffContent instead.
1283 Allow modifying the wikitext that will be used in "Show changes". Note that it
1284 is preferable to implement diff handling for different data types using the
1285 ContentHandler facility.
1286 $editPage: EditPage object
1287 &$newtext: wikitext that will be used as "your version"
1289 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1290 previewed. Note that it is preferable to implement previews for different data
1291 types using the ContentHandler facility.
1292 $editPage: EditPage object
1293 &$content: Content object to be previewed (may be replaced by hook function)
1295 'EditPageGetPreviewText': DEPRECATED! Use EditPageGetPreviewContent instead.
1296 Allow modifying the wikitext that will be previewed. Note that it is preferable
1297 to implement previews for different data types using the ContentHandler
1299 $editPage: EditPage object
1300 &$toparse: wikitext that will be parsed
1302 'EditPageNoSuchSection': When a section edit request is given for an
1303 non-existent section
1304 &$editpage: The current EditPage object
1305 &$res: the HTML of the error text
1307 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1308 of terms of service summary link that might exist separately from the copyright
1310 $title: title of page being edited
1311 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1313 'EmailConfirmed': When checking that the user's email address is "confirmed".
1314 This runs before the other checks, such as anonymity and the real check; return
1315 true to allow those checks to occur, and false if checking is done.
1316 &$user: User being checked
1317 &$confirmed: Whether or not the email address is confirmed
1319 'EmailUser': Before sending email from one user to another.
1320 &$to: MailAddress object of receiving user
1321 &$from: MailAddress object of sending user
1322 &$subject: subject of the mail
1323 &$text: text of the mail
1324 &$error: Out-param for an error
1326 'EmailUserCC': Before sending the copy of the email to the author.
1327 &$to: MailAddress object of receiving user
1328 &$from: MailAddress object of sending user
1329 &$subject: subject of the mail
1330 &$text: text of the mail
1332 'EmailUserComplete': After sending email from one user to another.
1333 $to: MailAddress object of receiving user
1334 $from: MailAddress object of sending user
1335 $subject: subject of the mail
1336 $text: text of the mail
1338 'EmailUserForm': After building the email user form object.
1339 &$form: HTMLForm object
1341 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1343 $user: The user who is trying to email another user.
1344 $editToken: The user's edit token.
1345 &$hookErr: Out-param for the error. Passed as the parameters to
1346 OutputPage::showErrorPage.
1348 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1349 group of changes in EnhancedChangesList.
1350 Hook subscribers can return false to omit this line from recentchanges.
1351 $changesList: EnhancedChangesList object
1352 &$links: The links that were generated by EnhancedChangesList
1353 $block: The RecentChanges objects in that block
1355 'EnhancedChangesListModifyLineData': to alter data used to build
1356 a grouped recent change inner line in EnhancedChangesList.
1357 Hook subscribers can return false to omit this line from recentchanges.
1358 $changesList: EnhancedChangesList object
1359 &$data: An array with all the components that will be joined in order to create the line
1360 $block: An array of RecentChange objects in that block
1361 $rc: The RecentChange object for this line
1362 &$classes: An array of classes to change
1364 'EnhancedChangesListModifyBlockLineData': to alter data used to build
1365 a non-grouped recent change line in EnhancedChangesList.
1366 $changesList: EnhancedChangesList object
1367 &$data: An array with all the components that will be joined in order to create the line
1368 $rc: The RecentChange object for this line
1370 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1372 $ip: The ip address of the user
1374 'ExtensionTypes': Called when generating the extensions credits, use this to
1375 change the tables headers.
1376 &$extTypes: associative array of extensions types
1378 'ExtractThumbParameters': DEPRECATED! Media handler should override
1379 MediaHandler::parseParamString instead.
1380 Called when extracting thumbnail parameters from a thumbnail file name.
1381 $thumbname: the base name of the thumbnail file
1382 &$params: the currently extracted params (has source name, temp or archived
1385 'FetchChangesList': When fetching the ChangesList derivative for a particular
1387 $user: User the list is being fetched for
1388 &$skin: Skin object to be used with the list
1389 &$list: List object (defaults to NULL, change it to an object instance and
1390 return false override the list derivative used)
1392 'FileDeleteComplete': When a file is deleted.
1393 &$file: reference to the deleted file
1394 &$oldimage: in case of the deletion of an old image, the name of the old file
1395 &$article: in case all revisions of the file are deleted a reference to the
1396 WikiFilePage associated with the file.
1397 &$user: user who performed the deletion
1400 'FileTransformed': When a file is transformed and moved into storage.
1401 $file: reference to the File object
1402 $thumb: the MediaTransformOutput object
1403 $tmpThumbPath: The temporary file system path of the transformed file
1404 $thumbPath: The permanent storage path of the transformed file
1406 'FileUndeleteComplete': When a file is undeleted
1407 $title: title object to the file
1408 $fileVersions: array of undeleted versions. Empty if all versions were restored
1409 $user: user who performed the undeletion
1412 'FileUpload': When a file upload occurs.
1413 $file: Image object representing the file that was uploaded
1414 $reupload: Boolean indicating if there was a previously another image there or
1416 $hasDescription: Boolean indicating that there was already a description page
1417 and a new one from the comment wasn't created (since 1.17)
1419 'FormatAutocomments': When an autocomment is formatted by the Linker.
1420 &$comment: Reference to the accumulated comment. Initially null, when set the
1421 default code will be skipped.
1422 $pre: Boolean, true if there is text before this autocomment
1423 $auto: The extracted part of the parsed comment before the call to the hook.
1424 $post: Boolean, true if there is text after this autocomment
1425 $title: An optional title object used to links to sections. Can be null.
1426 $local: Boolean indicating whether section links should refer to local page.
1427 $wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
1428 autocomment originated; null for the local wiki. Added in 1.26, should default
1429 to null in handler functions, for backwards compatibility.
1431 'GalleryGetModes': Get list of classes that can render different modes of a
1433 &$modeArray: An associative array mapping mode names to classes that implement
1434 that mode. It is expected all registered classes are a subclass of
1437 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1439 $user: user to promote.
1440 &$promote: groups that will be added.
1442 'GetBlockedStatus': after loading blocking status of an user from the database
1443 &$user: user (object) being checked
1445 'GetCacheVaryCookies': Get cookies that should vary cache options.
1446 $out: OutputPage object
1447 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1448 that have to vary cache options
1450 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1452 &$title: Title object of page
1453 &$url: string value as output (out parameter, can modify)
1454 $query: query options passed to Title::getCanonicalURL()
1456 'GetDefaultSortkey': Override the default sortkey for a page.
1457 $title: Title object that we need to get a sortkey for
1458 &$sortkey: Sortkey to use.
1460 'GetDifferenceEngine': Called when getting a new difference engine interface
1461 object Return false for valid object in $differenceEngine or true for the
1462 default difference engine.
1463 $context: IContextSource context to be used for diff
1464 $old: Revision ID to show and diff with
1465 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1466 $refreshCache: If set, refreshes the diff cache
1467 $unhide: If set, allow viewing deleted revs
1468 &$differenceEngine: output parameter, difference engine object to be used for
1471 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1472 underscore) magic words. Called by MagicWord.
1473 &$doubleUnderscoreIDs: array of strings
1475 'GetExtendedMetadata': Get extended file metadata for the API
1476 &$combinedMeta: Array of the form:
1477 'MetadataPropName' => array(
1478 value' => prop value,
1479 'source' => 'name of hook'
1481 $file: File object of file in question
1482 $context: RequestContext (including language to use)
1483 $single: Only extract the current language; if false, the prop value should
1484 be in the metadata multi-language array format:
1485 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1486 &$maxCacheTime: how long the results can be cached
1488 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1489 &$title: Title object of page
1490 &$url: string value as output (out parameter, can modify)
1491 $query: query options passed to Title::getFullURL()
1493 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp
1494 generated by MWTimestamp::getHumanTimestamp(). Return false in this hook to use
1496 &$output: string for the output timestamp
1497 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1498 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1499 $user: User whose preferences are being used to make timestamp
1500 $lang: Language that will be used to render the timestamp
1502 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1503 &$title: Title object of page
1504 &$url: string value as output (out parameter, can modify)
1505 $query: query options passed to Title::getInternalURL()
1507 'GetIP': modify the ip of the current user (called only once).
1508 &$ip: string holding the ip as determined so far
1510 'GetLinkColours': modify the CSS class of an array of page links.
1511 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1513 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1515 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1516 working with internal urls (non-interwiki) then it may be preferable to work
1517 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1518 be buggy for internal urls on render if you do not re-implement the horrible
1519 hack that Title::getLocalURL uses in your own extension.
1520 &$title: Title object of page
1521 &$url: string value as output (out parameter, can modify)
1522 $query: query options passed to Title::getLocalURL()
1524 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1525 without any fancy queries or variants.
1526 &$title: Title object of page
1527 &$url: string value as output (out parameter, can modify)
1529 'GetLocalURL::Internal': Modify local URLs to internal pages.
1530 &$title: Title object of page
1531 &$url: string value as output (out parameter, can modify)
1532 $query: query options passed to Title::getLocalURL()
1534 'GetLogTypesOnUser': Add log types where the target is a userpage
1535 &$types: Array of log types
1537 'GetMetadataVersion': Modify the image metadata version currently in use. This
1538 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1539 that need to have versioned metadata should add an element to the end of the
1540 version array of the form 'handler_name=version'. Most media handlers won't need
1541 to do this unless they broke backwards compatibility with a previous version of
1542 the media handler metadata output.
1543 &$version: Array of version strings
1545 'GetNewMessagesAlert': Disable or modify the new messages alert
1546 &$newMessagesAlert: An empty string by default. If the user has new talk page
1547 messages, this should be populated with an alert message to that effect
1548 $newtalks: An empty array if the user has no new messages or an array
1549 containing links and revisions if there are new messages (See
1550 User::getNewMessageLinks)
1551 $user: The user object of the user who is loading the page
1552 $out: OutputPage object (to check what type of page the user is on)
1554 'GetPreferences': Modify user preferences.
1555 $user: User whose preferences are being modified.
1556 &$preferences: Preferences description array, to be fed to an HTMLForm object
1558 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1559 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the
1561 &$output: string for the output timestamp
1562 &$diff: DateInterval representing the difference between the timestamps
1563 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1564 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1565 $user: User whose preferences are being used to make timestamp
1566 $lang: Language that will be used to render the timestamp
1568 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1569 checked for. Use instead of userCan for most cases. Return false if the user
1570 can't do it, and populate $result with the reason in the form of
1571 array( messagename, param1, param2, ... ) or a MessageSpecifier instance (you
1572 might want to use ApiMessage to provide machine-readable details for the API).
1573 For consistency, error messages
1574 should be plain text with no special coloring, bolding, etc. to show that
1575 they're errors; presenting them properly to the user as errors is done by the
1577 &$title: Title object being checked against
1578 &$user: Current user object
1579 $action: Action being checked
1580 &$result: User permissions error to add. If none, return true.
1582 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1583 called only if expensive checks are enabled. Add a permissions error when
1584 permissions errors are checked for. Return false if the user can't do it, and
1585 populate $result with the reason in the form of array( messagename, param1,
1586 param2, ... ) or a MessageSpecifier instance (you might want to use ApiMessage
1587 to provide machine-readable details for the API). For consistency, error
1588 messages should be plain text with no
1589 special coloring, bolding, etc. to show that they're errors; presenting them
1590 properly to the user as errors is done by the caller.
1591 &$title: Title object being checked against
1592 &$user: Current user object
1593 $action: Action being checked
1594 &$result: User permissions error to add. If none, return true.
1596 'GitViewers': Called when generating the list of git viewers for
1597 Special:Version, use this to change the list.
1598 &$extTypes: associative array of repo URLS to viewer URLs.
1600 'HistoryRevisionTools': Override or extend the revision tools available from the
1601 page history view, i.e. undo, rollback, etc.
1602 $rev: Revision object
1603 &$links: Array of HTML links
1604 $prevRev: Revision object, next in line in page history, or null
1605 $user: Current user object
1607 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1609 $context: An IContextSource object with information about the request being
1612 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1613 image insertion. You can skip the default logic entirely by returning false, or
1614 just modify a few things using call-by-reference.
1616 &$title: Title object of the image
1617 &$file: File object, or false if it doesn't exist
1618 &$frameParams: Various parameters with special meanings; see documentation in
1619 includes/Linker.php for Linker::makeImageLink
1620 &$handlerParams: Various parameters with special meanings; see documentation in
1621 includes/Linker.php for Linker::makeImageLink
1622 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1623 &$res: Final HTML output, used if you return false
1625 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1626 the image on an image page.
1627 &$imagePage: ImagePage object ($this)
1630 'ImagePageAfterImageLinks': Called after the image links section on an image
1632 $imagePage: ImagePage object ($this)
1633 &$html: HTML for the hook to add
1635 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1636 $imagePage: ImagePage object ($this)
1638 &$line: the HTML of the history line
1639 &$css: the line CSS class
1641 'ImagePageFindFile': Called when fetching the file associated with an image
1643 $page: ImagePage object
1645 &$displayFile: displayed File object
1647 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1648 $page: ImagePage object
1649 &$toc: Array of <li> strings
1651 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1653 &$title: the Title object of the file as it would appear for the upload page
1654 &$path: the original file and path name when img_auth was invoked by the web
1656 &$name: the name only component of the file
1657 &$result: The location to pass back results of the hook routine (only used if
1659 $result[0]=The index of the header message
1660 $result[1]=The index of the body text message
1661 $result[2 through n]=Parameters passed to body text message. Please note the
1662 header message cannot receive/use parameters.
1664 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1665 Return false to stop further processing of the tag
1666 $reader: XMLReader object
1667 $logInfo: Array of information
1669 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1670 Return false to stop further processing of the tag
1671 $reader: XMLReader object
1672 &$pageInfo: Array of information
1674 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1675 Return false to stop further processing of the tag
1676 $reader: XMLReader object
1677 $pageInfo: Array of page information
1678 $revisionInfo: Array of revision information
1680 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1681 Return false to stop further processing of the tag
1682 $reader: XMLReader object
1684 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1685 Return false to stop further processing of the tag
1686 $reader: XMLReader object
1687 $revisionInfo: Array of information
1689 'ImportLogInterwikiLink': Hook to change the interwiki link used in log entries
1690 and edit summaries for transwiki imports.
1691 &$fullInterwikiPrefix: Interwiki prefix, may contain colons.
1692 &$pageTitle: String that contains page title.
1694 'ImportSources': Called when reading from the $wgImportSources configuration
1695 variable. Can be used to lazy-load the import sources list.
1696 &$importSources: The value of $wgImportSources. Modify as necessary. See the
1697 comment in DefaultSettings.php for the detail of how to structure this array.
1699 'InfoAction': When building information to display on the action=info page.
1700 $context: IContextSource object
1701 &$pageInfo: Array of information
1703 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1704 &$title: Title object for the current page
1705 &$request: WebRequest
1706 &$ignoreRedirect: boolean to skip redirect check
1707 &$target: Title/string of redirect target
1708 &$article: Article object
1710 'InternalParseBeforeLinks': during Parser's internalParse method before links
1711 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1712 &$parser: Parser object
1713 &$text: string containing partially parsed text
1714 &$stripState: Parser's internal StripState object
1716 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1717 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1718 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1719 template/parser function execution which respect nowiki and HTML-comments.
1720 &$parser: Parser object
1721 &$text: string containing partially parsed text
1722 &$stripState: Parser's internal StripState object
1724 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1725 Return true without providing an interwiki to continue interwiki search.
1726 $prefix: interwiki prefix we are looking for.
1727 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1728 iw_trans and optionally iw_api and iw_wikiid.
1730 'InvalidateEmailComplete': Called after a user's email has been invalidated
1732 $user: user (object) whose email is being invalidated
1734 'IRCLineURL': When constructing the URL to use in an IRC notification.
1735 Callee may modify $url and $query, URL will be constructed as $url . $query
1736 &$url: URL to index.php
1737 &$query: Query string
1738 $rc: RecentChange object that triggered url generation
1740 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1741 &$article: article (object) being checked
1743 'IsTrustedProxy': Override the result of IP::isTrustedProxy()
1744 &$ip: IP being check
1745 &$result: Change this value to override the result of IP::isTrustedProxy()
1747 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1748 $url: URL used to upload from
1749 &$allowed: Boolean indicating if uploading is allowed for given URL
1751 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1752 instance to return false if the domain name doesn't match your organization.
1753 $addr: The e-mail address entered by the user
1754 &$result: Set this and return false to override the internal checks
1756 'isValidPassword': Override the result of User::isValidPassword()
1757 $password: The password entered by the user
1758 &$result: Set this and return false to override the internal checks
1759 $user: User the password is being validated for
1761 'Language::getMessagesFileName':
1762 $code: The language code or the language we're looking for a messages file for
1763 &$file: The messages file path, you can override this to change the location.
1765 'LanguageGetMagic': DEPRECATED! Use $magicWords in a file listed in
1766 $wgExtensionMessagesFiles instead.
1767 Use this to define synonyms of magic words depending of the language
1768 &$magicExtensions: associative array of magic words synonyms
1769 $lang: language code (string)
1771 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1772 remove namespaces. Do not use this hook to add namespaces. Use
1773 CanonicalNamespaces for that.
1774 &$namespaces: Array of namespaces indexed by their numbers
1776 'LanguageGetSpecialPageAliases': DEPRECATED! Use $specialPageAliases in a file
1777 listed in $wgExtensionMessagesFiles instead.
1778 Use to define aliases of special pages names depending of the language
1779 &$specialPageAliases: associative array of magic words synonyms
1780 $lang: language code (string)
1782 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1783 &$names: array of language code => language name
1784 $code: language of the preferred translations
1786 'LanguageLinks': Manipulate a page's language links. This is called
1787 in various places to allow extensions to define the effective language
1789 $title: The page's Title.
1790 &$links: Associative array mapping language codes to prefixed links of the
1791 form "language:title".
1792 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1793 Currently unused, but planned to provide support for marking individual
1794 language links in the UI, e.g. for featured articles.
1796 'LanguageSelector': Hook to change the language selector available on a page.
1797 $out: The output page.
1798 $cssClassName: CSS class name of the language selector.
1800 'LinkBegin': DEPRECATED! Use HtmlPageLinkRendererBegin instead.
1801 Used when generating internal and interwiki links in
1802 Linker::link(), before processing starts. Return false to skip default
1803 processing and return $ret. See documentation for Linker::link() for details on
1804 the expected meanings of parameters.
1805 $skin: the Skin object
1806 $target: the Title that the link is pointing to
1807 &$html: the contents that the <a> tag should have (raw HTML); null means
1809 &$customAttribs: the HTML attributes that the <a> tag should have, in
1810 associative array form, with keys and values unescaped. Should be merged
1811 with default values, with a value of false meaning to suppress the
1813 &$query: the query string to add to the generated URL (the bit after the "?"),
1814 in associative array form, with keys and values unescaped.
1815 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1816 &$ret: the value to return if your hook returns false.
1818 'LinkEnd': DEPRECATED! Use HtmlPageLinkRendererEnd hook instead
1819 Used when generating internal and interwiki links in Linker::link(),
1820 just before the function returns a value. If you return true, an <a> element
1821 with HTML attributes $attribs and contents $html will be returned. If you
1822 return false, $ret will be returned.
1823 $skin: the Skin object
1824 $target: the Title object that the link is pointing to
1825 $options: the options. Will always include either 'known' or 'broken', and may
1826 include 'noclasses'.
1827 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1828 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1829 associative array form.
1830 &$ret: the value to return if your hook returns false.
1832 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1834 &$url: the image url
1835 &$alt: the image's alt text
1836 &$img: the new image HTML (if returning false)
1838 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1841 &$text: the link text
1842 &$link: the new link HTML (if returning false)
1843 &$attribs: the attributes to be applied.
1844 $linkType: The external link type
1846 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1848 $title: the Title object that the link is pointing to
1849 $file: the File object or false if broken link
1850 &$html: the link text
1851 &$attribs: the attributes to be applied
1852 &$ret: the value to return if your hook returns false
1854 'HtmlPageLinkRendererBegin':
1855 Used when generating internal and interwiki links in
1856 LinkRenderer, before processing starts. Return false to skip default
1857 processing and return $ret.
1858 $linkRenderer: the LinkRenderer object
1859 $target: the LinkTarget that the link is pointing to
1860 &$html: the contents that the <a> tag should have (raw HTML); null means
1862 &$customAttribs: the HTML attributes that the <a> tag should have, in
1863 associative array form, with keys and values unescaped. Should be merged
1864 with default values, with a value of false meaning to suppress the
1866 &$query: the query string to add to the generated URL (the bit after the "?"),
1867 in associative array form, with keys and values unescaped.
1868 &$ret: the value to return if your hook returns false.
1870 'HtmlPageLinkRendererEnd':
1871 Used when generating internal and interwiki links in LinkRenderer,
1872 just before the function returns a value. If you return true, an <a> element
1873 with HTML attributes $attribs and contents $html will be returned. If you
1874 return false, $ret will be returned.
1875 $linkRenderer: the LinkRenderer object
1876 $target: the LinkTarget object that the link is pointing to
1877 $isKnown: boolean indicating whether the page is known or not
1878 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1879 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1880 associative array form.
1881 &$ret: the value to return if your hook returns false.
1883 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1885 &$linksUpdate: the LinksUpdate object
1887 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1888 each link table insert. For example, pagelinks, imagelinks, externallinks.
1889 $linksUpdate: LinksUpdate object
1890 $table: the table to insert links to
1891 $insertions: an array of links to insert
1893 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1894 including delete and insert, has completed for all link tables
1895 &$linksUpdate: the LinksUpdate object
1897 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1898 &$linksUpdate: the LinksUpdate object
1900 'ListDefinedTags': When trying to find all defined tags.
1901 &$tags: The list of tags.
1903 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1904 $updater: A DatabaseUpdater subclass
1906 'LocalFile::getHistory': Called before file history query performed.
1907 &$file: the File object
1909 &$fields: select fields
1911 &$opts: query options
1912 &$join_conds: JOIN conditions
1914 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1915 $file: the File object
1916 $archiveName: name of an old file version or false if it's the current one
1918 'LocalisationCacheRecache': Called when loading the localisation data into
1920 $cache: The LocalisationCache object
1921 $code: language code
1922 &$alldata: The localisation data from core and extensions
1923 &$purgeBlobs: whether to purge/update the message blobs via
1924 MessageBlobStore::clear()
1926 'LocalisationCacheRecacheFallback': Called for each language when merging
1927 fallback data into the cache.
1928 $cache: The LocalisationCache object
1929 $code: language code
1930 &$alldata: The localisation data from core and extensions. Note some keys may
1931 be omitted if they won't be merged into the final result.
1933 'LocalisationChecksBlacklist': When fetching the blacklist of
1934 localisation checks.
1935 &$blacklist: array of checks to blacklist. See the bottom of
1936 maintenance/language/checkLanguage.inc for the format of this variable.
1938 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1939 optional localisation messages
1940 &$ignored: Array of ignored message keys
1941 &$optional: Array of optional message keys
1943 'LocalUserCreated': Called when a local user has been created
1944 $user: User object for the created user
1945 $autocreated: Boolean, whether this was an auto-creation
1947 'LogEventsListGetExtraInputs': When getting extra inputs to display on
1948 Special:Log for a specific log type
1949 $type: String of log type being displayed
1950 $logEventsList: LogEventsList object for context and access to the WebRequest
1951 &$input: string HTML of an input element
1953 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1954 Returning false will prevent the string from being added to the OutputPage.
1955 &$s: html string to show for the log extract
1956 $types: String or Array Log types to show
1957 $page: String or Title The page title to show log entries for
1958 $user: String The user who made the log entries
1959 $param: Associative Array with the following additional options:
1960 - lim Integer Limit of items to show, default is 50
1961 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1962 - showIfEmpty boolean Set to false if you don't want any output in case the
1963 loglist is empty if set to true (default), "No matching items in log" is
1964 displayed if loglist is empty
1965 - msgKey Array If you want a nice box with a message, set this to the key of
1966 the message. First element is the message key, additional optional elements
1967 are parameters for the key that are processed with
1968 wfMessage()->params()->parseAsBlock()
1969 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1971 - wrap String Wrap the message in html (usually something like
1972 "<div ...>$1</div>").
1973 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1975 'LogException': Called before an exception (or PHP error) is logged. This is
1976 meant for integration with external error aggregation services; returning false
1977 will NOT prevent logging.
1978 $e: The exception (in case of a plain old PHP error, a wrapping ErrorException)
1979 $suppressed: true if the error was suppressed via
1980 error_reporting()/wfSuppressWarnings()
1982 'LoginAuthenticateAudit': A login attempt for a valid user account either
1983 succeeded or failed. No return data is accepted; this hook is for auditing only.
1984 $user: the User object being authenticated against
1985 $password: the password being submitted and found wanting
1986 $retval: a LoginForm class constant with authenticateUserData() return
1987 value (SUCCESS, WRONG_PASS, etc.).
1989 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid
1990 error messages. Allows to add additional error messages (except messages already
1991 in LoginForm::$validErrorMessages).
1992 &$messages: Already added messages (inclusive messages from
1993 LoginForm::$validErrorMessages)
1995 'LoginUserMigrated': DEPRECATED! Create a PreAuthenticationProvider instead.
1996 Called during login to allow extensions the opportunity to inform a user that
1997 their username doesn't exist for a specific reason, instead of letting the
1998 login form give the generic error message that the account does not exist. For
1999 example, when the account has been renamed or deleted.
2000 $user: the User object being authenticated against.
2001 &$msg: the message identifier for abort reason, or an array to pass a message
2004 'LogLine': Processes a single log entry on Special:Log.
2005 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
2006 logging.log_type database field.
2007 $log_action: string for the type of log action (e.g. 'delete', 'block',
2008 'create2'). Corresponds to logging.log_action database field.
2009 $title: Title object that corresponds to logging.log_namespace and
2010 logging.log_title database fields.
2011 $paramArray: Array of parameters that corresponds to logging.log_params field.
2012 Note that only $paramArray[0] appears to contain anything.
2013 &$comment: string that corresponds to logging.log_comment database field, and
2014 which is displayed in the UI.
2015 &$revert: string that is displayed in the UI, similar to $comment.
2016 $time: timestamp of the log entry (added in 1.12)
2018 'LonelyPagesQuery': Allow extensions to modify the query used by
2019 Special:LonelyPages.
2020 &$tables: tables to join in the query
2021 &$conds: conditions for the query
2022 &$joinConds: join conditions for the query
2024 'MagicWordwgVariableIDs': When defining new magic words IDs.
2025 &$variableIDs: array of strings
2027 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
2029 $refreshLinks: RefreshLinks object
2031 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
2032 Ideally, this hook should only be used to add variables that depend on
2033 the current page/request; static configuration should be added through
2034 ResourceLoaderGetConfigVars instead.
2035 &$vars: variable (or multiple variables) to be added into the output of
2036 Skin::makeVariablesScript
2037 $out: The OutputPage which called the hook, can be used to get the real title.
2039 'MarkPatrolled': Before an edit is marked patrolled.
2040 $rcid: ID of the revision to be marked patrolled
2041 &$user: the user (object) marking the revision as patrolled
2042 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
2043 sysop in order to mark an edit patrolled.
2044 $auto: true if the edit is being marked as patrolled automatically
2046 'MarkPatrolledComplete': After an edit is marked patrolled.
2047 $rcid: ID of the revision marked as patrolled
2048 &$user: user (object) who marked the edit patrolled
2049 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
2050 sysop to patrol the edit.
2051 $auto: true if the edit is being marked as patrolled automatically
2053 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
2054 something completely different, after the basic globals have been set up, but
2055 before ordinary actions take place.
2057 $article: Article on which the action will be performed
2058 $title: Title on which the action will be performed
2060 $request: $wgRequest
2061 $mediaWiki: The $mediawiki object
2063 'MediaWikiServices': Called when a global MediaWikiServices instance is
2064 initialized. Extensions may use this to define, replace, or wrap services.
2065 However, the preferred way to define a new service is
2066 the $wgServiceWiringFiles array.
2067 $services: MediaWikiServices
2069 'MessageCache::get': When fetching a message. Can be used to override the key
2070 for customisations. Given and returned message key must be in special format:
2071 1) first letter must be in lower case according to the content language.
2072 2) spaces must be replaced with underscores
2073 &$key: message key (string)
2075 'MessageCacheReplace': When a message page is changed. Useful for updating
2077 $title: name of the page changed.
2078 $text: new contents of the page.
2080 'MessagesPreLoad': When loading a message from the database.
2081 $title: title of the message (string)
2082 &$message: value (string), change it to the message you want to define
2084 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
2085 $mimeMagic: Instance of MimeMagic.
2086 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
2087 &$tail: More or equal than last 65558 bytes of the file in a string
2088 (in - Do not alter!).
2090 &$mime: MIME type (out).
2092 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
2093 MIME type detected by considering the file extension.
2094 $mimeMagic: Instance of MimeMagic.
2095 $ext: File extension.
2096 &$mime: MIME type (in/out).
2098 'MimeMagicInit': Before processing the list mapping MIME types to media types
2099 and the list mapping MIME types to file extensions.
2100 As an extension author, you are encouraged to submit patches to MediaWiki's
2101 core to add new MIME types to mime.types.
2102 $mimeMagic: Instance of MimeMagic.
2103 Use $mimeMagic->addExtraInfo( $stringOfInfo );
2104 for adding new MIME info to the list.
2105 Use $mimeMagic->addExtraTypes( $stringOfTypes );
2106 for adding new MIME types to the list.
2108 'ModifyExportQuery': Modify the query used by the exporter.
2109 $db: The database object to be queried.
2110 &$tables: Tables in the query.
2111 &$conds: Conditions in the query.
2112 &$opts: Options for the query.
2113 &$join_conds: Join conditions for the query.
2115 'MovePageCheckPermissions': Specify whether the user is allowed to move the
2117 $oldTitle: Title object of the current (old) location
2118 $newTitle: Title object of the new location
2119 $user: User making the move
2120 $reason: string of the reason provided by the user
2121 $status: Status object to pass error messages to
2123 'MovePageIsValidMove': Specify whether a page can be moved for technical
2125 $oldTitle: Title object of the current (old) location
2126 $newTitle: Title object of the new location
2127 $status: Status object to pass error messages to
2129 'NamespaceIsMovable': Called when determining if it is possible to pages in a
2131 $index: Integer; the index of the namespace being checked.
2132 &$result: Boolean; whether MediaWiki currently thinks that pages in this
2133 namespace are movable. Hooks may change this value to override the return
2134 value of MWNamespace::isMovable().
2136 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
2137 $title: the diff page title (nullable)
2138 &$oldId: the actual old Id to use in the diff
2139 &$newId: the actual new Id to use in the diff (0 means current)
2140 $old: the ?old= param value from the url
2141 $new: the ?new= param value from the url
2143 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
2145 $wikiPage: the WikiPage edited
2146 $rev: the new revision
2147 $baseID: the revision ID this was based off, if any
2148 $user: the editing user
2150 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
2151 return false to omit the line from RecentChanges and Watchlist special pages.
2152 &$changeslist: The OldChangesList instance.
2153 &$s: HTML of the form "<li>...</li>" containing one RC entry.
2154 $rc: The RecentChange object.
2155 &$classes: array of css classes for the <li> element
2157 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
2158 can alter or append to the array of URLs for search & suggestion formats.
2159 &$urls: array of associative arrays with Url element attributes
2161 'OpportunisticLinksUpdate': Called by WikiPage::triggerOpportunisticLinksUpdate
2162 when a page view triggers a re-rendering of the page. This may happen
2163 particularly if the parser cache is split by user language, and no cached
2164 rendering of the page exists in the user's language. The hook is called
2165 before checking whether page_links_updated indicates that the links are up
2166 to date. Returning false will cause triggerOpportunisticLinksUpdate() to abort
2167 without triggering any updates.
2168 $page: the Page that was rendered.
2169 $title: the Title of the rendered page.
2170 $parserOutput: ParserOutput resulting from rendering the page.
2172 'OtherBlockLogLink': Get links to the block log from extensions which blocks
2173 users and/or IP addresses too.
2174 &$otherBlockLink: An array with links to other block logs
2175 $ip: The requested IP address or username
2177 'OutputPageBeforeHTML': A page has been processed by the parser and the
2178 resulting HTML is about to be displayed.
2179 &$parserOutput: the parserOutput (object) that corresponds to the page
2180 &$text: the text that will be displayed, in HTML (string)
2182 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2183 body tag to allow for extensions to add attributes to the body of the page they
2184 might need. Or to allow building extensions to add body classes that aren't of
2185 high enough demand to be included in core.
2186 $out: The OutputPage which called the hook, can be used to get the real title
2187 $sk: The Skin that called OutputPage::headElement
2188 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2190 'OutputPageCheckLastModified': when checking if the page has been modified
2191 since the last visit.
2192 &$modifiedTimes: array of timestamps.
2193 The following keys are set: page, user, epoch
2194 $out: OutputPage object (since 1.28)
2196 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2197 categories. Implementations should return false if they generate the category
2198 links, so the default link generation is skipped.
2199 &$out: OutputPage instance (object)
2200 $categories: associative array, keys are category names, values are category
2201 types ("normal" or "hidden")
2202 &$links: array, intended to hold the result. Must be an associative array with
2203 category types as keys and arrays of HTML links as values.
2205 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2206 &$out: OutputPage instance (object)
2207 $parserOutput: parserOutput instance being added in $out
2209 'PageContentInsertComplete': After a new article is created.
2210 $wikiPage: WikiPage created
2211 $user: User creating the article
2212 $content: New content as a Content object
2213 $summary: Edit summary/comment
2214 $isMinor: Whether or not the edit was marked as minor
2215 $isWatch: (No longer used)
2216 $section: (No longer used)
2217 $flags: Flags passed to WikiPage::doEditContent()
2218 $revision: New Revision of the article
2220 'PageContentLanguage': Allows changing the language in which the content of a
2221 page is written. Defaults to the wiki content language ($wgContLang).
2222 $title: Title object
2223 &$pageLang: the page content language (either an object or a language code)
2224 $wgLang: the user language
2226 'PageContentSave': Before an article is saved.
2227 $wikiPage: the WikiPage (object) being saved
2228 $user: the user (object) saving the article
2229 $content: the new article content, as a Content object
2230 $summary: the article summary (comment)
2231 $isminor: minor flag
2232 $iswatch: watch flag
2235 'PageContentSaveComplete': After an article has been updated.
2236 $wikiPage: WikiPage modified
2237 $user: User performing the modification
2238 $content: New content, as a Content object
2239 $summary: Edit summary/comment
2240 $isMinor: Whether or not the edit was marked as minor
2241 $isWatch: (No longer used)
2242 $section: (No longer used)
2243 $flags: Flags passed to WikiPage::doEditContent()
2244 $revision: New Revision of the article (can be null for edits that change
2246 $status: Status object about to be returned by doEditContent()
2247 $baseRevId: the rev ID (or false) this edit was based on
2249 'PageHistoryBeforeList': When a history page list is about to be constructed.
2250 &$article: the article that the history is loading for
2251 $context: RequestContext object
2253 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2254 $historyAction: the action object
2255 &$row: the revision row for this line
2256 &$s: the string representing this parsed line
2257 &$classes: array containing the <li> element classes
2259 'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
2260 any output is generated, to allow batch lookups for prefetching information
2261 needed for display. If the hook handler returns false, the regular behavior of
2262 doBatchLookups() is skipped.
2263 $pager: the PageHistoryPager
2264 $result: a ResultWrapper representing the query result
2266 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2269 &$queryInfo: the query parameters
2271 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2272 which depends on user options should install this hook and append its values to
2274 &$confstr: reference to a hash key string which can be modified
2275 $user: User (object) requesting the page
2276 &$forOptions: array of options the hash is for
2278 'PageViewUpdates': Allow database (or other) changes to be made after a
2279 page view is seen by MediaWiki. Note this does not capture views made
2280 via external caches such as Squid.
2281 $wikipage: WikiPage (object) for the page being viewed.
2282 $user: User (object) for the user who is viewing.
2284 'ParserAfterParse': Called from Parser::parse() just after the call to
2285 Parser::internalParse() returns.
2286 &$parser: parser object
2287 &$text: text being parsed
2288 &$stripState: stripState used (object)
2290 'ParserAfterStrip': Called at end of parsing time.
2291 TODO: No more strip, deprecated ?
2292 &$parser: parser object
2293 &$text: text being parsed
2294 &$stripState: stripState used (object)
2296 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2297 &$parser: Parser object being used
2298 &$text: text that will be returned
2300 'ParserAfterUnstrip': Called after the first unstripGeneral() in
2301 Parser::internalParseHalfParsed()
2302 &$parser: Parser object being used
2303 &$text: text that will be returned
2305 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2306 &$parser: Parser object
2307 &$text: text to parse
2308 &$stripState: StripState instance being used
2310 'ParserBeforeStrip': Called at start of parsing time.
2311 TODO: No more strip, deprecated ?
2312 &$parser: parser object
2313 &$text: text being parsed
2314 &$stripState: stripState used (object)
2316 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2317 &$parser: Parser object being used
2320 'ParserCacheSaveComplete': Called after a ParserOutput has been committed to
2322 $parserCache: ParserCache object $parserOutput was stored in
2323 $parserOutput: ParserOutput object that was stored
2324 $title: Title of the page that was parsed to generate $parserOutput
2325 $popts: ParserOptions used for generating $parserOutput
2326 $revId: ID of the revision that was parsed to create $parserOutput
2328 'ParserClearState': Called at the end of Parser::clearState().
2329 &$parser: Parser object being cleared
2331 'ParserCloned': Called when the parser is cloned.
2332 $parser: Newly-cloned Parser object
2334 'ParserFirstCallInit': Called when the parser initialises for the first time.
2335 &$parser: Parser object being cleared
2337 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2339 &$parser: Parser object
2340 &$varCache: array to store the value in case of multiples calls of the
2342 &$index: index (string) of the magic
2343 &$ret: value of the magic word (the hook should set it)
2344 &$frame: PPFrame object to use for expanding any template variables
2346 'ParserGetVariableValueTs': Use this to change the value of the time for the
2347 {{LOCAL...}} magic word.
2348 &$parser: Parser object
2349 &$time: actual time (timestamp)
2351 'ParserGetVariableValueVarCache': use this to change the value of the variable
2352 cache or return false to not use it.
2353 &$parser: Parser object
2354 &$varCache: variable cache (array)
2356 'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and
2357 ParserLimitReportFormat instead.
2358 Called at the end of Parser:parse() when the parser will
2359 include comments about size of the text parsed.
2360 $parser: Parser object
2361 &$limitReport: text that will be included (without comment tags)
2363 'ParserLimitReportFormat': Called for each row in the parser limit report that
2364 needs formatting. If nothing handles this hook, the default is to use "$key" to
2365 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2367 $key: Key for the limit report item (string)
2368 &$value: Value of the limit report item
2369 &$report: String onto which to append the data
2370 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2371 text intended for display in a monospaced font.
2372 $localize: If false, $report should be output in English.
2374 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser
2375 will include comments about size of the text parsed. Hooks should use
2376 $output->setLimitReportData() to populate data. Functions for this hook should
2377 not use $wgLang; do that in ParserLimitReportFormat instead.
2378 $parser: Parser object
2379 $output: ParserOutput object
2381 'ParserMakeImageParams': Called before the parser make an image link, use this
2382 to modify the parameters of the image.
2383 $title: title object representing the file
2384 $file: file object that will be used to create the image
2385 &$params: 2-D array of parameters
2386 $parser: Parser object that called the hook
2388 'ParserSectionCreate': Called each time the parser creates a document section
2389 from wikitext. Use this to apply per-section modifications to HTML (like
2390 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2391 can begin in one section and end in another. Make sure your code can handle
2392 that case gracefully. See the EditSectionClearerLink extension for an example.
2393 $parser: the calling Parser instance
2394 $section: the section number, zero-based, but section 0 is usually empty
2395 &$sectionContent: ref to the content of the section. modify this.
2396 $showEditLinks: boolean describing whether this section has an edit link
2398 'ParserTestGlobals': Allows to define globals for parser tests.
2399 &$globals: Array with all the globals which should be set for parser tests.
2400 The arrays keys serve as the globals names, its values are the globals values.
2402 'ParserTestParser': Called when creating a new instance of Parser in
2403 tests/parser/parserTest.inc.
2404 &$parser: Parser object created
2406 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2407 run. Use when page save hooks require the presence of custom tables to ensure
2408 that tests continue to run properly.
2409 &$tables: array of table names
2411 'ParserOutputStashForEdit': Called when an edit stash parse finishes, before the output is cached.
2412 $page: the WikiPage of the candidate edit
2413 $content: the Content object of the candidate edit
2414 $output: the ParserOutput result of the candidate edit
2415 $summary: the change summary of the candidate edit
2416 $user: the User considering the edit
2418 'PasswordPoliciesForUser': Alter the effective password policy for a user.
2419 $user: User object whose policy you are modifying
2420 &$effectivePolicy: Array of policy statements that apply to this user
2421 $purpose: string indicating purpose of the check, one of 'login', 'create',
2424 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
2426 $block: Block object (which is set to be autoblocking)
2427 &$blockIds: Array of block IDs of the autoblock
2429 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2430 my talk page, my contributions" etc).
2431 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2432 &$title: Title object representing the current page
2433 $skin: SkinTemplate object providing context (e.g. to check if the user is
2436 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2437 &$user: User performing the action
2438 $action: Action being performed
2439 &$result: Whether or not the action should be prevented
2440 Change $result and return false to give a definitive answer, otherwise
2441 the built-in rate limiting checks are used, if enabled.
2442 $incrBy: Amount to increment counter by
2444 'PlaceNewSection': Override placement of new sections. Return false and put the
2445 merged text into $text to override the default behavior.
2446 $wikipage: WikiPage object
2447 $oldtext: the text of the article before editing
2448 $subject: subject of the new section
2449 &$text: text of the new section
2451 'PostLoginRedirect': Modify the post login redirect behavior.
2452 Occurs after signing up or logging in, allows for interception of redirect.
2453 &$returnTo: The page name to return to, as a string
2454 &$returnToQuery: array of url parameters, mapping parameter names to values
2455 &$type: type of login redirect as string;
2456 error: display a return to link ignoring $wgRedirectOnLogin
2457 signup: display a return to link using $wgRedirectOnLogin if needed
2458 success: display a return to link using $wgRedirectOnLogin if needed
2459 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2461 'PreferencesFormPreSave': Override preferences being saved
2462 $formData: array of user submitted data
2463 $form: PreferencesForm object, also a ContextSource
2464 $user: User object with preferences to be saved set
2465 &$result: boolean indicating success
2467 'PreferencesGetLegend': Override the text used for the <legend> of a
2468 preferences section.
2469 $form: the PreferencesForm object. This is a ContextSource as well
2470 $key: the section name
2471 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may
2474 'PrefixSearchBackend': DEPRECATED! Override SearchEngine::completionSearchBackend instead.
2475 Override the title prefix search used for OpenSearch and
2476 AJAX search suggestions. Put results into &$results outparam and return false.
2477 $ns: array of int namespace keys to search in
2478 $search: search term (not guaranteed to be conveniently normalized)
2479 $limit: maximum number of results to return
2480 &$results: out param: array of page names (strings)
2481 $offset: number of results to offset from the beginning
2483 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2484 namespace from the search string so that extensions can attempt it.
2485 &$namespaces: array of int namespace keys to search in (change this if you can
2487 &$search: search term (replace this with term without the namespace if you can
2490 'PrefsEmailAudit': Called when user changes their email address.
2491 $user: User (object) changing his email address
2492 $oldaddr: old email address (string)
2493 $newaddr: new email address (string)
2495 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2497 $article: the title being (un)protected
2498 &$output: a string of the form HTML so far
2500 'ProtectionForm::save': Called when a protection form is submitted.
2501 $article: the Page being (un)protected
2502 &$errorMsg: an html message string of an error or an array of message name and
2504 $reasonstr: a string describing the reason page protection level is altered
2506 'ProtectionForm::showLogExtract': Called after the protection log extract is
2508 $article: the page the form is shown for
2509 $out: OutputPage object
2511 'RandomPageQuery': Lets you modify the query used by Special:Random to select
2513 &$tables: Database tables to be used in the query
2514 &$conds: Conditions to be applied in the query
2515 &$joinConds: Join conditions to be applied in the query
2517 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2518 &$obj: RawAction object
2519 &$text: The text that's going to be the output
2521 'RecentChange_save': Called at the end of RecentChange::save().
2522 &$recentChange: RecentChange object
2524 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2525 names such as "oldid" that are preserved when using redirecting special pages
2526 such as Special:MyPage and Special:MyTalk.
2527 &$redirectParams: An array of parameters preserved by redirecting special pages.
2529 'RejectParserCacheValue': Return false to reject an otherwise usable
2530 cached value from the Parser cache. NOTE: CARELESS USE OF THIS HOOK CAN
2531 HAVE CATASTROPHIC CONSEQUENCES FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH
2533 $parserOutput: ParserOutput value.
2534 $wikiPage: WikiPage object.
2535 $parserOptions: ParserOptions object.
2537 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2538 instance. Can be used by an extension override what skin is used in certain
2540 $context: (IContextSource) The RequestContext the skin is being created for.
2541 &$skin: A variable reference you may set a Skin instance or string key on to
2542 override the skin that will be used for the context.
2544 'RequestHasSameOriginSecurity': Called to determine if the request is somehow
2545 flagged to lack same-origin security. Return false to indicate the lack. Note
2546 if the "somehow" involves HTTP headers, you'll probably need to make sure
2547 the header is varied on.
2548 $request: The WebRequest object.
2550 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2551 $user: The user having their password expiration reset
2552 &$newExpire: The new expiration date
2554 'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
2555 Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
2556 to override its behavior. See the module docs for more information.
2557 &$dependencies: string[] List of modules that 'mediawiki.ForeignApi' should
2559 $context: ResourceLoaderContext|null
2561 'ResourceLoaderGetConfigVars': Called at the end of
2562 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2563 configuration variables to JavaScript. Things that depend on the current page
2564 or request state must be added through MakeGlobalVariablesScript instead.
2565 &$vars: array( variable name => value )
2567 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after
2568 variables from $wgResourceLoaderLESSVars are added. Can be used to add
2569 context-based variables.
2570 &$lessVars: array of variables already added
2572 'ResourceLoaderRegisterModules': Right before modules information is required,
2573 such as when responding to a resource
2574 loader request or generating HTML output.
2575 &$resourceLoader: ResourceLoader object
2577 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2578 called after the addition of 'qunit' and MediaWiki testing resources.
2579 &$testModules: array of JavaScript testing modules. The 'qunit' framework,
2580 included in core, is fed using tests/qunit/QUnitTestResources.php.
2581 To add a new qunit module named 'myext.tests':
2582 $testModules['qunit']['myext.tests'] = array(
2583 'script' => 'extension/myext/tests.js',
2584 'dependencies' => <any module dependency you might have>
2586 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2587 added to any module.
2588 &$ResourceLoader: object
2590 'RevisionInsertComplete': Called after a revision is inserted into the database.
2591 &$revision: the Revision
2592 $data: the data stored in old_text. The meaning depends on $flags: if external
2593 is set, it's the URL of the revision text in external storage; otherwise,
2594 it's the revision text itself. In either case, if gzip is set, the revision
2596 $flags: a comma-delimited list of strings representing the options used. May
2597 include: utf8 (this will always be set for new revisions); gzip; external.
2599 'SearchableNamespaces': An option to modify which namespaces are searchable.
2600 &$arr: Array of namespaces ($nsId => $name) which will be used.
2602 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2603 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2605 $term: Search term string
2606 &$title: Outparam; set to $title object and return false for a match
2608 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2609 if nothing was found.
2610 $term: Search term string
2611 &$title: Outparam; set to $title object and return false for a match
2613 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2614 the normal operations.
2615 $allSearchTerms: Array of the search terms in all content languages
2616 &$titleResult: Outparam; the value to return. A Title object or null.
2618 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2620 $term: Search term string
2621 &$title: Current Title object that is being returned (null if none found).
2623 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2625 $title: Current Title object being displayed in search results.
2626 &$id: Revision ID (default is false, for latest)
2628 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2629 perform when page content is modified. Currently called by
2630 AbstractContent::getSecondaryDataUpdates.
2631 $title: Title of the page that is being edited.
2632 $oldContent: Content object representing the page's content before the edit.
2633 $recursive: bool indicating whether DataUpdates should trigger recursive
2634 updates (relevant mostly for LinksUpdate).
2635 $parserOutput: ParserOutput representing the rendered version of the page
2637 &$updates: a list of DataUpdate objects, to be modified or replaced by
2640 'SecuritySensitiveOperationStatus': Affect the return value from
2641 MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus().
2642 &$status: (string) The status to be returned. One of the AuthManager::SEC_*
2643 constants. SEC_REAUTH will be automatically changed to SEC_FAIL if
2644 authentication isn't possible for the current session type.
2645 $operation: (string) The operation being checked.
2646 $session: (MediaWiki\Session\Session) The current session. The
2647 currently-authenticated user may be retrieved as $session->getUser().
2648 $timeSinceAuth: (int) The time since last authentication. PHP_INT_MAX if
2649 the time of last auth is unknown, or -1 if authentication is not possible.
2651 'SelfLinkBegin': Called before a link to the current article is displayed to
2652 allow the display of the link to be customized.
2653 $nt: the Title object
2654 &$html: html to display for the link
2655 &$trail: optional text to display before $html
2656 &$prefix: optional text to display after $html
2657 &$ret: the value to return if your hook returns false
2659 'SendWatchlistEmailNotification': Return true to send watchlist email
2661 $targetUser: the user whom to send watchlist email notification
2662 $title: the page title
2663 $enotif: EmailNotification object
2665 'SessionCheckInfo': Validate a MediaWiki\Session\SessionInfo as it's being
2666 loaded from storage. Return false to prevent it from being used.
2667 &$reason: String rejection reason to be logged
2668 $info: MediaWiki\Session\SessionInfo being validated
2669 $request: WebRequest being loaded from
2670 $metadata: Array|false Metadata array for the MediaWiki\Session\Session
2671 $data: Array|false Data array for the MediaWiki\Session\Session
2673 'SessionMetadata': Add metadata to a session being saved.
2674 $backend: MediaWiki\Session\SessionBackend being saved.
2675 &$metadata: Array Metadata to be stored. Add new keys here.
2676 $requests: Array of WebRequests potentially being saved to. Generally 0-1 real
2677 request and 0+ FauxRequests.
2679 'SetupAfterCache': Called in Setup.php, after cache objects are set
2681 'ShortPagesQuery': Allow extensions to modify the query used by
2683 &$tables: tables to join in the query
2684 &$conds: conditions for the query
2685 &$joinConds: join conditions for the query
2686 &$options: options for the query
2688 'ShowMissingArticle': Called when generating the output for a non-existent page.
2689 $article: The article object corresponding to the page
2691 'ShowRawCssJs': DEPRECATED! Use the ContentGetParserOutput hook instead.
2692 Customise the output of raw CSS and JavaScript in page views.
2693 $text: Text being shown
2694 $title: Title of the custom script/stylesheet page
2695 $output: Current OutputPage object
2697 'ShowSearchHit': Customize display of search hit.
2698 $searchPage: The SpecialSearch instance.
2699 $result: The SearchResult to show
2700 $terms: Search terms, for highlighting
2701 &$link: HTML of link to the matching page. May be modified.
2702 &$redirect: HTML of redirect info. May be modified.
2703 &$section: HTML of matching section. May be modified.
2704 &$extract: HTML of content extract. May be modified.
2705 &$score: HTML of score. May be modified.
2706 &$size: HTML of page size. May be modified.
2707 &$date: HTML of of page modification date. May be modified.
2708 &$related: HTML of additional info for the matching page. May be modified.
2709 &$html: May be set to the full HTML that should be used to represent the search
2710 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2711 function returned false.
2713 'ShowSearchHitTitle': Customise display of search hit title/link.
2714 &$title: Title to link to
2715 &$text: Text to use for the link
2716 $result: The search result
2717 $terms: The search terms entered
2718 $page: The SpecialSearch object
2719 &$query: Query string to be appended to the link
2721 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins.
2722 Warning: This hook is run on each display. You should consider to use
2723 'SkinBuildSidebar' that is aggressively cached.
2725 &$bar: Sidebar content
2726 Modify $bar to add or modify sidebar portlets.
2728 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2729 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2730 the sitenotice/anonnotice.
2733 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2734 allow the normal method of notice selection/rendering to work, or change the
2735 value of $siteNotice and return false to alter it.
2736 &$siteNotice: HTML returned as the sitenotice
2739 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2741 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2742 the stock bottom scripts.
2744 'SkinAfterContent': Allows extensions to add text after the page content and
2745 article metadata. This hook should work in all skins. Set the &$data variable to
2746 the text you're going to add.
2747 &$data: (string) Text to be printed out directly (without parsing)
2750 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2752 &$bar: Sidebar contents
2753 Modify $bar to add or modify sidebar portlets.
2755 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2757 $title: displayed page title
2758 $type: 'normal' or 'history' for old/diff views
2759 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2760 message must be in HTML format, not wikitext!
2761 &$link: overridable HTML link to be passed into the message as $1
2762 &$forContent: DEPRECATED! overridable flag if copyright footer is shown in
2765 'SkinEditSectionLinks': Modify the section edit links
2766 $skin: Skin object rendering the UI
2767 $title: Title object for the title being linked to (may not be the same as
2768 the page title, if the section is included from a template)
2769 $section: The designation of the section being pointed to, to be included in
2770 the link, like "§ion=$section"
2771 $tooltip: The default tooltip. Escape before using.
2772 By default, this is wrapped in the 'editsectionhint' message.
2773 &$result: Array containing all link detail arrays. Each link detail array should
2774 contain the following keys:
2775 - targetTitle - Target Title object
2776 - text - String for the text
2777 - attribs - Array of attributes
2778 - query - Array of query parameters to add to the URL
2779 - options - Array of options for Linker::link
2780 $lang: The language code to use for the link in the wfMessage function
2782 'SkinGetPoweredBy': TODO
2783 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2784 the MediaWiki icon but plain text instead.
2787 'SkinPreloadExistence': Supply titles that should be added to link existence
2788 cache before the page is rendered.
2789 &$titles: Array of Title objects
2792 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2793 If false is returned $subpages will be used instead of the HTML
2794 subPageSubtitle() generates.
2795 If true is returned, $subpages will be ignored and the rest of
2796 subPageSubtitle() will run.
2797 &$subpages: Subpage links HTML
2799 $out: OutputPage object
2801 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2803 &$sktemplate: SkinTemplate object
2804 &$nav_urls: array of tabs
2805 &$revid: The revision id of the permanent link
2806 &$revid2: The revision id of the permanent link, second time
2808 'SkinTemplateGetLanguageLink': After building the data for a language link from
2809 which the actual html is constructed.
2810 &$languageLink: array containing data about the link. The following keys can be
2811 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2812 $languageLinkTitle: Title object belonging to the external language link.
2813 $title: Title object of the page the link belongs to.
2814 $outputPage: The OutputPage object the links are built from.
2816 'SkinTemplateNavigation': Called on content pages after the tabs have been
2817 added, but before variants have been added.
2818 &$sktemplate: SkinTemplate object
2819 &$links: Structured navigation links. This is used to alter the navigation for
2820 skins which use buildNavigationUrls such as Vector.
2822 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2823 tab is added but before variants have been added.
2824 &$sktemplate: SkinTemplate object
2825 &$links: Structured navigation links. This is used to alter the navigation for
2826 skins which use buildNavigationUrls such as Vector.
2828 'SkinTemplateNavigation::Universal': Called on both content and special pages
2829 after variants have been added.
2830 &$sktemplate: SkinTemplate object
2831 &$links: Structured navigation links. This is used to alter the navigation for
2832 skins which use buildNavigationUrls such as Vector.
2834 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2836 &$sktemplate: SkinTemplate object
2837 &$tpl: QuickTemplate engine object
2839 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2840 &$sktemplate: SkinTemplate object
2841 &$res: set to true to prevent active tabs
2843 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2844 You can either create your own array, or alter the parameters for
2846 &$sktemplate: The SkinTemplate instance.
2847 $title: Title instance for the page.
2848 $message: Visible label of tab.
2849 $selected: Whether this is a selected tab.
2850 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2851 &$classes: Array of CSS classes to apply.
2852 &$query: Query string to add to link.
2854 &$result: Complete assoc. array if you want to return true.
2856 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2857 been rendered (useful for adding more).
2858 &$sk: The QuickTemplate based skin template running the hook.
2859 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2860 extensions that add support for BaseTemplateToolbox should watch for this
2861 dummy parameter with "$dummy=false" in their code and return without echoing
2862 any HTML to avoid creating duplicate toolbox items.
2864 'SoftwareInfo': Called by Special:Version for returning information about the
2866 &$software: The array of software in format 'name' => 'version'. See
2867 SpecialVersion::softwareInformation().
2869 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2870 $sp: SpecialPage object, for context
2871 &$fields: Current HTMLForm fields
2873 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2874 $id: User id number, only provided for backwards-compatibility
2875 $user: User object representing user contributions are being fetched for
2876 $sp: SpecialPage instance, providing context
2878 'SpecialContributions::formatRow::flags': Called before rendering a
2879 Special:Contributions row.
2880 $context: IContextSource object
2881 $row: Revision information from the database
2882 &$flags: List of flags on this row
2884 'SpecialContributions::getForm::filters': Called with a list of filters to render
2885 on Special:Contributions.
2886 $sp: SpecialContributions object, for context
2887 &$filters: List of filters rendered as HTML
2889 'SpecialListusersDefaultQuery': Called right before the end of
2890 UsersPager::getDefaultQuery().
2891 $pager: The UsersPager instance
2892 &$query: The query array to be returned
2894 'SpecialListusersFormatRow': Called right before the end of
2895 UsersPager::formatRow().
2896 &$item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2897 $row: Database row object
2899 'SpecialListusersHeader': Called before closing the <fieldset> in
2900 UsersPager::getPageHeader().
2901 $pager: The UsersPager instance
2902 &$out: The header HTML
2904 'SpecialListusersHeaderForm': Called before adding the submit button in
2905 UsersPager::getPageHeader().
2906 $pager: The UsersPager instance
2907 &$out: The header HTML
2909 'SpecialListusersQueryInfo': Called right before the end of.
2910 UsersPager::getQueryInfo()
2911 $pager: The UsersPager instance
2912 &$query: The query array to be returned
2914 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2915 $type: String of the log type
2916 $request: WebRequest object for getting the value provided by the current user
2917 &$qc: Array for query conditions to add
2919 'SpecialMovepageAfterMove': Called after moving a page.
2920 &$movePage: MovePageForm object
2921 &$oldTitle: old title (object)
2922 &$newTitle: new title (object)
2924 'SpecialNewpagesConditions': Called when building sql query for
2926 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2927 $opts: FormOptions object containing special page options
2928 &$conds: array of WHERE conditionals for query
2929 &$tables: array of tables to be queried
2930 &$fields: array of columns to select
2931 &$join_conds: join conditions for the tables
2933 'SpecialNewPagesFilters': Called after building form options at NewPages.
2934 $special: the special page object
2935 &$filters: associative array of filter definitions. The keys are the HTML
2936 name/URL parameters. Each key maps to an associative array with a 'msg'
2937 (message key) and a 'default' value.
2939 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use
2940 this hook to remove a core special page or conditionally register special pages.
2941 &$list: list (array) of core special pages
2943 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2944 $special: the SpecialPage object
2945 $subPage: the subpage string or null if no subpage was specified
2947 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2948 Return false to prevent execution.
2949 $special: the SpecialPage object
2950 $subPage: the subpage string or null if no subpage was specified
2952 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2953 $name: name of the special page
2954 &$form: HTMLForm object
2956 'SpecialPasswordResetOnSubmit': When executing a form submission on
2957 Special:PasswordReset.
2958 &$users: array of User objects.
2959 $data: array of data submitted by the user
2960 &$error: string, error code (message key) used to describe to error (out
2961 parameter). The hook needs to return false when setting this, otherwise it
2962 will have no effect.
2964 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2965 use this to change some selection criteria or substitute a different title.
2966 &$randstr: The random number from wfRandom()
2967 &$isRedir: Boolean, whether to select a redirect or non-redirect
2968 &$namespaces: An array of namespace indexes to get the title from
2969 &$extra: An array of extra SQL statements
2970 &$title: If the hook returns false, a Title object to use instead of the
2971 result from the normal query
2973 'SpecialRecentChangesFilters': DEPRECATED! Use ChangesListSpecialPageFilters
2975 Called after building form options at RecentChanges.
2976 $special: the special page object
2977 &$filters: associative array of filter definitions. The keys are the HTML
2978 name/URL parameters. Each key maps to an associative array with a 'msg'
2979 (message key) and a 'default' value.
2981 'SpecialRecentChangesPanel': Called when building form options in
2982 SpecialRecentChanges.
2983 &$extraOpts: array of added items, to which can be added
2984 $opts: FormOptions for this request
2986 'SpecialRecentChangesQuery': DEPRECATED! Use ChangesListSpecialPageQuery
2988 Called when building SQL query for SpecialRecentChanges and
2989 SpecialRecentChangesLinked.
2990 &$conds: array of WHERE conditionals for query
2991 &$tables: array of tables to be queried
2992 &$join_conds: join conditions for the tables
2993 $opts: FormOptions for this request
2994 &$query_options: array of options for the database request
2995 &$select: Array of columns to select
2997 'SpecialResetTokensTokens': Called when building token list for
2999 &$tokens: array of token information arrays in the format of
3001 'preference' => '<preference-name>',
3002 'label-message' => '<message-key>',
3005 'SpecialSearchCreateLink': Called when making the message to create a page or
3006 go to the existing page.
3007 $t: title object searched for
3008 &$params: an array of the default message name and page title (as parameter)
3010 'SpecialSearchGoResult': If a hook returns false the 'go' feature will be
3011 canceled and a normal search will be performed. Returning true without setting
3012 $url does a standard redirect to $title. Setting $url redirects to the
3014 $term: The string the user searched for
3015 $title: The title the 'go' feature has decided to forward the user to
3016 &$url: Initially null, hook subscribers can set this to specify the final url to redirect to
3018 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
3019 target doesn't exist.
3020 &$title: title object generated from the text entered by the user
3022 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
3023 the advanced form, a.k.a. power search box.
3024 &$showSections: an array to add values with more options to
3025 $term: the search term (not a title object)
3026 $opts: an array of hidden options (containing 'redirs' and 'profile')
3028 'SpecialSearchProfileForm': Allows modification of search profile forms.
3029 $search: special page object
3030 &$form: String: form html
3031 $profile: String: current search profile
3032 $term: String: search term
3033 $opts: Array: key => value of hidden options for inclusion in custom forms
3035 'SpecialSearchProfiles': Allows modification of search profiles.
3036 &$profiles: profiles, which can be modified.
3038 'SpecialSearchResults': Called before search result display
3039 $term: string of search term
3040 &$titleMatches: empty or SearchResultSet object
3041 &$textMatches: empty or SearchResultSet object
3043 'SpecialSearchResultsPrepend': Called immediately before returning HTML
3044 on the search results page. Useful for including an external search
3045 provider. To disable the output of MediaWiki search output, return
3047 $specialSearch: SpecialSearch object ($this)
3049 $term: Search term specified by the user
3051 'SpecialSearchResultsAppend': Called immediately before returning HTML
3052 on the search results page. Useful for including a feedback link.
3053 $specialSearch: SpecialSearch object ($this)
3055 $term: Search term specified by the user
3057 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
3058 $search: SpecialSearch special page object
3059 $profile: String: current search profile
3060 $engine: the search engine
3062 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
3063 &$extraStats: Array to save the new stats
3064 $extraStats['<name of statistic>'] => <value>;
3065 <value> can be an array with the keys "name" and "number":
3066 "name" is the HTML to be displayed in the name column
3067 "number" is the number to be displayed.
3068 or, <value> can be the number to be displayed and <name> is the
3069 message key to use in the name column,
3070 $context: IContextSource object
3072 'SpecialUploadComplete': Called after successfully uploading a file from
3074 &$form: The SpecialUpload object
3076 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
3077 $wgVersion: Current $wgVersion for you to use
3078 &$versionUrl: Raw url to link to (eg: release notes)
3080 'SpecialWatchlistFilters': DEPRECATED! Use ChangesListSpecialPageFilters
3082 Called after building form options at Watchlist.
3083 $special: the special page object
3084 &$filters: associative array of filter definitions. The keys are the HTML
3085 name/URL parameters. Each key maps to an associative array with a 'msg'
3086 (message key) and a 'default' value.
3088 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
3089 SpecialWatchlist. Allows extensions to register custom values they have
3090 inserted to rc_type so they can be returned as part of the watchlist.
3091 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
3093 'SpecialWatchlistQuery': DEPRECATED! Use ChangesListSpecialPageQuery instead.
3094 Called when building sql query for SpecialWatchlist.
3095 &$conds: array of WHERE conditionals for query
3096 &$tables: array of tables to be queried
3097 &$join_conds: join conditions for the tables
3098 &$fields: array of query fields
3099 $opts: A FormOptions object with watchlist options for the current request
3101 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
3102 URL for a title when we have no other parameters on the URL. Gives a chance for
3103 extensions that alter page view behavior radically to abort that redirect or
3105 $request: WebRequest
3106 $title: Title of the currently found title obj
3107 $output: OutputPage object
3109 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
3110 rendered (by ThumbnailImage:toHtml method).
3111 $thumbnail: the ThumbnailImage object
3112 &$attribs: image attribute array
3113 &$linkAttribs: image link attribute array
3115 'TitleArrayFromResult': Called when creating an TitleArray object from a
3117 &$titleArray: set this to an object to override the default object returned
3118 $res: database result used to create the object
3120 'TitleExists': Called when determining whether a page exists at a given title.
3121 $title: The title being tested.
3122 &$exists: Whether the title exists.
3124 'TitleGetEditNotices': Allows extensions to add edit notices
3125 $title: The Title object for the page the edit notices are for
3126 $oldid: Revision ID that the edit notices are for (or 0 for latest)
3127 &$notices: Array of notices. Keys are i18n message keys, values are
3128 parseAsBlock()ed messages.
3130 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
3131 that can be applied.
3132 $title: The title in question.
3133 &$types: The types of protection available.
3135 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
3136 overriding default behavior for determining if a page exists. If $isKnown is
3137 kept as null, regular checks happen. If it's a boolean, this value is returned
3138 by the isKnown method.
3139 $title: Title object that is being checked
3140 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
3142 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3143 Called when determining if a page is a CSS or JS page.
3144 $title: Title object that is being checked
3145 &$result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
3146 Hooks may change this value to override the return value of
3147 Title::isCssOrJsPage().
3149 'TitleIsMovable': Called when determining if it is possible to move a page. Note
3150 that this hook is not called for interwiki pages or pages in immovable
3151 namespaces: for these, isMovable() always returns false.
3152 $title: Title object that is being checked
3153 &$result: Boolean; whether MediaWiki currently thinks this page is movable.
3154 Hooks may change this value to override the return value of
3157 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
3158 Called when determining if a page is a wikitext or should
3159 be handled by separate handler (via ArticleViewCustom).
3160 $title: Title object that is being checked
3161 &$result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
3162 Hooks may change this value to override the return value of
3163 Title::isWikitextPage()
3165 'TitleMove': Before moving an article (title).
3168 $user: user who does the move
3170 'TitleMoveStarting': Before moving an article (title), but just after the atomic DB section starts.
3173 $user: user who does the move
3175 'TitleMoveComplete': After moving an article (title), post-commit.
3178 &$user: user who did the move
3179 $pageid: database ID of the page that's been moved
3180 $redirid: database ID of the created redirect
3181 $reason: reason for the move
3182 $revision: the Revision created by the move
3184 'TitleMoveCompleting': After moving an article (title), pre-commit.
3187 $user: user who did the move
3188 $pageid: database ID of the page that's been moved
3189 $redirid: database ID of the created redirect
3190 $reason: reason for the move
3191 $revision: the Revision created by the move
3193 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
3194 or override the quick permissions check.
3195 $title: The Title object being accessed
3196 $user: The User performing the action
3197 $action: Action being performed
3198 &$errors: Array of errors
3199 $doExpensiveQueries: Whether to do expensive DB queries
3200 $short: Whether to return immediately on first error
3202 'TitleReadWhitelist': Called at the end of read permissions checks, just before
3203 adding the default error message if nothing allows the user to read the page. If
3204 a handler wants a title to *not* be whitelisted, it should also return false.
3205 $title: Title object being checked against
3206 $user: Current user object
3207 &$whitelisted: Boolean value of whether this title is whitelisted
3209 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
3210 $title: Title object to purge
3211 &$urls: An array of URLs to purge from the caches, to be manipulated.
3213 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
3214 PageArchive object has been created but before any further processing is done.
3215 &$archive: PageArchive object
3216 $title: Title object of the page that we're viewing
3218 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
3219 PageArchive object has been created but before any further processing is done.
3220 &$archive: PageArchive object
3221 $title: Title object of the page that we're viewing
3223 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
3224 the site is not in read-only mode, that the Title object is not null and after
3225 a PageArchive object has been constructed but before performing any further
3227 &$archive: PageArchive object
3228 $title: Title object of the page that we're about to undelete
3230 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
3231 $title: title object related to the revision
3232 $rev: revision (object) that will be viewed
3234 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
3235 Since 1.24: Paths pointing to a directory will be recursively scanned for
3236 test case files matching the suffix "Test.php".
3237 &$paths: list of test cases and directories to search.
3239 'UnknownAction': An unknown "action" has occurred (useful for defining your own
3241 $action: action name
3242 $article: article "acted on"
3244 'UnwatchArticle': Before a watch is removed from an article.
3245 &$user: user watching
3246 &$page: WikiPage object to be removed
3247 &$status: Status object to be returned if the hook returns false
3249 'UnwatchArticleComplete': After a watch is removed from an article.
3250 $user: user that watched
3251 &$page: WikiPage object that was watched
3253 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
3254 &$formattedPageStatus: list of valid page states
3256 'UploadComplete': Upon completion of a file upload.
3257 &$uploadBase: UploadBase (or subclass) object. File can be accessed by
3258 $uploadBase->getLocalFile().
3260 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
3261 $type: (string) the requested upload type
3262 &$className: the class name of the Upload instance to be created
3264 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
3265 poke at member variables like $mUploadDescription before the file is saved. Do
3266 not use this hook to break upload processing. This will return the user to a
3267 blank form with no error message; use UploadVerification and UploadVerifyFile
3269 &$form: UploadForm object
3271 'UploadForm:initial': Before the upload form is generated. You might set the
3272 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
3273 text (HTML) either before or after the editform.
3274 &$form: UploadForm object
3276 'UploadFormInitDescriptor': After the descriptor for the upload form as been
3278 &$descriptor: (array) the HTMLForm descriptor
3280 'UploadFormSourceDescriptors': after the standard source inputs have been
3281 added to the descriptor
3282 &$descriptor: (array) the HTMLForm descriptor
3283 &$radio: Boolean, if source type should be shown as radio button
3284 $selectedSourceType: The selected source type
3286 'UploadVerification': Additional chances to reject an uploaded file. Consider
3287 using UploadVerifyFile instead.
3288 $saveName: (string) destination file name
3289 $tempName: (string) filesystem path to the temporary file for checks
3290 &$error: (string) output: message key for message to show if upload canceled by
3291 returning false. May also be an array, where the first element is the message
3292 key and the remaining elements are used as parameters to the message.
3294 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
3295 in most cases over UploadVerification.
3296 $upload: (object) an instance of UploadBase, with all info about the upload
3297 $mime: (string) The uploaded file's MIME type, as detected by MediaWiki.
3298 Handlers will typically only apply for specific MIME types.
3299 &$error: (object) output: true if the file is valid. Otherwise, an indexed array
3300 representing the problem with the file, where the first element is the message
3301 key and the remaining elements are used as parameters to the message.
3303 'UserIsBot': when determining whether a user is a bot account
3305 &$isBot: whether this is user a bot or not (boolean)
3307 'User::mailPasswordInternal': before creation and mailing of a user's new
3309 &$user: the user who sent the message out
3310 &$ip: IP of the user who sent the message out
3311 &$u: the account whose new password will be set
3313 'UserAddGroup': Called when adding a group; return false to override
3314 stock group addition.
3315 $user: the user object that is to have a group added
3316 &$group: the group to add, can be modified
3318 'UserArrayFromResult': Called when creating an UserArray object from a database
3320 &$userArray: set this to an object to override the default object returned
3321 $res: database result used to create the object
3323 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
3324 want to display an error message, try getUserPermissionsErrors.
3325 &$title: Title object being checked against
3326 &$user: Current user object
3327 $action: Action being checked
3328 &$result: Pointer to result returned if hook returns false. If null is returned,
3329 userCan checks are continued by internal code.
3331 'UserCanSendEmail': To override User::canSendEmail() permission check.
3332 &$user: User (object) whose permission is being checked
3333 &$canSend: bool set on input, can override on output
3335 'UserClearNewTalkNotification': Called when clearing the "You have new
3336 messages!" message, return false to not delete it.
3337 &$user: User (object) that will clear the message
3338 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
3340 'UserCreateForm': DEPRECATED! Create an AuthenticationProvider instead.
3341 Manipulate the login form.
3342 &$template: SimpleTemplate instance for the form
3344 'UserEffectiveGroups': Called in User::getEffectiveGroups().
3345 &$user: User to get groups for
3346 &$groups: Current effective groups
3348 'UserGetAllRights': After calculating a list of all available rights.
3349 &$rights: Array of rights, which may be added to.
3351 'UserGetDefaultOptions': After fetching the core default, this hook is run right
3352 before returning the options to the caller. Warning: This hook is called for
3353 every call to User::getDefaultOptions(), which means it's potentially called
3354 dozens or hundreds of times. You may want to cache the results of non-trivial
3355 operations in your hook function for this reason.
3356 &$defaultOptions: Array of preference keys and their default values.
3358 'UserGetEmail': Called when getting an user email address.
3360 &$email: email, change this to override local email
3362 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3363 email authentication.
3365 &$timestamp: timestamp, change this to override local email authentication
3368 'UserGetImplicitGroups': DEPRECATED!
3369 Called in User::getImplicitGroups().
3370 &$groups: List of implicit (automatically-assigned) groups
3372 'UserGetLanguageObject': Called when getting user's interface language object.
3374 &$code: Language code that will be used to create the object
3375 $context: IContextSource object
3377 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3378 &$reservedUsernames: $wgReservedUsernames
3380 'UserGetRights': Called in User::getRights().
3381 $user: User to get rights for
3382 &$rights: Current rights
3384 'UserGroupsChanged': Called after user groups are changed.
3385 $user: User whose groups changed
3386 $added: Groups added
3387 $removed: Groups removed
3388 $performer: User who performed the change, false if via autopromotion
3389 $reason: The reason, if any, given by the user performing the change,
3390 false if via autopromotion.
3392 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3393 specific block exemptions).
3394 $user: User in question
3395 $title: Title of the page in question
3396 &$blocked: Out-param, whether or not the user is blocked from that page.
3397 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3398 to edit their own user talk pages.
3400 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3402 $ip: User's IP address
3403 &$blocked: Whether the user is blocked, to be modified by the hook
3404 &$block: The Block object, to be modified by the hook
3406 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3407 false if a UserGetRights hook might remove the named right.
3408 $right: The user right being checked
3410 'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
3411 $user: User in question.
3412 &$hidden: Set true if the user's name should be hidden.
3414 'UserIsLocked': Check if the user is locked. See User::isLocked().
3415 $user: User in question.
3416 &$locked: Set true if the user should be locked.
3418 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3419 environmental means; occurs after session is loaded.
3420 $user: user object being loaded
3422 'UserLoadDefaults': Called when loading a default user.
3426 'UserLoadFromDatabase': Called when loading a user from the database.
3428 &$s: database query object
3430 'UserLoadFromSession': DEPRECATED! Create a MediaWiki\Session\SessionProvider instead.
3431 Called to authenticate users on external/environmental means; occurs before
3433 $user: user object being loaded
3434 &$result: set this to a boolean value to abort the normal authentication
3437 'UserLoadOptions': When user options/preferences are being loaded from the
3440 &$options: Options, can be modified.
3442 'UserLoggedIn': Called after a user is logged in
3443 $user: User object for the logged-in user
3445 'UserLoginComplete': Show custom content after a user has logged in via the web interface.
3446 For functionality that needs to run after any login (API or web) use UserLoggedIn.
3447 &$user: the user object that was created on login
3448 &$inject_html: Any HTML to inject after the "logged in" message.
3450 'UserLoginForm': DEPRECATED! Create an AuthenticationProvider instead.
3451 Manipulate the login form.
3452 &$template: QuickTemplate instance for the form
3454 'UserLogout': Before a user logs out.
3455 &$user: the user object that is about to be logged out
3457 'UserLogoutComplete': After a user has logged out.
3458 &$user: the user object _after_ logout (won't have name, ID, etc.)
3459 &$inject_html: Any HTML to inject after the "logged out" message.
3460 $oldName: name of the user before logout (string)
3462 'UserMailerChangeReturnPath': Called to generate a VERP return address
3463 when UserMailer sends an email, with a bounce handling extension.
3464 $to: Array of MailAddress objects for the recipients
3465 &$returnPath: The return address string
3467 'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
3468 to split up an email with multiple the To: field into separate emails.
3469 &$to: array of MailAddress objects; unset the ones which should be mailed separately
3471 'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
3472 Extensions can block sending the email by returning false and setting $error.
3473 $to: array of MailAdresses of the targets
3474 $from: MailAddress of the sender
3475 &$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
3476 &$error: should be set to an error message string
3478 'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
3479 the MIME transform. Extensions can block sending the email by returning false and setting $error.
3480 $to: array of MailAdresses of the targets
3481 $from: MailAddress of the sender
3482 &$subject: email subject (not MIME encoded)
3483 &$headers: email headers (except To: and Subject:) as an array of header name => value pairs
3484 &$body: email body (in MIME format) as a string
3485 &$error: should be set to an error message string
3487 'UserRemoveGroup': Called when removing a group; return false to override stock
3489 $user: the user object that is to have a group removed
3490 &$group: the group to be removed, can be modified
3492 'UserRequiresHTTPS': Called to determine whether a user needs
3493 to be switched to HTTPS.
3494 $user: User in question.
3495 &$https: Boolean whether $user should be switched to HTTPS.
3497 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3498 have been requested to be reset. This hook can be used to exclude certain
3499 options from being reset even when the user has requested all prefs to be reset,
3500 because certain options might be stored in the user_properties database table
3501 despite not being visible and editable via Special:Preferences.
3502 $user: the User (object) whose preferences are being reset
3503 &$newOptions: array of new (site default) preferences
3504 $options: array of the user's old preferences
3505 $resetKinds: array containing the kinds of preferences to reset
3507 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3509 &$user: user retrieving new talks messages
3510 &$talks: array of new talks page(s)
3512 'UserRights': DEPRECATED! Use UserGroupsChanged instead.
3513 After a user's group memberships are changed.
3514 &$user: User object that was changed
3515 $add: Array of strings corresponding to groups added
3516 $remove: Array of strings corresponding to groups removed
3518 'UserSaveOptions': Called just before saving user preferences/options.
3520 &$options: Options, modifiable
3522 'UserSaveSettings': Called when saving user settings.
3525 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie
3526 handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider
3527 instead. Otherwise, you can no longer count on user data being saved to cookies
3528 versus some other mechanism.
3529 Called when setting user cookies.
3531 &$session: session array, will be added to the session
3532 &$cookies: cookies array mapping cookie name to its value
3534 'UserSetEmail': Called when changing user email address.
3536 &$email: new email, change this to override new email address
3538 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3539 email authentication.
3541 &$timestamp: new timestamp, change this to override local email
3542 authentication timestamp
3544 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3545 "Foobar (Talk | Contribs | Block)".
3546 $userId: User id of the current user
3547 $userText: User name of the current user
3548 &$items: Array of user tool links as HTML fragments
3550 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3551 FormatMetadata::getExtendedMeta (return false means cache will be
3552 invalidated and GetExtendedMetadata hook called again).
3553 $timestamp: The timestamp metadata was generated
3554 $file: The file the metadata is for
3556 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3557 used to alter the SQL query which gets the list of wanted pages.
3558 &$wantedPages: WantedPagesPage object
3559 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3561 'WatchArticle': Before a watch is added to an article.
3562 &$user: user that will watch
3563 &$page: WikiPage object to be watched
3564 &$status: Status object to be returned if the hook returns false
3566 'WatchArticleComplete': After a watch is added to an article.
3567 &$user: user that watched
3568 &$page: WikiPage object watched
3570 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3571 form, used to manipulate the list of pages or preload data based on that list.
3572 &$watchlistInfo: array of watchlisted pages in
3573 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3575 'WatchlistEditorBuildRemoveLine': when building remove lines in
3576 Special:Watchlist/edit.
3577 &$tools: array of extra links
3578 $title: Title object
3579 $redirect: whether the page is a redirect
3581 &$link: HTML link to title
3583 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3585 $router: The PathRouter instance
3587 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3588 Return false to prevent setting of the cookie.
3589 &$name: Cookie name passed to WebResponse::setcookie()
3590 &$value: Cookie value passed to WebResponse::setcookie()
3591 &$expire: Cookie expiration, as for PHP's setcookie()
3592 &$options: Options passed to WebResponse::setcookie()
3594 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3595 run a MediaWiki cli script.
3596 &$script: MediaWiki cli script path
3597 &$parameters: Array of arguments and options to the script
3598 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3601 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3602 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3603 &$qp: The list of QueryPages
3605 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3606 $row: The DB row of the entry.
3607 $title: The Title of the page where the link comes FROM
3608 $target: The Title of the page where the link goes TO
3609 &$props: Array of HTML strings to display after the title.
3611 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3612 dumps. One, and only one hook should set this, and return false.
3613 &$tables: Database tables to use in the SELECT query
3614 &$opts: Options to use for the query
3615 &$join: Join conditions
3617 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3618 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3619 specific to a content model should be provided by the respective Content's
3620 getDeletionUpdates() method.
3622 $content: the Content to generate updates for
3623 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3625 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3626 extra metadata to be added.
3627 $obj: The XmlDumpWriter object.
3628 &$out: The output string.
3629 $row: The database row for the page.
3630 $title: The title of the page.
3632 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3634 &$obj: The XmlDumpWriter object.
3635 &$out: The text being output.
3636 $row: The database row for the revision.
3637 $text: The revision text.
3639 More hooks might be available but undocumented, you can execute
3640 "php maintenance/findHooks.php" to find hidden ones.