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', 'ArticleSave', 'ArticleSaveComplete',
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 (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('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['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = 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 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation,
238 where normally authentication against an external auth plugin would be creating
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
253 $rc: The current RecentChange object.
255 'AbortLogin': Return false to cancel account login.
256 $user: the User object being authenticated against
257 $password: the password being submitted, not yet checked for validity
258 &$retval: a LoginForm class constant to return from authenticateUserData();
259 default is LoginForm::ABORTED. Note that the client may be using
260 a machine API rather than the HTML user interface.
261 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: HTML to display on abort
266 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
267 Create the object with Status::newFatal() to ensure proper API error messages
268 are returned when creating account through API clients.
270 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
271 $targetUser: the user whom to send talk page email notification
272 $title: the page title
274 'SendWatchlistEmailNotification': Return true to send watchlist email notification
275 $targetUser: the user whom to send watchlist email notification
276 $title: the page title
277 $enotif: EmailNotification object
279 'AbortChangePassword': Return false to cancel password change.
280 $user: the User object to which the password change is occuring
281 $mOldpass: the old password provided by the user
282 $newpass: the new password provided by the user
283 &$abortMsg: the message identifier for abort reason
285 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
286 $name: name of the action
287 &$form: HTMLForm object
288 $article: Article object
290 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
291 Allows to change the fields on the form that will be generated.
292 $name: name of the action
293 &$fields: HTMLForm descriptor array
294 $article: Article object
296 'AddNewAccount': 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 account via API.
301 $apiModule: the ApiCreateAccount module calling
302 $loginForm: the LoginForm used
304 'AddNewAccountApiResult': Modify API output when creating a new account via API.
305 $apiModule: the ApiCreateAccount module calling
306 $loginForm: the LoginForm used
307 &$result: associative array for API result data
309 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
310 before OutputPage::sendCacheControl() and final ob_end_flush() which
311 will send the buffered output to the client. This allows for last-minute
312 modification of the output within the buffer by using ob_get_clean().
313 $output: The OutputPage object where output() was called
315 'AfterImportPage': When a page import is completed.
316 $title: Title under which the revisions were imported
317 $origTitle: Title provided by the XML file
318 $revCount: Number of revisions in the XML file
319 $sRevCount: Number of successfully imported revisions
320 $pageInfo: associative array of page information
322 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
323 just before adding its HTML to parser output.
324 $parser: Parser object that called the hook
325 $ig: Gallery, an object of one of the gallery classes (inheriting from
327 $html: HTML generated by the gallery
329 'AlternateEdit': Before checking if a user can edit a page and before showing
330 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
331 $editPage: the EditPage object
333 'AlternateEditPreview': Before generating the preview of the page when editing
334 ( EditPage::getPreviewText() ).
335 $editPage: the EditPage object
336 &$content: the Content object for the text field from the edit page
337 &$previewHTML: Text to be placed into the page for the preview
338 &$parserOutput: the ParserOutput object for the preview
339 return false and set $previewHTML and $parserOutput to output custom page
342 'AlternateUserMailer': Called before mail is sent so that mail could be logged
343 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
344 the regular method of sending mail. Return a string to return a php-mail-error
345 message containing the error. Returning true will continue with sending email
347 $headers: Associative array of headers for the email
348 $to: MailAddress object or array
350 $subject: Subject of the email
351 $body: Body of the message
353 'APIAfterExecute': After calling the execute() method of an API module. Use
354 this to extend core API modules.
355 &$module: Module object
357 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
358 &$main: ApiMain object
360 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
361 authenticate and authorize API clients before executing the module. Return
362 false and set a message to cancel the request.
363 $module: Module object
365 &$message: API usage message to die with, as a message key or array
366 as accepted by ApiBase::dieUsageMsg.
368 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
369 processing request parameters. Return false to let the request fail, returning
370 an error message or an <edit result="Failure"> tag if $resultArr was filled.
371 $editPage : the EditPage object
372 $text : the new text of the article (has yet to be saved)
373 &$resultArr : data in this array will be added to the API result
375 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
376 highlighting, add output to $context->getOutput() and return false.
377 $context: An IContextSource.
378 $text: Text to be highlighted.
379 $mime: MIME type of $text.
380 $format: API format code for $text.
382 'APIGetAllowedParams': Use this hook to modify a module's parameters.
383 &$module: ApiBase Module object
384 &$params: Array of parameters
385 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
387 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
388 Use this hook to modify a module's description.
389 &$module: ApiBase Module object
390 &$desc: String description, or array of description strings
392 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
393 $module: ApiBase Module object
394 &$msg: Array of Message objects
396 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages instead.
397 Use this hook to modify a module's parameter descriptions.
398 &$module: ApiBase Module object
399 &$desc: Array of parameter descriptions
401 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter descriptions.
402 $module: ApiBase Module object
403 &$msg: Array of arrays of Message objects
405 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
406 $module: ApiBase Module object
407 &$help: Array of HTML strings to be joined for the output.
408 $options: Array Options passed to ApiHelp::getHelp
410 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
411 can alter or append to the array.
412 &$results: array of associative arrays. Keys are:
413 - title: Title object.
414 - redirect from: Title or null.
415 - extract: Description for this result.
416 - extract trimmed: If truthy, the extract will not be trimmed to
417 $wgOpenSearchDescriptionLength.
418 - image: Thumbnail for this result. Value is an array with subkeys 'source'
419 (url), 'width', 'height', 'alt', 'align'.
420 - url: Url for the given title.
422 'APIQueryAfterExecute': After calling the execute() method of an
423 action=query submodule. Use this to extend core API modules.
424 &$module: Module object
426 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
427 an action=query submodule. Use this to extend core API modules.
428 &$module: Module object
429 &$resultPageSet: ApiPageSet object
431 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
432 Use this hook to add custom tokens to prop=info. Every token has an action,
433 which will be used in the intoken parameter and in the output
434 (actiontoken="..."), and a callback function which should return the token, or
435 false if the user isn't allowed to obtain it. The prototype of the callback
436 function is func($pageid, $title), where $pageid is the page ID of the page the
437 token is requested for and $title is the associated Title object. In the hook,
438 just add your callback to the $tokenFunctions array and return true (returning
439 false makes no sense).
440 $tokenFunctions: array(action => callback)
442 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
443 Use this hook to add custom tokens to prop=revisions. Every token has an
444 action, which will be used in the rvtoken parameter and in the output
445 (actiontoken="..."), and a callback function which should return the token, or
446 false if the user isn't allowed to obtain it. The prototype of the callback
447 function is func($pageid, $title, $rev), where $pageid is the page ID of the
448 page associated to the revision the token is requested for, $title the
449 associated Title object and $rev the associated Revision object. In the hook,
450 just add your callback to the $tokenFunctions array and return true (returning
451 false makes no sense).
452 $tokenFunctions: array(action => callback)
454 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
455 Use this hook to add custom tokens to list=recentchanges. Every token has an
456 action, which will be used in the rctoken parameter and in the output
457 (actiontoken="..."), and a callback function which should return the token, or
458 false if the user isn't allowed to obtain it. The prototype of the callback
459 function is func($pageid, $title, $rc), where $pageid is the page ID of the
460 page associated to the revision the token is requested for, $title the
461 associated Title object and $rc the associated RecentChange object. In the
462 hook, just add your callback to the $tokenFunctions array and return true
463 (returning false makes no sense).
464 $tokenFunctions: array(action => callback)
466 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
467 sites general information.
468 $module: the current ApiQuerySiteInfo module
469 &$results: array of results, add things here
471 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
472 sites statistics information.
473 &$results: array of results, add things here
475 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
476 action=query&meta=tokens. Note that most modules will probably be able to use
477 the 'csrf' token instead of creating their own token types.
478 &$salts: array( type => salt to pass to User::getEditToken() )
480 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
481 Use this hook to add custom token to list=users. Every token has an action,
482 which will be used in the ustoken parameter and in the output
483 (actiontoken="..."), and a callback function which should return the token, or
484 false if the user isn't allowed to obtain it. The prototype of the callback
485 function is func($user) where $user is the User object. In the hook, just add
486 your callback to the $tokenFunctions array and return true (returning false
488 $tokenFunctions: array(action => callback)
490 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
491 an exception is thrown during API action execution.
492 $apiMain: Calling ApiMain instance.
493 $e: Exception object.
495 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
496 should have its own entry in the $apis array and have a unique name, passed as
497 key for the array that represents the service data. In this data array, the
498 key-value-pair identified by the apiLink key is required.
499 &$apis: array of services
501 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
502 Use this hook to extend action=tokens with new token types.
503 &$tokenTypes: supported token types in format 'type' => callback function
504 used to retrieve this type of tokens.
506 'Article::MissingArticleConditions': Before fetching deletion & move log entries
507 to display a message of a non-existing page being deleted/moved, give extensions
508 a chance to hide their (unrelated) log entries.
509 &$conds: Array of query conditions (all of which have to be met; conditions will
510 AND in the final query)
511 $logTypes: Array of log types being queried
513 'ArticleAfterFetchContent': After fetching content of an article from the
514 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
515 $article: the article (object) being loaded from the database
516 &$content: the content (string) of the article
518 'ArticleAfterFetchContentObject': After fetching content of an article from the
520 $article: the article (object) being loaded from the database
521 &$content: the content of the article, as a Content object
523 'ArticleConfirmDelete': Before writing the confirmation form for article
525 $article: the article (object) being deleted
526 $output: the OutputPage object
527 &$reason: the reason (string) the article is being deleted
529 'ArticleContentOnDiff': Before showing the article content below a diff. Use
530 this to change the content in this area or how it is loaded.
531 $diffEngine: the DifferenceEngine
532 $output: the OutputPage object
534 'ArticleDelete': Before an article is deleted.
535 $wikiPage: the WikiPage (object) being deleted
536 $user: the user (object) deleting the article
537 $reason: the reason (string) the article is being deleted
538 $error: if the deletion was prohibited, the (raw HTML) error message to display
540 $status: Status object, modify this to throw an error. Overridden by $error
543 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
544 $title: Title of the article that has been deleted.
545 $outputPage: OutputPage that can be used to append the output.
547 'ArticleDeleteComplete': After an article is deleted.
548 $wikiPage: the WikiPage that was deleted
549 $user: the user that deleted the article
550 $reason: the reason the article was deleted
551 $id: id of the article that was deleted
552 $content: the Content of the deleted page
553 $logEntry: the ManualLogEntry used to record the deletion
555 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
557 &$wikiPage: WikiPage (object) of the user talk page
558 $recipient: User (object) who's talk page was edited
560 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
561 article has been changed.
562 $wikiPage: the WikiPage (object)
563 $editInfo: data holder that includes the parser output ($editInfo->output) for
564 that page after the change
565 $changed: bool for if the page was changed
567 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
568 recentchanges table, return false to not delete old entries.
569 $wikiPage: WikiPage (object) being modified
571 'ArticleFromTitle': when creating an article object from a title object using
572 Wiki::articleFromTitle().
573 $title: Title (object) used to create the article object
574 $article: Article (object) that will be returned
575 $context: IContextSource (object)
577 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
578 PageContentInsertComplete.
579 $wikiPage: WikiPage created
580 $user: User creating the article
582 $summary: Edit summary/comment
583 $isMinor: Whether or not the edit was marked as minor
584 $isWatch: (No longer used)
585 $section: (No longer used)
586 $flags: Flags passed to WikiPage::doEditContent()
587 $revision: New Revision of the article
589 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
590 $targetTitle: target title (object)
591 $destTitle: destination title (object)
593 'ArticlePageDataAfter': After loading data of an article from the database.
594 $wikiPage: WikiPage (object) whose data were loaded
595 $row: row (object) returned from the database server
597 'ArticlePageDataBefore': Before loading data of an article from the database.
598 $wikiPage: WikiPage (object) that data will be loaded
599 $fields: fields (array) to load from the database
601 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
602 $wikiPage: the WikiPage being saved
603 $popts: parser options to be used for pre-save transformation
605 'ArticleProtect': Before an article is protected.
606 $wikiPage: the WikiPage being protected
607 $user: the user doing the protection
608 $protect: boolean whether this is a protect or an unprotect
609 $reason: Reason for protect
610 $moveonly: boolean whether this is for move only or not
612 'ArticleProtectComplete': After an article is protected.
613 $wikiPage: the WikiPage that was protected
614 $user: the user who did the protection
615 $protect: boolean whether it was a protect or an unprotect
616 $reason: Reason for protect
617 $moveonly: boolean whether it was for move only or not
619 'ArticlePurge': Before executing "&action=purge".
620 $wikiPage: WikiPage (object) to purge
622 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
623 revisions of an article.
624 &$title: Title object of the article
626 'ArticleRevisionUndeleted': After an article revision is restored.
627 $title: the article title
628 $revision: the revision
629 $oldPageID: the page ID of the revision when archived (may be null)
631 'ArticleRollbackComplete': After an article rollback is completed.
632 $wikiPage: the WikiPage that was edited
633 $user: the user who did the rollback
634 $revision: the revision the page was reverted back to
635 $current: the reverted revision
637 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
639 $wikiPage: the WikiPage (object) being saved
640 $user: the user (object) saving the article
641 $text: the new article text
642 $summary: the article summary (comment)
647 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
648 PageContentSaveComplete instead.
649 $wikiPage: WikiPage modified
650 $user: User performing the modification
652 $summary: Edit summary/comment
653 $isMinor: Whether or not the edit was marked as minor
654 $isWatch: (No longer used)
655 $section: (No longer used)
656 $flags: Flags passed to WikiPage::doEditContent()
657 $revision: New Revision of the article
658 $status: Status object about to be returned by doEditContent()
659 $baseRevId: the rev ID (or false) this edit was based on
661 'ArticleUndelete': When one or more revisions of an article are restored.
662 $title: Title corresponding to the article restored
663 $create: Whether or not the restoration caused the page to be created (i.e. it
664 didn't exist before).
665 $comment: The comment associated with the undeletion.
666 $oldPageId: ID of page previously deleted (from archive table)
668 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
669 $pageArchive: the PageArchive object
670 &$logEntry: ManualLogEntry object
671 $user: User who is performing the log action
673 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
674 the user is redirected back to the page.
675 &$article: the article
676 &$sectionanchor: The section anchor link (e.g. "#overview" )
677 &$extraq: Extra query parameters which can be added via hooked functions
679 'ArticleViewFooter': After showing the footer section of an ordinary page view
680 $article: Article object
681 $patrolFooterShown: boolean whether patrol footer is shown
683 'ArticleViewHeader': Before the parser cache is about to be tried for article
685 &$article: the article
686 &$pcache: whether to try the parser cache or not
687 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
688 object to both indicate that the output is done and what parser output was used.
690 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
691 redirect was followed.
692 $article: target article (object)
694 'ArticleViewCustom': Allows to output the text of the article in a different
695 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
696 that it is preferable to implement proper handing for a custom data type using
697 the ContentHandler facility.
698 $text: text of the page
699 $title: title of the page
700 $output: reference to $wgOut
702 'ArticleContentViewCustom': Allows to output the text of the article in a
703 different format than wikitext. Note that it is preferable to implement proper
704 handing for a custom data type using the ContentHandler facility.
705 $content: content of the page, as a Content object
706 $title: title of the page
707 $output: reference to $wgOut
709 'AuthPluginAutoCreate': Called when creating a local account for an user logged
710 in from an external authentication method.
711 $user: User object created locally
713 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
714 Gives a chance for an extension to set it programmatically to a variable class.
715 &$auth: the $wgAuth object, probably a stub
717 'AutopromoteCondition': Check autopromote condition for user.
718 $type: condition type
721 $result: result of checking autopromote condition
723 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
727 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
728 certain title are fetched.
730 $title: title of the page to which backlinks are sought
731 &$conds: query conditions
733 'BadImage': When checking against the bad image list. Change $bad and return
734 false to override. If an image is "bad", it is not rendered inline in wiki
735 pages or galleries in category pages.
736 $name: Image name being checked
737 &$bad: Whether or not the image is "bad"
739 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
740 custom HTML after the section. Any uses of the hook need to handle escaping.
741 $template BaseTemplate
742 $portlet: string portlet name
745 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
746 "noarticletext-nopermission" at Article::showMissingArticle().
747 $article: article object
749 'BeforeInitialize': Before anything is initialized in
750 MediaWiki::performRequest().
751 &$title: Title being used for request
753 &$output: OutputPage object
755 $request: WebRequest object
756 $mediaWiki: Mediawiki object
758 'BeforePageDisplay': Prior to outputting a page.
759 &$out: OutputPage object
762 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
763 override how the redirect is output by modifying, or by returning false, and
764 letting standard HTTP rendering take place.
765 ATTENTION: This hook is likely to be removed soon due to overall design of the system.
766 $context: IContextSource object
767 &$redirect: string URL, modifiable
769 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
770 override how the redirect is output by modifying, or by returning false and
771 taking over the output.
772 $out: OutputPage object
773 &$redirect: URL, modifiable
774 &$code: HTTP code (eg '301' or '302'), modifiable
776 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
777 $parser: Parser object
779 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
780 as a key then the file will appear as a broken thumbnail.
781 &$descQuery: query string to add to thumbnail URL
783 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
784 $parser: Parser object
785 $title: title of the template
786 &$skip: skip this template and link it?
787 &$id: the id of the revision being parsed
789 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
790 &$parser: Parser object
791 &$ig: ImageGallery object
793 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
795 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
796 to a newly created user account.
797 &$injected_html: Any HTML to inject after the "logged in" message of a newly
800 'BitmapHandlerTransform': before a file is transformed, gives extension the
801 possibility to transform it themselves
802 $handler: BitmapHandler
804 &$scalerParams: Array with scaler parameters
805 &$mto: null, set to a MediaTransformOutput
807 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
808 normalizations have been performed, except for the $wgMaxImageArea check.
810 &$params: Array of parameters
811 &$checkImageAreaHookResult: null, set to true or false to override the
812 $wgMaxImageArea check result.
814 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
816 $block: Block object (which is set to be autoblocking)
817 &$blockIds: Array of block IDs of the autoblock
819 'BlockIp': Before an IP address or user is blocked.
820 $block: the Block object about to be saved
821 $user: the user _doing_ the block (not the one being blocked)
822 &$reason: if the hook is aborted, the error message to be returned in an array
824 'BlockIpComplete': After an IP address or user is blocked.
825 $block: the Block object that was saved
826 $user: the user who did the block (not the one being blocked)
828 'BookInformation': Before information output on Special:Booksources.
829 $isbn: ISBN to show information for
830 $output: OutputPage object in use
832 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
833 to be able to access the wiki via HTTPS.
834 $ip: The IP address in human-readable form
835 &$canDo: This reference should be set to false if the client may not be able
838 'CanonicalNamespaces': For extensions adding their own namespaces or altering
840 Note that if you need to specify namespace protection or content model for
841 a namespace that is added in a CanonicalNamespaces hook handler, you
842 should do so by altering $wgNamespaceProtection and
843 $wgNamespaceContentModels outside the handler, in top-level scope. The
844 point at which the CanonicalNamespaces hook fires is too late for altering
845 these variables. This applies even if the namespace addition is
846 conditional; it is permissible to declare a content model and protection
847 for a namespace and then decline to actually register it.
848 &$namespaces: Array of namespace numbers with corresponding canonical names
850 'CategoryAfterPageAdded': After a page is added to a category.
851 $category: Category that page was added to
852 $wikiPage: WikiPage that was added
854 'CategoryAfterPageRemoved': After a page is removed from a category.
855 $category: Category that page was removed from
856 $wikiPage: WikiPage that was removed
858 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
859 $catpage: CategoryPage instance
861 'ChangePasswordForm': For extensions that need to add a field to the
862 ChangePassword form via the Preferences form.
863 &$extraFields: An array of arrays that hold fields like would be passed to the
866 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
867 &$changesList: ChangesList instance.
868 &$articlelink: HTML of link to article (already filled-in).
869 &$s: HTML of row that is being constructed.
870 &$rc: RecentChange instance.
871 $unpatrolled: Whether or not we are showing unpatrolled changes.
872 $watched: Whether or not the change is watched by the user.
874 'ChangesListInitRows': Batch process change list rows prior to rendering.
875 $changesList: ChangesList instance
876 $rows: The data that will be rendered. May be a ResultWrapper instance or
879 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
880 $special: ChangesListSpecialPage instance
881 &$filters: associative array of filter definitions. The keys are the HTML
882 name/URL parameters. Each key maps to an associative array with a 'msg'
883 (message key) and a 'default' value.
885 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
886 $name: name of the special page, e.g. 'Watchlist'
887 &$tables: array of tables to be queried
888 &$fields: array of columns to select
889 &$conds: array of WHERE conditionals for query
890 &$query_options: array of options for the database request
891 &$join_conds: join conditions for the tables
892 $opts: FormOptions for this request
894 'LoginUserMigrated': Called during login to allow extensions the opportunity to
895 inform a user that their username doesn't exist for a specific reason, instead
896 of letting the login form give the generic error message that the account does
897 not exist. For example, when the account has been renamed or deleted.
898 $user: the User object being authenticated against.
899 &$msg: the message identifier for abort reason, or an array to pass a message
902 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
903 $collationName: Name of the collation in question
904 &$collationObject: Null. Replace with a subclass of the Collation class that
905 implements the collation given in $collationName.
907 'ConfirmEmailComplete': Called after a user's email has been confirmed
909 $user: user (object) whose email is being confirmed
911 'ContentHandlerDefaultModelFor': Called when the default content model is determined
912 for a given title. May be used to assign a different model for that title.
913 $title: the Title in question
914 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
916 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
917 content model name, but no entry for that model exists in $wgContentHandlers.
918 $modeName: the requested content model name
919 &$handler: set this to a ContentHandler object, if desired.
921 'ContentModelCanBeUsedOn': Called to determine whether that content model can
922 be used on a given page. This is especially useful to prevent some content models
923 to be used in some special location.
924 $contentModel: ID of the content model in question
925 $title: the Title in question.
926 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
927 Handler functions that modify $ok should generally return false to prevent further
928 hooks from further modifying $ok.
930 'ContentGetParserOutput': Customize parser output for a given content object,
931 called by AbstractContent::getParserOutput. May be used to override the normal
932 model-specific rendering of page content.
933 $content: The Content to render
934 $title: Title of the page, as context
935 $revId: The revision ID, as context
936 $options: ParserOptions for rendering. To avoid confusing the parser cache,
937 the output can only depend on parameters provided to this hook function, not on global state.
938 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
939 generation of HTML may be skipped, but other information should still be present in the
941 &$output: ParserOutput, to manipulate or replace
943 'ContentAlterParserOutput': Modify parser output for a given content object.
944 Called by Content::getParserOutput after parsing has finished. Can be used
945 for changes that depend on the result of the parsing but have to be done
946 before LinksUpdate is called (such as adding tracking categories based on
948 $content: The Content to render
949 $title: Title of the page, as context
950 $parserOutput: ParserOutput to manipulate
952 'ConvertContent': Called by AbstractContent::convert when a conversion to another
953 content model is requested.
954 $content: The Content object to be converted.
955 $toModel: The ID of the content model to convert to.
956 $lossy: boolean indicating whether lossy conversion is allowed.
957 &$result: Output parameter, in case the handler function wants to provide a
958 converted Content object. Note that $result->getContentModel() must return $toModel.
959 Handler functions that modify $result should generally return false to further
960 attempts at conversion.
962 'ContribsPager::getQueryInfo': Before the contributions query is about to run
963 &$pager: Pager object for contributions
964 &$queryInfo: The query for the contribs Pager
966 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
967 &$data: an array of results of all contribs queries
968 $pager: The ContribsPager object hooked into
969 $offset: Index offset, inclusive
970 $limit: Exact query limit
971 $descending: Query direction, false for ascending, true for descending
973 'ContributionsLineEnding': Called before a contributions HTML line is finished
974 $page: SpecialPage object for contributions
976 $row: the DB row for this line
977 &$classes: the classes to add to the surrounding <li>
979 'ContributionsToolLinks': Change tool links above Special:Contributions
981 $title: User page title
982 &$tools: Array of tool links
984 'CustomEditor': When invoking the page editor
985 $article: Article being edited
986 $user: User performing the edit
988 Return true to allow the normal editor to be used, or false
989 if implementing a custom editor, e.g. for a special namespace,
992 'DatabaseOraclePostInit': Called after initialising an Oracle database
993 &$db: the DatabaseOracle object
995 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
996 $title: the diff page title (nullable)
997 &$oldId: the actual old Id to use in the diff
998 &$newId: the actual new Id to use in the diff (0 means current)
999 $old: the ?old= param value from the url
1000 $new: the ?new= param value from the url
1002 'DiffRevisionTools': Override or extend the revision tools available from the
1003 diff view, i.e. undo, etc.
1004 $newRev: Revision object of the "new" revision
1005 &$links: Array of HTML links
1006 $oldRev: Revision object of the "old" revision (may be null)
1008 'DiffViewHeader': Called before diff display
1009 $diff: DifferenceEngine object that's calling
1010 $oldRev: Revision object of the "old" revision (may be null/invalid)
1011 $newRev: Revision object of the "new" revision
1013 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1015 $article: article (object) being viewed
1016 $oldid: oldid (int) being viewed
1018 'DoEditSectionLink': Override the HTML generated for section edit links
1019 $skin: Skin object rendering the UI
1020 $title: Title object for the title being linked to (may not be the same as
1021 the page title, if the section is included from a template)
1022 $section: The designation of the section being pointed to, to be included in
1023 the link, like "§ion=$section"
1024 $tooltip: The default tooltip. Escape before using.
1025 By default, this is wrapped in the 'editsectionhint' message.
1026 &$result: The HTML to return, prefilled with the default plus whatever other
1027 changes earlier hooks have made
1028 $lang: The language code to use for the link in the wfMessage function
1030 'EditFilter': Perform checks on an edit
1031 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1032 $text: Contents of the edit box
1033 $section: Section being edited
1034 &$error: Error message to return
1035 $summary: Edit summary for page
1037 'EditFilterMerged': Post-section-merge edit filter.
1038 DEPRECATED, use EditFilterMergedContent instead.
1039 $editor: EditPage instance (object)
1040 $text: content of the edit box
1041 &$error: error message to return
1042 $summary: Edit summary for page
1044 'EditFilterMergedContent': Post-section-merge edit filter.
1045 This may be triggered by the EditPage or any other facility that modifies page content.
1046 Use the $status object to indicate whether the edit should be allowed, and to provide
1047 a reason for disallowing it. Return false to abort the edit, and true to continue.
1048 Returning true if $status->isOK() returns false means "don't save but continue user
1049 interaction", e.g. show the edit form. $status->apiHookResult can be set to an array
1050 to be returned by api.php action=edit. This is used to deliver captchas.
1051 $context: object implementing the IContextSource interface.
1052 $content: content of the edit box, as a Content object.
1053 $status: Status object to represent errors, etc.
1054 $summary: Edit summary for page
1055 $user: the User object representing the user whois performing the edit.
1056 $minoredit: whether the edit was marked as minor by the user.
1058 'EditFormPreloadText': Allows population of the edit form when creating
1060 &$text: Text to preload with
1061 &$title: Title object representing the page being created
1063 'EditFormInitialText': Allows modifying the edit form when editing existing
1065 $editPage: EditPage object
1067 'EditPage::attemptSave': Called before an article is
1068 saved, that is before WikiPage::doEditContent() is called
1069 $editpage_Obj: the current EditPage object
1071 'EditPage::importFormData': allow extensions to read additional data
1073 $editpage: EditPage instance
1074 $request: Webrequest
1075 return value is ignored (should always return true)
1077 'EditPage::showEditForm:fields': allows injection of form field into edit form
1078 $editor: the EditPage instance for reference
1079 $out: an OutputPage instance to write to
1080 return value is ignored (should always return true)
1082 'EditPage::showEditForm:initial': before showing the edit form
1083 $editor: EditPage instance (object)
1084 $out: an OutputPage instance to write to
1086 Return false to halt editing; you'll need to handle error messages, etc.
1087 yourself. Alternatively, modifying $error and returning true will cause the
1088 contents of $error to be echoed at the top of the edit form as wikitext.
1089 Return true without altering $error to allow the edit to proceed.
1091 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1092 but for the read-only 'view source' variant of the edit form.
1093 $editor: EditPage instance (object)
1094 &$out: an OutputPage instance to write to
1095 return value is ignored (should always return true)
1097 'EditPage::showStandardInputs:options': allows injection of form fields into
1098 the editOptions area
1099 $editor: EditPage instance (object)
1100 $out: an OutputPage instance to write to
1101 &$tabindex: HTML tabindex of the last edit check/button
1102 return value is ignored (should always be true)
1104 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1105 when there's an edit conflict. Return false to halt normal diff output; in
1106 this case you're responsible for computing and outputting the entire "conflict"
1107 part, i.e., the "difference between revisions" and "your text" headers and
1109 &$editor: EditPage instance
1110 &$out: OutputPage instance
1112 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1113 textarea in the edit form.
1114 &$editpage: The current EditPage object
1115 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1116 &$tabindex: HTML tabindex of the last edit check/button
1118 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1120 &$editpage: The current EditPage object
1121 &$checks: Array of edit checks like "watch this page"/"minor edit"
1122 &$tabindex: HTML tabindex of the last edit check/button
1124 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1125 textarea in the edit form.
1126 &$toolbar: The toolbar HTMl
1128 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1129 contribution/copyright notice.
1130 $title: title of page being edited
1131 &$msg: localization message name, overridable. Default is either
1132 'copyrightwarning' or 'copyrightwarning2'.
1134 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1135 modifying the wikitext that will be used in "Show changes". Note that it is
1136 preferable to implement diff handling for different data types using the
1137 ContentHandler facility.
1138 $editPage: EditPage object
1139 &$newtext: wikitext that will be used as "your version"
1141 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1142 "Show changes". Note that it is preferable to implement diff handling for
1143 different data types using the ContentHandler facility.
1144 $editPage: EditPage object
1145 &$newtext: wikitext that will be used as "your version"
1147 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1148 Allow modifying the wikitext that will be previewed. Note that it is preferable
1149 to implement previews for different data types using the ContentHandler
1151 $editPage: EditPage object
1152 &$toparse: wikitext that will be parsed
1154 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1155 previewed. Note that it is preferable to implement previews for different data
1156 types using the ContentHandler facility.
1157 $editPage: EditPage object
1158 &$content: Content object to be previewed (may be replaced by hook function)
1160 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1161 &$editpage: The current EditPage object
1162 &$res: the HTML of the error text
1164 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1165 of terms of service summary link that might exist separately from the copyright
1167 $title: title of page being edited
1168 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1170 'EmailConfirmed': When checking that the user's email address is "confirmed".
1171 $user: User being checked
1172 $confirmed: Whether or not the email address is confirmed
1173 This runs before the other checks, such as anonymity and the real check; return
1174 true to allow those checks to occur, and false if checking is done.
1176 'EmailUser': Before sending email from one user to another.
1177 $to: address of receiving user
1178 $from: address of sending user
1179 $subject: subject of the mail
1180 $text: text of the mail
1182 'EmailUserCC': Before sending the copy of the email to the author.
1183 $to: address of receiving user
1184 $from: address of sending user
1185 $subject: subject of the mail
1186 $text: text of the mail
1188 'EmailUserComplete': After sending email from one user to another.
1189 $to: address of receiving user
1190 $from: address of sending user
1191 $subject: subject of the mail
1192 $text: text of the mail
1194 'EmailUserForm': After building the email user form object.
1195 $form: HTMLForm object
1197 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1199 $user: The user who is trying to email another user.
1200 $editToken: The user's edit token.
1201 &$hookErr: Out-param for the error. Passed as the parameters to
1202 OutputPage::showErrorPage.
1204 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1206 $ip: The ip address of the user
1208 'ExtensionTypes': Called when generating the extensions credits, use this to
1209 change the tables headers.
1210 &$extTypes: associative array of extensions types
1212 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1213 thumbnail file name.
1214 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1215 $thumbname: the base name of the thumbnail file
1216 &$params: the currently extracted params (has source name, temp or archived zone)
1218 'FetchChangesList': When fetching the ChangesList derivative for a particular
1220 $user: User the list is being fetched for
1221 &$skin: Skin object to be used with the list
1222 &$list: List object (defaults to NULL, change it to an object instance and
1223 return false override the list derivative used)
1225 'FileDeleteComplete': When a file is deleted.
1226 $file: reference to the deleted file
1227 $oldimage: in case of the deletion of an old image, the name of the old file
1228 $article: in case all revisions of the file are deleted a reference to the
1229 WikiFilePage associated with the file.
1230 $user: user who performed the deletion
1233 'FileTransformed': When a file is transformed and moved into storage.
1234 $file: reference to the File object
1235 $thumb: the MediaTransformOutput object
1236 $tmpThumbPath: The temporary file system path of the transformed file
1237 $thumbPath: The permanent storage path of the transformed file
1239 'FileUpload': When a file upload occurs.
1240 $file : Image object representing the file that was uploaded
1241 $reupload : Boolean indicating if there was a previously another image there or
1243 $hasDescription : Boolean indicating that there was already a description page
1244 and a new one from the comment wasn't created (since 1.17)
1246 'FileUndeleteComplete': When a file is undeleted
1247 $title: title object to the file
1248 $fileVersions: array of undeleted versions. Empty if all versions were restored
1249 $user: user who performed the undeletion
1252 'FormatAutocomments': When an autocomment is formatted by the Linker.
1253 &$comment: Reference to the accumulated comment. Initially null, when set the
1254 default code will be skipped.
1255 $pre: Initial part of the parsed comment before the call to the hook.
1256 $auto: The extracted part of the parsed comment before the call to the hook.
1257 $post: The final part of the parsed comment before the call to the hook.
1258 $title: An optional title object used to links to sections. Can be null.
1259 $local: Boolean indicating whether section links should refer to local page.
1261 'GalleryGetModes': Get list of classes that can render different modes of a
1263 $modeArray: An associative array mapping mode names to classes that implement
1264 that mode. It is expected all registered classes are a subclass of
1267 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1269 &$user: user to promote.
1270 &$promote: groups that will be added.
1272 'GetBlockedStatus': after loading blocking status of an user from the database
1273 $user: user (object) being checked
1275 'GetCacheVaryCookies': Get cookies that should vary cache options.
1276 $out: OutputPage object
1277 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1278 that have to vary cache options
1280 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1282 $title: Title object of page
1283 $url: string value as output (out parameter, can modify)
1284 $query: query options passed to Title::getCanonicalURL()
1286 'GetDefaultSortkey': Override the default sortkey for a page.
1287 $title: Title object that we need to get a sortkey for
1288 &$sortkey: Sortkey to use.
1290 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1291 underscore) magic words. Called by MagicWord.
1292 &$doubleUnderscoreIDs: array of strings
1294 'GetExtendedMetadata': Get extended file metadata for the API
1295 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1296 'value' => prop value, 'source' => 'name of hook' ).
1297 $file: File object of file in question
1298 $context: RequestContext (including language to use)
1299 $single: Only extract the current language; if false, the prop value should
1300 be in the metadata multi-language array format:
1301 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1302 &$maxCacheTime: how long the results can be cached
1304 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1305 $title: Title object of page
1306 $url: string value as output (out parameter, can modify)
1307 $query: query options passed to Title::getFullURL()
1309 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1310 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1312 &$output: string for the output timestamp
1313 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1314 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1315 $user: User whose preferences are being used to make timestamp
1316 $lang: Language that will be used to render the timestamp
1318 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1319 $title: Title object of page
1320 $url: string value as output (out parameter, can modify)
1321 $query: query options passed to Title::getInternalURL()
1323 'GetIP': modify the ip of the current user (called only once).
1324 &$ip: string holding the ip as determined so far
1326 'GetLinkColours': modify the CSS class of an array of page links.
1327 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1329 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1331 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1332 working with internal urls (non-interwiki) then it may be preferable to work
1333 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1334 be buggy for internal urls on render if you do not re-implement the horrible
1335 hack that Title::getLocalURL uses in your own extension.
1336 $title: Title object of page
1337 &$url: string value as output (out parameter, can modify)
1338 $query: query options passed to Title::getLocalURL()
1340 'GetLocalURL::Internal': Modify local URLs to internal pages.
1341 $title: Title object of page
1342 &$url: string value as output (out parameter, can modify)
1343 $query: query options passed to Title::getLocalURL()
1345 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1346 without any fancy queries or variants.
1347 $title: Title object of page
1348 &$url: string value as output (out parameter, can modify)
1350 'GetLogTypesOnUser': Add log types where the target is a userpage
1351 &$types: Array of log types
1353 'GetMetadataVersion': Modify the image metadata version currently in use. This
1354 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1355 that need to have versioned metadata should add an element to the end of the
1356 version array of the form 'handler_name=version'. Most media handlers won't need
1357 to do this unless they broke backwards compatibility with a previous version of
1358 the media handler metadata output.
1359 &$version: Array of version strings
1361 'GetNewMessagesAlert': Disable or modify the new messages alert
1362 &$newMessagesAlert: An empty string by default. If the user has new talk page
1363 messages, this should be populated with an alert message to that effect
1364 $newtalks: An empty array if the user has no new messages or an array containing
1365 links and revisions if there are new messages (See User::getNewMessageLinks)
1366 $user: The user object of the user who is loading the page
1367 $out: OutputPage object (to check what type of page the user is on)
1369 'GetPreferences': Modify user preferences.
1370 $user: User whose preferences are being modified.
1371 &$preferences: Preferences description array, to be fed to an HTMLForm object
1373 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1374 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1376 &$output: string for the output timestamp
1377 &$diff: DateInterval representing the difference between the timestamps
1378 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1379 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1380 $user: User whose preferences are being used to make timestamp
1381 $lang: Language that will be used to render the timestamp
1383 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1384 checked for. Use instead of userCan for most cases. Return false if the user
1385 can't do it, and populate $result with the reason in the form of
1386 array( messagename, param1, param2, ... ). For consistency, error messages
1387 should be plain text with no special coloring, bolding, etc. to show that
1388 they're errors; presenting them properly to the user as errors is done by the
1390 $title: Title object being checked against
1391 $user : Current user object
1392 $action: Action being checked
1393 $result: User permissions error to add. If none, return true.
1395 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1396 called only if expensive checks are enabled. Add a permissions error when
1397 permissions errors are checked for. Return false if the user can't do it, and
1398 populate $result with the reason in the form of array( messagename, param1,
1399 param2, ... ). For consistency, error messages should be plain text with no
1400 special coloring, bolding, etc. to show that they're errors; presenting them
1401 properly to the user as errors is done by the caller.
1403 $title: Title object being checked against
1404 $user : Current user object
1405 $action: Action being checked
1406 $result: User permissions error to add. If none, return true.
1408 'GitViewers': Called when generating the list of git viewers for
1409 Special:Version, use this to change the list.
1410 &$extTypes: associative array of repo URLS to viewer URLs.
1412 'HistoryRevisionTools': Override or extend the revision tools available from the
1413 page history view, i.e. undo, rollback, etc.
1414 $rev: Revision object
1415 &$links: Array of HTML links
1417 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1419 $context: An IContextSource object with information about the request being served.
1421 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1422 image insertion. You can skip the default logic entirely by returning false, or
1423 just modify a few things using call-by-reference.
1425 &$title: Title object of the image
1426 &$file: File object, or false if it doesn't exist
1427 &$frameParams: Various parameters with special meanings; see documentation in
1428 includes/Linker.php for Linker::makeImageLink
1429 &$handlerParams: Various parameters with special meanings; see documentation in
1430 includes/Linker.php for Linker::makeImageLink
1431 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1432 &$res: Final HTML output, used if you return false
1435 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1436 the image on an image page.
1437 $imagePage: ImagePage object ($this)
1440 'ImagePageAfterImageLinks': Called after the image links section on an image
1442 $imagePage: ImagePage object ($this)
1443 &$html: HTML for the hook to add
1445 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1447 $line: the HTML of the history line
1448 $css: the line CSS class
1450 'ImagePageFindFile': Called when fetching the file associated with an image
1452 $page: ImagePage object
1454 &$displayFile: displayed File object
1456 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1457 $page: ImagePage object
1458 &$toc: Array of <li> strings
1460 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1462 &$title: the Title object of the file as it would appear for the upload page
1463 &$path: the original file and path name when img_auth was invoked by the web
1465 &$name: the name only component of the file
1466 &$result: The location to pass back results of the hook routine (only used if
1468 $result[0]=The index of the header message
1469 $result[1]=The index of the body text message
1470 $result[2 through n]=Parameters passed to body text message. Please note the
1471 header message cannot receive/use parameters.
1473 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1474 $reader: XMLReader object
1475 $logInfo: Array of information
1476 Return false to stop further processing of the tag
1478 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1479 $reader: XMLReader object
1480 $pageInfo: Array of information
1481 Return false to stop further processing of the tag
1483 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1484 $reader: XMLReader object
1485 $pageInfo: Array of page information
1486 $revisionInfo: Array of revision information
1487 Return false to stop further processing of the tag
1489 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1490 $reader: XMLReader object
1491 Return false to stop further processing of the tag
1493 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1494 $reader: XMLReader object
1495 $revisionInfo: Array of information
1496 Return false to stop further processing of the tag
1498 'InfoAction': When building information to display on the action=info page.
1499 $context: IContextSource object
1500 &$pageInfo: Array of information
1502 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1503 $title: Title object for the current page
1504 $request: WebRequest
1505 $ignoreRedirect: boolean to skip redirect check
1506 $target: Title/string of redirect target
1507 $article: Article object
1509 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1510 Return true without providing an interwiki to continue interwiki search.
1511 $prefix: interwiki prefix we are looking for.
1512 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1513 iw_trans and optionally iw_api and iw_wikiid.
1515 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1516 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1517 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1518 template/parser function execution which respect nowiki and HTML-comments.
1519 &$parser: Parser object
1520 &$text: string containing partially parsed text
1521 &$stripState: Parser's internal StripState object
1523 'InternalParseBeforeLinks': during Parser's internalParse method before links
1524 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1525 &$parser: Parser object
1526 &$text: string containing partially parsed text
1527 &$stripState: Parser's internal StripState object
1529 'InvalidateEmailComplete': Called after a user's email has been invalidated
1531 $user: user (object) whose email is being invalidated
1533 'IRCLineURL': When constructing the URL to use in an IRC notification.
1534 Callee may modify $url and $query, URL will be constructed as $url . $query
1535 &$url: URL to index.php
1536 &$query: Query string
1537 $rc: RecentChange object that triggered url generation
1539 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1540 $article: article (object) being checked
1542 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1544 $result: Change this value to override the result of wfIsTrustedProxy()
1546 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1547 $url: URL used to upload from
1548 &$allowed: Boolean indicating if uploading is allowed for given URL
1550 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1551 instance to return false if the domain name doesn't match your organization.
1552 $addr: The e-mail address entered by the user
1553 &$result: Set this and return false to override the internal checks
1555 'isValidPassword': Override the result of User::isValidPassword()
1556 $password: The password entered by the user
1557 &$result: Set this and return false to override the internal checks
1558 $user: User the password is being validated for
1560 'Language::getMessagesFileName':
1561 $code: The language code or the language we're looking for a messages file for
1562 &$file: The messages file path, you can override this to change the location.
1564 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1565 remove namespaces. Do not use this hook to add namespaces. Use
1566 CanonicalNamespaces for that.
1567 &$namespaces: Array of namespaces indexed by their numbers
1569 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1570 $wgExtensionMessagesFiles instead.
1571 Use this to define synonyms of magic words depending of the language
1572 $magicExtensions: associative array of magic words synonyms
1573 $lang: language code (string)
1575 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1576 listed in $wgExtensionMessagesFiles instead.
1577 Use to define aliases of special pages names depending of the language
1578 $specialPageAliases: associative array of magic words synonyms
1579 $lang: language code (string)
1581 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1582 &$names: array of language code => language name
1583 $code language of the preferred translations
1585 'LanguageLinks': Manipulate a page's language links. This is called
1586 in various places to allow extensions to define the effective language
1588 $title: The page's Title.
1589 &$links: Associative array mapping language codes to prefixed links of the
1590 form "language:title".
1591 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1592 Currently unused, but planned to provide support for marking individual
1593 language links in the UI, e.g. for featured articles.
1595 'LanguageSelector': Hook to change the language selector available on a page.
1596 $out: The output page.
1597 $cssClassName: CSS class name of the language selector.
1599 'LinkBegin': Used when generating internal and interwiki links in
1600 Linker::link(), before processing starts. Return false to skip default
1601 processing and return $ret. See documentation for Linker::link() for details on
1602 the expected meanings of parameters.
1603 $skin: the Skin object
1604 $target: the Title that the link is pointing to
1605 &$html: the contents that the <a> tag should have (raw HTML); null means
1607 &$customAttribs: the HTML attributes that the <a> tag should have, in
1608 associative array form, with keys and values unescaped. Should be merged with
1609 default values, with a value of false meaning to suppress the attribute.
1610 &$query: the query string to add to the generated URL (the bit after the "?"),
1611 in associative array form, with keys and values unescaped.
1612 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1613 &$ret: the value to return if your hook returns false.
1615 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1616 just before the function returns a value. If you return true, an <a> element
1617 with HTML attributes $attribs and contents $html will be returned. If you
1618 return false, $ret will be returned.
1619 $skin: the Skin object
1620 $target: the Title object that the link is pointing to
1621 $options: the options. Will always include either 'known' or 'broken', and may
1622 include 'noclasses'.
1623 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1624 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1625 associative array form.
1626 &$ret: the value to return if your hook returns false.
1628 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1630 &$url: the image url
1631 &$alt: the image's alt text
1632 &$img: the new image HTML (if returning false)
1634 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1637 &$text: the link text
1638 &$link: the new link HTML (if returning false)
1639 &$attribs: the attributes to be applied.
1640 $linkType: The external link type
1642 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1644 $title: the Title object that the link is pointing to
1645 $file: the File object or false if broken link
1646 &$html: the link text
1647 &$attribs: the attributes to be applied
1648 &$ret: the value to return if your hook returns false
1650 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1652 &$linksUpdate: the LinksUpdate object
1654 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1655 each link table insert. For example, pagelinks, imagelinks, externallinks.
1656 $linksUpdate: LinksUpdate object
1657 $table: the table to insert links to
1658 $insertions: an array of links to insert
1660 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1661 including delete and insert, has completed for all link tables
1662 &$linksUpdate: the LinksUpdate object
1664 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1665 &$linksUpdate: the LinksUpdate object
1667 'ListDefinedTags': When trying to find all defined tags.
1668 &$tags: The list of tags.
1670 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1671 &updater: A DatabaseUpdater subclass
1673 'LocalFile::getHistory': Called before file history query performed.
1674 $file: the File object
1676 $fields: select fields
1678 $opts: query options
1679 $join_conds: JOIN conditions
1681 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1682 $file: the File object
1683 $archiveName: name of an old file version or false if it's the current one
1685 'LocalisationCacheRecache': Called when loading the localisation data into
1687 $cache: The LocalisationCache object
1688 $code: language code
1689 &$alldata: The localisation data from core and extensions
1690 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1692 'LocalisationCacheRecacheFallback': Called for each language when merging
1693 fallback data into the cache.
1694 $cache: The LocalisationCache object
1695 $code: language code
1696 &$alldata: The localisation data from core and extensions. Note some keys may
1697 be omitted if they won't be merged into the final result.
1699 'LocalisationChecksBlacklist': When fetching the blacklist of
1700 localisation checks.
1701 &$blacklist: array of checks to blacklist. See the bottom of
1702 maintenance/language/checkLanguage.inc for the format of this variable.
1704 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1705 optional localisation messages
1706 &$ignored Array of ignored message keys
1707 &$optional Array of optional message keys
1709 'LogEventsListGetExtraInputs': When getting extra inputs to display on Special:Log
1710 for a specific log type
1711 $type: String of log type being displayed
1712 $logEventsList: LogEventsList object for context and access to the WebRequest
1713 &$input: string HTML of an input element
1716 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1717 Returning false will prevent the string from being added to the OutputPage.
1718 &$s: html string to show for the log extract
1719 $types: String or Array Log types to show
1720 $page: String or Title The page title to show log entries for
1721 $user: String The user who made the log entries
1722 $param: Associative Array with the following additional options:
1723 - lim Integer Limit of items to show, default is 50
1724 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1725 - showIfEmpty boolean Set to false if you don't want any output in case the
1726 loglist is empty if set to true (default), "No matching items in log" is
1727 displayed if loglist is empty
1728 - msgKey Array If you want a nice box with a message, set this to the key of
1729 the message. First element is the message key, additional optional elements
1730 are parameters for the key that are processed with
1731 wfMessage()->params()->parseAsBlock()
1732 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1734 - wrap String Wrap the message in html (usually something like
1735 "<div ...>$1</div>").
1736 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1738 'LoginAuthenticateAudit': A login attempt for a valid user account either
1739 succeeded or failed. No return data is accepted; this hook is for auditing only.
1740 $user: the User object being authenticated against
1741 $password: the password being submitted and found wanting
1742 $retval: a LoginForm class constant with authenticateUserData() return
1743 value (SUCCESS, WRONG_PASS, etc.).
1745 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1746 Use this hook to change the Message that will be output on Special:ChangePassword.
1747 &$msg: Message object that will be shown to the user
1748 $username: Username of the user who's password was expired.
1750 'LogLine': Processes a single log entry on Special:Log.
1751 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1752 logging.log_type database field.
1753 $log_action: string for the type of log action (e.g. 'delete', 'block',
1754 'create2'). Corresponds to logging.log_action database field.
1755 $title: Title object that corresponds to logging.log_namespace and
1756 logging.log_title database fields.
1757 $paramArray: Array of parameters that corresponds to logging.log_params field.
1758 Note that only $paramArray[0] appears to contain anything.
1759 &$comment: string that corresponds to logging.log_comment database field, and
1760 which is displayed in the UI.
1761 &$revert: string that is displayed in the UI, similar to $comment.
1762 $time: timestamp of the log entry (added in 1.12)
1764 'LonelyPagesQuery': Allow extensions to modify the query used by
1765 Special:LonelyPages.
1766 &$tables: tables to join in the query
1767 &$conds: conditions for the query
1768 &$joinConds: join conditions for the query
1770 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1772 $refreshLinks: RefreshLinks object
1774 'MagicWordwgVariableIDs': When defining new magic words IDs.
1775 $variableIDs: array of strings
1777 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1778 Ideally, this hook should only be used to add variables that depend on
1779 the current page/request; static configuration should be added through
1780 ResourceLoaderGetConfigVars instead.
1781 &$vars: variable (or multiple variables) to be added into the output of
1782 Skin::makeVariablesScript
1783 $out: The OutputPage which called the hook, can be used to get the real title.
1785 'MarkPatrolled': Before an edit is marked patrolled.
1786 $rcid: ID of the revision to be marked patrolled
1787 $user: the user (object) marking the revision as patrolled
1788 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1789 sysop in order to mark an edit patrolled.
1791 'MarkPatrolledComplete': After an edit is marked patrolled.
1792 $rcid: ID of the revision marked as patrolled
1793 $user: user (object) who marked the edit patrolled
1794 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1795 sysop to patrol the edit.
1797 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1798 something completely different, after the basic globals have been set up, but
1799 before ordinary actions take place.
1801 $article: Article on which the action will be performed
1802 $title: Title on which the action will be performed
1804 $request: $wgRequest
1805 $mediaWiki: The $mediawiki object
1807 'MessagesPreLoad': When loading a message from the database.
1808 $title: title of the message (string)
1809 $message: value (string), change it to the message you want to define
1811 'MessageCache::get': When fetching a message. Can be used to override the key
1812 for customisations. Given and returned message key must be in special format:
1813 1) first letter must be in lower case according to the content language.
1814 2) spaces must be replaced with underscores
1815 &$key: message key (string)
1817 'MessageCacheReplace': When a message page is changed. Useful for updating
1819 $title: name of the page changed.
1820 $text: new contents of the page.
1822 'MimeMagicInit': Before processing the list mapping MIME types to media types
1823 and the list mapping MIME types to file extensions.
1824 As an extension author, you are encouraged to submit patches to MediaWiki's
1825 core to add new MIME types to mime.types.
1826 $mimeMagic: Instance of MimeMagic.
1827 Use $mimeMagic->addExtraInfo( $stringOfInfo );
1828 for adding new MIME info to the list.
1829 Use $mimeMagic->addExtraTypes( $stringOfTypes );
1830 for adding new MIME types to the list.
1832 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1833 MIME type detected by considering the file extension.
1834 $mimeMagic: Instance of MimeMagic.
1835 $ext: File extension.
1836 &$mime: MIME type (in/out).
1838 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1839 $mimeMagic: Instance of MimeMagic.
1840 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1841 &$tail: More or equal than last 65558 bytes of the file in a string
1842 (in - Do not alter!).
1844 &$mime: MIME type (out).
1846 'ModifyExportQuery': Modify the query used by the exporter.
1847 $db: The database object to be queried.
1848 &$tables: Tables in the query.
1849 &$conds: Conditions in the query.
1850 &$opts: Options for the query.
1851 &$join_conds: Join conditions for the query.
1853 'MovePageCheckPermissions': Specify whether the user is allowed to move the page.
1854 $oldTitle: Title object of the current (old) location
1855 $newTitle: Title object of the new location
1856 $user: User making the move
1857 $reason: string of the reason provided by the user
1858 $status: Status object to pass error messages to
1860 'MovePageIsValidMove': Specify whether a page can be moved for technical reasons.
1861 $oldTitle: Title object of the current (old) location
1862 $newTitle: Title object of the new location
1863 $status: Status object to pass error messages to
1865 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1866 and returning it for the skin to output. You can add items to the toolbox while
1867 still letting the skin make final decisions on skin-specific markup conventions
1869 &$sk: The BaseTemplate base skin template
1870 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1871 BaseTemplate::makeListItem for details on the format of individual items
1872 inside of this array.
1874 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1876 $index: Integer; the index of the namespace being checked.
1877 $result: Boolean; whether MediaWiki currently thinks that pages in this
1878 namespace are movable. Hooks may change this value to override the return
1879 value of MWNamespace::isMovable().
1881 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1883 $wikiPage: the WikiPage edited
1884 $rev: the new revision
1885 $baseID: the revision ID this was based off, if any
1886 $user: the editing user
1888 'NormalizeMessageKey': Called before the software gets the text of a message
1889 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1891 &$key: the message being looked up. Change this to something else to change
1892 what message gets displayed (string)
1893 &$useDB: whether or not to look up the message in the database (bool)
1894 &$langCode: the language code to get the message for (string) - or -
1895 whether to use the content language (true) or site language (false) (bool)
1896 &$transform: whether or not to expand variables and templates
1897 in the message (bool)
1899 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1900 return false to omit the line from RecentChanges and Watchlist special pages.
1901 &$changeslist: The OldChangesList instance.
1902 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1903 &$rc: The RecentChange object.
1904 &$classes: array of css classes for the <li> element
1906 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1907 can alter or append to the array of URLs for search & suggestion formats.
1908 &$urls: array of associative arrays with Url element attributes
1910 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1911 users and/or IP addresses too.
1912 $otherBlockLink: An array with links to other block logs
1913 $ip: The requested IP address or username
1915 'OutputPageBeforeHTML': A page has been processed by the parser and the
1916 resulting HTML is about to be displayed.
1917 $parserOutput: the parserOutput (object) that corresponds to the page
1918 $text: the text that will be displayed, in HTML (string)
1920 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1921 body tag to allow for extensions to add attributes to the body of the page they
1922 might need. Or to allow building extensions to add body classes that aren't of
1923 high enough demand to be included in core.
1924 $out: The OutputPage which called the hook, can be used to get the real title
1925 $sk: The Skin that called OutputPage::headElement
1926 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1928 'OutputPageCheckLastModified': when checking if the page has been modified
1929 since the last visit.
1930 &$modifiedTimes: array of timestamps.
1931 The following keys are set: page, user, epoch
1933 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1934 $out: OutputPage instance (object)
1935 $parserOutput: parserOutput instance being added in $out
1937 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1938 categories. Implementations should return false if they generate the category
1939 links, so the default link generation is skipped.
1940 $out: OutputPage instance (object)
1941 $categories: associative array, keys are category names, values are category
1942 types ("normal" or "hidden")
1943 $links: array, intended to hold the result. Must be an associative array with
1944 category types as keys and arrays of HTML links as values.
1946 'PageContentInsertComplete': After a new article is created.
1947 $wikiPage: WikiPage created
1948 $user: User creating the article
1949 $content: New content as a Content object
1950 $summary: Edit summary/comment
1951 $isMinor: Whether or not the edit was marked as minor
1952 $isWatch: (No longer used)
1953 $section: (No longer used)
1954 $flags: Flags passed to WikiPage::doEditContent()
1955 $revision: New Revision of the article
1957 'PageContentLanguage': Allows changing the language in which the content of a
1958 page is written. Defaults to the wiki content language ($wgContLang).
1959 $title: Title object
1960 &$pageLang: the page content language (either an object or a language code)
1961 $wgLang: the user language
1963 'PageContentSave': Before an article is saved.
1964 $wikiPage: the WikiPage (object) being saved
1965 $user: the user (object) saving the article
1966 $content: the new article content, as a Content object
1967 $summary: the article summary (comment)
1968 $isminor: minor flag
1969 $iswatch: watch flag
1972 'PageContentSaveComplete': After an article has been updated.
1973 $wikiPage: WikiPage modified
1974 $user: User performing the modification
1975 $content: New content, as a Content object
1976 $summary: Edit summary/comment
1977 $isMinor: Whether or not the edit was marked as minor
1978 $isWatch: (No longer used)
1979 $section: (No longer used)
1980 $flags: Flags passed to WikiPage::doEditContent()
1981 $revision: New Revision of the article (can be null for edits that change nothing)
1982 $status: Status object about to be returned by doEditContent()
1983 $baseRevId: the rev ID (or false) this edit was based on
1985 'PageHistoryBeforeList': When a history page list is about to be constructed.
1986 $article: the article that the history is loading for
1987 $context: RequestContext object
1989 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1990 $row: the revision row for this line
1991 $s: the string representing this parsed line
1992 $classes: array containing the <li> element classes
1994 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1997 $queryInfo: the query parameters
1999 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2000 which depends on user options should install this hook and append its values to
2002 &$confstr: reference to a hash key string which can be modified
2003 $user: User (object) requesting the page
2005 'ParserAfterParse': Called from Parser::parse() just after the call to
2006 Parser::internalParse() returns.
2007 $parser: parser object
2008 $text: text being parsed
2009 $stripState: stripState used (object)
2011 'ParserAfterStrip': Called at end of parsing time.
2012 TODO: No more strip, deprecated ?
2013 $parser: parser object
2014 $text: text being parsed
2015 $stripState: stripState used (object)
2017 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2018 $parser: Parser object being used
2019 $text: text that will be returned
2021 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2022 $parser: Parser object
2023 $text: text to parse
2024 $stripState: StripState instance being used
2026 'ParserBeforeStrip': Called at start of parsing time.
2027 TODO: No more strip, deprecated ?
2028 $parser: parser object
2029 $text: text being parsed
2030 $stripState: stripState used (object)
2032 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2033 $parser: Parser object being used
2036 'ParserClearState': Called at the end of Parser::clearState().
2037 $parser: Parser object being cleared
2039 'ParserCloned': Called when the parser is cloned.
2040 $parser: Newly-cloned Parser object
2042 'ParserFirstCallInit': Called when the parser initialises for the first time.
2043 &$parser: Parser object being cleared
2045 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2047 $parser: Parser object
2048 $varCache: array to store the value in case of multiples calls of the
2050 $index: index (string) of the magic
2051 $ret: value of the magic word (the hook should set it)
2052 $frame: PPFrame object to use for expanding any template variables
2054 'ParserGetVariableValueTs': Use this to change the value of the time for the
2055 {{LOCAL...}} magic word.
2056 $parser: Parser object
2057 $time: actual time (timestamp)
2059 'ParserGetVariableValueVarCache': use this to change the value of the variable
2060 cache or return false to not use it.
2061 $parser: Parser object
2062 $varCache: variable cache (array)
2064 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
2065 ParserLimitReportFormat instead.
2066 Called at the end of Parser:parse() when the parser will
2067 include comments about size of the text parsed.
2068 $parser: Parser object
2069 &$limitReport: text that will be included (without comment tags)
2071 'ParserLimitReportFormat': Called for each row in the parser limit report that
2072 needs formatting. If nothing handles this hook, the default is to use "$key" to
2073 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2075 $key: Key for the limit report item (string)
2076 &$value: Value of the limit report item
2077 &$report: String onto which to append the data
2078 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2079 text intended for display in a monospaced font.
2080 $localize: If false, $report should be output in English.
2082 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2083 include comments about size of the text parsed. Hooks should use
2084 $output->setLimitReportData() to populate data. Functions for this hook should
2085 not use $wgLang; do that in ParserLimitReportFormat instead.
2086 $parser: Parser object
2087 $output: ParserOutput object
2089 'ParserMakeImageParams': Called before the parser make an image link, use this
2090 to modify the parameters of the image.
2091 $title: title object representing the file
2092 $file: file object that will be used to create the image
2093 &$params: 2-D array of parameters
2094 $parser: Parser object that called the hook
2096 'ParserSectionCreate': Called each time the parser creates a document section
2097 from wikitext. Use this to apply per-section modifications to HTML (like
2098 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2099 can begin in one section and end in another. Make sure your code can handle
2100 that case gracefully. See the EditSectionClearerLink extension for an example.
2101 $parser: the calling Parser instance
2102 $section: the section number, zero-based, but section 0 is usually empty
2103 &$sectionContent: ref to the content of the section. modify this.
2104 $showEditLinks: boolean describing whether this section has an edit link
2106 'ParserTestParser': Called when creating a new instance of Parser in
2107 tests/parser/parserTest.inc.
2108 $parser: Parser object created
2110 'ParserTestGlobals': Allows to define globals for parser tests.
2111 &$globals: Array with all the globals which should be set for parser tests.
2112 The arrays keys serve as the globals names, its values are the globals values.
2114 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2115 run. Use when page save hooks require the presence of custom tables to ensure
2116 that tests continue to run properly.
2117 &$tables: array of table names
2119 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2120 my talk page, my contributions" etc).
2121 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2122 &$title: Title object representing the current page
2123 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2125 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2126 &$user : User performing the action
2127 $action : Action being performed
2128 &$result : Whether or not the action should be prevented
2129 Change $result and return false to give a definitive answer, otherwise
2130 the built-in rate limiting checks are used, if enabled.
2131 $incrBy: Amount to increment counter by
2133 'PlaceNewSection': Override placement of new sections. Return false and put the
2134 merged text into $text to override the default behavior.
2135 $wikipage : WikiPage object
2136 $oldtext : the text of the article before editing
2137 $subject : subject of the new section
2138 &$text : text of the new section
2140 'PostLoginRedirect': Modify the post login redirect behavior.
2141 Occurs after signing up or logging in, allows for interception of redirect.
2142 &$returnTo: The page name to return to, as a string
2143 &$returnToQuery: array of url parameters, mapping parameter names to values
2144 &$type: type of login redirect as string;
2145 error: display a return to link ignoring $wgRedirectOnLogin
2146 signup: display a return to link using $wgRedirectOnLogin if needed
2147 success: display a return to link using $wgRedirectOnLogin if needed
2148 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2150 'PreferencesGetLegend': Override the text used for the <legend> of a
2151 preferences section.
2152 $form: the PreferencesForm object. This is a ContextSource as well
2153 $key: the section name
2154 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2156 'PreferencesFormPreSave': Override preferences being saved
2157 $formData: array of user submitted data
2158 $form: PreferencesForm object, also a ContextSource
2159 $user: User object with preferences to be saved set
2160 &$result: boolean indicating success
2162 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2163 AJAX search suggestions. Put results into &$results outparam and return false.
2164 $ns : array of int namespace keys to search in
2165 $search : search term (not guaranteed to be conveniently normalized)
2166 $limit : maximum number of results to return
2167 &$results : out param: array of page names (strings)
2168 $offset : number of results to offset from the beginning
2170 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2171 namespace from the search string so that extensions can attempt it.
2172 $namespaces : array of int namespace keys to search in (change this if you can
2174 $search : search term (replace this with term without the namespace if you can
2177 'PrefsEmailAudit': Called when user changes their email address.
2178 $user: User (object) changing his email address
2179 $oldaddr: old email address (string)
2180 $newaddr: new email address (string)
2182 'PrefsPasswordAudit': Called when user changes his password.
2183 $user: User (object) changing his password
2184 $newPass: new password
2185 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2187 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2189 $article: the title being (un)protected
2190 $output: a string of the form HTML so far
2192 'ProtectionForm::save': Called when a protection form is submitted.
2193 $article: the Page being (un)protected
2194 &$errorMsg: an html message string of an error or an array of message name and
2196 $reasonstr: a string describing the reason page protection level is altered
2198 'ProtectionForm::showLogExtract': Called after the protection log extract is
2200 $article: the page the form is shown for
2201 $out: OutputPage object
2203 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2204 &$obj: RawAction object
2205 &$text: The text that's going to be the output
2207 'RecentChange_save': Called at the end of RecentChange::save().
2208 $recentChange: RecentChange object
2210 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2211 names such as "oldid" that are preserved when using redirecting special pages
2212 such as Special:MyPage and Special:MyTalk.
2213 &$redirectParams: An array of parameters preserved by redirecting special pages.
2215 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2216 instance. Can be used by an extension override what skin is used in certain
2218 IContextSource $context: The RequestContext the skin is being created for.
2219 &$skin: A variable reference you may set a Skin instance or string key on to
2220 override the skin that will be used for the context.
2222 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2223 $user: The user having their password expiration reset
2224 &$newExpire: The new expiration date
2226 'ResetSessionID': Called from wfResetSessionID
2227 $oldSessionID: old session id
2228 $newSessionID: new session id
2230 'ResourceLoaderGetConfigVars': Called at the end of
2231 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2232 configuration variables to JavaScript. Things that depend on the current page
2233 or request state must be added through MakeGlobalVariablesScript instead.
2234 &$vars: array( variable name => value )
2236 'ResourceLoaderRegisterModules': Right before modules information is required,
2237 such as when responding to a resource
2238 loader request or generating HTML output.
2239 &$resourceLoader: ResourceLoader object
2241 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2242 called after the addition of 'qunit' and MediaWiki testing resources.
2243 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2244 included in core, is fed using tests/qunit/QUnitTestResources.php.
2245 &ResourceLoader object
2247 To add a new qunit module named 'myext.tests':
2248 testModules['qunit']['myext.tests'] = array(
2249 'script' => 'extension/myext/tests.js',
2250 'dependencies' => <any module dependency you might have>
2252 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2253 added to any module.
2255 'RevisionInsertComplete': Called after a revision is inserted into the database.
2256 &$revision: the Revision
2257 $data: the data stored in old_text. The meaning depends on $flags: if external
2258 is set, it's the URL of the revision text in external storage; otherwise,
2259 it's the revision text itself. In either case, if gzip is set, the revision
2261 $flags: a comma-delimited list of strings representing the options used. May
2262 include: utf8 (this will always be set for new revisions); gzip; external.
2264 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2265 the normal operations.
2266 $allSearchTerms : Array of the search terms in all content languages
2267 &$titleResult : Outparam; the value to return. A Title object or null.
2269 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2270 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2272 $term : Search term string
2273 &$title : Outparam; set to $title object and return false for a match
2275 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2276 if nothing was found.
2277 $term : Search term string
2278 &$title : Outparam; set to $title object and return false for a match
2280 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2282 $term : Search term string
2283 &$title : Current Title object that is being returned (null if none found).
2285 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2287 $title : Current Title object being displayed in search results.
2288 &$id: Revision ID (default is false, for latest)
2290 'SearchableNamespaces': An option to modify which namespaces are searchable.
2291 &$arr : Array of namespaces ($nsId => $name) which will be used.
2293 'SelfLinkBegin': Called before a link to the current article is displayed to
2294 allow the display of the link to be customized.
2295 $nt: the Title object
2296 &$html: html to display for the link
2297 &$trail: optional text to display before $html
2298 &$prefix: optional text to display after $html
2299 &$ret: the value to return if your hook returns false
2301 'SetupAfterCache': Called in Setup.php, after cache objects are set
2303 'ShowMissingArticle': Called when generating the output for a non-existent page.
2304 $article: The article object corresponding to the page
2306 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2307 DEPRECATED, use the ContentGetParserOutput hook instead!
2308 $text: Text being shown
2309 $title: Title of the custom script/stylesheet page
2310 $output: Current OutputPage object
2312 'ShowSearchHitTitle': Customise display of search hit title/link.
2313 &$title: Title to link to
2314 &$text: Text to use for the link
2315 $result: The search result
2316 $terms: The search terms entered
2317 $page: The SpecialSearch object.
2319 'ShowSearchHit': Customize display of search hit.
2320 $searchPage: The SpecialSearch instance.
2321 $result: The SearchResult to show
2322 $terms: Search terms, for highlighting
2323 &$link: HTML of link to the matching page. May be modified.
2324 &$redirect: HTML of redirect info. May be modified.
2325 &$section: HTML of matching section. May be modified.
2326 &$extract: HTML of content extract. May be modified.
2327 &$score: HTML of score. May be modified.
2328 &$size: HTML of page size. May be modified.
2329 &$date: HTML of of page modification date. May be modified.
2330 &$related: HTML of additional info for the matching page. May be modified.
2331 &$html: May be set to the full HTML that should be used to represent the search
2332 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2333 function returned false.
2335 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2336 allow the normal method of notice selection/rendering to work, or change the
2337 value of $siteNotice and return false to alter it.
2338 &$siteNotice: HTML returned as the sitenotice
2341 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2342 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2343 the sitenotice/anonnotice.
2346 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2348 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2349 the stock bottom scripts.
2351 'SkinAfterContent': Allows extensions to add text after the page content and
2352 article metadata. This hook should work in all skins. Set the &$data variable to
2353 the text you're going to add.
2354 &$data: (string) Text to be printed out directly (without parsing)
2357 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2359 &$bar: Sidebar contents
2360 Modify $bar to add or modify sidebar portlets.
2362 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2364 &$bar: Sidebar content
2365 Modify $bar to add or modify sidebar portlets.
2366 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2368 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2370 $title: displayed page title
2371 $type: 'normal' or 'history' for old/diff views
2372 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2373 message must be in HTML format, not wikitext!
2374 &$link: overridable HTML link to be passed into the message as $1
2375 &$forContent: overridable flag if copyright footer is shown in content language.
2376 This parameter is deprecated.
2378 'SkinGetPoweredBy': TODO
2379 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2380 the MediaWiki icon but plain text instead.
2383 'SkinPreloadExistence': Supply titles that should be added to link existence
2384 cache before the page is rendered.
2385 &$titles: Array of Title objects
2388 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2389 &$subpages: Subpage links HTML
2391 $out: OutputPage object
2392 If false is returned $subpages will be used instead of the HTML
2393 subPageSubtitle() generates.
2394 If true is returned, $subpages will be ignored and the rest of
2395 subPageSubtitle() will run.
2397 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2399 $sktemplate: SkinTemplate object
2400 $nav_urls: array of tabs
2402 'SkinTemplateGetLanguageLink': After building the data for a language link from
2403 which the actual html is constructed.
2404 &$languageLink: array containing data about the link. The following keys can be
2405 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2406 $languageLinkTitle: Title object belonging to the external language link.
2407 $title: Title object of the page the link belongs to.
2408 $outputPage: The OutputPage object the links are built from.
2410 To alter the structured navigation links in SkinTemplates, there are three
2411 hooks called in different spots:
2413 'SkinTemplateNavigation': Called on content pages after the tabs have been
2414 added, but before variants have been added.
2415 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2416 tab is added but before variants have been added.
2417 'SkinTemplateNavigation::Universal': Called on both content and special pages
2418 after variants have been added.
2419 &$sktemplate: SkinTemplate object
2420 &$links: Structured navigation links. This is used to alter the navigation for
2421 skins which use buildNavigationUrls such as Vector.
2423 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2425 &$sktemplate: SkinTemplate object
2426 &$tpl: QuickTemplate engine object
2428 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2429 $sktemplate: SkinTemplate object
2430 $res: set to true to prevent active tabs
2432 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2433 You can either create your own array, or alter the parameters for
2435 &$sktemplate: The SkinTemplate instance.
2436 $title: Title instance for the page.
2437 $message: Visible label of tab.
2438 $selected: Whether this is a selected tab.
2439 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2440 &$classes: Array of CSS classes to apply.
2441 &$query: Query string to add to link.
2443 &$result: Complete assoc. array if you want to return true.
2445 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2446 been rendered (useful for adding more).
2447 $sk: The QuickTemplate based skin template running the hook.
2448 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2449 extensions that add support for BaseTemplateToolbox should watch for this
2450 dummy parameter with "$dummy=false" in their code and return without echoing
2451 any HTML to avoid creating duplicate toolbox items.
2453 'SoftwareInfo': Called by Special:Version for returning information about the
2455 $software: The array of software in format 'name' => 'version'. See
2456 SpecialVersion::softwareInformation().
2458 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2459 $name: name of the special page
2460 &$form: HTMLForm object
2462 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2463 $sp: SpecialPage object, for context
2464 &$fields: Current HTMLForm fields
2466 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2467 $id: User id number, only provided for backwards-compatibility
2468 $user: User object representing user contributions are being fetched for
2469 $sp: SpecialPage instance, providing context
2471 'SpecialListusersDefaultQuery': Called right before the end of
2472 UsersPager::getDefaultQuery().
2473 $pager: The UsersPager instance
2474 $query: The query array to be returned
2476 'SpecialListusersFormatRow': Called right before the end of
2477 UsersPager::formatRow().
2478 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2479 $row: Database row object
2481 'SpecialListusersHeader': Called before closing the <fieldset> in
2482 UsersPager::getPageHeader().
2483 $pager: The UsersPager instance
2484 $out: The header HTML
2486 'SpecialListusersHeaderForm': Called before adding the submit button in
2487 UsersPager::getPageHeader().
2488 $pager: The UsersPager instance
2489 $out: The header HTML
2491 'SpecialListusersQueryInfo': Called right before the end of.
2492 UsersPager::getQueryInfo()
2493 $pager: The UsersPager instance
2494 $query: The query array to be returned
2496 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2497 $type: String of the log type
2498 $request: WebRequest object for getting the value provided by the current user
2499 &$qc: Array for query conditions to add
2501 'SpecialMovepageAfterMove': Called after moving a page.
2502 $movePage: MovePageForm object
2503 $oldTitle: old title (object)
2504 $newTitle: new title (object)
2506 'SpecialNewpagesConditions': Called when building sql query for
2508 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2509 $opts: FormOptions object containing special page options
2510 &$conds: array of WHERE conditionals for query
2511 &tables: array of tables to be queried
2512 &$fields: array of columns to select
2513 &$join_conds: join conditions for the tables
2515 'SpecialNewPagesFilters': Called after building form options at NewPages.
2516 $special: the special page object
2517 &$filters: associative array of filter definitions. The keys are the HTML
2518 name/URL parameters. Each key maps to an associative array with a 'msg'
2519 (message key) and a 'default' value.
2521 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2522 hook to remove a core special page.
2523 $list: list (array) of core special pages
2525 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2526 $special: the SpecialPage object
2527 $subPage: the subpage string or null if no subpage was specified
2529 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2530 $special: the SpecialPage object
2531 $subPage: the subpage string or null if no subpage was specified
2533 'SpecialPasswordResetOnSubmit': When executing a form submission on
2534 Special:PasswordReset.
2535 $users: array of User objects.
2536 $data: array of data submitted by the user
2537 &$error: string, error code (message key) used to describe to error (out
2538 parameter). The hook needs to return false when setting this, otherwise it
2539 will have no effect.
2541 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2542 use this to change some selection criteria or substitute a different title.
2543 &$randstr: The random number from wfRandom()
2544 &$isRedir: Boolean, whether to select a redirect or non-redirect
2545 &$namespaces: An array of namespace indexes to get the title from
2546 &$extra: An array of extra SQL statements
2547 &$title: If the hook returns false, a Title object to use instead of the
2548 result from the normal query
2550 'SpecialRecentChangesFilters': Called after building form options at
2551 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2552 $special: the special page object
2553 &$filters: associative array of filter definitions. The keys are the HTML
2554 name/URL parameters. Each key maps to an associative array with a 'msg'
2555 (message key) and a 'default' value.
2557 'SpecialRecentChangesPanel': Called when building form options in
2558 SpecialRecentChanges.
2559 &$extraOpts: array of added items, to which can be added
2560 $opts: FormOptions for this request
2562 'SpecialRecentChangesQuery': Called when building SQL query for
2563 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2564 ChangesListSpecialPageQuery instead.
2565 &$conds: array of WHERE conditionals for query
2566 &$tables: array of tables to be queried
2567 &$join_conds: join conditions for the tables
2568 $opts: FormOptions for this request
2569 &$query_options: array of options for the database request
2570 &$select: Array of columns to select
2572 'SpecialResetTokensTokens': Called when building token list for
2574 &$tokens: array of token information arrays in the format of
2575 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2577 'SpecialSearchCreateLink': Called when making the message to create a page or
2578 go to the existing page.
2579 $t: title object searched for
2580 &$params: an array of the default message name and page title (as parameter)
2582 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2583 target doesn't exist.
2584 &$title: title object generated from the text entered by the user
2586 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2587 the advanced form, a.k.a. power search box.
2588 &$showSections: an array to add values with more options to
2589 $term: the search term (not a title object)
2590 $opts: an array of hidden options (containing 'redirs' and 'profile')
2592 'SpecialSearchProfiles': Allows modification of search profiles.
2593 &$profiles: profiles, which can be modified.
2595 'SpecialSearchProfileForm': Allows modification of search profile forms.
2596 $search: special page object
2597 &$form: String: form html
2598 $profile: String: current search profile
2599 $term: String: search term
2600 $opts: Array: key => value of hidden options for inclusion in custom forms
2602 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2603 $search: SpecialSearch special page object
2604 $profile: String: current search profile
2605 $engine: the search engine
2607 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2608 on the search results page. Useful for including an external search
2609 provider. To disable the output of MediaWiki search output, return
2611 $specialSearch: SpecialSearch object ($this)
2613 $term: Search term specified by the user
2615 'SpecialSearchResults': Called before search result display
2616 $term: string of search term
2617 &$titleMatches: empty or SearchResultSet object
2618 &$textMatches: empty or SearchResultSet object
2620 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2621 &$extraStats: Array to save the new stats
2622 ( $extraStats['<name of statistic>'] => <value>; )
2624 'SpecialUploadComplete': Called after successfully uploading a file from
2626 $form: The SpecialUpload object
2628 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2629 $wgVersion: Current $wgVersion for you to use
2630 &$versionUrl: Raw url to link to (eg: release notes)
2632 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2633 Deprecated, use ChangesListSpecialPageFilters instead.
2634 $special: the special page object
2635 &$filters: associative array of filter definitions. The keys are the HTML
2636 name/URL parameters. Each key maps to an associative array with a 'msg'
2637 (message key) and a 'default' value.
2639 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2640 Deprecated, use ChangesListSpecialPageQuery instead.
2641 &$conds: array of WHERE conditionals for query
2642 &$tables: array of tables to be queried
2643 &$join_conds: join conditions for the tables
2644 &$fields: array of query fields
2645 $opts: A FormOptions object with watchlist options for the current request
2647 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2648 SpecialWatchlist. Allows extensions to register custom values they have
2649 inserted to rc_type so they can be returned as part of the watchlist.
2650 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2652 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2653 URL for a title when we have no other parameters on the URL. Gives a chance for
2654 extensions that alter page view behavior radically to abort that redirect or
2656 $request: WebRequest
2657 $title: Title of the currently found title obj
2658 $output: OutputPage object
2660 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2661 rendered (by ThumbnailImage:toHtml method).
2662 $thumbnail: the ThumbnailImage object
2663 &$attribs: image attribute array
2664 &$linkAttribs: image link attribute array
2666 'TitleArrayFromResult': Called when creating an TitleArray object from a
2668 &$titleArray: set this to an object to override the default object returned
2669 $res: database result used to create the object
2671 'TitleExists': Called when determining whether a page exists at a given title.
2672 $title: The title being tested.
2673 &$exists: Whether the title exists.
2675 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2676 or override the quick permissions check.
2677 $title: The Title object being accessed
2678 $user: The User performing the action
2679 $action: Action being performed
2680 &$errors: Array of errors
2681 $doExpensiveQueries: Whether to do expensive DB queries
2682 $short: Whether to return immediately on first error
2684 'TitleGetEditNotices': Allows extensions to add edit notices
2685 $title: The Title object for the page the edit notices are for
2686 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2687 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2689 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2690 that can be applied.
2691 $title: The title in question.
2692 &$types: The types of protection available.
2694 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2695 Called when determining if a page is a CSS or JS page.
2696 $title: Title object that is being checked
2697 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2698 Hooks may change this value to override the return value of
2699 Title::isCssOrJsPage().
2701 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2702 overriding default behavior for determining if a page exists. If $isKnown is
2703 kept as null, regular checks happen. If it's a boolean, this value is returned
2704 by the isKnown method.
2705 $title: Title object that is being checked
2706 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2708 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2709 that this hook is not called for interwiki pages or pages in immovable
2710 namespaces: for these, isMovable() always returns false.
2711 $title: Title object that is being checked
2712 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2713 Hooks may change this value to override the return value of
2716 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2717 Called when determining if a page is a wikitext or should
2718 be handled by separate handler (via ArticleViewCustom).
2719 $title: Title object that is being checked
2720 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2721 Hooks may change this value to override the return value of
2722 Title::isWikitextPage()
2724 'TitleMove': Before moving an article (title).
2727 $user: user who does the move
2729 'TitleMoveComplete': After moving an article (title).
2732 $user: user who did the move
2733 $pageid: database ID of the page that's been moved
2734 $redirid: database ID of the created redirect
2735 $reason: reason for the move
2737 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2738 adding the default error message if nothing allows the user to read the page. If
2739 a handler wants a title to *not* be whitelisted, it should also return false.
2740 $title: Title object being checked against
2741 $user: Current user object
2742 &$whitelisted: Boolean value of whether this title is whitelisted
2744 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2745 $title: Title object to purge
2746 &$urls: An array of URLs to purge from the caches, to be manipulated.
2748 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2749 PageArchive object has been created but before any further processing is done.
2750 &$archive: PageArchive object
2751 $title: Title object of the page that we're viewing
2753 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2754 PageArchive object has been created but before any further processing is done.
2755 &$archive: PageArchive object
2756 $title: Title object of the page that we're viewing
2758 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2759 the site is not in read-only mode, that the Title object is not null and after
2760 a PageArchive object has been constructed but before performing any further
2762 &$archive: PageArchive object
2763 $title: Title object of the page that we're about to undelete
2765 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2766 $title: title object related to the revision
2767 $rev: revision (object) that will be viewed
2769 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2771 $action: action name
2772 $article: article "acted on"
2774 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
2775 Since 1.24: Paths pointing to a directory will be recursively scanned for
2776 test case files matching the suffix "Test.php".
2777 &$paths: list of test cases and directories to search.
2779 'UnwatchArticle': Before a watch is removed from an article.
2780 $user: user watching
2781 $page: WikiPage object to be removed
2782 &$status: Status object to be returned if the hook returns false
2784 'UnwatchArticleComplete': After a watch is removed from an article.
2785 $user: user that watched
2786 $page: WikiPage object that was watched
2788 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2789 $formattedPageStatus: list of valid page states
2791 'UploadForm:initial': Before the upload form is generated. You might set the
2792 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2793 text (HTML) either before or after the editform.
2794 $form: UploadForm object
2796 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2797 poke at member variables like $mUploadDescription before the file is saved. Do
2798 not use this hook to break upload processing. This will return the user to a
2799 blank form with no error message; use UploadVerification and UploadVerifyFile
2801 $form: UploadForm object
2803 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2804 $type: (string) the requested upload type
2805 &$className: the class name of the Upload instance to be created
2807 'UploadComplete': when Upload completes an upload.
2808 &$upload: an UploadBase child instance
2810 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2812 $descriptor: (array) the HTMLForm descriptor
2814 'UploadFormSourceDescriptors': after the standard source inputs have been
2815 added to the descriptor
2816 $descriptor: (array) the HTMLForm descriptor
2818 'UploadVerification': Additional chances to reject an uploaded file. Consider
2819 using UploadVerifyFile instead.
2820 string $saveName: destination file name
2821 string $tempName: filesystem path to the temporary file for checks
2822 string &$error: output: message key for message to show if upload canceled by
2823 returning false. May also be an array, where the first element is the message
2824 key and the remaining elements are used as parameters to the message.
2826 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
2827 in most cases over UploadVerification.
2828 object $upload: an instance of UploadBase, with all info about the upload
2829 string $mime: The uploaded file's MIME type, as detected by MediaWiki. Handlers
2830 will typically only apply for specific MIME types.
2831 object &$error: output: true if the file is valid. Otherwise, an indexed array
2832 representing the problem with the file, where the first element is the message
2833 key and the remaining elements are used as parameters to the message.
2835 'UploadComplete': Upon completion of a file upload.
2836 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2837 $uploadBase->getLocalFile().
2839 'User::mailPasswordInternal': before creation and mailing of a user's new
2841 $user: the user who sent the message out
2842 $ip: IP of the user who sent the message out
2843 $u: the account whose new password will be set
2845 'UserAddGroup': Called when adding a group; return false to override
2846 stock group addition.
2847 $user: the user object that is to have a group added
2848 &$group: the group to add, can be modified
2850 'UserArrayFromResult': Called when creating an UserArray object from a database
2852 &$userArray: set this to an object to override the default object returned
2853 $res: database result used to create the object
2855 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2856 want to display an error message, try getUserPermissionsErrors.
2857 $title: Title object being checked against
2858 $user : Current user object
2859 $action: Action being checked
2860 $result: Pointer to result returned if hook returns false. If null is returned,
2861 userCan checks are continued by internal code.
2863 'UserCanSendEmail': To override User::canSendEmail() permission check.
2864 $user: User (object) whose permission is being checked
2865 &$canSend: bool set on input, can override on output
2867 'UserClearNewTalkNotification': Called when clearing the "You have new
2868 messages!" message, return false to not delete it.
2869 $user: User (object) that will clear the message
2870 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2872 'UserCreateForm': change to manipulate the login form
2873 $template: SimpleTemplate instance for the form
2875 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2876 $user: User to get groups for
2877 &$groups: Current effective groups
2879 'UserGetAllRights': After calculating a list of all available rights.
2880 &$rights: Array of rights, which may be added to.
2882 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2883 before returning the options to the caller. Warning: This hook is called for
2884 every call to User::getDefaultOptions(), which means it's potentially called
2885 dozens or hundreds of times. You may want to cache the results of non-trivial
2886 operations in your hook function for this reason.
2887 &$defaultOptions: Array of preference keys and their default values.
2889 'UserGetEmail': Called when getting an user email address.
2891 &$email: email, change this to override local email
2893 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2894 email authentication.
2896 &$timestamp: timestamp, change this to override local email authentication
2899 'UserGetImplicitGroups': DEPRECATED, called in User::getImplicitGroups().
2900 &$groups: List of implicit (automatically-assigned) groups
2902 'UserGetLanguageObject': Called when getting user's interface language object.
2904 &$code: Language code that will be used to create the object
2905 $context: IContextSource object
2907 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2908 &$reservedUsernames: $wgReservedUsernames
2910 'UserGetRights': Called in User::getRights().
2911 $user: User to get rights for
2912 &$rights: Current rights
2914 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2915 specific block exemptions).
2916 $user: User in question
2917 $title: Title of the page in question
2918 &$blocked: Out-param, whether or not the user is blocked from that page.
2919 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2920 to edit their own user talk pages.
2922 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2924 $ip: User's IP address
2925 &$blocked: Whether the user is blocked, to be modified by the hook
2927 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2928 false if a UserGetRights hook might remove the named right.
2929 $right: The user right being checked
2931 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2932 environmental means; occurs after session is loaded.
2933 $user: user object being loaded
2935 'UserLoadDefaults': Called when loading a default user.
2939 'UserLoadFromDatabase': Called when loading a user from the database.
2941 &$s: database query object
2943 'UserLoadFromSession': Called to authenticate users on external/environmental
2944 means; occurs before session is loaded.
2945 $user: user object being loaded
2946 &$result: set this to a boolean value to abort the normal authentication
2949 'UserLoadOptions': When user options/preferences are being loaded from the
2952 &$options: Options, can be modified.
2954 'UserLoginComplete': After a user has logged in.
2955 $user: the user object that was created on login
2956 $inject_html: Any HTML to inject after the "logged in" message.
2958 'UserLoginForm': change to manipulate the login form
2959 $template: SimpleTemplate instance for the form
2961 'UserLogout': Before a user logs out.
2962 $user: the user object that is about to be logged out
2964 'UserLogoutComplete': After a user has logged out.
2965 $user: the user object _after_ logout (won't have name, ID, etc.)
2966 $inject_html: Any HTML to inject after the "logged out" message.
2967 $oldName: name of the user before logout (string)
2969 'UserRemoveGroup': Called when removing a group; return false to override stock
2971 $user: the user object that is to have a group removed
2972 &$group: the group to be removed, can be modified
2974 'UserRights': After a user's group memberships are changed.
2975 $user : User object that was changed
2976 $add : Array of strings corresponding to groups added
2977 $remove: Array of strings corresponding to groups removed
2979 'UserRequiresHTTPS': Called to determine whether a user needs
2980 to be switched to HTTPS.
2981 $user: User in question.
2982 &$https: Boolean whether $user should be switched to HTTPS.
2984 'UserResetAllOptions': Called in User::resetOptions() when user preferences
2985 have been requested to be reset. This hook can be used to exclude certain
2986 options from being reset even when the user has requested all prefs to be reset,
2987 because certain options might be stored in the user_properties database table
2988 despite not being visible and editable via Special:Preferences.
2989 $user: the User (object) whose preferences are being reset
2990 &$newOptions: array of new (site default) preferences
2991 $options: array of the user's old preferences
2992 $resetKinds: array containing the kinds of preferences to reset
2994 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2996 $user: user retrieving new talks messages
2997 $talks: array of new talks page(s)
2999 'UserSaveSettings': Called when saving user settings.
3002 'UserSaveOptions': Called just before saving user preferences/options.
3004 &$options: Options, modifiable
3006 'UserSetCookies': Called when setting user cookies.
3008 &$session: session array, will be added to $_SESSION
3009 &$cookies: cookies array mapping cookie name to its value
3011 'UserSetEmail': Called when changing user email address.
3013 &$email: new email, change this to override new email address
3015 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3016 email authentication.
3018 &$timestamp: new timestamp, change this to override local email
3019 authentication timestamp
3021 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3022 "Foobar (Talk | Contribs | Block)".
3023 $userId: User id of the current user
3024 $userText: User name of the current user
3025 &$items: Array of user tool links as HTML fragments
3027 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3028 FormatMetadata::getExtendedMeta (return false means cache will be
3029 invalidated and GetExtendedMetadata hook called again).
3030 $timestamp: The timestamp metadata was generated
3031 $file: The file the metadata is for
3033 'UserMailerChangeReturnPath': Called to generate a VERP return address
3034 when UserMailer sends an email, with a bounce handling extension.
3035 $to: Array of MailAddress objects for the recipients
3036 &$returnPath: The return address string
3038 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid error
3039 messages. Allows to add additional error messages (except messages already in
3040 LoginForm::$validErrorMessages).
3041 &$messages Already added messages (inclusive messages from LoginForm::$validErrorMessages)
3043 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3044 used to alter the SQL query which gets the list of wanted pages.
3045 &$wantedPages: WantedPagesPage object
3046 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3048 'WatchArticle': Before a watch is added to an article.
3049 $user: user that will watch
3050 $page: WikiPage object to be watched
3051 &$status: Status object to be returned if the hook returns false
3053 'WatchArticleComplete': After a watch is added to an article.
3054 $user: user that watched
3055 $page: WikiPage object watched
3057 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3058 form, used to manipulate the list of pages or preload data based on that list.
3059 &$watchlistInfo: array of watchlisted pages in
3060 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3062 'WatchlistEditorBuildRemoveLine': when building remove lines in
3063 Special:Watchlist/edit.
3064 &$tools: array of extra links
3065 $title: Title object
3066 $redirect: whether the page is a redirect
3068 &$link: HTML link to title
3070 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3072 $router: The PathRouter instance
3074 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3075 Return false to prevent setting of the cookie.
3076 &$name: Cookie name passed to WebResponse::setcookie()
3077 &$value: Cookie value passed to WebResponse::setcookie()
3078 &$expire: Cookie expiration, as for PHP's setcookie()
3079 $options: Options passed to WebResponse::setcookie()
3081 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3082 $row: The DB row of the entry.
3083 $title: The Title of the page where the link comes FROM
3084 $target: The Title of the page where the link goes TO
3085 &$props: Array of HTML strings to display after the title.
3087 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3088 dumps. One, and only one hook should set this, and return false.
3089 &$tables: Database tables to use in the SELECT query
3090 &$opts: Options to use for the query
3091 &$join: Join conditions
3093 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3094 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3095 specific to a content model should be provided by the respective Content's
3096 getDeletionUpdates() method.
3098 $content: the Content to generate updates for
3099 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3101 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3102 run a MediaWiki cli script.
3103 &$script: MediaWiki cli script path
3104 &$parameters: Array of arguments and options to the script
3105 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3108 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3109 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3110 $qp: The list of QueryPages
3112 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3113 extra metadata to be added.
3114 $obj: The XmlDumpWriter object.
3115 &$out: The output string.
3116 $row: The database row for the page.
3117 $title: The title of the page.
3119 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3121 $obj: The XmlDumpWriter object.
3122 &$out: The text being output.
3123 $row: The database row for the revision.
3124 $text: The revision text.
3126 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3127 to add additional tags to extract.
3128 &$items: Array containing information on which items to extract. See XMPInfo for
3129 details on the format.
3131 'XMPGetResults': Called just before returning the results array of parsing xmp
3132 data. Can be used to post-process the results.
3133 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3134 is an array of metadata tags returned (each tag is either a value, or an array
3137 More hooks might be available but undocumented, you can execute
3138 "php maintenance/findHooks.php" to find hidden ones.