Remove all calls to $wgMessageCache->loadAllMessages()
[mediawiki.git] / docs / hooks.txt
blob1073828b281f403f10296ad6b3762ac2c37b7c57
1 hooks.txt
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.
6 ==Glossary==
8 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',
14      'ArticleDelete'.
16 hook
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.
20 hook function
21      The function part of a hook.
23 ==Rationale==
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);
42                 }
44                 if ($wgCapitalizeTitle) {
45                         wfCapitalizeTitle($article);
46                 }
48                 # code to actually show the article goes here
49         }
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);
60                 }
62                 if ($wgCapitalizeTitle) {
63                         wfCapitalizeTitle($article);
64                 }
66                 # code to actually show the article goes here
68                 if ($wgNotifyArticle) {
69                         wfNotifyArticleShow($article));
70                 }
71         }
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));
83                 }
84         }
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
94 file:
96         function reverseArticleTitle($article) {
97                 # ...
98         }
100         function reverseForExport($article) {
101                 # ...
102         }
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
107         setupTitleReversingExtension() {
108                 global $wgHooks;
110                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112                 $wgHooks['ArticleExport'][] = 'reverseForExport';
113         }
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
126 just leave it out.
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.
131 ==Writing hooks==
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:
154         # function, no data
155         someFunction($param1, $param2)
156         # function with data
157         someFunction($someData, $param1, $param2)
159         # object only
160         $object->onEventName($param1, $param2)
161         # object with method
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
185            function should skip
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) {
194                 # log user into LDAP
195                 return false;
196         }
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.
205 ==Using hooks==
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
210         class Article {
211                 # ...
212                 function protect() {
213                         global $wgUser;
214                         if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215                                 # protect the article
216                                 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217                         }
218                 }
219         }
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
230 MediaWiki 1.4rc1.
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 'AbortAutoblock': Return false to cancel an autoblock.
238 $autoblockip: The IP going to be autoblocked.
239 $block: The block from which the autoblock is coming.
241 'AbortDiffCache': Can be used to cancel the caching of a diff
242 &$diffEngine: DifferenceEngine object
244 'AbortLogin': Return false to cancel account login.
245 $user: the User object being authenticated against
246 $password: the password being submitted, not yet checked for validity
247 &$retval: a LoginForm class constant to return from authenticateUserData();
248           default is LoginForm::ABORTED. Note that the client may be using
249           a machine API rather than the HTML user interface.
251 'AbortMove': allows to abort moving an article (title)
252 $old: old title
253 $nt: new title
254 $user: user who is doing the move
255 $err: error message
256 $reason: the reason for the move (added in 1.13)
258 'AbortNewAccount': Return false to cancel account creation.
259 $user: the User object about to be created (read-only, incomplete)
260 $message: out parameter: error message to display on abort
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
266 'AfterImportPage': When a page import is completed
267 $title: Title under which the revisions were imported
268 $origTitle: Title provided by the XML file
269 $revCount: Number of revisions in the XML file
270 $sRevCount: Number of sucessfully imported revisions
271 $pageInfo: associative array of page information
273 'AfterUserMessage': After a user message has been left, this hook is
274 called to take care of any cleanup.
275 $user: The user who we left the message for.
276 $article: The article the message was left on.
277 $subject: The subject of the message
278 $text: The text of the message.
279 $signature: The signature we used.
280 $summary: The edit summary.
281 $editor: The editor that performed the edit.
283 'AjaxAddScript': Called in output page just before the initialisation
284 of the javascript ajax engine. The hook is only called when ajax
285 is enabled ( $wgUseAjax = true; ).
287 'AlternateEdit': before checking if an user can edit a page and
288 before showing the edit form ( EditPage::edit() ). This is triggered
289 on &action=edit.
290 $EditPage: the EditPage object
292 'APIAfterExecute': after calling the execute() method of an API module.
293 Use this to extend core API modules.
294 &$module: Module object
296 'APIEditBeforeSave': before saving a page with api.php?action=edit,
297 after processing request parameters. Return false to let the request
298 fail, returning an error message or an <edit result="Failure"> tag
299 if $resultArr was filled.
300 $EditPage : the EditPage object
301 $text : the new text of the article (has yet to be saved)
302 &$resultArr : data in this array will be added to the API result
304 'APIGetAllowedParams': use this hook to modify a module's parameters.
305 &$module: Module object
306 &$params: Array of parameters
308 'APIGetParamDescription': use this hook to modify a module's parameter
309 descriptions.
310 &$module: Module object
311 &$desc: Array of parameter descriptions
313 'APIQueryAfterExecute': after calling the execute() method of an
314 action=query submodule. Use this to extend core API modules.
315 &$module: Module object
317 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
318 method of an action=query submodule. Use this to extend core API modules.
319 &$module: Module object
320 &$resultPageSet: ApiPageSet object
322 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
323 Every token has an action, which will be used in the intoken parameter
324 and in the output (actiontoken="..."), and a callback function which
325 should return the token, or false if the user isn't allowed to obtain
326 it. The prototype of the callback function is func($pageid, $title)
327 where $pageid is the page ID of the page the token is requested for
328 and $title is the associated Title object. In the hook, just add
329 your callback to the $tokenFunctions array and return true (returning
330 false makes no sense)
331 $tokenFunctions: array(action => callback)
333 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
334 Every token has an action, which will be used in the rvtoken parameter
335 and in the output (actiontoken="..."), and a callback function which
336 should return the token, or false if the user isn't allowed to obtain
337 it. The prototype of the callback function is func($pageid, $title, $rev)
338 where $pageid is the page ID of the page associated to the revision the
339 token is requested for, $title the associated Title object and $rev the
340 associated Revision object. In the hook, just add your callback to the
341 $tokenFunctions array and return true (returning false makes no sense)
342 $tokenFunctions: array(action => callback)
344 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
345 list=recentchanges.
346 Every token has an action, which will be used in the rctoken parameter
347 and in the output (actiontoken="..."), and a callback function which
348 should return the token, or false if the user isn't allowed to obtain
349 it. The prototype of the callback function is func($pageid, $title, $rc)
350 where $pageid is the page ID of the page associated to the revision the
351 token is requested for, $title the associated Title object and $rc the
352 associated RecentChange object. In the hook, just add your callback to the
353 $tokenFunctions array and return true (returning false makes no sense)
354 $tokenFunctions: array(action => callback)
356 'APIQueryUsersTokens': use this hook to add custom token to list=users.
357 Every token has an action, which will be used in the ustoken parameter
358 and in the output (actiontoken="..."), and a callback function which
359 should return the token, or false if the user isn't allowed to obtain
360 it. The prototype of the callback function is func($user) where $user
361 is the User object. In the hook, just add your callback to the
362 $tokenFunctions array and return true (returning false makes no sense)
363 $tokenFunctions: array(action => callback)
365 'ArticleAfterFetchContent': after fetching content of an article from
366 the database
367 $article: the article (object) being loaded from the database
368 $content: the content (string) of the article
370 'ArticleConfirmDelete': before writing the confirmation form for article
371         deletion
372 $article: the article (object) being deleted
373 $output: the OutputPage object ($wgOut)
374 &$reason: the reason (string) the article is being deleted
376 'ArticleDelete': before an article is deleted
377 $article: the article (object) being deleted
378 $user: the user (object) deleting the article
379 $reason: the reason (string) the article is being deleted
380 $error: if the deletion was prohibited, the (raw HTML) error message to display
381   (added in 1.13)
383 'ArticleDeleteComplete': after an article is deleted
384 $article: the article that was deleted
385 $user: the user that deleted the article
386 $reason: the reason the article was deleted
387 $id: id of the article that was deleted
389 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
390 was changed
391 $article: article (object) of the user talk page
393 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
394 article has been changed
395 $article: the article (object)
396 $editInfo: data holder that includes the parser output ($editInfo->output) for
397 that page after the change
398 $changed: bool for if the page was changed
400 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
401 recentchanges table, return false to not delete old entries
402 $article: article (object) being modified
404 'ArticleFromTitle': when creating an article object from a title object using
405 Wiki::articleFromTitle()
406 $title: title (object) used to create the article object
407 $article: article (object) that will be returned
409 'ArticleInsertComplete': After a new article is created
410 $article: Article created
411 $user: User creating the article
412 $text: New content
413 $summary: Edit summary/comment
414 $isMinor: Whether or not the edit was marked as minor
415 $isWatch: (No longer used)
416 $section: (No longer used)
417 $flags: Flags passed to Article::doEdit()
418 $revision: New Revision of the article
420 'ArticleMergeComplete': after merging to article using Special:Mergehistory
421 $targetTitle: target title (object)
422 $destTitle: destination title (object)
424 'ArticlePageDataAfter': after loading data of an article from the database
425 $article: article (object) whose data were loaded
426 $row: row (object) returned from the database server
428 'ArticlePageDataBefore': before loading data of an article from the database
429 $article: article (object) that data will be loaded
430 $fields: fileds (array) to load from the database
432 'ArticleProtect': before an article is protected
433 $article: the article being protected
434 $user: the user doing the protection
435 $protect: boolean whether this is a protect or an unprotect
436 $reason: Reason for protect
437 $moveonly: boolean whether this is for move only or not
439 'ArticleProtectComplete': after an article is protected
440 $article: the article that was protected
441 $user: the user who did the protection
442 $protect: boolean whether it was a protect or an unprotect
443 $reason: Reason for protect
444 $moveonly: boolean whether it was for move only or not
446 'ArticlePurge': before executing "&action=purge"
447 $article: article (object) to purge
449 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
450 revision of an article
451 &$title: title object of the article
453 'ArticleRevisionUndeleted': after an article revision is restored
454 $title: the article title
455 $revision: the revision
456 $oldPageID: the page ID of the revision when archived (may be null)
458 'ArticleRollbackComplete': after an article rollback is completed
459 $article: the article that was edited
460 $user: the user who did the rollback
461 $revision: the revision the page was reverted back to
462 $current: the reverted revision
464 'ArticleSave': before an article is saved
465 $article: the article (object) being saved
466 $user: the user (object) saving the article
467 $text: the new article text
468 $summary: the article summary (comment)
469 $isminor: minor flag
470 $iswatch: watch flag
471 $section: section #
473 'ArticleSaveComplete': After an article has been updated
474 $article: Article modified
475 $user: User performing the modification
476 $text: New content
477 $summary: Edit summary/comment
478 $isMinor: Whether or not the edit was marked as minor
479 $isWatch: (No longer used)
480 $section: (No longer used)
481 $flags: Flags passed to Article::doEdit()
482 $revision: New Revision of the article
483 $baseRevId: the rev ID (or false) this edit was based on
485 'ArticleUndelete': When one or more revisions of an article are restored
486 $title: Title corresponding to the article restored
487 $create: Whether or not the restoration caused the page to be created
488 (i.e. it didn't exist before)
489 $comment: The comment associated with the undeletion.
491 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
492 before the user is redirected back to the page
493 &$article: the article
494 &$sectionanchor: The section anchor link (e.g. "#overview" )
495 &$extraq: Extra query parameters which can be added via hooked functions
497 'ArticleViewHeader': Before the parser cache is about to be tried for article
498 viewing.
499 &$article: the article
500 &$pcache: whether to try the parser cache or not
501 &$outputDone: whether the output for this page finished or not
503 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
504 follwed an redirect
505 $article: target article (object)
507 'AuthPluginAutoCreate': Called when creating a local account for an user logged
508 in from an external authentication method
509 $user: User object created locally
511 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
512 Gives a chance for an extension to set it programattically to a variable class.
513 &$auth: the $wgAuth object, probably a stub
515 'AutopromoteCondition': check autopromote condition for user.
516 $type: condition type
517 $args: arguments
518 $user: user
519 $result: result of checking autopromote condition
521 'BadImage': When checking against the bad image list
522 $name: Image name being checked
523 &$bad: Whether or not the image is "bad"
525 Change $bad and return false to override. If an image is "bad", it is not
526 rendered inline in wiki pages or galleries in category pages.
528 'BeforeGalleryFindFile': before an image is fetched for a gallery
529 &$gallery,: the gallery object
530 &$nt: the image title
531 &$time: image timestamp
533 'BeforeInitialize': before anything is initialized in performRequestForTitle()
534 &$title: Title being used for request
535 &$article: The associated Article object
536 &$output: OutputPage object
537 &$user: User
538 $request: WebRequest object
539 $mediaWiki: Mediawiki object
541 'BeforePageDisplay': Prior to outputting a page
542 &$out: OutputPage object
543 &$skin: Skin object
545 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
546 &$parser: Parser object
547 &$title: title of the template
548 &$skip: skip this template and link it?
549 &$id: the id of the revision being parsed
551 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
552 &$parser: Parser object
553 &$nt: the image title
554 &$skip: skip this image and link it?
555 &$time: the image timestamp
557 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
558 &$parser: Parser object
559 &$ig: ImageGallery object
561 'BlockIp': before an IP address or user is blocked
562 $block: the Block object about to be saved
563 $user: the user _doing_ the block (not the one being blocked)
565 'BlockIpComplete': after an IP address or user is blocked
566 $block: the Block object that was saved
567 $user: the user who did the block (not the one being blocked)
569 'BookInformation': Before information output on Special:Booksources
570 $isbn: ISBN to show information for
571 $output: OutputPage object in use
573 'CategoryPageView': before viewing a categorypage in CategoryPage::view
574 $catpage: CategoryPage instance
576 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
577 &$changesList: ChangesList instance.
578 &$articlelink: HTML of link to article (already filled-in).
579 &$s:           HTML of row that is being constructed.
580 &$rc:          RecentChange instance.
581 $unpatrolled:  Whether or not we are showing unpatrolled changes.
582 $watched:      Whether or not the change is watched by the user.
584 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
585 $user: user (object) whose email is being confirmed
587 'ContribsPager::getQueryInfo': Before the contributions query is about to run
588 &$pager: Pager object for contributions
589 &queryInfo: The query for the contribs Pager
591 'ContributionsLineEnding': Called before a contributions HTML line is finished
592 $page: SpecialPage object for contributions
593 $ret: the HTML line
594 $row: the DB row for this line
596 'ContributionsToolLinks': Change tool links above Special:Contributions
597 $id: User identifier
598 $title: User page title
599 &$tools: Array of tool links
601 'CustomEditor': When invoking the page editor
602 $article: Article being edited
603 $user: User performing the edit
605 Return true to allow the normal editor to be used, or false
606 if implementing a custom editor, e.g. for a special namespace,
607 etc.
609 'DatabaseOraclePostInit': Called after initialising an Oracle database
610 &$db: the DatabaseOracle object
612 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
613 $title: the diff page title (nullable)
614 &$oldId: the actual old Id to use in the diff
615 &$newId: the actual new Id to use in the diff (0 means current)
616 $old: the ?old= param value from the url
617 $new: the ?new= param value from the url
619 'DiffViewHeader': called before diff display
620 $diff: DifferenceEngine object that's calling
621 $oldRev: Revision object of the "old" revision (may be null/invalid)
622 $newRev: Revision object of the "new" revision
624 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
625 an article
626 $article: article (object) being viewed
627 $oldid: oldid (int) being viewed
629 'DoEditSectionLink': Override the HTML generated for section edit links
630 $skin: Skin object rendering the UI
631 $title: Title object for the title being linked to (may not be the same as
632   $wgTitle, if the section is included from a template)
633 $section: The designation of the section being pointed to, to be included in
634   the link, like "&section=$section"
635 $tooltip: The default tooltip.  Escape with htmlspecialchars() before using.
636   By default, this is wrapped in the 'editsectionhint' message.
637 $result: The HTML to return, prefilled with the default plus whatever other
638   changes earlier hooks have made
640 'EditFilter': Perform checks on an edit
641 $editor: Edit form (see includes/EditPage.php)
642 $text: Contents of the edit box
643 $section: Section being edited
644 &$error: Error message to return
645 $summary: Edit summary for page
647 'EditFilterMerged': Post-section-merge edit filter
648 $editor: EditPage instance (object)
649 $text: content of the edit box
650 &$error: error message to return
651 $summary: Edit summary for page
653 'EditFormPreloadText': Allows population of the edit form when creating
654 new pages
655 &$text: Text to preload with
656 &$title: Title object representing the page being created
658 'EditFormInitialText': Allows modifying the edit form when editing existing
659 pages
660 $editPage: EditPage     object
662 'EditPage::attemptSave': called before an article is
663 saved, that is before Article::doEdit() is called
664 $editpage_Obj: the current EditPage object
666 'EditPage::importFormData': allow extensions to read additional data
667 posted in the form
668 $editpage: EditPage instance 
669 $request: Webrequest
670 return value is ignored (should always return true)
672 'EditPage::showEditForm:fields': allows injection of form field into edit form
673 &$editor: the EditPage instance for reference
674 &$out: an OutputPage instance to write to
675 return value is ignored (should always return true)
677 'EditPage::showEditForm:initial': before showing the edit form
678 $editor: EditPage instance (object)
680 Return false to halt editing; you'll need to handle error messages, etc.
681 yourself. Alternatively, modifying $error and returning true will cause the
682 contents of $error to be echoed at the top of the edit form as wikitext.
683 Return true without altering $error to allow the edit to proceed.
685 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
686 when there's an edit conflict.  Return false to halt normal diff output; in
687 this case you're responsible for computing and outputting the entire "conflict"
688 part, i.e., the "difference between revisions" and "your text" headers and
689 sections.
690 &$editor: EditPage instance
691 &$out: OutputPage instance
693 'EditPageBeforeEditButtons':  allows modifying the edit buttons below the
694 textarea in the edit form
695 &$editpage: The current EditPage object
696 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
697 &$tabindex: HTML tabindex of the last edit check/button
699 'EditPageBeforeEditChecks':  allows modifying the edit checks below the
700 textarea in the edit form
701 &$editpage: The current EditPage object
702 &$checks: Array of edit checks like "watch this page"/"minor edit"
703 &$tabindex: HTML tabindex of the last edit check/button
705 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
706 textarea in the edit form
707 &$toolbar: The toolbar HTMl
709 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
710 $title: title of page being edited
711 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
713 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
714 "Show changes"
715 $editPage: EditPage object
716 &$newtext: wikitext that will be used as "your version"
718 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
719 $editPage: EditPage object
720 &$toparse: wikitext that will be parsed
722 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
723 &$editpage: The current EditPage object
724 &$res: the HTML of the error text
726 'EditPageTosSummary':  Give a chance for site and per-namespace customizations
727 of terms of service summary link that might exist separately from the copyright
728 notice.
729 $title: title of page being edited
730 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
732 'EditSectionLink': Do not use, use DoEditSectionLink instead.
733 $skin: Skin rendering the UI
734 $title: Title being linked to
735 $section: Section to link to
736 $link: Default link
737 $result: Result (alter this to override the generated links)
739 'EmailConfirmed': When checking that the user's email address is "confirmed"
740 $user: User being checked
741 $confirmed: Whether or not the email address is confirmed
742 This runs before the other checks, such as anonymity and the real check; return
743 true to allow those checks to occur, and false if checking is done.
745 'EmailUser': before sending email from one user to another
746 $to: address of receiving user
747 $from: address of sending user
748 $subject: subject of the mail
749 $text: text of the mail
751 'EmailUserCC': before sending the copy of the email to the author
752 $to: address of receiving user
753 $from: address of sending user
754 $subject: subject of the mail
755 $text: text of the mail
757 'EmailUserComplete': after sending email from one user to another
758 $to: address of receiving user
759 $from: address of sending user
760 $subject: subject of the mail
761 $text: text of the mail
763 'EmailUserForm': after building the email user form object
764 $form: HTMLForm object
766 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
767 $user: The user who is trying to email another user.
768 $editToken: The user's edit token.
769 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
771 'FetchChangesList': When fetching the ChangesList derivative for
772 a particular user
773 &$user: User the list is being fetched for
774 &$skin: Skin object to be used with the list
775 &$list: List object (defaults to NULL, change it to an object
776         instance and return false override the list derivative used)
778 'FileDeleteComplete': When a file is deleted
779 $file: reference to the deleted file
780 $oldimage: in case of the deletion of an old image, the name of the old file
781 $article: in case all revisions of the file are deleted a reference to the
782         article associated with the file.
783 $user: user who performed the deletion
784 $reason: reason
786 'FileUpload': When a file upload occurs
787 $file : Image object representing the file that was uploaded
789 'FileUndeleteComplete': When a file is undeleted
790 $title: title object to the file
791 $fileVersions: array of undeleted versions. Empty if all versions were restored
792 $user: user who performed the undeletion
793 $reason: reason
795 'FormatUserMessage': Hook to format a message if you want to override
796 the internal formatter.
797 $subject: Title of the message.
798 &$text: Text of the message.
799 $signature: Signature that they would like to leave.
801 'GetAutoPromoteGroups': When determining which autopromote groups a user
802 is entitled to be in.
803 &$user: user to promote.
804 &$promote: groups that will be added.
806 'GetBlockedStatus': after loading blocking status of an user from the database
807 $user: user (object) being checked
809 'GetCacheVaryCookies': get cookies that should vary cache options
810 $out: OutputPage object
811 &$cookies: array of cookies name, add a value to it if you want to add a cookie
812         that have to vary cache options
814 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
815 $title: Title object of page
816 $url: string value as output (out parameter, can modify)
817 $query: query options passed to Title::getFullURL()
819 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
820 $title: Title object of page
821 $url: string value as output (out parameter, can modify)
822 $query: query options passed to Title::getInternalURL()
824 'GetLinkColours': modify the CSS class of an array of page links
825 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
826         indexed by page_id.
827 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
829 'GetLocalURL': modify local URLs as output into page links
830 $title: Title object of page
831 $url: string value as output (out parameter, can modify)
832 $query: query options passed to Title::getLocalURL()
834 'GetPreferences': modify user preferences
835 $user: User whose preferences are being modified.
836 &$preferences: Preferences description array, to be fed to an HTMLForm object
838 'getUserPermissionsErrors': Add a permissions error when permissions errors are
839         checked for.  Use instead of userCan for most cases. Return false if the
840         user can't do it, and populate $result with the reason in the form of
841         array( messagename, param1, param2, ... ).  For consistency, error messages
842         should be plain text with no special coloring, bolding, etc. to show that
843         they're errors; presenting them properly to the user as errors is done by
844         the caller.
845 $title: Title object being checked against
846 $user : Current user object
847 $action: Action being checked
848 $result: User permissions error to add. If none, return true.
850 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
851         if expensive checks are enabled.
853 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
854 into the job queue.
855 $title: Title object, pages linked to this title are purged.
857 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
858         image insertion.  You can skip the default logic entirely by returning
859         false, or just modify a few things using call-by-reference.
860 &$skin: Skin object
861 &$title: Title object of the image
862 &$file: File object, or false if it doesn't exist
863 &$frameParams: Various parameters with special meanings; see documentation in
864         includes/Linker.php for Linker::makeImageLink2
865 &$handlerParams: Various parameters with special meanings; see documentation in
866         includes/Linker.php for Linker::makeImageLink2
867 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
868 &$res: Final HTML output, used if you return false
871 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
872         the image on an image page
873 $imagePage: ImagePage object ($this)
874 $output: $wgOut
876 'ImagePageAfterImageLinks': called after the image links section on an image 
877         page is built
878 $imagePage: ImagePage object ($this)
879 &$html: HTML for the hook to add
881 'ImagePageFileHistoryLine': called when a file history line is contructed
882 $file: the file
883 $line: the HTML of the history line
884 $css: the line CSS class
886 'ImagePageFindFile': called when fetching the file associated with an image page
887 $page: ImagePage object
888 &$file: File object
889 &$displayFile: displayed File object
891 'ImagePageShowTOC': called when the file toc on an image page is generated
892 $page: ImagePage object
893 &$toc: Array of <li> strings
895 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
896         using img_auth.php
897 &$title: the Title object of the file as it would appear for the upload page
898 &$path: the original file and path name when img_auth was invoked by the the web
899         server
900 &$name: the name only component of the file
901 &$result: The location to pass back results of the hook routine (only used if
902         failed)
903         $result[0]=The index of the header message
904         $result[1]=The index of the body text message
905         $result[2 through n]=Parameters passed to body text message. Please note the
906         header message cannot receive/use parameters.
908 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
909 $reader: XMLReader object
910 $logInfo: Array of information
911 Return false to stop further processing of the tag
913 'ImportHandlePageXMLTag': When parsing a XML tag in a page
914 $reader: XMLReader object
915 $pageInfo: Array of information
916 Return false to stop further processing of the tag
918 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
919 $reader: XMLReader object
920 $revInfo: Array of information
921 Return false to stop further processing of the tag
923 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
924 $reader: XMLReader object
925 Return false to stop further processing of the tag
927 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
928 $reader: XMLReader object
929 $revisionInfo: Array of information
930 Return false to stop further processing of the tag
932 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
933 $title: Title object ($wgTitle)
934 $request: WebRequest
935 $ignoreRedirect: boolean to skip redirect check
936 $target: Title/string of redirect target
937 $article: Article object
939 'InternalParseBeforeLinks': during Parser's internalParse method before links
940 but after noinclude/includeonly/onlyinclude and other processing.
941 &$parser: Parser object
942 &$text: string containing partially parsed text
943 &$stripState: Parser's internal StripState object
945 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
946 $user: user (object) whose email is being invalidated
948 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
949 $article: article (object) being checked
951 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
952 $ip: IP being check
953 $result: Change this value to override the result of wfIsTrustedProxy()
955 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
956 tance to return false if the domain name doesn't match your organization
957 $addr: The e-mail address entered by the user
958 &$result: Set this and return false to override the internal checks
960 'isValidPassword': Override the result of User::isValidPassword()
961 $password: The password entered by the user
962 &$result: Set this and return false to override the internal checks
963 $user: User the password is being validated for
965 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in 
966 $wgExtensionMessagesFiles instead. 
967 Use this to define synonyms of magic words depending of the language
968 $magicExtensions: associative array of magic words synonyms
969 $lang: laguage code (string)
971 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
972 listed in $wgExtensionMessagesFiles instead.
973 Use to define aliases of special pages names depending of the language
974 $specialPageAliases: associative array of magic words synonyms
975 $lang: laguage code (string)
977 'LinkBegin': Used when generating internal and interwiki links in
978 Linker::link(), before processing starts.  Return false to skip default proces-
979 sing and return $ret.  See documentation for Linker::link() for details on the
980 expected meanings of parameters.
981 $skin: the Skin object
982 $target: the Title that the link is pointing to
983 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
984         fault"
985 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
986         tive array form, with keys and values unescaped.  Should be merged with de-
987         fault values, with a value of false meaning to suppress the attribute.
988 &$query: the query string to add to the generated URL (the bit after the "?"),
989         in associative array form, with keys and values unescaped.
990 &$options: array of options.  Can include 'known', 'broken', 'noclasses'.
991 &$ret: the value to return if your hook returns false.
993 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
994 just before the function returns a value.  If you return true, an <a> element
995 with HTML attributes $attribs and contents $text will be returned.  If you re-
996 turn false, $ret will be returned.
997 $skin: the Skin object
998 $target: the Title object that the link is pointing to
999 $options: the options.  Will always include either 'known' or 'broken', and may
1000         include 'noclasses'.
1001 &$text: the final (raw HTML) contents of the <a> tag, after processing.
1002 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1003         ciative array form.
1004 &$ret: the value to return if your hook returns false.
1006 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1007 before the return
1008 &$url: the image url
1009 &$alt: the image's alt text
1010 &$img: the new image HTML (if returning false)
1012 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1013 before the return
1014 &$url: the link url
1015 &$text: the link text
1016 &$link: the new link HTML (if returning false)
1017 &$attribs: the attributes to be applied.
1018 $linkType: The external link type
1020 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1021 actual update
1022 &$linksUpdate: the LinksUpdate object
1024 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1025 completed
1026 &$linksUpdate: the LinksUpdate object
1028 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1029 &$linksUpdate: the LinksUpdate object
1031 'ListDefinedTags': When trying to find all defined tags.
1032 &$tags: The list of tags.
1034 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
1035 database schema
1037 'LocalFile::getHistory': called before file history query performed
1038 $file: the file
1039 $tables: tables
1040 $fields: select fields
1041 $conds: conditions
1042 $opts: query options
1043 $join_conds: JOIN conditions
1045 'LocalisationCacheRecache': Called when loading the localisation data into cache
1046 $cache: The LocalisationCache object
1047 $code: language code
1048 &$alldata: The localisation data from core and extensions
1050 'LoginAuthenticateAudit': a login attempt for a valid user account either
1051 succeeded or failed. No return data is accepted; this hook is for auditing only.
1052 $user: the User object being authenticated against
1053 $password: the password being submitted and found wanting
1054 $retval: a LoginForm class constant with authenticateUserData() return
1055         value (SUCCESS, WRONG_PASS, etc)
1057 'LogLine': Processes a single log entry on Special:Log
1058 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1059         logging.log_type database field.
1060 $log_action: string for the type of log action (e.g. 'delete', 'block',
1061         'create2'). Corresponds to logging.log_action database field.
1062 $title: Title object that corresponds to logging.log_namespace and
1063         logging.log_title database fields.
1064 $paramArray: Array of parameters that corresponds to logging.log_params field.
1065         Note that only $paramArray[0] appears to contain anything.
1066 &$comment: string that corresponds to logging.log_comment database field, and
1067         which is displayed in the UI.
1068 &$revert: string that is displayed in the UI, similar to $comment.
1069 $time: timestamp of the log entry (added in 1.12)
1071 'LogPageValidTypes': action being logged.
1072 DEPRECATED: Use $wgLogTypes
1073 &$type: array of strings
1075 'LogPageLogName': name of the logging page(s).
1076 DEPRECATED: Use $wgLogNames
1077 &$typeText: array of strings
1079 'LogPageLogHeader': strings used by wfMsg as a header.
1080 DEPRECATED: Use $wgLogHeaders
1081 &$headerText: array of strings
1083 'LogPageActionText': strings used by wfMsg as a header.
1084 DEPRECATED: Use $wgLogActions
1085 &$actionText: array of strings
1087 'MagicWordMagicWords': When defining new magic word.
1088 DEPRECATED: use $magicWords in a file listed in 
1089 $wgExtensionMessagesFiles instead.
1090 $magicWords: array of strings
1092 'MagicWordwgVariableIDs': When definig new magic words IDs.
1093 $variableIDs: array of strings
1095 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1096 is executed
1097 &$vars: variable (or multiple variables) to be added into the output
1098         of Skin::makeVariablesScript
1100 'MarkPatrolled': before an edit is marked patrolled
1101 $rcid: ID of the revision to be marked patrolled
1102 $user: the user (object) marking the revision as patrolled
1103 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1104         needs to be a sysop in order to mark an edit patrolled
1106 'MarkPatrolledComplete': after an edit is marked patrolled
1107 $rcid: ID of the revision marked as patrolled
1108 $user: user (object) who marked the edit patrolled
1109 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1110         must be a sysop to patrol the edit
1112 'MathAfterTexvc': after texvc is executed when rendering mathematics
1113 $mathRenderer: instance of MathRenderer
1114 $errmsg: error message, in HTML (string). Nonempty indicates failure
1115         of rendering the formula
1117 'MediaWikiPerformAction': Override MediaWiki::performAction().
1118 Use this to do something completely different, after the basic
1119 globals have been set up, but before ordinary actions take place.
1120 $output: $wgOut
1121 $article: $wgArticle
1122 $title: $wgTitle
1123 $user: $wgUser
1124 $request: $wgRequest
1125 $mediaWiki: The $mediawiki object
1127 'MessagesPreLoad': When loading a message from the database
1128 $title: title of the message (string)
1129 $message: value (string), change it to the message you want to define
1131 'MessageCacheReplace': When a message page is changed.
1132 Useful for updating caches.
1133 $title: name of the page changed.
1134 $text: new contents of the page.
1136 'ModifyExportQuery': Modify the query used by the exporter.
1137 $db: The database object to be queried.
1138 &$tables: Tables in the query.
1139 &$conds: Conditions in the query.
1140 &$opts: Options for the query.
1141 &$join_conds: Join conditions for the query.
1143 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1144 been rendered (useful for adding more)
1145 Note: this is only run for the Monobook skin. This hook is deprecated and
1146 may be removed in the future. To add items to the toolbox you should use 
1147 the SkinTemplateToolboxEnd hook instead, which works for all 
1148 "SkinTemplate"-type skins.
1149 $tools: array of tools
1151 'NewRevisionFromEditComplete': called when a revision was inserted
1152 due to an edit
1153 $article: the article edited
1154 $rev: the new revision
1155 $baseID: the revision ID this was based off, if any
1156 $user: the editing user
1158 'NormalizeMessageKey': Called before the software gets the text of a message
1159 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1160 displayed
1161 &$key: the message being looked up. Change this to something else to change
1162         what message gets displayed (string)
1163 &$useDB: whether or not to look up the message in the database (bool)
1164 &$langCode: the language code to get the message for (string) - or -
1165         whether to use the content language (true) or site language (false) (bool)
1166 &$transform: whether or not to expand variables and templates
1167         in the message (bool)
1169 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1170 &$changeslist: The OldChangesList instance.
1171 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1172 &$rc: The RecentChange object.
1174 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1175 Hooks can alter or append to the array of URLs for search & suggestion formats.
1176 &$urls: array of associative arrays with Url element attributes
1178 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1179         users and/or IP addresses too
1180 $otherBlockLink: An array with links to other block logs
1181 $ip: The requested IP address or username
1183 'OutputPageBeforeHTML': a page has been processed by the parser and
1184 the resulting HTML is about to be displayed.
1185 $parserOutput: the parserOutput (object) that corresponds to the page
1186 $text: the text that will be displayed, in HTML (string)
1188 'OutputPageCheckLastModified': when checking if the page has been modified
1189 since the last visit
1190 &$modifiedTimes: array of timestamps.
1191         The following keys are set: page, user, epoch
1193 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1194 $out: OutputPage instance (object)
1195 $parserOutput: parserOutput instance being added in $out
1197 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1198 categories. Implementations should return false if they generate the category
1199 links, so the default link generation is skipped.
1200 $out: OutputPage instance (object)
1201 $categories: associative array, keys are category names, values are category
1202         types ("normal" or "hidden")
1203 $links: array, intended to hold the result. Must be an associative array with
1204         category types as keys and arrays of HTML links as values.
1206 'PageHistoryBeforeList': When a history page list is about to be constructed.
1207 $article: the article that the history is loading for
1209 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1210 $row: the revision row for this line
1211 $s: the string representing this parsed line
1212 $classes: array containing the <li> element classes
1214 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1215 is constructed
1216 $pager: the pager
1217 $queryInfo: the query parameters
1219 'PageRenderingHash': alter the parser cache option hash key
1220 A parser extension which depends on user options should install
1221 this hook and append its values to the key.
1222 $hash: reference to a hash key string which can be modified
1224 'ParserAfterStrip': Same as ParserBeforeStrip
1226 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1227 $parser: Parser object being used
1228 $text: text that'll be returned
1230 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1231 $parser: Parser object
1232 $text: text to parse
1233 $stripState: StripState instance being used
1235 'ParserBeforeStrip': Called at start of parsing time
1236 (no more strip, deprecated ?)
1237 $parser: parser object
1238 $text: text being parsed
1239 $stripState: stripState used (object)
1241 'ParserBeforeTidy': called before tidy and custom tags replacements
1242 $parser: Parser object being used
1243 $text: actual text
1245 'ParserClearState': called at the end of Parser::clearState()
1246 $parser: Parser object being cleared
1248 'ParserFirstCallInit': called when the parser initialises for the first time
1249 &$parser: Parser object being cleared
1251 'ParserGetVariableValueSwitch': called when the parser need the value of a
1252 custom magic word
1253 $parser: Parser object
1254 $varCache: array to store the value in case of multiples calls of the
1255         same magic word
1256 $index: index (string) of the magic
1257 $ret: value of the magic word (the hook should set it)
1258 $frame: PPFrame object to use for expanding any template variables
1260 'ParserGetVariableValueTs': use this to change the value of the time for the
1261 {{LOCAL...}} magic word
1262 $parser: Parser object
1263 $time: actual time (timestamp)
1265 'ParserGetVariableValueVarCache': use this to change the value of the
1266 variable cache or return false to not use it
1267 $parser: Parser object
1268 $varCache: varaiable cache (array)
1270 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1271 include comments about size of the text parsed
1272 $parser: Parser object
1273 $limitReport: text that will be included (without comment tags)
1275 'ParserMakeImageParams': Called before the parser make an image link, use this
1276 to modify the parameters of the image.
1277 $title: title object representing the file
1278 $file: file object that will be used to create the image
1279 &$params: 2-D array of parameters
1281 'ParserTestParser': called when creating a new instance of Parser in
1282 maintenance/parserTests.inc
1283 $parser: Parser object created
1285 'ParserTestTables': alter the list of tables to duplicate when parser tests
1286 are run. Use when page save hooks require the presence of custom tables
1287 to ensure that tests continue to run properly.
1288 &$tables: array of table names
1290 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1291 my talk page, my contributions" etc).
1293 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1294 &$title: Title object representing the current page
1296 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1297 &$user : User performing the action
1298 $action : Action being performed
1299 &$result : Whether or not the action should be prevented
1300 Change $result and return false to give a definitive answer, otherwise
1301 the built-in rate limiting checks are used, if enabled.
1303 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1304 AJAX search suggestions. Put results into &$results outparam and return false.
1305 $ns : array of int namespace keys to search in
1306 $search : search term (not guaranteed to be conveniently normalized)
1307 $limit : maximum number of results to return
1308 &$results : out param: array of page names (strings)
1310 'PrefsEmailAudit': called when user changes his email address
1311 $user: User (object) changing his email address
1312 $oldaddr: old email address (string)
1313 $newaddr: new email address (string)
1315 'PrefsPasswordAudit': called when user changes his password
1316 $user: User (object) changing his passoword
1317 $newPass: new password
1318 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1320 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1321 $article: the title being (un)protected
1322 $output: a string of the form HTML so far
1324 'ProtectionForm::save': called when a protection form is submitted
1325 $article: the title being (un)protected
1326 $errorMsg: an html message string of an error
1328 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1329 $article: the page the form is shown for
1330 $out: OutputPage object
1332 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1333 &$obj: RawPage object
1334 &$text: The text that's going to be the output
1336 'RecentChange_save': called at the end of RecenChange::save()
1337 $recentChange: RecentChange object
1339 'RevisionInsertComplete': called after a revision is inserted into the DB
1340 &$revision: the Revision
1341 $data: the data stored in old_text.  The meaning depends on $flags: if external
1342   is set, it's the URL of the revision text in external storage; otherwise,
1343   it's the revision text itself.  In either case, if gzip is set, the revision
1344   text is gzipped.
1345 $flags: a comma-delimited list of strings representing the options used.  May
1346   include: utf8 (this will always be set for new revisions); gzip; external.
1348 'SearchUpdate': Prior to search update completion
1349 $id : Page id
1350 $namespace : Page namespace
1351 $title : Page title
1352 $text : Current text being indexed
1354 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1355 $allSearchTerms : Array of the search terms in all content languages
1356 &$titleResult : Outparam; the value to return. A Title object or null.
1358 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1359 $term : Search term string
1360 &$title : Outparam; set to $title object and return false for a match
1362 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1363 $term : Search term string
1364 &$title : Current Title object that is being returned (null if none found).
1366 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1367 $searchEngine : The SearchEngine object. Users of this hooks will be interested 
1368 in the $searchEngine->namespaces array.
1369 $query : Original query.
1370 &$parsed : Resultant query with the prefixes stripped.
1372 'SearchableNamespaces': An option to modify which namespaces are searchable.
1373 &$arr : Array of namespaces ($nsId => $name) which will be used.
1375 'SetupAfterCache': Called in Setup.php, after cache objects are set
1377 'SetupUserMessageArticle': Called in User::leaveUserMessage() before
1378 anything has been posted to the article.
1379 $user: The user who we left the message for.
1380 &$article: The article that will be posted to.
1381 $subject: The subject of the message
1382 $text: The text of the message.
1383 $signature: The signature we used.
1384 $summary: The edit summary.
1385 $editor: The editor that performed the edit.
1387 'ShowMissingArticle': Called when generating the output for a non-existent page
1388 $article: The article object corresponding to the page
1390 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1391 $text: Text being shown
1392 $title: Title of the custom script/stylesheet page
1393 $output: Current OutputPage object
1395 'ShowSearchHitTitle': Customise display of search hit title/link.
1396 &$title: Title to link to
1397 &$text: Text to use for the link
1398 $result: The search result
1399 $terms: The search terms entered
1400 $page: The SpecialSearch object.
1402 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1403 &$siteNotice: HTML returned as the sitenotice
1404 Return true to allow the normal method of notice selection/rendering to work,
1405 or change the value of $siteNotice and return false to alter it.
1407 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1408 &$siteNotice: HTML sitenotice
1409 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1411 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1412 $skin: Skin object
1413 &$text: bottomScripts Text
1414 Append to $text to add additional text/scripts after the stock bottom scripts.
1416 'SkinAfterContent': Allows extensions to add text after the page content and
1417 article metadata.
1418 &$data: (string) Text to be printed out directly (without parsing)
1419 This hook should work in all skins. Just set the &$data variable to the text
1420 you're going to add.
1422 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1423 $skin: Skin object
1424 &$bar: Sidebar contents
1425 Modify $bar to add or modify sidebar portlets.
1427 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1428 $title: displayed page title
1429 $type: 'normal' or 'history' for old/diff views
1430 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1431 &$link: overridable HTML link to be passed into the message as $1
1432 &$forContent: overridable flag if copyright footer is shown in content language. 
1434 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1435 $skin: Skin object
1436 &$subpages: Subpage links HTML
1437 If false is returned $subpages will be used instead of the HTML
1438 subPageSubtitle() generates.
1439 If true is returned, $subpages will be ignored and the rest of
1440 subPageSubtitle() will run.
1442 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1443 when showing a special page
1444 $sktemplate: SkinTemplate object
1445 $content_actions: array of tabs
1447 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1448 "permanent link" tab
1449 $sktemplate: SkinTemplate object
1450 $nav_urls: array of tabs
1452 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1453 &$content_actions: Content actions
1454 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1455 for an example]
1457 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1458 &$sktemplate: SkinTemplate object
1459 &$links: Structured navigation links
1460 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1462 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1463 starts page output
1464 &$sktemplate: SkinTemplate object
1465 &$tpl: Template engine object
1467 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1468 $sktemplate: SkinTemplate object
1469 $res: set to true to prevent active tabs
1471 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1472 $out: Css to return
1474 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1475 You can either create your own array, or alter the parameters for
1476 the normal one.
1477 &$sktemplate: The SkinTemplate instance.
1478 $title: Title instance for the page.
1479 $message: Visible label of tab.
1480 $selected: Whether this is a selected tab.
1481 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1482 &$classes: Array of CSS classes to apply.
1483 &$query: Query string to add to link.
1484 &$text: Link text.
1485 &$result: Complete assoc. array if you want to return true.
1487 'SkinTemplateTabs': called when finished to build the actions tabs
1488 $sktemplate: SkinTemplate object
1489 $content_actions: array of tabs
1491 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1492 been rendered (useful for adding more)
1493 $tools: array of tools
1495 'SoftwareInfo': Called by Special:Version for returning information about
1496 the software
1497 $software: The array of software in format 'name' => 'version'.
1498         See SpecialVersion::softwareInformation()
1500 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1501 $id: User identifier
1503 'SpecialListusersDefaultQuery': called right before the end of
1504 UsersPager::getDefaultQuery()
1505 $pager: The UsersPager instance
1506 $query: The query array to be returned
1508 'SpecialListusersFormatRow': called right before the end of
1509 UsersPager::formatRow()
1510 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1511 $row: Database row object
1513 'SpecialListusersHeader': called before closing the <fieldset> in
1514 UsersPager::getPageHeader()
1515 $pager: The UsersPager instance
1516 $out: The header HTML
1518 'SpecialListusersHeaderForm': called before adding the submit button in
1519 UsersPager::getPageHeader()
1520 $pager: The UsersPager instance
1521 $out: The header HTML
1523 'SpecialListusersQueryInfo': called right before the end of
1524 UsersPager::getQueryInfo()
1525 $pager: The UsersPager instance
1526 $query: The query array to be returned
1528 'SpecialMovepageAfterMove': called after moving a page
1529 $movePage: MovePageForm object
1530 $oldTitle: old title (object)
1531 $newTitle: new title (object)
1533 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1534 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1535 $opts: FormOptions object containing special page options
1536 &$conds: array of WHERE conditionals for query
1538 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1539 hook to remove a core special page
1540 $list: list (array) of core special pages
1542 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1543 use this to change some selection criteria or substitute a different title
1544 &$randstr: The random number from wfRandom()
1545 &$isRedir: Boolean, whether to select a redirect or non-redirect 
1546 &$namespaces: An array of namespace indexes to get the title from
1547 &$extra: An array of extra SQL statements 
1548 &$title: If the hook returns false, a Title object to use instead of the
1549 result from the normal query
1551 'SpecialRecentChangesPanel': called when building form options in
1552 SpecialRecentChanges
1553 &$extraOpts: array of added items, to which can be added
1554 $opts: FormOptions for this request
1556 'SpecialRecentChangesQuery': called when building sql query for
1557 SpecialRecentChanges
1558 &$conds: array of WHERE conditionals for query
1559 &$tables: array of tables to be queried
1560 &$join_conds: join conditions for the tables
1561 $opts: FormOptions for this request
1562 &$query_options: array of options for the database request
1564 'SpecialSearchGomatch': called when user clicked the "Go" button and the target
1565 exists
1566 &$title: title object generated from the text entred by the user
1568 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1569 target doesn't exist
1570 &$title: title object generated from the text entred by the user
1572 'SpecialSearchProfiles': allows modification of search profiles
1573 &$profiles: profiles, which can be modified.
1575 'SpecialSearchResults': called before search result display when there
1576 are matches
1577 $term: string of search term
1578 &$titleMatches: empty or SearchResultSet object
1579 &$textMatches: empty or SearchResultSet object
1581 'SpecialSearchNoResults': called before search result display when there are
1582 no matches
1583 $term: string of search term
1585 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1586 &$extraStats: Array to save the new stats 
1587               ( $extraStats['<name of statistic>'] => <value>; )
1589 'SpecialUploadComplete': Called after successfully uploading a file from 
1590 Special:Upload
1591 $form: The SpecialUpload object
1593 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1594 use this to change the tables headers
1595 $extTypes: associative array of extensions types
1597 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1598 &$conds: array of WHERE conditionals for query
1599 &$tables: array of tables to be queried
1600 &$join_conds: join conditions for the tables
1601 &$fields: array of query fields
1603 'TitleArrayFromResult': called when creating an TitleArray object from a
1604 database result
1605 &$titleArray: set this to an object to override the default object returned
1606 $res: database result used to create the object
1608 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1609   that can be applied.
1610 $title: The title in question.
1611 &$types: The types of protection available.
1613 'TitleMoveComplete': after moving an article (title)
1614 $old: old title
1615 $nt: new title
1616 $user: user who did the move
1617 $pageid: database ID of the page that's been moved
1618 $redirid: database ID of the created redirect
1620 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1621 $title: title object related to the revision
1622 $rev: revision (object) that will be viewed
1624 'UnknownAction': An unknown "action" has occured (useful for defining
1625                  your own actions)
1626 $action: action name
1627 $article: article "acted on"
1629 'UnitTestsList': Called when building a list of files with PHPUnit tests
1630 &$files: list of files
1632 'UnwatchArticle': before a watch is removed from an article
1633 $user: user watching
1634 $article: article object to be removed
1636 'UnwatchArticle': after a watch is removed from an article
1637 $user: user that was watching
1638 $article: article object removed
1640 'UnwatchArticleComplete': after a watch is removed from an article
1641 $user: user that watched
1642 $article: article object that was watched
1644 'UploadForm:initial': before the upload form is generated
1645 $form: UploadForm object
1646 You might set the member-variables $uploadFormTextTop and
1647 $uploadFormTextAfterSummary to inject text (HTML) either before
1648 or after the editform.
1650 'UploadForm:BeforeProcessing': DEPRECATED! at the beginning of processUpload()
1651 $form: UploadForm object
1652 Lets you poke at member variables like $mUploadDescription before the
1653 file is saved.
1655 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1656 $type: (string) the requested upload type
1657 &$className: the class name of the Upload instance to be created
1659 'UploadComplete': when Upload completes an upload
1660 &$upload: an UploadBase child instance
1662 'UploadFormInitDescriptor': after the descriptor for the upload form as been 
1663         assembled
1664 $descriptor: (array) the HTMLForm descriptor
1666 'UploadFormSourceDescriptors': after the standard source inputs have been 
1667 added to the descriptor
1668 $descriptor: (array) the HTMLForm descriptor
1670 'UploadVerification': additional chances to reject an uploaded file
1671 string $saveName: destination file name
1672 string $tempName: filesystem path to the temporary file for checks
1673 string &$error: output: message key for message to show if upload canceled 
1674         by returning false. May also be an array, where the first element
1675         is the message key and the remaining elements are used as parameters to
1676         the message.
1678 'UploadComplete': Upon completion of a file upload
1679 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1680         $uploadBase->getLocalFile().
1682 'User::mailPasswordInternal': before creation and mailing of a user's new
1683 temporary password
1684 $user: the user who sent the message out
1685 $ip: IP of the user who sent the message out
1686 $u: the account whose new password will be set
1688 'UserArrayFromResult': called when creating an UserArray object from a
1689 database result
1690 &$userArray: set this to an object to override the default object returned
1691 $res: database result used to create the object
1693 'userCan': To interrupt/advise the "user can do X to Y article" check.
1694 If you want to display an error message, try getUserPermissionsErrors.
1695 $title: Title object being checked against
1696 $user : Current user object
1697 $action: Action being checked
1698 $result: Pointer to result returned if hook returns false. If null is returned,
1699         userCan checks are continued by internal code.
1701 'UserCanSendEmail': To override User::canSendEmail() permission check
1702 $user: User (object) whose permission is being checked
1703 &$canSend: bool set on input, can override on output
1705 'UserClearNewTalkNotification': called when clearing the
1706 "You have new messages!" message, return false to not delete it
1707 $user: User (object) that'll clear the message
1709 'UserComparePasswords': called when checking passwords, return false to
1710 override the default password checks
1711 &$hash: String of the password hash (from the database)
1712 &$password: String of the plaintext password the user entered
1713 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1714         supplied
1715 &$result: If the hook returns false, this Boolean value will be checked to
1716         determine if the password was valid
1718 'UserCreateForm': change to manipulate the login form
1719 $template: SimpleTemplate instance for the form
1721 'UserCryptPassword': called when hashing a password, return false to implement
1722 your own hashing method
1723 &$password: String of the plaintext password to encrypt
1724 &$salt: String of the password salt or Boolean false if no salt is provided
1725 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1726         hashing method
1727 &$hash: If the hook returns false, this String will be used as the hash
1729 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1730 $user: User to get groups for
1731 &$groups: Current effective groups
1733 'UserGetAllRights': after calculating a list of all available rights
1734 &$rights: Array of rights, which may be added to.
1736 'UserGetEmail': called when getting an user email address
1737 $user: User object
1738 &$email: email, change this to override local email
1740 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1741 email authentification
1742 $user: User object
1743 &$timestamp: timestamp, change this to override local email authentification
1744         timestamp
1746 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1747 &$groups: List of implicit (automatically-assigned) groups
1749 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1750 &$reservedUsernames: $wgReservedUsernames
1752 'UserGetRights': Called in User::getRights()
1753 $user: User to get rights for
1754 &$rights: Current rights
1756 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1757         exemptions).
1758 $user: User in question
1759 $title: Title of the page in question
1760 &$blocked: Out-param, whether or not the user is blocked from that page.
1761 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1762                   own user talk pages.
1764 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1765 &$user: User object
1766 $ip: User's IP address
1767 &$blocked: Whether the user is blocked, to be modified by the hook
1769 'UserLoadAfterLoadFromSession': called to authenticate users on
1770 external/environmental means; occurs after session is loaded
1771 $user: user object being loaded
1773 'UserLoadDefaults': called when loading a default user
1774 $user: user object
1775 $name: user name
1777 'UserLoadFromDatabase': called when loading a user from the database
1778 $user: user object
1779 &$s: database query object
1781 'UserLoadFromSession': called to authenticate users on external/environmental
1782 means; occurs before session is loaded
1783 $user: user object being loaded
1784 &$result: set this to a boolean value to abort the normal authentification
1785         process
1787 'UserLoadOptions': when user options/preferences are being loaded from
1788 the database.
1789 $user: User object
1790 &$options: Options, can be modified.
1792 'UserLoginComplete': after a user has logged in
1793 $user: the user object that was created on login
1794 $inject_html: Any HTML to inject after the "logged in" message.
1796 'UserLoginForm': change to manipulate the login form
1797 $template: SimpleTemplate instance for the form
1799 'UserLoginMailPassword': Block users from emailing passwords
1800 $name: the username to email the password of.
1801 &$error: out-param - the error message to return.
1803 'UserLogout': before a user logs out
1804 $user: the user object that is about to be logged out
1806 'UserLogoutComplete': after a user has logged out
1807 $user: the user object _after_ logout (won't have name, ID, etc.)
1808 $inject_html: Any HTML to inject after the "logged out" message.
1809 $oldName: name of the user before logout (string)
1811 'UserRights': After a user's group memberships are changed
1812 $user  : User object that was changed
1813 $add   : Array of strings corresponding to groups added
1814 $remove: Array of strings corresponding to groups removed
1816 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1817 message(s)
1818 $user: user retrieving new talks messages
1819 $talks: array of new talks page(s)
1821 'UserSaveSettings': called when saving user settings
1822 $user: User object
1824 'UserSaveOptions': Called just before saving user preferences/options.
1825 $user: User object
1826 &$options: Options, modifiable
1828 'UserSetCookies': called when setting user cookies
1829 $user: User object
1830 &$session: session array, will be added to $_SESSION
1831 &$cookies: cookies array mapping cookie name to its value
1833 'UserSetEmail': called when changing user email address
1834 $user: User object
1835 &$email: new email, change this to override new email address
1837 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1838 of email authentification
1839 $user: User object
1840 &$timestamp: new timestamp, change this to override local email
1841 authentification timestamp
1843 'UserToggles': called when initialising User::$mToggles, use this to add
1844 new toggles
1845 $toggles: array of toggles to add
1847 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1848 alter the SQL query which gets the list of wanted pages
1849 &$wantedPages: WantedPagesPage object
1850 &$sql: raw SQL query used to get the list of wanted pages
1852 'WatchArticle': before a watch is added to an article
1853 $user: user that will watch
1854 $article: article object to be watched
1856 'WatchArticleComplete': after a watch is added to an article
1857 $user: user that watched
1858 $article: article object watched
1860 'WatchlistEditorBuildRemoveLine': when building remove lines in
1861         Special:Watchlist/edit
1862 &$tools: array of extra links
1863 $title: Title object
1864 $redirect: whether the page is a redirect
1865 $skin: Skin object
1867 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1868 dumps
1869 One, and only one hook should set this, and return false.
1870 &$tables: Database tables to use in the SELECT query
1871 &$opts: Options to use for the query
1872 &$join: Join conditions
1874 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1875 query pages to be updated with maintenance/updateSpecialPages.php
1876 $query: $wgQueryPages itself
1878 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1879  metadata to be added.
1880 $obj: The XmlDumpWriter object.
1881 &$out: The output string.
1882 $row: The database row for the page.
1883 $title: The title of the page.
1885 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1886  metadata.
1887 $obj: The XmlDumpWriter object.
1888 &$out: The text being output.
1889 $row: The database row for the revision.
1890 $text: The revision text.
1892 More hooks might be available but undocumented, you can execute
1893 ./maintenance/findhooks.php to find hidden one.