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, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
248 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
249 $editor: The User who made the change.
250 $title: The Title of the page that was edited.
252 'AbortLogin': Return false to cancel account login.
253 $user: the User object being authenticated against
254 $password: the password being submitted, not yet checked for validity
255 &$retval: a LoginForm class constant to return from authenticateUserData();
256 default is LoginForm::ABORTED. Note that the client may be using
257 a machine API rather than the HTML user interface.
258 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
260 'AbortMove': allows to abort moving an article (title)
263 $user: user who is doing the move
265 $reason: the reason for the move (added in 1.13)
267 'AbortNewAccount': Return false to cancel explicit account creation.
268 $user: the User object about to be created (read-only, incomplete)
269 &$msg: out parameter: HTML to display on abort
271 'ActionBeforeFormDisplay': before executing the HTMLForm object
272 $name: name of the action
273 &$form: HTMLForm object
274 $article: Article object
276 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
277 allows to change the fields on the form that will be generated
278 $name: name of the action
279 &$fields: HTMLForm descriptor array
280 $article: Article object
282 'AddNewAccount': after a user account is created
283 $user: the User object that was created. (Parameter added in 1.7)
284 $byEmail: true when account was created "by email" (added in 1.12)
286 'AfterFinalPageOutput': At the end of OutputPage::output() but before
287 final ob_end_flush() which will send the buffered output to the client.
288 This allows for last-minute modification of the output within the buffer
289 by using ob_get_clean().
291 'AfterImportPage': When a page import is completed
292 $title: Title under which the revisions were imported
293 $origTitle: Title provided by the XML file
294 $revCount: Number of revisions in the XML file
295 $sRevCount: Number of sucessfully imported revisions
296 $pageInfo: associative array of page information
298 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
299 before OutputPage::sendCacheControl() and final ob_end_flush() which
300 will send the buffered output to the client. This allows for last-minute
301 modification of the output within the buffer by using ob_get_clean().
302 $output: The OutputPage object where output() was called
304 'AjaxAddScript': Called in output page just before the initialisation
305 of the javascript ajax engine. The hook is only called when ajax
306 is enabled ( $wgUseAjax = true; ).
308 'AlternateEdit': before checking if a user can edit a page and
309 before showing the edit form ( EditPage::edit() ). This is triggered
311 $EditPage: the EditPage object
313 'AlternateUserMailer': Called before mail is sent so that mail could
314 be logged (or something else) instead of using PEAR or PHP's mail().
315 Return false to skip the regular method of sending mail. Return a
316 string to return a php-mail-error message containing the error.
317 Returning true will continue with sending email in the regular way.
318 $headers: Associative array of headers for the email
319 $to: MailAddress object or array
321 $subject: Subject of the email
322 $body: Body of the message
324 'APIAfterExecute': after calling the execute() method of an API module.
325 Use this to extend core API modules.
326 &$module: Module object
328 'APICheckCanExecute': Called during ApiMain::checkCanExecute. Use to
329 further authenticate and authorize API clients before executing the
330 module. Return false and set a message to cancel the request.
331 $module: Module object
333 &$message: API usage message to die with
335 'APIEditBeforeSave': before saving a page with api.php?action=edit,
336 after processing request parameters. Return false to let the request
337 fail, returning an error message or an <edit result="Failure"> tag
338 if $resultArr was filled.
339 $EditPage : the EditPage object
340 $text : the new text of the article (has yet to be saved)
341 &$resultArr : data in this array will be added to the API result
343 'APIGetAllowedParams': use this hook to modify a module's parameters.
344 &$module: ApiBase Module object
345 &$params: Array of parameters
347 'APIGetDescription': use this hook to modify a module's description
348 &$module: ApiBase Module object
349 &$desc: Array of descriptions
351 'APIGetParamDescription': use this hook to modify a module's parameter
353 &$module: ApiBase Module object
354 &$desc: Array of parameter descriptions
356 'APIGetResultProperties': use this hook to mofify the properties
357 in a module's result.
358 &$module: ApiBase Module object
359 &$properties: Array of properties
361 'APIQueryAfterExecute': after calling the execute() method of an
362 action=query submodule. Use this to extend core API modules.
363 &$module: Module object
365 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
366 method of an action=query submodule. Use this to extend core API modules.
367 &$module: Module object
368 &$resultPageSet: ApiPageSet object
370 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
371 Every token has an action, which will be used in the intoken parameter
372 and in the output (actiontoken="..."), and a callback function which
373 should return the token, or false if the user isn't allowed to obtain
374 it. The prototype of the callback function is func($pageid, $title)
375 where $pageid is the page ID of the page the token is requested for
376 and $title is the associated Title object. In the hook, just add
377 your callback to the $tokenFunctions array and return true (returning
378 false makes no sense)
379 $tokenFunctions: array(action => callback)
381 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
382 Every token has an action, which will be used in the rvtoken parameter
383 and in the output (actiontoken="..."), and a callback function which
384 should return the token, or false if the user isn't allowed to obtain
385 it. The prototype of the callback function is func($pageid, $title, $rev)
386 where $pageid is the page ID of the page associated to the revision the
387 token is requested for, $title the associated Title object and $rev the
388 associated Revision object. In the hook, just add your callback to the
389 $tokenFunctions array and return true (returning false makes no sense)
390 $tokenFunctions: array(action => callback)
392 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
394 Every token has an action, which will be used in the rctoken parameter
395 and in the output (actiontoken="..."), and a callback function which
396 should return the token, or false if the user isn't allowed to obtain
397 it. The prototype of the callback function is func($pageid, $title, $rc)
398 where $pageid is the page ID of the page associated to the revision the
399 token is requested for, $title the associated Title object and $rc the
400 associated RecentChange object. In the hook, just add your callback to the
401 $tokenFunctions array and return true (returning false makes no sense)
402 $tokenFunctions: array(action => callback)
404 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
405 the sites general information.
406 $module: the current ApiQuerySiteInfo module
407 &$results: array of results, add things here
409 'APIQueryUsersTokens': use this hook to add custom token to list=users.
410 Every token has an action, which will be used in the ustoken parameter
411 and in the output (actiontoken="..."), and a callback function which
412 should return the token, or false if the user isn't allowed to obtain
413 it. The prototype of the callback function is func($user) where $user
414 is the User object. In the hook, just add your callback to the
415 $tokenFunctions array and return true (returning false makes no sense)
416 $tokenFunctions: array(action => callback)
418 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling()
419 when an exception is thrown during API action execution.
420 $apiMain: Calling ApiMain instance.
421 $e: Exception object.
423 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
424 Each service should have its own entry in the $apis array and have a
425 unique name, passed as key for the array that represents the service data.
426 In this data array, the key-value-pair identified by the apiLink key is
428 &$apis: array of services
430 'ApiTokensGetTokenTypes': use this hook to extend action=tokens with new
432 &$tokenTypes: supported token types in format 'type' => callback function
433 used to retrieve this type of tokens.
435 'ArticleAfterFetchContent': after fetching content of an article from
436 the database. DEPRECATED, use ArticleAfterFetchContentObject instead.
437 $article: the article (object) being loaded from the database
438 &$content: the content (string) of the article
440 'ArticleAfterFetchContentObject': after fetching content of an article from
442 $article: the article (object) being loaded from the database
443 &$content: the content of the article, as a Content object
445 'ArticleConfirmDelete': before writing the confirmation form for article
447 $article: the article (object) being deleted
448 $output: the OutputPage object ($wgOut)
449 &$reason: the reason (string) the article is being deleted
451 'ArticleContentOnDiff': before showing the article content below a diff.
452 Use this to change the content in this area or how it is loaded.
453 $diffEngine: the DifferenceEngine
454 $output: the OutputPage object ($wgOut)
456 'ArticleDelete': before an article is deleted
457 $article: the WikiPage (object) being deleted
458 $user: the user (object) deleting the article
459 $reason: the reason (string) the article is being deleted
460 $error: if the deletion was prohibited, the (raw HTML) error message to display
462 $status: Status object, modify this to throw an error. Overridden by $error
465 'ArticleDeleteComplete': after an article is deleted
466 $article: the WikiPage that was deleted
467 $user: the user that deleted the article
468 $reason: the reason the article was deleted
469 $id: id of the article that was deleted
471 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
473 $article: WikiPage (object) of the user talk page
475 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
476 article has been changed
477 $article: the WikiPage (object)
478 $editInfo: data holder that includes the parser output ($editInfo->output) for
479 that page after the change
480 $changed: bool for if the page was changed
482 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
483 recentchanges table, return false to not delete old entries
484 $article: WikiPage (object) being modified
486 'ArticleFromTitle': when creating an article object from a title object using
487 Wiki::articleFromTitle()
488 $title: title (object) used to create the article object
489 $article: article (object) that will be returned
491 'ArticleInsertComplete': After a new article is created. DEPRECATED, use ArticleContentInsertComplete
492 $article: WikiPage created
493 $user: User creating the article
495 $summary: Edit summary/comment
496 $isMinor: Whether or not the edit was marked as minor
497 $isWatch: (No longer used)
498 $section: (No longer used)
499 $flags: Flags passed to WikiPage::doEditContent()
500 $revision: New Revision of the article
502 'ArticleContentInsertComplete': After a new article is created
503 $article: WikiPage created
504 $user: User creating the article
505 $content: New content as a Content object
506 $summary: Edit summary/comment
507 $isMinor: Whether or not the edit was marked as minor
508 $isWatch: (No longer used)
509 $section: (No longer used)
510 $flags: Flags passed to WikiPage::doEditContent()
511 $revision: New Revision of the article
513 'ArticleMergeComplete': after merging to article using Special:Mergehistory
514 $targetTitle: target title (object)
515 $destTitle: destination title (object)
517 'ArticlePageDataAfter': after loading data of an article from the database
518 $article: WikiPage (object) whose data were loaded
519 $row: row (object) returned from the database server
521 'ArticlePageDataBefore': before loading data of an article from the database
522 $article: WikiPage (object) that data will be loaded
523 $fields: fileds (array) to load from the database
525 'ArticlePrepareTextForEdit': called when preparing text to be saved
526 $article: the WikiPage being saved
527 $popts: parser options to be used for pre-save transformation
529 'ArticleProtect': before an article is protected
530 $article: the WikiPage being protected
531 $user: the user doing the protection
532 $protect: boolean whether this is a protect or an unprotect
533 $reason: Reason for protect
534 $moveonly: boolean whether this is for move only or not
536 'ArticleProtectComplete': after an article is protected
537 $article: the WikiPage that was protected
538 $user: the user who did the protection
539 $protect: boolean whether it was a protect or an unprotect
540 $reason: Reason for protect
541 $moveonly: boolean whether it was for move only or not
543 'ArticlePurge': before executing "&action=purge"
544 $article: WikiPage (object) to purge
546 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
547 revision of an article
548 &$title: title object of the article
550 'ArticleRevisionUndeleted': after an article revision is restored
551 $title: the article title
552 $revision: the revision
553 $oldPageID: the page ID of the revision when archived (may be null)
555 'ArticleRollbackComplete': after an article rollback is completed
556 $article: the WikiPage that was edited
557 $user: the user who did the rollback
558 $revision: the revision the page was reverted back to
559 $current: the reverted revision
561 'ArticleSave': before an article is saved. DEPRECATED, use ArticleContentSave instead
562 $article: the WikiPage (object) being saved
563 $user: the user (object) saving the article
564 $text: the new article text
565 $summary: the article summary (comment)
570 'ArticleContentSave': before an article is saved.
571 $article: the WikiPage (object) being saved
572 $user: the user (object) saving the article
573 $content: the new article content, as a Content object
574 $summary: the article summary (comment)
579 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use ArticleContentSaveComplete instead.
580 $article: WikiPage modified
581 $user: User performing the modification
583 $summary: Edit summary/comment
584 $isMinor: Whether or not the edit was marked as minor
585 $isWatch: (No longer used)
586 $section: (No longer used)
587 $flags: Flags passed to WikiPage::doEditContent()
588 $revision: New Revision of the article
589 $status: Status object about to be returned by doEditContent()
590 $baseRevId: the rev ID (or false) this edit was based on
592 'ArticleContentSaveComplete': After an article has been updated
593 $article: WikiPage modified
594 $user: User performing the modification
595 $content: New content, as a Content object
596 $summary: Edit summary/comment
597 $isMinor: Whether or not the edit was marked as minor
598 $isWatch: (No longer used)
599 $section: (No longer used)
600 $flags: Flags passed to WikiPage::doEditContent()
601 $revision: New Revision of the article
602 $status: Status object about to be returned by doEditContent()
603 $baseRevId: the rev ID (or false) this edit was based on
605 'ArticleUndelete': When one or more revisions of an article are restored
606 $title: Title corresponding to the article restored
607 $create: Whether or not the restoration caused the page to be created
608 (i.e. it didn't exist before)
609 $comment: The comment associated with the undeletion.
611 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
612 before the user is redirected back to the page
613 &$article: the article
614 &$sectionanchor: The section anchor link (e.g. "#overview" )
615 &$extraq: Extra query parameters which can be added via hooked functions
617 'ArticleViewFooter': After showing the footer section of an ordinary page view
618 $article: Article object
620 'ArticleViewHeader': Before the parser cache is about to be tried for article
622 &$article: the article
623 &$pcache: whether to try the parser cache or not
624 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
625 object to both indicate that the output is done and what parser output was used.
627 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
629 $article: target article (object)
631 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext.
632 DEPRECATED, use ArticleContentViewCustom instead.
633 Note that it is preferrable to implement proper handing for a custom data type using the ContentHandler facility.
634 $text: text of the page
635 $title: title of the page
636 $output: reference to $wgOut
638 'ArticleContentViewCustom': allows to output the text of the article in a different format than wikitext.
639 Note that it is preferrable to implement proper handing for a custom data type using the ContentHandler facility.
640 $content: content of the page, as a Content object
641 $title: title of the page
642 $output: reference to $wgOut
644 'AuthPluginAutoCreate': Called when creating a local account for an user logged
645 in from an external authentication method
646 $user: User object created locally
648 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
649 Gives a chance for an extension to set it programattically to a variable class.
650 &$auth: the $wgAuth object, probably a stub
652 'AutopromoteCondition': check autopromote condition for user.
653 $type: condition type
656 $result: result of checking autopromote condition
658 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
662 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
665 $title: title of the page to which backlinks are sought
666 &$conds: query conditions
668 'BadImage': When checking against the bad image list
669 $name: Image name being checked
670 &$bad: Whether or not the image is "bad"
672 Change $bad and return false to override. If an image is "bad", it is not
673 rendered inline in wiki pages or galleries in category pages.
675 'BeforeDisplayNoArticleText': before displaying noarticletext or noarticletext-nopermission
676 at Article::showMissingArticle()
678 $article: article object
680 'BeforeInitialize': before anything is initialized in MediaWiki::performRequest()
681 &$title: Title being used for request
683 &$output: OutputPage object
685 $request: WebRequest object
686 $mediaWiki: Mediawiki object
688 'BeforePageDisplay': Prior to outputting a page
689 &$out: OutputPage object
692 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
693 override how the redirect is output by modifying, or by returning false and
694 taking over the output.
695 $out: OutputPage object
696 &$redirect: URL, modifiable
697 &$code: HTTP code (eg '301' or '302'), modifiable
699 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
700 $parser: Parser object
702 &$options: array of options to RepoGroup::findFile
703 &$descQuery: query string to add to thumbnail URL
705 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
707 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
708 $parser: Parser object
709 $title: title of the template
710 &$skip: skip this template and link it?
711 &$id: the id of the revision being parsed
713 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
714 &$parser: Parser object
715 &$ig: ImageGallery object
717 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
718 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
719 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
721 'BitmapHandlerTransform': before a file is transformed, gives extension the
722 possibility to transform it themselves
723 $handler: BitmapHandler
725 &$scalerParams: Array with scaler parameters
726 &$mto: null, set to a MediaTransformOutput
728 'BitmapHandlerCheckImageArea': by BitmapHandler::normaliseParams, after all normalizations have been performed, except for the $wgMaxImageArea check
730 &$params: Array of parameters
731 &$checkImageAreaHookResult: null, set to true or false to override the $wgMaxImageArea check result
733 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
734 $block: Block object (which is set to be autoblocking)
735 &$blockIds: Array of block IDs of the autoblock
737 'BlockIp': before an IP address or user is blocked
738 $block: the Block object about to be saved
739 $user: the user _doing_ the block (not the one being blocked)
741 'BlockIpComplete': after an IP address or user is blocked
742 $block: the Block object that was saved
743 $user: the user who did the block (not the one being blocked)
745 'BookInformation': Before information output on Special:Booksources
746 $isbn: ISBN to show information for
747 $output: OutputPage object in use
749 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
750 &$namespaces: Array of namespace numbers with corresponding canonical names
752 'CategoryPageView': before viewing a categorypage in CategoryPage::view
753 $catpage: CategoryPage instance
755 'ChangePasswordForm': For extensions that need to add a field to the ChangePassword form
756 via the Preferences form
757 &$extraFields: An array of arrays that hold fields like would be passed to the pretty function.
759 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
760 &$changesList: ChangesList instance.
761 &$articlelink: HTML of link to article (already filled-in).
762 &$s: HTML of row that is being constructed.
763 &$rc: RecentChange instance.
764 $unpatrolled: Whether or not we are showing unpatrolled changes.
765 $watched: Whether or not the change is watched by the user.
767 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
768 $collationName: Name of the collation in question
769 &$collationObject: Null. Replace with a subclass of the Collation class that implements
770 the collation given in $collationName.
772 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
773 $user: user (object) whose email is being confirmed
775 'ContentHandlerDefaultModelFor': Called when the default content model is determiend
776 for a given title. May be used to assign a different model for that title.
777 $title: the Title in question
778 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
780 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
781 cointent model name, but no entry for that model exists in $wgContentHandlers.
782 $modeName: the requested content model name
783 &$handler: set this to a ContentHandler object, if desired.
785 'ContribsPager::getQueryInfo': Before the contributions query is about to run
786 &$pager: Pager object for contributions
787 &$queryInfo: The query for the contribs Pager
789 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
790 &$data: an array of results of all contribs queries
791 $pager: The ContribsPager object hooked into
792 $offset: Index offset, inclusive
793 $limit: Exact query limit
794 $descending: Query direction, false for ascending, true for descending
796 'ContributionsLineEnding': Called before a contributions HTML line is finished
797 $page: SpecialPage object for contributions
799 $row: the DB row for this line
800 &$classes: the classes to add to the surrounding <li>
802 'ContributionsToolLinks': Change tool links above Special:Contributions
804 $title: User page title
805 &$tools: Array of tool links
807 'CustomEditor': When invoking the page editor
808 $article: Article being edited
809 $user: User performing the edit
811 Return true to allow the normal editor to be used, or false
812 if implementing a custom editor, e.g. for a special namespace,
815 'DatabaseOraclePostInit': Called after initialising an Oracle database
816 &$db: the DatabaseOracle object
818 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
819 $text: plaintext string to be output
820 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
822 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
823 $title: the diff page title (nullable)
824 &$oldId: the actual old Id to use in the diff
825 &$newId: the actual new Id to use in the diff (0 means current)
826 $old: the ?old= param value from the url
827 $new: the ?new= param value from the url
829 'DiffViewHeader': called before diff display
830 $diff: DifferenceEngine object that's calling
831 $oldRev: Revision object of the "old" revision (may be null/invalid)
832 $newRev: Revision object of the "new" revision
834 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
836 $article: article (object) being viewed
837 $oldid: oldid (int) being viewed
839 'DoEditSectionLink': Override the HTML generated for section edit links
840 $skin: Skin object rendering the UI
841 $title: Title object for the title being linked to (may not be the same as
842 $wgTitle, if the section is included from a template)
843 $section: The designation of the section being pointed to, to be included in
844 the link, like "§ion=$section"
845 $tooltip: The default tooltip. Escape before using.
846 By default, this is wrapped in the 'editsectionhint' message.
847 &$result: The HTML to return, prefilled with the default plus whatever other
848 changes earlier hooks have made
849 $lang: The language code to use for the link in the wfMessage function
851 'EditFilter': Perform checks on an edit
852 $editor: Edit form (see includes/EditPage.php)
853 $text: Contents of the edit box
854 $section: Section being edited
855 &$error: Error message to return
856 $summary: Edit summary for page
858 'EditFilterMerged': Post-section-merge edit filter.
859 DEPRECATED, use EditFilterMergedContent instead.
860 $editor: EditPage instance (object)
861 $text: content of the edit box
862 &$error: error message to return
863 $summary: Edit summary for page
865 'EditFilterMergedContent': Post-section-merge edit filter
866 $editor: EditPage instance (object)
867 $content: content of the edit box, as a Content object
868 &$error: error message to return
869 $summary: Edit summary for page
871 'EditFormPreloadText': Allows population of the edit form when creating
873 &$text: Text to preload with
874 &$title: Title object representing the page being created
876 'EditFormInitialText': Allows modifying the edit form when editing existing
878 $editPage: EditPage object
880 'EditPage::attemptSave': called before an article is
881 saved, that is before WikiPage::doEditContent() is called
882 $editpage_Obj: the current EditPage object
884 'EditPage::importFormData': allow extensions to read additional data
886 $editpage: EditPage instance
888 return value is ignored (should always return true)
890 'EditPage::showEditForm:fields': allows injection of form field into edit form
891 $editor: the EditPage instance for reference
892 $out: an OutputPage instance to write to
893 return value is ignored (should always return true)
895 'EditPage::showEditForm:initial': before showing the edit form
896 $editor: EditPage instance (object)
897 $out: an OutputPage instance to write to
899 Return false to halt editing; you'll need to handle error messages, etc.
900 yourself. Alternatively, modifying $error and returning true will cause the
901 contents of $error to be echoed at the top of the edit form as wikitext.
902 Return true without altering $error to allow the edit to proceed.
904 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
905 when there's an edit conflict. Return false to halt normal diff output; in
906 this case you're responsible for computing and outputting the entire "conflict"
907 part, i.e., the "difference between revisions" and "your text" headers and
909 &$editor: EditPage instance
910 &$out: OutputPage instance
912 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
913 textarea in the edit form
914 &$editpage: The current EditPage object
915 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
916 &$tabindex: HTML tabindex of the last edit check/button
918 'EditPageBeforeEditChecks': allows modifying the edit checks below the
919 textarea in the edit form
920 &$editpage: The current EditPage object
921 &$checks: Array of edit checks like "watch this page"/"minor edit"
922 &$tabindex: HTML tabindex of the last edit check/button
924 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
925 textarea in the edit form
926 &$toolbar: The toolbar HTMl
928 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
929 $title: title of page being edited
930 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
932 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
933 "Show changes". DEPRECATED. Use EditPageGetDiffContent instead.
934 Note that it is preferrable to implement diff handling for different data types using the ContentHandler facility.
935 $editPage: EditPage object
936 &$newtext: wikitext that will be used as "your version"
938 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
940 Note that it is preferrable to implement diff handling for different data types using the ContentHandler facility.
941 $editPage: EditPage object
942 &$newtext: wikitext that will be used as "your version"
944 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed.
945 DEPRECATED. Use EditPageGetPreviewContent instead.
946 Note that it is preferrable to implement previews for different data types using the COntentHandler facility.
947 $editPage: EditPage object
948 &$toparse: wikitext that will be parsed
950 'EditPageGetPreviewContent': Allow modifying the wikitext that will be previewed.
951 Note that it is preferrable to implement previews for different data types using the COntentHandler facility.
952 $editPage: EditPage object
953 &$content: Content object to be previewed (may be replaced by hook function)
955 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
956 &$editpage: The current EditPage object
957 &$res: the HTML of the error text
959 'EditPageTosSummary': Give a chance for site and per-namespace customizations
960 of terms of service summary link that might exist separately from the copyright
962 $title: title of page being edited
963 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
965 'EditSectionLink': Do not use, use DoEditSectionLink instead.
966 $skin: Skin rendering the UI
967 $title: Title being linked to
968 $section: Section to link to
970 &$result: Result (alter this to override the generated links)
971 $lang: The language code to use for the link in the wfMessage function
973 'EmailConfirmed': When checking that the user's email address is "confirmed"
974 $user: User being checked
975 $confirmed: Whether or not the email address is confirmed
976 This runs before the other checks, such as anonymity and the real check; return
977 true to allow those checks to occur, and false if checking is done.
979 'EmailUser': before sending email from one user to another
980 $to: address of receiving user
981 $from: address of sending user
982 $subject: subject of the mail
983 $text: text of the mail
985 'EmailUserCC': before sending the copy of the email to the author
986 $to: address of receiving user
987 $from: address of sending user
988 $subject: subject of the mail
989 $text: text of the mail
991 'EmailUserComplete': after sending email from one user to another
992 $to: address of receiving user
993 $from: address of sending user
994 $subject: subject of the mail
995 $text: text of the mail
997 'EmailUserForm': after building the email user form object
998 $form: HTMLForm object
1000 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
1001 $user: The user who is trying to email another user.
1002 $editToken: The user's edit token.
1003 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
1005 'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle
1006 $ip: The ip address of the user
1008 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1009 &$extTypes: associative array of extensions types
1011 'ExtractThumbParameters': called when extracting thumbnail parameters from a thumbnail file name
1012 $thumbname: the base name of the thumbnail file
1013 &$params: the currently extracted params (has source name, temp or archived zone)
1015 'FetchChangesList': When fetching the ChangesList derivative for
1017 $user: User the list is being fetched for
1018 &$skin: Skin object to be used with the list
1019 &$list: List object (defaults to NULL, change it to an object
1020 instance and return false override the list derivative used)
1022 'FileDeleteComplete': When a file is deleted
1023 $file: reference to the deleted file
1024 $oldimage: in case of the deletion of an old image, the name of the old file
1025 $article: in case all revisions of the file are deleted a reference to the
1026 WikiFilePage associated with the file.
1027 $user: user who performed the deletion
1030 'FileTransformed': When a file is transformed and moved into storage
1031 $file: reference to the File object
1032 $thumb: the MediaTransformOutput object
1033 $tmpThumbPath: The temporary file system path of the transformed file
1034 $thumbPath: The permanent storage path of the transformed file
1036 'FileUpload': When a file upload occurs
1037 $file : Image object representing the file that was uploaded
1038 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
1039 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
1041 'FileUndeleteComplete': When a file is undeleted
1042 $title: title object to the file
1043 $fileVersions: array of undeleted versions. Empty if all versions were restored
1044 $user: user who performed the undeletion
1047 'FormatAutocomments': When an autocomment is formatted by the Linker
1048 &$comment: Reference to the accumulated comment. Initially null, when set the default code will be skipped.
1049 $pre: Initial part of the parsed comment before the call to the hook.
1050 $auto: The extracted part of the parsed comment before the call to the hook.
1051 $post: The final part of the parsed comment before the call to the hook.
1052 $title: An optional title object used to links to sections. Can be null.
1053 $local: Boolean indicating whether section links should refer to local page.
1055 'GetAutoPromoteGroups': When determining which autopromote groups a user
1056 is entitled to be in.
1057 &$user: user to promote.
1058 &$promote: groups that will be added.
1060 'GetBlockedStatus': after loading blocking status of an user from the database
1061 $user: user (object) being checked
1063 'GetCacheVaryCookies': get cookies that should vary cache options
1064 $out: OutputPage object
1065 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1066 that have to vary cache options
1068 'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
1069 $title: Title object of page
1070 $url: string value as output (out parameter, can modify)
1071 $query: query options passed to Title::getCanonicalURL()
1073 'GetDefaultSortkey': Override the default sortkey for a page.
1074 $title: Title object that we need to get a sortkey for
1075 &$sortkey: Sortkey to use.
1077 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
1078 $title: Title object of page
1079 $url: string value as output (out parameter, can modify)
1080 $query: query options passed to Title::getFullURL()
1082 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
1083 $title: Title object of page
1084 $url: string value as output (out parameter, can modify)
1085 $query: query options passed to Title::getInternalURL()
1087 'GetIP': modify the ip of the current user (called only once)
1088 &$ip: string holding the ip as determined so far
1090 'GetLinkColours': modify the CSS class of an array of page links
1091 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1093 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1095 'GetLocalURL': modify local URLs as output into page links. Note that if you
1096 are working with internal urls (non-interwiki) then it may be preferable
1097 to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
1098 GetLocalURL can be buggy for internal urls on render if you do not
1099 re-implement the horrible hack that Title::getLocalURL uses
1100 in your own extension.
1101 $title: Title object of page
1102 &$url: string value as output (out parameter, can modify)
1103 $query: query options passed to Title::getLocalURL()
1105 'GetLocalURL::Internal': modify local URLs to internal pages.
1106 $title: Title object of page
1107 &$url: string value as output (out parameter, can modify)
1108 $query: query options passed to Title::getLocalURL()
1110 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
1111 without any fancy queries or variants.
1112 $title: Title object of page
1113 &$url: string value as output (out parameter, can modify)
1115 'GetMetadataVersion': modify the image metadata version currently in use. This is
1116 used when requesting image metadata from a ForiegnApiRepo. Media handlers
1117 that need to have versioned metadata should add an element to the end of
1118 the version array of the form 'handler_name=version'. Most media handlers
1119 won't need to do this unless they broke backwards compatibility with a
1120 previous version of the media handler metadata output.
1121 &$version: Array of version strings
1123 'GetPreferences': modify user preferences
1124 $user: User whose preferences are being modified.
1125 &$preferences: Preferences description array, to be fed to an HTMLForm object
1127 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1128 checked for. Use instead of userCan for most cases. Return false if the
1129 user can't do it, and populate $result with the reason in the form of
1130 array( messagename, param1, param2, ... ). For consistency, error messages
1131 should be plain text with no special coloring, bolding, etc. to show that
1132 they're errors; presenting them properly to the user as errors is done by
1134 $title: Title object being checked against
1135 $user : Current user object
1136 $action: Action being checked
1137 $result: User permissions error to add. If none, return true.
1139 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
1140 if expensive checks are enabled.
1142 'GitViewers': called when generating the list of git viewers for Special:Version, use
1143 this to change the list.
1144 &$extTypes: associative array of repo URLS to viewer URLs.
1147 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1148 image insertion. You can skip the default logic entirely by returning
1149 false, or just modify a few things using call-by-reference.
1151 &$title: Title object of the image
1152 &$file: File object, or false if it doesn't exist
1153 &$frameParams: Various parameters with special meanings; see documentation in
1154 includes/Linker.php for Linker::makeImageLink
1155 &$handlerParams: Various parameters with special meanings; see documentation in
1156 includes/Linker.php for Linker::makeImageLink
1157 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1158 &$res: Final HTML output, used if you return false
1161 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1162 the image on an image page
1163 $imagePage: ImagePage object ($this)
1166 'ImagePageAfterImageLinks': called after the image links section on an image
1168 $imagePage: ImagePage object ($this)
1169 &$html: HTML for the hook to add
1171 'ImagePageFileHistoryLine': called when a file history line is contructed
1173 $line: the HTML of the history line
1174 $css: the line CSS class
1176 'ImagePageFindFile': called when fetching the file associated with an image page
1177 $page: ImagePage object
1179 &$displayFile: displayed File object
1181 'ImagePageShowTOC': called when the file toc on an image page is generated
1182 $page: ImagePage object
1183 &$toc: Array of <li> strings
1185 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1187 &$title: the Title object of the file as it would appear for the upload page
1188 &$path: the original file and path name when img_auth was invoked by the the web
1190 &$name: the name only component of the file
1191 &$result: The location to pass back results of the hook routine (only used if
1193 $result[0]=The index of the header message
1194 $result[1]=The index of the body text message
1195 $result[2 through n]=Parameters passed to body text message. Please note the
1196 header message cannot receive/use parameters.
1198 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1199 $reader: XMLReader object
1200 $logInfo: Array of information
1201 Return false to stop further processing of the tag
1203 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1204 $reader: XMLReader object
1205 $pageInfo: Array of information
1206 Return false to stop further processing of the tag
1208 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1209 $reader: XMLReader object
1210 $pageInfo: Array of page information
1211 $revisionInfo: Array of revision information
1212 Return false to stop further processing of the tag
1214 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1215 $reader: XMLReader object
1216 Return false to stop further processing of the tag
1218 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1219 $reader: XMLReader object
1220 $revisionInfo: Array of information
1221 Return false to stop further processing of the tag
1223 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1224 $title: Title object ($wgTitle)
1225 $request: WebRequest
1226 $ignoreRedirect: boolean to skip redirect check
1227 $target: Title/string of redirect target
1228 $article: Article object
1230 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1231 Return true without providing an interwiki to continue interwiki search.
1232 $prefix: interwiki prefix we are looking for.
1233 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1234 iw_trans and optionally iw_api and iw_wikiid.
1236 'InternalParseBeforeSanitize': during Parser's internalParse method just before the
1237 parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/
1238 onlyinclude and other processings. Ideal for syntax-extensions after template/parser
1239 function execution which respect nowiki and HTML-comments.
1240 &$parser: Parser object
1241 &$text: string containing partially parsed text
1242 &$stripState: Parser's internal StripState object
1244 'InternalParseBeforeLinks': during Parser's internalParse method before links
1245 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1246 &$parser: Parser object
1247 &$text: string containing partially parsed text
1248 &$stripState: Parser's internal StripState object
1250 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1251 $user: user (object) whose email is being invalidated
1253 'IRCLineURL': When constructing the URL to use in an IRC notification.
1254 Callee may modify $url and $query, URL will be constructed as $url . $query
1255 &$url: URL to index.php
1256 &$query: Query string
1258 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1259 $article: article (object) being checked
1261 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1263 $result: Change this value to override the result of wfIsTrustedProxy()
1265 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1266 tance to return false if the domain name doesn't match your organization
1267 $addr: The e-mail address entered by the user
1268 &$result: Set this and return false to override the internal checks
1270 'isValidPassword': Override the result of User::isValidPassword()
1271 $password: The password entered by the user
1272 &$result: Set this and return false to override the internal checks
1273 $user: User the password is being validated for
1275 'Language::getMessagesFileName':
1276 $code: The language code or the language we're looking for a messages file for
1277 &$file: The messages file path, you can override this to change the location.
1279 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1280 remove namespaces. Do not use this hook to add namespaces. Use
1281 CanonicalNamespaces for that.
1282 &$namespaces: Array of namespaces indexed by their numbers
1284 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1285 $wgExtensionMessagesFiles instead.
1286 Use this to define synonyms of magic words depending of the language
1287 $magicExtensions: associative array of magic words synonyms
1288 $lang: laguage code (string)
1290 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1291 listed in $wgExtensionMessagesFiles instead.
1292 Use to define aliases of special pages names depending of the language
1293 $specialPageAliases: associative array of magic words synonyms
1294 $lang: laguage code (string)
1296 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1297 &$names: array of language code => language name
1298 $code language of the preferred translations
1300 'LinkBegin': Used when generating internal and interwiki links in
1301 Linker::link(), before processing starts. Return false to skip default proces-
1302 sing and return $ret. See documentation for Linker::link() for details on the
1303 expected meanings of parameters.
1304 $skin: the Skin object
1305 $target: the Title that the link is pointing to
1306 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1308 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1309 tive array form, with keys and values unescaped. Should be merged with de-
1310 fault values, with a value of false meaning to suppress the attribute.
1311 &$query: the query string to add to the generated URL (the bit after the "?"),
1312 in associative array form, with keys and values unescaped.
1313 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1314 &$ret: the value to return if your hook returns false.
1316 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1317 just before the function returns a value. If you return true, an <a> element
1318 with HTML attributes $attribs and contents $html will be returned. If you re-
1319 turn false, $ret will be returned.
1320 $skin: the Skin object
1321 $target: the Title object that the link is pointing to
1322 $options: the options. Will always include either 'known' or 'broken', and may
1323 include 'noclasses'.
1324 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1325 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1327 &$ret: the value to return if your hook returns false.
1329 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1331 &$url: the image url
1332 &$alt: the image's alt text
1333 &$img: the new image HTML (if returning false)
1335 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1338 &$text: the link text
1339 &$link: the new link HTML (if returning false)
1340 &$attribs: the attributes to be applied.
1341 $linkType: The external link type
1343 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1345 &$linksUpdate: the LinksUpdate object
1347 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1349 &$linksUpdate: the LinksUpdate object
1351 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1352 &$linksUpdate: the LinksUpdate object
1354 'ListDefinedTags': When trying to find all defined tags.
1355 &$tags: The list of tags.
1357 'LoadExtensionSchemaUpdates': called during database installation and updates
1358 &updater: A DatabaseUpdater subclass
1360 'LocalFile::getHistory': called before file history query performed
1361 $file: the File object
1363 $fields: select fields
1365 $opts: query options
1366 $join_conds: JOIN conditions
1368 'LocalFilePurgeThumbnails': called before thumbnails for a local file a purged
1369 $file: the File object
1370 $archiveName: name of an old file version or false if it's the current one
1372 'LocalisationCacheRecache': Called when loading the localisation data into cache
1373 $cache: The LocalisationCache object
1374 $code: language code
1375 &$alldata: The localisation data from core and extensions
1377 'LogEventsListShowLogExtract': called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage
1378 &$s: html string to show for the log extract
1379 $types: String or Array Log types to show
1380 $page: String or Title The page title to show log entries for
1381 $user: String The user who made the log entries
1382 $param: Associative Array with the following additional options:
1383 - lim Integer Limit of items to show, default is 50
1384 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1385 - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
1386 - msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wfMessage()->params()->parseAsBlock()
1387 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset
1388 - wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
1389 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1391 'LoggableUserIPData': called when IP data for a user action can be logged by extensions like CheckUser.
1392 This is intended for when users do things that do not already create edits or log entries.
1393 $context: The context the of the action, which includes the user and request
1394 $data: Associative array of data for handlers to record. It must include values for:
1395 - 'namespace' Integer namespace for target title (NS_SPECIAL is allowed)
1396 - 'title' Database key string for target title (empty string if not applicable)
1397 - 'pageid' Integer page ID for target title (zero if not applicable)
1398 - 'action' Wikitext string in the same format as an edit summary
1399 - 'comment' Wikitext string in the same format as an edit summary
1400 - 'timestamp' Timestamp when the action occured
1402 'LoginAuthenticateAudit': a login attempt for a valid user account either
1403 succeeded or failed. No return data is accepted; this hook is for auditing only.
1404 $user: the User object being authenticated against
1405 $password: the password being submitted and found wanting
1406 $retval: a LoginForm class constant with authenticateUserData() return
1407 value (SUCCESS, WRONG_PASS, etc)
1409 'LogLine': Processes a single log entry on Special:Log
1410 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1411 logging.log_type database field.
1412 $log_action: string for the type of log action (e.g. 'delete', 'block',
1413 'create2'). Corresponds to logging.log_action database field.
1414 $title: Title object that corresponds to logging.log_namespace and
1415 logging.log_title database fields.
1416 $paramArray: Array of parameters that corresponds to logging.log_params field.
1417 Note that only $paramArray[0] appears to contain anything.
1418 &$comment: string that corresponds to logging.log_comment database field, and
1419 which is displayed in the UI.
1420 &$revert: string that is displayed in the UI, similar to $comment.
1421 $time: timestamp of the log entry (added in 1.12)
1423 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1424 $refreshLinks: RefreshLinks object
1426 'MagicWordwgVariableIDs': When definig new magic words IDs.
1427 $variableIDs: array of strings
1429 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1430 is executed. Ideally, this hook should only be used to add variables that
1431 depend on the current page/request; static configuration should be added
1432 through ResourceLoaderGetConfigVars instead.
1433 &$vars: variable (or multiple variables) to be added into the output
1434 of Skin::makeVariablesScript
1435 $out: The OutputPage which called the hook,
1436 can be used to get the real title
1438 'MarkPatrolled': before an edit is marked patrolled
1439 $rcid: ID of the revision to be marked patrolled
1440 $user: the user (object) marking the revision as patrolled
1441 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1442 needs to be a sysop in order to mark an edit patrolled
1444 'MarkPatrolledComplete': after an edit is marked patrolled
1445 $rcid: ID of the revision marked as patrolled
1446 $user: user (object) who marked the edit patrolled
1447 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1448 must be a sysop to patrol the edit
1450 'MediaWikiPerformAction': Override MediaWiki::performAction().
1451 Use this to do something completely different, after the basic
1452 globals have been set up, but before ordinary actions take place.
1454 $article: $wgArticle
1457 $request: $wgRequest
1458 $mediaWiki: The $mediawiki object
1460 'MessagesPreLoad': When loading a message from the database
1461 $title: title of the message (string)
1462 $message: value (string), change it to the message you want to define
1464 'MessageCacheReplace': When a message page is changed.
1465 Useful for updating caches.
1466 $title: name of the page changed.
1467 $text: new contents of the page.
1469 'ModifyExportQuery': Modify the query used by the exporter.
1470 $db: The database object to be queried.
1471 &$tables: Tables in the query.
1472 &$conds: Conditions in the query.
1473 &$opts: Options for the query.
1474 &$join_conds: Join conditions for the query.
1476 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1477 been rendered (useful for adding more)
1478 Note: this is only run for the Monobook skin. This hook is deprecated and
1479 may be removed in the future. To add items to the toolbox you should use
1480 the SkinTemplateToolboxEnd hook instead, which works for all
1481 "SkinTemplate"-type skins.
1482 $tools: array of tools
1484 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1485 and returning it for the skin to output. You can add items to the toolbox while
1486 still letting the skin make final decisions on skin-specific markup conventions
1488 &$sk: The BaseTemplate base skin template
1489 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1490 BaseTemplate::makeListItem for details on the format of individual
1491 items inside of this array
1493 'NamespaceIsMovable': Called when determining if it is possible to pages in a namespace.
1494 $index: Integer; the index of the namespace being checked.
1495 $result: Boolean; whether MediaWiki currently thinks that pages in this namespace are movable.
1496 Hooks may change this value to override the return value of MWNamespace::isMovable()
1498 'NewRevisionFromEditComplete': called when a revision was inserted
1500 $article: the WikiPage edited
1501 $rev: the new revision
1502 $baseID: the revision ID this was based off, if any
1503 $user: the editing user
1505 'NormalizeMessageKey': Called before the software gets the text of a message
1506 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1508 &$key: the message being looked up. Change this to something else to change
1509 what message gets displayed (string)
1510 &$useDB: whether or not to look up the message in the database (bool)
1511 &$langCode: the language code to get the message for (string) - or -
1512 whether to use the content language (true) or site language (false) (bool)
1513 &$transform: whether or not to expand variables and templates
1514 in the message (bool)
1516 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1517 &$changeslist: The OldChangesList instance.
1518 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1519 &$rc: The RecentChange object.
1521 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1522 Hooks can alter or append to the array of URLs for search & suggestion formats.
1523 &$urls: array of associative arrays with Url element attributes
1525 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1526 users and/or IP addresses too
1527 $otherBlockLink: An array with links to other block logs
1528 $ip: The requested IP address or username
1530 'OutputPageBeforeHTML': a page has been processed by the parser and
1531 the resulting HTML is about to be displayed.
1532 $parserOutput: the parserOutput (object) that corresponds to the page
1533 $text: the text that will be displayed, in HTML (string)
1535 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1536 tag to allow for extensions to add attributes to the body of the page they might
1537 need. Or to allow building extensions to add body classes that aren't of high
1538 enough demand to be included in core.
1539 $out: The OutputPage which called the hook, can be used to get the real title
1540 $sk: The Skin that called OutputPage::headElement
1541 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1543 'OutputPageCheckLastModified': when checking if the page has been modified
1544 since the last visit
1545 &$modifiedTimes: array of timestamps.
1546 The following keys are set: page, user, epoch
1548 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1549 $out: OutputPage instance (object)
1550 $parserOutput: parserOutput instance being added in $out
1552 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1553 categories. Implementations should return false if they generate the category
1554 links, so the default link generation is skipped.
1555 $out: OutputPage instance (object)
1556 $categories: associative array, keys are category names, values are category
1557 types ("normal" or "hidden")
1558 $links: array, intended to hold the result. Must be an associative array with
1559 category types as keys and arrays of HTML links as values.
1561 'PageContentLanguage': allows changing the language in which the content of
1562 a page is written. Defaults to the wiki content language ($wgContLang).
1563 $title: Title object
1564 &$pageLang: the page content language (either an object or a language code)
1565 $wgLang: the user language
1567 'PageHistoryBeforeList': When a history page list is about to be constructed.
1568 $article: the article that the history is loading for
1570 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1571 $row: the revision row for this line
1572 $s: the string representing this parsed line
1573 $classes: array containing the <li> element classes
1575 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1578 $queryInfo: the query parameters
1580 'PageRenderingHash': alter the parser cache option hash key
1581 A parser extension which depends on user options should install
1582 this hook and append its values to the key.
1583 $hash: reference to a hash key string which can be modified
1585 'ParserAfterParse': Called from Parser::parse() just after the call to
1586 Parser::internalParse() returns
1587 $parser: parser object
1588 $text: text being parsed
1589 $stripState: stripState used (object)
1591 'ParserAfterStrip': Same as ParserBeforeStrip
1593 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1594 $parser: Parser object being used
1595 $text: text that'll be returned
1597 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1598 $parser: Parser object
1599 $text: text to parse
1600 $stripState: StripState instance being used
1602 'ParserBeforeStrip': Called at start of parsing time
1603 (no more strip, deprecated ?)
1604 $parser: parser object
1605 $text: text being parsed
1606 $stripState: stripState used (object)
1608 'ParserBeforeTidy': called before tidy and custom tags replacements
1609 $parser: Parser object being used
1612 'ParserClearState': called at the end of Parser::clearState()
1613 $parser: Parser object being cleared
1615 'ParserFirstCallInit': called when the parser initialises for the first time
1616 &$parser: Parser object being cleared
1618 'ParserGetVariableValueSwitch': called when the parser need the value of a
1620 $parser: Parser object
1621 $varCache: array to store the value in case of multiples calls of the
1623 $index: index (string) of the magic
1624 $ret: value of the magic word (the hook should set it)
1625 $frame: PPFrame object to use for expanding any template variables
1627 'ParserGetVariableValueTs': use this to change the value of the time for the
1628 {{LOCAL...}} magic word
1629 $parser: Parser object
1630 $time: actual time (timestamp)
1632 'ParserGetVariableValueVarCache': use this to change the value of the
1633 variable cache or return false to not use it
1634 $parser: Parser object
1635 $varCache: varaiable cache (array)
1637 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1638 include comments about size of the text parsed
1639 $parser: Parser object
1640 $limitReport: text that will be included (without comment tags)
1642 'ParserMakeImageParams': Called before the parser make an image link, use this
1643 to modify the parameters of the image.
1644 $title: title object representing the file
1645 $file: file object that will be used to create the image
1646 &$params: 2-D array of parameters
1647 $parser: Parser object that called the hook
1649 'ParserSectionCreate': Called each time the parser creates a document section
1650 from wikitext. Use this to apply per-section modifications to HTML (like
1651 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1652 can begin in one section and end in another. Make sure your code can handle
1653 that case gracefully. See the EditSectionClearerLink extension for an
1655 $parser: the calling Parser instance
1656 $section: the section number, zero-based, but section 0 is usually empty
1657 &$sectionContent: ref to the content of the section. modify this.
1658 $showEditLinks: boolean describing whether this section has an edit link
1660 'ParserTestParser': called when creating a new instance of Parser in
1661 maintenance/parserTests.inc
1662 $parser: Parser object created
1664 'ParserTestGlobals': Allows to define globals for parser tests.
1665 &$globals: Array with all the globals which should be set for parser tests.
1666 The arrays keys serve as the globals names, its values are the globals values.
1668 'ParserTestTables': alter the list of tables to duplicate when parser tests
1669 are run. Use when page save hooks require the presence of custom tables
1670 to ensure that tests continue to run properly.
1671 &$tables: array of table names
1673 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1674 my talk page, my contributions" etc).
1675 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1676 &$title: Title object representing the current page
1678 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1679 &$user : User performing the action
1680 $action : Action being performed
1681 &$result : Whether or not the action should be prevented
1682 Change $result and return false to give a definitive answer, otherwise
1683 the built-in rate limiting checks are used, if enabled.
1685 'PlaceNewSection': Override placement of new sections.
1686 $wikipage : WikiPage object
1687 $oldtext : the text of the article before editing
1688 $subject : subject of the new section
1689 &$text : text of the new section
1690 Return false and put the merged text into $text to override the default behavior.
1692 'PreferencesGetLegend': Override the text used for the <legend> of a preferences section
1693 $form: the PreferencesForm object. This is a ContextSource as well
1694 $key: the section name
1695 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1697 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1698 AJAX search suggestions. Put results into &$results outparam and return false.
1699 $ns : array of int namespace keys to search in
1700 $search : search term (not guaranteed to be conveniently normalized)
1701 $limit : maximum number of results to return
1702 &$results : out param: array of page names (strings)
1704 'PrefsEmailAudit': called when user changes his email address
1705 $user: User (object) changing his email address
1706 $oldaddr: old email address (string)
1707 $newaddr: new email address (string)
1709 'PrefsPasswordAudit': called when user changes his password
1710 $user: User (object) changing his passoword
1711 $newPass: new password
1712 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1714 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1715 $article: the title being (un)protected
1716 $output: a string of the form HTML so far
1718 'ProtectionForm::save': called when a protection form is submitted
1719 $article: the title being (un)protected
1720 $errorMsg: an html message string of an error or an array of message name and its parameters
1722 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1723 $article: the page the form is shown for
1724 $out: OutputPage object
1726 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1727 &$obj: RawPage object
1728 &$text: The text that's going to be the output
1730 'RecentChange_save': called at the end of RecentChange::save()
1731 $recentChange: RecentChange object
1733 'RedirectSpecialArticleRedirectParams': lets you alter the set of
1734 parameter names such as "oldid" that are preserved when using
1735 redirecting special pages such as Special:MyPage and Special:MyTalk.
1736 &$redirectParams: An array of parameters preserved by redirecting special pages.
1738 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin instance.
1739 Can be used by an extension override what skin is used in certain contexts.
1740 IContextSource $context: The RequestContext the skin is being created for.
1741 &$skin: A variable reference you may set a Skin instance or string key on to override the skin that will be used for the context.
1743 'ResourceLoaderGetConfigVars': called at the end of
1744 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1745 configuration variables to JavaScript. Things that depend on the current
1746 page/request state must be added through MakeGlobalVariablesScript instead.
1747 &$vars: array( variable name => value )
1749 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1750 to add modules to the startup module. This hook should be used sparingly since any module added here
1751 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1754 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1755 loader request or generating HTML output.
1756 &$resourceLoader: ResourceLoader object
1758 'ResourceLoaderTestModules': let you add new JavaScript testing modules. This is called after the addition of 'qunit' and MediaWiki testing resources.
1759 &testModules: array of JavaScript testing modules. The 'qunit' framework, included in core, is fed using tests/qunit/QUnitTestResources.php.
1760 &ResourceLoader object
1761 To add a new qunit module named 'myext.tests':
1762 testModules['qunit']['myext.tests'] = array(
1763 'script' => 'extension/myext/tests.js',
1764 'dependencies' => <any module dependency you might have>
1766 For qunit framework, the mediawiki.tests.qunit.testrunner dependency will be added to any module.
1768 'RevisionInsertComplete': called after a revision is inserted into the DB
1769 &$revision: the Revision
1770 $data: the data stored in old_text. The meaning depends on $flags: if external
1771 is set, it's the URL of the revision text in external storage; otherwise,
1772 it's the revision text itself. In either case, if gzip is set, the revision
1774 $flags: a comma-delimited list of strings representing the options used. May
1775 include: utf8 (this will always be set for new revisions); gzip; external.
1777 'SearchUpdate': Prior to search update completion
1779 $namespace : Page namespace
1781 $text : Current text being indexed
1783 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1784 $allSearchTerms : Array of the search terms in all content languages
1785 &$titleResult : Outparam; the value to return. A Title object or null.
1787 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1788 $term : Search term string
1789 &$title : Outparam; set to $title object and return false for a match
1791 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1792 $term : Search term string
1793 &$title : Current Title object that is being returned (null if none found).
1795 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1796 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1797 in the $searchEngine->namespaces array.
1798 $query : Original query.
1799 &$parsed : Resultant query with the prefixes stripped.
1801 'SearchResultInitFromTitle': Set the revision used when displaying a page in
1803 $title : Current Title object being displayed in search results.
1804 &$id: Revision ID (default is false, for latest)
1806 'SearchableNamespaces': An option to modify which namespaces are searchable.
1807 &$arr : Array of namespaces ($nsId => $name) which will be used.
1809 'SetupAfterCache': Called in Setup.php, after cache objects are set
1811 'ShowMissingArticle': Called when generating the output for a non-existent page
1812 $article: The article object corresponding to the page
1814 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
1815 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
1816 $text: Text being shown
1817 $title: Title of the custom script/stylesheet page
1818 $output: Current OutputPage object
1820 'ShowSearchHitTitle': Customise display of search hit title/link.
1821 &$title: Title to link to
1822 &$text: Text to use for the link
1823 $result: The search result
1824 $terms: The search terms entered
1825 $page: The SpecialSearch object.
1827 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1828 &$siteNotice: HTML returned as the sitenotice
1830 Return true to allow the normal method of notice selection/rendering to work,
1831 or change the value of $siteNotice and return false to alter it.
1833 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1834 &$siteNotice: HTML sitenotice
1836 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1838 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1840 &$text: bottomScripts Text
1841 Append to $text to add additional text/scripts after the stock bottom scripts.
1843 'SkinAfterContent': Allows extensions to add text after the page content and
1845 &$data: (string) Text to be printed out directly (without parsing)
1847 This hook should work in all skins. Just set the &$data variable to the text
1848 you're going to add.
1850 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1852 &$bar: Sidebar contents
1853 Modify $bar to add or modify sidebar portlets.
1855 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1856 $title: displayed page title
1857 $type: 'normal' or 'history' for old/diff views
1858 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1859 &$link: overridable HTML link to be passed into the message as $1
1860 &$forContent: overridable flag if copyright footer is shown in content language.
1863 &$text: additional 'powered by' icons in HTML.
1864 Note: Modern skin does not use the MediaWiki icon but plain text instead
1867 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1868 &$subpages: Subpage links HTML
1870 $out: OutputPage object
1871 If false is returned $subpages will be used instead of the HTML
1872 subPageSubtitle() generates.
1873 If true is returned, $subpages will be ignored and the rest of
1874 subPageSubtitle() will run.
1876 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1877 "permanent link" tab
1878 $sktemplate: SkinTemplate object
1879 $nav_urls: array of tabs
1881 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1882 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1883 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1884 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1885 &$sktemplate: SkinTemplate object
1886 &$links: Structured navigation links
1887 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1889 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1891 &$sktemplate: SkinTemplate object
1892 &$tpl: Template engine object
1894 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1895 $sktemplate: SkinTemplate object
1896 $res: set to true to prevent active tabs
1898 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1899 You can either create your own array, or alter the parameters for
1901 &$sktemplate: The SkinTemplate instance.
1902 $title: Title instance for the page.
1903 $message: Visible label of tab.
1904 $selected: Whether this is a selected tab.
1905 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1906 &$classes: Array of CSS classes to apply.
1907 &$query: Query string to add to link.
1909 &$result: Complete assoc. array if you want to return true.
1911 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1912 been rendered (useful for adding more)
1913 $sk: The QuickTemplate based skin template running the hook.
1914 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
1915 extensions that add support for BaseTemplateToolbox should watch for this dummy
1916 parameter with "$dummy=false" in their code and return without echoing any html
1917 to avoid creating duplicate toolbox items.
1919 'SoftwareInfo': Called by Special:Version for returning information about
1921 $software: The array of software in format 'name' => 'version'.
1922 See SpecialVersion::softwareInformation()
1924 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1925 $id: User identifier
1927 'SpecialListusersDefaultQuery': called right before the end of
1928 UsersPager::getDefaultQuery()
1929 $pager: The UsersPager instance
1930 $query: The query array to be returned
1932 'SpecialListusersFormatRow': called right before the end of
1933 UsersPager::formatRow()
1934 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1935 $row: Database row object
1937 'SpecialListusersHeader': called before closing the <fieldset> in
1938 UsersPager::getPageHeader()
1939 $pager: The UsersPager instance
1940 $out: The header HTML
1942 'SpecialListusersHeaderForm': called before adding the submit button in
1943 UsersPager::getPageHeader()
1944 $pager: The UsersPager instance
1945 $out: The header HTML
1947 'SpecialListusersQueryInfo': called right before the end of
1948 UsersPager::getQueryInfo()
1949 $pager: The UsersPager instance
1950 $query: The query array to be returned
1952 'SpecialMovepageAfterMove': called after moving a page
1953 $movePage: MovePageForm object
1954 $oldTitle: old title (object)
1955 $newTitle: new title (object)
1957 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1958 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1959 $opts: FormOptions object containing special page options
1960 &$conds: array of WHERE conditionals for query
1961 &tables: array of tables to be queried
1962 &$fields: array of columns to select
1963 &$join_conds: join conditions for the tables
1965 'SpecialNewPagesFilters': called after building form options at NewPages
1966 $special: the special page object
1967 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1968 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1970 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1971 hook to remove a core special page
1972 $list: list (array) of core special pages
1974 'SpecialPageAfterExecute': called after SpecialPage::execute
1975 $special: the SpecialPage object
1976 $subPage: the subpage string or null if no subpage was specified
1978 'SpecialPageBeforeExecute': called before SpecialPage::execute
1979 $special: the SpecialPage object
1980 $subPage: the subpage string or null if no subpage was specified
1982 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1983 $users: array of User objects
1984 $data: array of data submitted by the user
1985 &$error: string, error code (message name) used to describe to error (out paramater).
1986 The hook needs to return false when setting this, otherwise it will have no effect.
1988 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1989 use this to change some selection criteria or substitute a different title
1990 &$randstr: The random number from wfRandom()
1991 &$isRedir: Boolean, whether to select a redirect or non-redirect
1992 &$namespaces: An array of namespace indexes to get the title from
1993 &$extra: An array of extra SQL statements
1994 &$title: If the hook returns false, a Title object to use instead of the
1995 result from the normal query
1997 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1998 $special: the special page object
1999 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
2000 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2002 'SpecialRecentChangesPanel': called when building form options in
2003 SpecialRecentChanges
2004 &$extraOpts: array of added items, to which can be added
2005 $opts: FormOptions for this request
2007 'SpecialRecentChangesQuery': called when building sql query for
2008 SpecialRecentChanges and SpecialRecentChangesLinked
2009 &$conds: array of WHERE conditionals for query
2010 &$tables: array of tables to be queried
2011 &$join_conds: join conditions for the tables
2012 $opts: FormOptions for this request
2013 &$query_options: array of options for the database request
2014 &$select: Array of columns to select
2016 'SpecialSearchCreateLink': called when making the message to create a page or
2017 go to the existing page
2018 $t: title object searched for
2019 &$params: an array of the default message name and page title (as parameter)
2021 'SpecialSearchGo': called when user clicked the "Go"
2022 &$title: title object generated from the text entered by the user
2023 &$term: the search term entered by the user
2025 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
2026 target doesn't exist
2027 &$title: title object generated from the text entered by the user
2029 'SpecialSearchPowerBox': the equivalent of SpecialSearchProfileForm for
2030 the advanced form, a.k.a. power search box
2031 &$showSections: an array to add values with more options to
2032 $term: the search term (not a title object)
2033 $opts: an array of hidden options (containing 'redirs' and 'profile')
2035 'SpecialSearchProfiles': allows modification of search profiles
2036 &$profiles: profiles, which can be modified.
2038 'SpecialSearchProfileForm': allows modification of search profile forms
2039 $search: special page object
2040 &$form: String: form html
2041 $profile: String: current search profile
2042 $term: String: search term
2043 $opts: Array: key => value of hidden options for inclusion in custom forms
2045 'SpecialSearchSetupEngine': allows passing custom data to search engine
2046 $search: special page object
2047 $profile: String: current search profile
2048 $engine: the search engine
2050 'SpecialSearchResults': called before search result display when there
2052 $term: string of search term
2053 &$titleMatches: empty or SearchResultSet object
2054 &$textMatches: empty or SearchResultSet object
2056 'SpecialSearchNoResults': called before search result display when there are
2058 $term: string of search term
2060 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
2061 &$extraStats: Array to save the new stats
2062 ( $extraStats['<name of statistic>'] => <value>; )
2064 'SpecialUploadComplete': Called after successfully uploading a file from
2066 $form: The SpecialUpload object
2068 'SpecialVersionExtensionTypes': called when generating the extensions credits,
2069 use this to change the tables headers
2070 $extTypes: associative array of extensions types
2072 'SpecialWatchlistFilters': called after building form options at Watchlist
2073 $special: the special page object
2074 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
2075 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2077 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
2078 &$conds: array of WHERE conditionals for query
2079 &$tables: array of tables to be queried
2080 &$join_conds: join conditions for the tables
2081 &$fields: array of query fields
2083 'TestCanonicalRedirect': called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. Gives a chance for extensions that alter page view behavior radically to abort that redirect or handle it manually.
2084 $request: WebRequest
2085 $title: Title of the currently found title obj
2086 $output: OutputPage object
2088 'TitleArrayFromResult': called when creating an TitleArray object from a
2090 &$titleArray: set this to an object to override the default object returned
2091 $res: database result used to create the object
2093 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2094 that can be applied.
2095 $title: The title in question.
2096 &$types: The types of protection available.
2098 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
2099 $title: Title object that is being checked
2100 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
2102 'TitleIsAlwaysKnown': Called when determining if a page exists.
2103 Allows overriding default behaviour for determining if a page exists.
2104 If $isKnown is kept as null, regular checks happen. If it's a boolean, this value is returned by the isKnown method.
2105 $title: Title object that is being checked
2106 $result: Boolean|null; whether MediaWiki currently thinks this page is known
2108 'TitleIsMovable': Called when determining if it is possible to move a page.
2109 Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
2110 $title: Title object that is being checked
2111 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
2113 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2114 be handled by seperate handler (via ArticleViewCustom)
2115 $title: Title object that is being checked
2116 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
2118 'TitleMoveComplete': after moving an article (title)
2121 $user: user who did the move
2122 $pageid: database ID of the page that's been moved
2123 $redirid: database ID of the created redirect
2125 'TitleReadWhitelist': called at the end of read permissions checks, just before
2126 adding the default error message if nothing allows the user to read the page.
2127 If a handler wants a title to *not* be whitelisted, it should also return false.
2128 $title: Title object being checked against
2129 $user: Current user object
2130 &$whitelisted: Boolean value of whether this title is whitelisted
2132 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
2133 PageArchive object has been created but before any further processing is done.
2134 &$archive: PageArchive object
2135 $title: Title object of the page that we're viewing
2137 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
2138 PageArchive object has been created but before any further processing is done.
2139 &$archive: PageArchive object
2140 $title: Title object of the page that we're viewing
2142 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
2143 the site is not in read-only mode, that the Title object is not null and after
2144 a PageArchive object has been constructed but before performing any further
2146 &$archive: PageArchive object
2147 $title: Title object of the page that we're about to undelete
2149 'UndeleteShowRevision': called when showing a revision in Special:Undelete
2150 $title: title object related to the revision
2151 $rev: revision (object) that will be viewed
2153 'UnknownAction': An unknown "action" has occured (useful for defining
2155 $action: action name
2156 $article: article "acted on"
2158 'UnitTestsList': Called when building a list of files with PHPUnit tests
2159 &$files: list of files
2161 'UnwatchArticle': before a watch is removed from an article
2162 $user: user watching
2163 $page: WikiPage object to be removed
2165 'UnwatchArticleComplete': after a watch is removed from an article
2166 $user: user that watched
2167 $page: WikiPage object that was watched
2169 'UploadForm:initial': before the upload form is generated
2170 $form: UploadForm object
2171 You might set the member-variables $uploadFormTextTop and
2172 $uploadFormTextAfterSummary to inject text (HTML) either before
2173 or after the editform.
2175 'UploadForm:BeforeProcessing': at the beginning of processUpload()
2176 $form: UploadForm object
2177 Lets you poke at member variables like $mUploadDescription before the
2179 Do not use this hook to break upload processing. This will return the user to
2180 a blank form with no error message; use UploadVerification and
2181 UploadVerifyFile instead
2183 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
2184 $type: (string) the requested upload type
2185 &$className: the class name of the Upload instance to be created
2187 'UploadComplete': when Upload completes an upload
2188 &$upload: an UploadBase child instance
2190 'UploadFormInitDescriptor': after the descriptor for the upload form as been
2192 $descriptor: (array) the HTMLForm descriptor
2194 'UploadFormSourceDescriptors': after the standard source inputs have been
2195 added to the descriptor
2196 $descriptor: (array) the HTMLForm descriptor
2198 'UploadVerification': additional chances to reject an uploaded file. Consider
2199 using UploadVerifyFile instead.
2200 string $saveName: destination file name
2201 string $tempName: filesystem path to the temporary file for checks
2202 string &$error: output: message key for message to show if upload canceled
2203 by returning false. May also be an array, where the first element
2204 is the message key and the remaining elements are used as parameters to
2207 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2208 in most cases over UploadVerification.
2209 object $upload: an instance of UploadBase, with all info about the upload
2210 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
2211 will typically only apply for specific mime types.
2212 object &$error: output: true if the file is valid. Otherwise, an indexed array
2213 representing the problem with the file, where the first element
2214 is the message key and the remaining elements are used as parameters to
2217 'UploadComplete': Upon completion of a file upload
2218 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2219 $uploadBase->getLocalFile().
2221 'User::mailPasswordInternal': before creation and mailing of a user's new
2223 $user: the user who sent the message out
2224 $ip: IP of the user who sent the message out
2225 $u: the account whose new password will be set
2227 'UserAddGroup': called when adding a group; return false to override
2228 stock group addition.
2229 $user: the user object that is to have a group added
2230 &$group: the group to add, can be modified
2232 'UserArrayFromResult': called when creating an UserArray object from a
2234 &$userArray: set this to an object to override the default object returned
2235 $res: database result used to create the object
2237 'userCan': To interrupt/advise the "user can do X to Y article" check.
2238 If you want to display an error message, try getUserPermissionsErrors.
2239 $title: Title object being checked against
2240 $user : Current user object
2241 $action: Action being checked
2242 $result: Pointer to result returned if hook returns false. If null is returned,
2243 userCan checks are continued by internal code.
2245 'UserCanSendEmail': To override User::canSendEmail() permission check
2246 $user: User (object) whose permission is being checked
2247 &$canSend: bool set on input, can override on output
2249 'UserClearNewTalkNotification': called when clearing the
2250 "You have new messages!" message, return false to not delete it
2251 $user: User (object) that'll clear the message
2253 'UserComparePasswords': called when checking passwords, return false to
2254 override the default password checks
2255 &$hash: String of the password hash (from the database)
2256 &$password: String of the plaintext password the user entered
2257 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2259 &$result: If the hook returns false, this Boolean value will be checked to
2260 determine if the password was valid
2262 'UserCreateForm': change to manipulate the login form
2263 $template: SimpleTemplate instance for the form
2265 'UserCryptPassword': called when hashing a password, return false to implement
2266 your own hashing method
2267 &$password: String of the plaintext password to encrypt
2268 &$salt: String of the password salt or Boolean false if no salt is provided
2269 &$wgPasswordSalt: Boolean of whether the salt is used in the default
2271 &$hash: If the hook returns false, this String will be used as the hash
2273 'UserEffectiveGroups': Called in User::getEffectiveGroups()
2274 $user: User to get groups for
2275 &$groups: Current effective groups
2277 'UserGetAllRights': after calculating a list of all available rights
2278 &$rights: Array of rights, which may be added to.
2280 'UserGetDefaultOptions': after fetching the core default, this hook is ran
2281 right before returning the options to the caller. WARNING: this hook is
2282 called for every call to User::getDefaultOptions(), which means it's
2283 potentially called dozens or hundreds of times. You may want to cache
2284 the results of non-trivial operations in your hook function for this reason.
2285 &$defaultOptions: Array of preference keys and their default values.
2287 'UserGetEmail': called when getting an user email address
2289 &$email: email, change this to override local email
2291 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
2292 email authentification
2294 &$timestamp: timestamp, change this to override local email authentification
2297 'UserGetImplicitGroups': Called in User::getImplicitGroups()
2298 &$groups: List of implicit (automatically-assigned) groups
2300 'UserGetLanguageObject': Called when getting user's interface language object
2302 &$code: Langauge code that will be used to create the object
2304 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2305 &$reservedUsernames: $wgReservedUsernames
2307 'UserGetRights': Called in User::getRights()
2308 $user: User to get rights for
2309 &$rights: Current rights
2311 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
2313 $user: User in question
2314 $title: Title of the page in question
2315 &$blocked: Out-param, whether or not the user is blocked from that page.
2316 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2317 own user talk pages.
2319 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2321 $ip: User's IP address
2322 &$blocked: Whether the user is blocked, to be modified by the hook
2324 'UserLoadAfterLoadFromSession': called to authenticate users on
2325 external/environmental means; occurs after session is loaded
2326 $user: user object being loaded
2328 'UserLoadDefaults': called when loading a default user
2332 'UserLoadFromDatabase': called when loading a user from the database
2334 &$s: database query object
2336 'UserLoadFromSession': called to authenticate users on external/environmental
2337 means; occurs before session is loaded
2338 $user: user object being loaded
2339 &$result: set this to a boolean value to abort the normal authentification
2342 'UserLoadOptions': when user options/preferences are being loaded from
2345 &$options: Options, can be modified.
2347 'UserLoginComplete': after a user has logged in
2348 $user: the user object that was created on login
2349 $inject_html: Any HTML to inject after the "logged in" message.
2351 'UserLoginForm': change to manipulate the login form
2352 $template: SimpleTemplate instance for the form
2354 'UserLogout': before a user logs out
2355 $user: the user object that is about to be logged out
2357 'UserLogoutComplete': after a user has logged out
2358 $user: the user object _after_ logout (won't have name, ID, etc.)
2359 $inject_html: Any HTML to inject after the "logged out" message.
2360 $oldName: name of the user before logout (string)
2362 'UserRemoveGroup': called when removing a group; return false to override
2363 stock group removal.
2364 $user: the user object that is to have a group removed
2365 &$group: the group to be removed, can be modified
2367 'UserRights': After a user's group memberships are changed
2368 $user : User object that was changed
2369 $add : Array of strings corresponding to groups added
2370 $remove: Array of strings corresponding to groups removed
2372 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2374 $user: user retrieving new talks messages
2375 $talks: array of new talks page(s)
2377 'UserSaveSettings': called when saving user settings
2380 'UserSaveOptions': Called just before saving user preferences/options.
2382 &$options: Options, modifiable
2384 'UserSetCookies': called when setting user cookies
2386 &$session: session array, will be added to $_SESSION
2387 &$cookies: cookies array mapping cookie name to its value
2389 'UserSetEmail': called when changing user email address
2391 &$email: new email, change this to override new email address
2393 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2394 of email authentification
2396 &$timestamp: new timestamp, change this to override local email
2397 authentification timestamp
2399 'UserToolLinksEdit': Called when generating a list of user tool links, eg "Foobar (Talk | Contribs | Block)"
2400 $userId: User id of the current user
2401 $userText: User name of the current user
2402 &$items: Array of user tool links as HTML fragments
2404 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2405 used to alter the SQL query which gets the list of wanted pages
2406 &$wantedPages: WantedPagesPage object
2407 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2409 'WatchArticle': before a watch is added to an article
2410 $user: user that will watch
2411 $page: WikiPage object to be watched
2413 'WatchArticleComplete': after a watch is added to an article
2414 $user: user that watched
2415 $page: WikiPage object watched
2417 'WatchlistEditorBuildRemoveLine': when building remove lines in
2418 Special:Watchlist/edit
2419 &$tools: array of extra links
2420 $title: Title object
2421 $redirect: whether the page is a redirect
2424 'WebRequestPathInfoRouter': While building the PathRouter to parse the REQUEST_URI.
2425 $router: The PathRouter instance
2427 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2429 One, and only one hook should set this, and return false.
2430 &$tables: Database tables to use in the SELECT query
2431 &$opts: Options to use for the query
2432 &$join: Join conditions
2434 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2435 a page is deleted. Called in WikiPage::getDeletionUpdates().
2436 Note that updates specific to a content model should be provided by the
2437 respective Content's getDeletionUpdates() method.
2439 $content: the Content to generate updates for
2440 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2442 'wfShellWikiCmd': Called when generating a shell-escaped command line
2443 string to run a MediaWiki cli script.
2444 &$script: MediaWiki cli script path
2445 &$parameters: Array of arguments and options to the script
2446 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2449 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2450 query pages to be updated with maintenance/updateSpecialPages.php
2451 $query: $wgQueryPages itself
2453 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2454 metadata to be added.
2455 $obj: The XmlDumpWriter object.
2456 &$out: The output string.
2457 $row: The database row for the page.
2458 $title: The title of the page.
2460 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2462 $obj: The XmlDumpWriter object.
2463 &$out: The text being output.
2464 $row: The database row for the revision.
2465 $text: The revision text.
2467 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2468 additional tags to extract.
2469 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2471 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2472 used to post-process the results.
2473 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2474 metadata tags returned (each tag is either a value, or an array of values).
2476 More hooks might be available but undocumented, you can execute
2477 ./maintenance/findhooks.php to find hidden one.