Moved mediaWiki.loader.go() up to be above scripts that are not wrapped, and need...
[lhc/web/wiklou.git] / docs / hooks.txt
1 hooks.txt
2
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.
5
6 ==Glossary==
7
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'.
15
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.
19
20 hook function
21 The function part of a hook.
22
23 ==Rationale==
24
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.
31
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):
36
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
39
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
42 }
43
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
46 }
47
48 # code to actually show the article goes here
49 }
50
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:
54
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
57
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
60 }
61
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
64 }
65
66 # code to actually show the article goes here
67
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
70 }
71 }
72
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:
75
76 function showAnArticle($article) {
77
78 if (wfRunHooks('ArticleShow', array(&$article))) {
79
80 # code to actually show the article goes here
81
82 wfRunHooks('ArticleShowComplete', array(&$article));
83 }
84 }
85
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.
89
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:
95
96 function reverseArticleTitle($article) {
97 # ...
98 }
99
100 function reverseForExport($article) {
101 # ...
102 }
103
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
106
107 setupTitleReversingExtension() {
108 global $wgHooks;
109
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
113 }
114
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.
118
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:
122
123 require_once('extensions/ReverseTitle.php');
124
125 ...to their LocalSettings.php file; those of us who don't want or need it can
126 just leave it out.
127
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.
130
131 ==Writing hooks==
132
133 A hook is a chunk of code run at some particular event. It consists of:
134
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
137
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:
140
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
144
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
149
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:
153
154 # function, no data
155 someFunction($param1, $param2)
156 # function with data
157 someFunction($someData, $param1, $param2)
158
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)
165
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.
169
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
172
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
175
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
178
179 Hooks can return three possible values:
180
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
186
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:
190
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
192
193 function ldapLogin($username, $password) {
194 # log user into LDAP
195 return false;
196 }
197
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
200
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.
204
205 ==Using hooks==
206
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
209
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 }
220
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.
225
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.
231
232 ==Events and parameters==
233
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.
236
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.
240
241 'AbortDiffCache': Can be used to cancel the caching of a diff
242 &$diffEngine: DifferenceEngine object
243
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.
250
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)
257
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
261
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)
265
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
272
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.
282
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; ).
286
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
291
292 'APIAfterExecute': after calling the execute() method of an API module.
293 Use this to extend core API modules.
294 &$module: Module object
295
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
303
304 'APIGetAllowedParams': use this hook to modify a module's parameters.
305 &$module: Module object
306 &$params: Array of parameters
307
308 'APIGetParamDescription': use this hook to modify a module's parameter
309 descriptions.
310 &$module: Module object
311 &$desc: Array of parameter descriptions
312
313 'APIQueryAfterExecute': after calling the execute() method of an
314 action=query submodule. Use this to extend core API modules.
315 &$module: Module object
316
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
321
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)
332
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)
343
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)
355
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)
364
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
369
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
375
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)
382
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
388
389 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
390 was changed
391 $article: article (object) of the user talk page
392
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
399
400 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
401 recentchanges table, return false to not delete old entries
402 $article: article (object) being modified
403
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
408
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
419
420 'ArticleMergeComplete': after merging to article using Special:Mergehistory
421 $targetTitle: target title (object)
422 $destTitle: destination title (object)
423
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
427
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
431
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
438
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
445
446 'ArticlePurge': before executing "&action=purge"
447 $article: article (object) to purge
448
449 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
450 revision of an article
451 &$title: title object of the article
452
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)
457
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
463
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 #
472
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
484
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.
490
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
496
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
502
503 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
504 follwed an redirect
505 $article: target article (object)
506
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
510
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
514
515 'AutopromoteCondition': check autopromote condition for user.
516 $type: condition type
517 $args: arguments
518 $user: user
519 $result: result of checking autopromote condition
520
521 'BadImage': When checking against the bad image list
522 $name: Image name being checked
523 &$bad: Whether or not the image is "bad"
524
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.
527
528 'BeforeGalleryFindFile': before an image is fetched for a gallery
529 &$gallery,: the gallery object
530 &$nt: the image title
531 &$time: image timestamp
532
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
540
541 'BeforePageDisplay': Prior to outputting a page
542 &$out: OutputPage object
543 &$skin: Skin object
544
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
550
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
556
557 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
558 &$parser: Parser object
559 &$ig: ImageGallery object
560
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)
564
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)
568
569 'BookInformation': Before information output on Special:Booksources
570 $isbn: ISBN to show information for
571 $output: OutputPage object in use
572
573 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
574 &$namespaces: Array of namespace numbers with corresponding canonical names
575
576 'CategoryPageView': before viewing a categorypage in CategoryPage::view
577 $catpage: CategoryPage instance
578
579 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
580 &$changesList: ChangesList instance.
581 &$articlelink: HTML of link to article (already filled-in).
582 &$s: HTML of row that is being constructed.
583 &$rc: RecentChange instance.
584 $unpatrolled: Whether or not we are showing unpatrolled changes.
585 $watched: Whether or not the change is watched by the user.
586
587 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
588 $user: user (object) whose email is being confirmed
589
590 'ContribsPager::getQueryInfo': Before the contributions query is about to run
591 &$pager: Pager object for contributions
592 &queryInfo: The query for the contribs Pager
593
594 'ContributionsLineEnding': Called before a contributions HTML line is finished
595 $page: SpecialPage object for contributions
596 $ret: the HTML line
597 $row: the DB row for this line
598
599 'ContributionsToolLinks': Change tool links above Special:Contributions
600 $id: User identifier
601 $title: User page title
602 &$tools: Array of tool links
603
604 'CustomEditor': When invoking the page editor
605 $article: Article being edited
606 $user: User performing the edit
607
608 Return true to allow the normal editor to be used, or false
609 if implementing a custom editor, e.g. for a special namespace,
610 etc.
611
612 'DatabaseOraclePostInit': Called after initialising an Oracle database
613 &$db: the DatabaseOracle object
614
615 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
616 $title: the diff page title (nullable)
617 &$oldId: the actual old Id to use in the diff
618 &$newId: the actual new Id to use in the diff (0 means current)
619 $old: the ?old= param value from the url
620 $new: the ?new= param value from the url
621
622 'DiffViewHeader': called before diff display
623 $diff: DifferenceEngine object that's calling
624 $oldRev: Revision object of the "old" revision (may be null/invalid)
625 $newRev: Revision object of the "new" revision
626
627 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
628 an article
629 $article: article (object) being viewed
630 $oldid: oldid (int) being viewed
631
632 'DoEditSectionLink': Override the HTML generated for section edit links
633 $skin: Skin object rendering the UI
634 $title: Title object for the title being linked to (may not be the same as
635 $wgTitle, if the section is included from a template)
636 $section: The designation of the section being pointed to, to be included in
637 the link, like "&section=$section"
638 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
639 By default, this is wrapped in the 'editsectionhint' message.
640 $result: The HTML to return, prefilled with the default plus whatever other
641 changes earlier hooks have made
642
643 'EditFilter': Perform checks on an edit
644 $editor: Edit form (see includes/EditPage.php)
645 $text: Contents of the edit box
646 $section: Section being edited
647 &$error: Error message to return
648 $summary: Edit summary for page
649
650 'EditFilterMerged': Post-section-merge edit filter
651 $editor: EditPage instance (object)
652 $text: content of the edit box
653 &$error: error message to return
654 $summary: Edit summary for page
655
656 'EditFormPreloadText': Allows population of the edit form when creating
657 new pages
658 &$text: Text to preload with
659 &$title: Title object representing the page being created
660
661 'EditFormInitialText': Allows modifying the edit form when editing existing
662 pages
663 $editPage: EditPage object
664
665 'EditPage::attemptSave': called before an article is
666 saved, that is before insertNewArticle() is called
667 $editpage_Obj: the current EditPage object
668
669 'EditPage::importFormData': allow extensions to read additional data
670 posted in the form
671 $editpage: EditPage instance
672 $request: Webrequest
673 return value is ignored (should always return true)
674
675 'EditPage::showEditForm:fields': allows injection of form field into edit form
676 &$editor: the EditPage instance for reference
677 &$out: an OutputPage instance to write to
678 return value is ignored (should always return true)
679
680 'EditPage::showEditForm:initial': before showing the edit form
681 $editor: EditPage instance (object)
682
683 Return false to halt editing; you'll need to handle error messages, etc.
684 yourself. Alternatively, modifying $error and returning true will cause the
685 contents of $error to be echoed at the top of the edit form as wikitext.
686 Return true without altering $error to allow the edit to proceed.
687
688 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
689 when there's an edit conflict. Return false to halt normal diff output; in
690 this case you're responsible for computing and outputting the entire "conflict"
691 part, i.e., the "difference between revisions" and "your text" headers and
692 sections.
693 &$editor: EditPage instance
694 &$out: OutputPage instance
695
696 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
697 textarea in the edit form
698 &$editpage: The current EditPage object
699 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
700 &$tabindex: HTML tabindex of the last edit check/button
701
702 'EditPageBeforeEditChecks': allows modifying the edit checks below the
703 textarea in the edit form
704 &$editpage: The current EditPage object
705 &$checks: Array of edit checks like "watch this page"/"minor edit"
706 &$tabindex: HTML tabindex of the last edit check/button
707
708 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
709 textarea in the edit form
710 &$toolbar: The toolbar HTMl
711
712 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
713 $title: title of page being edited
714 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
715
716 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
717 "Show changes"
718 $editPage: EditPage object
719 &$newtext: wikitext that will be used as "your version"
720
721 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
722 $editPage: EditPage object
723 &$toparse: wikitext that will be parsed
724
725 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
726 &$editpage: The current EditPage object
727 &$res: the HTML of the error text
728
729 'EditPageTosSummary': Give a chance for site and per-namespace customizations
730 of terms of service summary link that might exist separately from the copyright
731 notice.
732 $title: title of page being edited
733 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
734
735 'EditSectionLink': Do not use, use DoEditSectionLink instead.
736 $skin: Skin rendering the UI
737 $title: Title being linked to
738 $section: Section to link to
739 $link: Default link
740 $result: Result (alter this to override the generated links)
741
742 'EmailConfirmed': When checking that the user's email address is "confirmed"
743 $user: User being checked
744 $confirmed: Whether or not the email address is confirmed
745 This runs before the other checks, such as anonymity and the real check; return
746 true to allow those checks to occur, and false if checking is done.
747
748 'EmailUser': before sending email from one user to another
749 $to: address of receiving user
750 $from: address of sending user
751 $subject: subject of the mail
752 $text: text of the mail
753
754 'EmailUserCC': before sending the copy of the email to the author
755 $to: address of receiving user
756 $from: address of sending user
757 $subject: subject of the mail
758 $text: text of the mail
759
760 'EmailUserComplete': after sending email from one user to another
761 $to: address of receiving user
762 $from: address of sending user
763 $subject: subject of the mail
764 $text: text of the mail
765
766 'EmailUserForm': after building the email user form object
767 $form: HTMLForm object
768
769 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
770 $user: The user who is trying to email another user.
771 $editToken: The user's edit token.
772 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
773
774 'FetchChangesList': When fetching the ChangesList derivative for
775 a particular user
776 &$user: User the list is being fetched for
777 &$skin: Skin object to be used with the list
778 &$list: List object (defaults to NULL, change it to an object
779 instance and return false override the list derivative used)
780
781 'FileDeleteComplete': When a file is deleted
782 $file: reference to the deleted file
783 $oldimage: in case of the deletion of an old image, the name of the old file
784 $article: in case all revisions of the file are deleted a reference to the
785 article associated with the file.
786 $user: user who performed the deletion
787 $reason: reason
788
789 'FileUpload': When a file upload occurs
790 $file : Image object representing the file that was uploaded
791 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
792 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
793
794 'FileUndeleteComplete': When a file is undeleted
795 $title: title object to the file
796 $fileVersions: array of undeleted versions. Empty if all versions were restored
797 $user: user who performed the undeletion
798 $reason: reason
799
800 'FormatUserMessage': Hook to format a message if you want to override
801 the internal formatter.
802 $subject: Title of the message.
803 &$text: Text of the message.
804 $signature: Signature that they would like to leave.
805
806 'GetAutoPromoteGroups': When determining which autopromote groups a user
807 is entitled to be in.
808 &$user: user to promote.
809 &$promote: groups that will be added.
810
811 'GetBlockedStatus': after loading blocking status of an user from the database
812 $user: user (object) being checked
813
814 'GetCacheVaryCookies': get cookies that should vary cache options
815 $out: OutputPage object
816 &$cookies: array of cookies name, add a value to it if you want to add a cookie
817 that have to vary cache options
818
819 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
820 $title: Title object of page
821 $url: string value as output (out parameter, can modify)
822 $query: query options passed to Title::getFullURL()
823
824 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
825 $title: Title object of page
826 $url: string value as output (out parameter, can modify)
827 $query: query options passed to Title::getInternalURL()
828
829 'GetLinkColours': modify the CSS class of an array of page links
830 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
831 indexed by page_id.
832 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
833
834 'GetLocalURL': modify local URLs as output into page links
835 $title: Title object of page
836 $url: string value as output (out parameter, can modify)
837 $query: query options passed to Title::getLocalURL()
838
839 'GetPreferences': modify user preferences
840 $user: User whose preferences are being modified.
841 &$preferences: Preferences description array, to be fed to an HTMLForm object
842
843 'getUserPermissionsErrors': Add a permissions error when permissions errors are
844 checked for. Use instead of userCan for most cases. Return false if the
845 user can't do it, and populate $result with the reason in the form of
846 array( messagename, param1, param2, ... ). For consistency, error messages
847 should be plain text with no special coloring, bolding, etc. to show that
848 they're errors; presenting them properly to the user as errors is done by
849 the caller.
850 $title: Title object being checked against
851 $user : Current user object
852 $action: Action being checked
853 $result: User permissions error to add. If none, return true.
854
855 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
856 if expensive checks are enabled.
857
858 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
859 into the job queue.
860 $title: Title object, pages linked to this title are purged.
861
862 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
863 image insertion. You can skip the default logic entirely by returning
864 false, or just modify a few things using call-by-reference.
865 &$skin: Skin object
866 &$title: Title object of the image
867 &$file: File object, or false if it doesn't exist
868 &$frameParams: Various parameters with special meanings; see documentation in
869 includes/Linker.php for Linker::makeImageLink2
870 &$handlerParams: Various parameters with special meanings; see documentation in
871 includes/Linker.php for Linker::makeImageLink2
872 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
873 &$res: Final HTML output, used if you return false
874
875
876 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
877 the image on an image page
878 $imagePage: ImagePage object ($this)
879 $output: $wgOut
880
881 'ImagePageAfterImageLinks': called after the image links section on an image
882 page is built
883 $imagePage: ImagePage object ($this)
884 &$html: HTML for the hook to add
885
886 'ImagePageFileHistoryLine': called when a file history line is contructed
887 $file: the file
888 $line: the HTML of the history line
889 $css: the line CSS class
890
891 'ImagePageFindFile': called when fetching the file associated with an image page
892 $page: ImagePage object
893 &$file: File object
894 &$displayFile: displayed File object
895
896 'ImagePageShowTOC': called when the file toc on an image page is generated
897 $page: ImagePage object
898 &$toc: Array of <li> strings
899
900 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
901 using img_auth.php
902 &$title: the Title object of the file as it would appear for the upload page
903 &$path: the original file and path name when img_auth was invoked by the the web
904 server
905 &$name: the name only component of the file
906 &$result: The location to pass back results of the hook routine (only used if
907 failed)
908 $result[0]=The index of the header message
909 $result[1]=The index of the body text message
910 $result[2 through n]=Parameters passed to body text message. Please note the
911 header message cannot receive/use parameters.
912
913 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
914 $reader: XMLReader object
915 $logInfo: Array of information
916 Return false to stop further processing of the tag
917
918 'ImportHandlePageXMLTag': When parsing a XML tag in a page
919 $reader: XMLReader object
920 $pageInfo: Array of information
921 Return false to stop further processing of the tag
922
923 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
924 $reader: XMLReader object
925 $revInfo: Array of information
926 Return false to stop further processing of the tag
927
928 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
929 $reader: XMLReader object
930 Return false to stop further processing of the tag
931
932 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
933 $reader: XMLReader object
934 $revisionInfo: Array of information
935 Return false to stop further processing of the tag
936
937 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
938 $title: Title object ($wgTitle)
939 $request: WebRequest
940 $ignoreRedirect: boolean to skip redirect check
941 $target: Title/string of redirect target
942 $article: Article object
943
944 'InternalParseBeforeLinks': during Parser's internalParse method before links
945 but after noinclude/includeonly/onlyinclude and other processing.
946 &$parser: Parser object
947 &$text: string containing partially parsed text
948 &$stripState: Parser's internal StripState object
949
950 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
951 $user: user (object) whose email is being invalidated
952
953 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
954 $article: article (object) being checked
955
956 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
957 $ip: IP being check
958 $result: Change this value to override the result of wfIsTrustedProxy()
959
960 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
961 tance to return false if the domain name doesn't match your organization
962 $addr: The e-mail address entered by the user
963 &$result: Set this and return false to override the internal checks
964
965 'isValidPassword': Override the result of User::isValidPassword()
966 $password: The password entered by the user
967 &$result: Set this and return false to override the internal checks
968 $user: User the password is being validated for
969
970 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
971 $wgExtensionMessagesFiles instead.
972 Use this to define synonyms of magic words depending of the language
973 $magicExtensions: associative array of magic words synonyms
974 $lang: laguage code (string)
975
976 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
977 listed in $wgExtensionMessagesFiles instead.
978 Use to define aliases of special pages names depending of the language
979 $specialPageAliases: associative array of magic words synonyms
980 $lang: laguage code (string)
981
982 'LinkBegin': Used when generating internal and interwiki links in
983 Linker::link(), before processing starts. Return false to skip default proces-
984 sing and return $ret. See documentation for Linker::link() for details on the
985 expected meanings of parameters.
986 $skin: the Skin object
987 $target: the Title that the link is pointing to
988 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
989 fault"
990 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
991 tive array form, with keys and values unescaped. Should be merged with de-
992 fault values, with a value of false meaning to suppress the attribute.
993 &$query: the query string to add to the generated URL (the bit after the "?"),
994 in associative array form, with keys and values unescaped.
995 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
996 &$ret: the value to return if your hook returns false.
997
998 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
999 just before the function returns a value. If you return true, an <a> element
1000 with HTML attributes $attribs and contents $text will be returned. If you re-
1001 turn false, $ret will be returned.
1002 $skin: the Skin object
1003 $target: the Title object that the link is pointing to
1004 $options: the options. Will always include either 'known' or 'broken', and may
1005 include 'noclasses'.
1006 &$text: the final (raw HTML) contents of the <a> tag, after processing.
1007 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1008 ciative array form.
1009 &$ret: the value to return if your hook returns false.
1010
1011 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1012 before the return
1013 &$url: the image url
1014 &$alt: the image's alt text
1015 &$img: the new image HTML (if returning false)
1016
1017 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1018 before the return
1019 &$url: the link url
1020 &$text: the link text
1021 &$link: the new link HTML (if returning false)
1022 &$attribs: the attributes to be applied.
1023 $linkType: The external link type
1024
1025 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1026 actual update
1027 &$linksUpdate: the LinksUpdate object
1028
1029 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1030 completed
1031 &$linksUpdate: the LinksUpdate object
1032
1033 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1034 &$linksUpdate: the LinksUpdate object
1035
1036 'ListDefinedTags': When trying to find all defined tags.
1037 &$tags: The list of tags.
1038
1039 'LoadExtensionSchemaUpdates': called during database installation and updates
1040 &updater: A DatabaseUpdater subclass
1041
1042 'LocalFile::getHistory': called before file history query performed
1043 $file: the file
1044 $tables: tables
1045 $fields: select fields
1046 $conds: conditions
1047 $opts: query options
1048 $join_conds: JOIN conditions
1049
1050 'LocalisationCacheRecache': Called when loading the localisation data into cache
1051 $cache: The LocalisationCache object
1052 $code: language code
1053 &$alldata: The localisation data from core and extensions
1054
1055 'LoginAuthenticateAudit': a login attempt for a valid user account either
1056 succeeded or failed. No return data is accepted; this hook is for auditing only.
1057 $user: the User object being authenticated against
1058 $password: the password being submitted and found wanting
1059 $retval: a LoginForm class constant with authenticateUserData() return
1060 value (SUCCESS, WRONG_PASS, etc)
1061
1062 'LogLine': Processes a single log entry on Special:Log
1063 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1064 logging.log_type database field.
1065 $log_action: string for the type of log action (e.g. 'delete', 'block',
1066 'create2'). Corresponds to logging.log_action database field.
1067 $title: Title object that corresponds to logging.log_namespace and
1068 logging.log_title database fields.
1069 $paramArray: Array of parameters that corresponds to logging.log_params field.
1070 Note that only $paramArray[0] appears to contain anything.
1071 &$comment: string that corresponds to logging.log_comment database field, and
1072 which is displayed in the UI.
1073 &$revert: string that is displayed in the UI, similar to $comment.
1074 $time: timestamp of the log entry (added in 1.12)
1075
1076 'LogPageValidTypes': action being logged.
1077 DEPRECATED: Use $wgLogTypes
1078 &$type: array of strings
1079
1080 'LogPageLogName': name of the logging page(s).
1081 DEPRECATED: Use $wgLogNames
1082 &$typeText: array of strings
1083
1084 'LogPageLogHeader': strings used by wfMsg as a header.
1085 DEPRECATED: Use $wgLogHeaders
1086 &$headerText: array of strings
1087
1088 'LogPageActionText': strings used by wfMsg as a header.
1089 DEPRECATED: Use $wgLogActions
1090 &$actionText: array of strings
1091
1092 'MagicWordMagicWords': When defining new magic word.
1093 DEPRECATED: use $magicWords in a file listed in
1094 $wgExtensionMessagesFiles instead.
1095 $magicWords: array of strings
1096
1097 'MagicWordwgVariableIDs': When definig new magic words IDs.
1098 $variableIDs: array of strings
1099
1100 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1101 is executed
1102 &$vars: variable (or multiple variables) to be added into the output
1103 of Skin::makeVariablesScript
1104
1105 'MarkPatrolled': before an edit is marked patrolled
1106 $rcid: ID of the revision to be marked patrolled
1107 $user: the user (object) marking the revision as patrolled
1108 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1109 needs to be a sysop in order to mark an edit patrolled
1110
1111 'MarkPatrolledComplete': after an edit is marked patrolled
1112 $rcid: ID of the revision marked as patrolled
1113 $user: user (object) who marked the edit patrolled
1114 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1115 must be a sysop to patrol the edit
1116
1117 'MathAfterTexvc': after texvc is executed when rendering mathematics
1118 $mathRenderer: instance of MathRenderer
1119 $errmsg: error message, in HTML (string). Nonempty indicates failure
1120 of rendering the formula
1121
1122 'MediaWikiPerformAction': Override MediaWiki::performAction().
1123 Use this to do something completely different, after the basic
1124 globals have been set up, but before ordinary actions take place.
1125 $output: $wgOut
1126 $article: $wgArticle
1127 $title: $wgTitle
1128 $user: $wgUser
1129 $request: $wgRequest
1130 $mediaWiki: The $mediawiki object
1131
1132 'MessagesPreLoad': When loading a message from the database
1133 $title: title of the message (string)
1134 $message: value (string), change it to the message you want to define
1135
1136 'MessageCacheReplace': When a message page is changed.
1137 Useful for updating caches.
1138 $title: name of the page changed.
1139 $text: new contents of the page.
1140
1141 'ModifyExportQuery': Modify the query used by the exporter.
1142 $db: The database object to be queried.
1143 &$tables: Tables in the query.
1144 &$conds: Conditions in the query.
1145 &$opts: Options for the query.
1146 &$join_conds: Join conditions for the query.
1147
1148 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1149 been rendered (useful for adding more)
1150 Note: this is only run for the Monobook skin. This hook is deprecated and
1151 may be removed in the future. To add items to the toolbox you should use
1152 the SkinTemplateToolboxEnd hook instead, which works for all
1153 "SkinTemplate"-type skins.
1154 $tools: array of tools
1155
1156 'NewRevisionFromEditComplete': called when a revision was inserted
1157 due to an edit
1158 $article: the article edited
1159 $rev: the new revision
1160 $baseID: the revision ID this was based off, if any
1161 $user: the editing user
1162
1163 'NormalizeMessageKey': Called before the software gets the text of a message
1164 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1165 displayed
1166 &$key: the message being looked up. Change this to something else to change
1167 what message gets displayed (string)
1168 &$useDB: whether or not to look up the message in the database (bool)
1169 &$langCode: the language code to get the message for (string) - or -
1170 whether to use the content language (true) or site language (false) (bool)
1171 &$transform: whether or not to expand variables and templates
1172 in the message (bool)
1173
1174 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1175 &$changeslist: The OldChangesList instance.
1176 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1177 &$rc: The RecentChange object.
1178
1179 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1180 Hooks can alter or append to the array of URLs for search & suggestion formats.
1181 &$urls: array of associative arrays with Url element attributes
1182
1183 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1184 users and/or IP addresses too
1185 $otherBlockLink: An array with links to other block logs
1186 $ip: The requested IP address or username
1187
1188 'OutputPageBeforeHTML': a page has been processed by the parser and
1189 the resulting HTML is about to be displayed.
1190 $parserOutput: the parserOutput (object) that corresponds to the page
1191 $text: the text that will be displayed, in HTML (string)
1192
1193 'OutputPageCheckLastModified': when checking if the page has been modified
1194 since the last visit
1195 &$modifiedTimes: array of timestamps.
1196 The following keys are set: page, user, epoch
1197
1198 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1199 $out: OutputPage instance (object)
1200 $parserOutput: parserOutput instance being added in $out
1201
1202 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1203 categories. Implementations should return false if they generate the category
1204 links, so the default link generation is skipped.
1205 $out: OutputPage instance (object)
1206 $categories: associative array, keys are category names, values are category
1207 types ("normal" or "hidden")
1208 $links: array, intended to hold the result. Must be an associative array with
1209 category types as keys and arrays of HTML links as values.
1210
1211 'PageHistoryBeforeList': When a history page list is about to be constructed.
1212 $article: the article that the history is loading for
1213
1214 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1215 $row: the revision row for this line
1216 $s: the string representing this parsed line
1217 $classes: array containing the <li> element classes
1218
1219 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1220 is constructed
1221 $pager: the pager
1222 $queryInfo: the query parameters
1223
1224 'PageRenderingHash': alter the parser cache option hash key
1225 A parser extension which depends on user options should install
1226 this hook and append its values to the key.
1227 $hash: reference to a hash key string which can be modified
1228
1229 'ParserAfterStrip': Same as ParserBeforeStrip
1230
1231 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1232 $parser: Parser object being used
1233 $text: text that'll be returned
1234
1235 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1236 $parser: Parser object
1237 $text: text to parse
1238 $stripState: StripState instance being used
1239
1240 'ParserBeforeStrip': Called at start of parsing time
1241 (no more strip, deprecated ?)
1242 $parser: parser object
1243 $text: text being parsed
1244 $stripState: stripState used (object)
1245
1246 'ParserBeforeTidy': called before tidy and custom tags replacements
1247 $parser: Parser object being used
1248 $text: actual text
1249
1250 'ParserClearState': called at the end of Parser::clearState()
1251 $parser: Parser object being cleared
1252
1253 'ParserFirstCallInit': called when the parser initialises for the first time
1254 &$parser: Parser object being cleared
1255
1256 'ParserGetVariableValueSwitch': called when the parser need the value of a
1257 custom magic word
1258 $parser: Parser object
1259 $varCache: array to store the value in case of multiples calls of the
1260 same magic word
1261 $index: index (string) of the magic
1262 $ret: value of the magic word (the hook should set it)
1263 $frame: PPFrame object to use for expanding any template variables
1264
1265 'ParserGetVariableValueTs': use this to change the value of the time for the
1266 {{LOCAL...}} magic word
1267 $parser: Parser object
1268 $time: actual time (timestamp)
1269
1270 'ParserGetVariableValueVarCache': use this to change the value of the
1271 variable cache or return false to not use it
1272 $parser: Parser object
1273 $varCache: varaiable cache (array)
1274
1275 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1276 include comments about size of the text parsed
1277 $parser: Parser object
1278 $limitReport: text that will be included (without comment tags)
1279
1280 'ParserMakeImageParams': Called before the parser make an image link, use this
1281 to modify the parameters of the image.
1282 $title: title object representing the file
1283 $file: file object that will be used to create the image
1284 &$params: 2-D array of parameters
1285
1286 'ParserTestParser': called when creating a new instance of Parser in
1287 maintenance/parserTests.inc
1288 $parser: Parser object created
1289
1290 'ParserTestTables': alter the list of tables to duplicate when parser tests
1291 are run. Use when page save hooks require the presence of custom tables
1292 to ensure that tests continue to run properly.
1293 &$tables: array of table names
1294
1295 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1296 my talk page, my contributions" etc).
1297
1298 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1299 &$title: Title object representing the current page
1300
1301 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1302 &$user : User performing the action
1303 $action : Action being performed
1304 &$result : Whether or not the action should be prevented
1305 Change $result and return false to give a definitive answer, otherwise
1306 the built-in rate limiting checks are used, if enabled.
1307
1308 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1309 AJAX search suggestions. Put results into &$results outparam and return false.
1310 $ns : array of int namespace keys to search in
1311 $search : search term (not guaranteed to be conveniently normalized)
1312 $limit : maximum number of results to return
1313 &$results : out param: array of page names (strings)
1314
1315 'PrefsEmailAudit': called when user changes his email address
1316 $user: User (object) changing his email address
1317 $oldaddr: old email address (string)
1318 $newaddr: new email address (string)
1319
1320 'PrefsPasswordAudit': called when user changes his password
1321 $user: User (object) changing his passoword
1322 $newPass: new password
1323 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1324
1325 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1326 $article: the title being (un)protected
1327 $output: a string of the form HTML so far
1328
1329 'ProtectionForm::save': called when a protection form is submitted
1330 $article: the title being (un)protected
1331 $errorMsg: an html message string of an error
1332
1333 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1334 $article: the page the form is shown for
1335 $out: OutputPage object
1336
1337 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1338 &$obj: RawPage object
1339 &$text: The text that's going to be the output
1340
1341 'RecentChange_save': called at the end of RecenChange::save()
1342 $recentChange: RecentChange object
1343
1344 'RevisionInsertComplete': called after a revision is inserted into the DB
1345 &$revision: the Revision
1346 $data: the data stored in old_text. The meaning depends on $flags: if external
1347 is set, it's the URL of the revision text in external storage; otherwise,
1348 it's the revision text itself. In either case, if gzip is set, the revision
1349 text is gzipped.
1350 $flags: a comma-delimited list of strings representing the options used. May
1351 include: utf8 (this will always be set for new revisions); gzip; external.
1352
1353 'SearchUpdate': Prior to search update completion
1354 $id : Page id
1355 $namespace : Page namespace
1356 $title : Page title
1357 $text : Current text being indexed
1358
1359 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1360 $allSearchTerms : Array of the search terms in all content languages
1361 &$titleResult : Outparam; the value to return. A Title object or null.
1362
1363 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1364 $term : Search term string
1365 &$title : Outparam; set to $title object and return false for a match
1366
1367 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1368 $term : Search term string
1369 &$title : Current Title object that is being returned (null if none found).
1370
1371 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1372 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1373 in the $searchEngine->namespaces array.
1374 $query : Original query.
1375 &$parsed : Resultant query with the prefixes stripped.
1376
1377 'SearchableNamespaces': An option to modify which namespaces are searchable.
1378 &$arr : Array of namespaces ($nsId => $name) which will be used.
1379
1380 'SetupAfterCache': Called in Setup.php, after cache objects are set
1381
1382 'SetupUserMessageArticle': Called in User::leaveUserMessage() before
1383 anything has been posted to the article.
1384 $user: The user who we left the message for.
1385 &$article: The article that will be posted to.
1386 $subject: The subject of the message
1387 $text: The text of the message.
1388 $signature: The signature we used.
1389 $summary: The edit summary.
1390 $editor: The editor that performed the edit.
1391
1392 'ShowMissingArticle': Called when generating the output for a non-existent page
1393 $article: The article object corresponding to the page
1394
1395 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1396 $text: Text being shown
1397 $title: Title of the custom script/stylesheet page
1398 $output: Current OutputPage object
1399
1400 'ShowSearchHitTitle': Customise display of search hit title/link.
1401 &$title: Title to link to
1402 &$text: Text to use for the link
1403 $result: The search result
1404 $terms: The search terms entered
1405 $page: The SpecialSearch object.
1406
1407 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1408 &$siteNotice: HTML returned as the sitenotice
1409 Return true to allow the normal method of notice selection/rendering to work,
1410 or change the value of $siteNotice and return false to alter it.
1411
1412 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1413 &$siteNotice: HTML sitenotice
1414 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1415
1416 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1417 $skin: Skin object
1418 &$text: bottomScripts Text
1419 Append to $text to add additional text/scripts after the stock bottom scripts.
1420
1421 'SkinAfterContent': Allows extensions to add text after the page content and
1422 article metadata.
1423 &$data: (string) Text to be printed out directly (without parsing)
1424 $skin: Skin object
1425 This hook should work in all skins. Just set the &$data variable to the text
1426 you're going to add.
1427
1428 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1429 $skin: Skin object
1430 &$bar: Sidebar contents
1431 Modify $bar to add or modify sidebar portlets.
1432
1433 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1434 $title: displayed page title
1435 $type: 'normal' or 'history' for old/diff views
1436 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1437 &$link: overridable HTML link to be passed into the message as $1
1438 &$forContent: overridable flag if copyright footer is shown in content language.
1439
1440 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1441 $skin: Skin object
1442 &$subpages: Subpage links HTML
1443 If false is returned $subpages will be used instead of the HTML
1444 subPageSubtitle() generates.
1445 If true is returned, $subpages will be ignored and the rest of
1446 subPageSubtitle() will run.
1447
1448 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1449 when showing a special page
1450 $sktemplate: SkinTemplate object
1451 $content_actions: array of tabs
1452
1453 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1454 "permanent link" tab
1455 $sktemplate: SkinTemplate object
1456 $nav_urls: array of tabs
1457
1458 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1459 &$content_actions: Content actions
1460 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1461 for an example]
1462
1463 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1464 &$sktemplate: SkinTemplate object
1465 &$links: Structured navigation links
1466 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1467
1468 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1469 starts page output
1470 &$sktemplate: SkinTemplate object
1471 &$tpl: Template engine object
1472
1473 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1474 $sktemplate: SkinTemplate object
1475 $res: set to true to prevent active tabs
1476
1477 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1478 $out: Css to return
1479
1480 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1481 You can either create your own array, or alter the parameters for
1482 the normal one.
1483 &$sktemplate: The SkinTemplate instance.
1484 $title: Title instance for the page.
1485 $message: Visible label of tab.
1486 $selected: Whether this is a selected tab.
1487 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1488 &$classes: Array of CSS classes to apply.
1489 &$query: Query string to add to link.
1490 &$text: Link text.
1491 &$result: Complete assoc. array if you want to return true.
1492
1493 'SkinTemplateTabs': called when finished to build the actions tabs
1494 $sktemplate: SkinTemplate object
1495 $content_actions: array of tabs
1496
1497 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1498 been rendered (useful for adding more)
1499 $tools: array of tools
1500
1501 'SoftwareInfo': Called by Special:Version for returning information about
1502 the software
1503 $software: The array of software in format 'name' => 'version'.
1504 See SpecialVersion::softwareInformation()
1505
1506 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1507 $id: User identifier
1508
1509 'SpecialListusersDefaultQuery': called right before the end of
1510 UsersPager::getDefaultQuery()
1511 $pager: The UsersPager instance
1512 $query: The query array to be returned
1513
1514 'SpecialListusersFormatRow': called right before the end of
1515 UsersPager::formatRow()
1516 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1517 $row: Database row object
1518
1519 'SpecialListusersHeader': called before closing the <fieldset> in
1520 UsersPager::getPageHeader()
1521 $pager: The UsersPager instance
1522 $out: The header HTML
1523
1524 'SpecialListusersHeaderForm': called before adding the submit button in
1525 UsersPager::getPageHeader()
1526 $pager: The UsersPager instance
1527 $out: The header HTML
1528
1529 'SpecialListusersQueryInfo': called right before the end of
1530 UsersPager::getQueryInfo()
1531 $pager: The UsersPager instance
1532 $query: The query array to be returned
1533
1534 'SpecialMovepageAfterMove': called after moving a page
1535 $movePage: MovePageForm object
1536 $oldTitle: old title (object)
1537 $newTitle: new title (object)
1538
1539 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1540 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1541 $opts: FormOptions object containing special page options
1542 &$conds: array of WHERE conditionals for query
1543
1544 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1545 hook to remove a core special page
1546 $list: list (array) of core special pages
1547
1548 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1549 use this to change some selection criteria or substitute a different title
1550 &$randstr: The random number from wfRandom()
1551 &$isRedir: Boolean, whether to select a redirect or non-redirect
1552 &$namespaces: An array of namespace indexes to get the title from
1553 &$extra: An array of extra SQL statements
1554 &$title: If the hook returns false, a Title object to use instead of the
1555 result from the normal query
1556
1557 'SpecialRecentChangesPanel': called when building form options in
1558 SpecialRecentChanges
1559 &$extraOpts: array of added items, to which can be added
1560 $opts: FormOptions for this request
1561
1562 'SpecialRecentChangesQuery': called when building sql query for
1563 SpecialRecentChanges and SpecialRecentChangesLinked
1564 &$conds: array of WHERE conditionals for query
1565 &$tables: array of tables to be queried
1566 &$join_conds: join conditions for the tables
1567 $opts: FormOptions for this request
1568 &$query_options: array of options for the database request
1569 &$select: String '*' or array of columns to select
1570
1571 'SpecialSearchGomatch': called when user clicked the "Go" button and the target
1572 exists
1573 &$title: title object generated from the text entred by the user
1574
1575 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1576 target doesn't exist
1577 &$title: title object generated from the text entred by the user
1578
1579 'SpecialSearchProfiles': allows modification of search profiles
1580 &$profiles: profiles, which can be modified.
1581
1582 'SpecialSearchResults': called before search result display when there
1583 are matches
1584 $term: string of search term
1585 &$titleMatches: empty or SearchResultSet object
1586 &$textMatches: empty or SearchResultSet object
1587
1588 'SpecialSearchNoResults': called before search result display when there are
1589 no matches
1590 $term: string of search term
1591
1592 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1593 &$extraStats: Array to save the new stats
1594 ( $extraStats['<name of statistic>'] => <value>; )
1595
1596 'SpecialUploadComplete': Called after successfully uploading a file from
1597 Special:Upload
1598 $form: The SpecialUpload object
1599
1600 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1601 use this to change the tables headers
1602 $extTypes: associative array of extensions types
1603
1604 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1605 &$conds: array of WHERE conditionals for query
1606 &$tables: array of tables to be queried
1607 &$join_conds: join conditions for the tables
1608 &$fields: array of query fields
1609
1610 'TitleArrayFromResult': called when creating an TitleArray object from a
1611 database result
1612 &$titleArray: set this to an object to override the default object returned
1613 $res: database result used to create the object
1614
1615 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1616 that can be applied.
1617 $title: The title in question.
1618 &$types: The types of protection available.
1619
1620 'TitleMoveComplete': after moving an article (title)
1621 $old: old title
1622 $nt: new title
1623 $user: user who did the move
1624 $pageid: database ID of the page that's been moved
1625 $redirid: database ID of the created redirect
1626
1627 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1628 $title: title object related to the revision
1629 $rev: revision (object) that will be viewed
1630
1631 'UnknownAction': An unknown "action" has occured (useful for defining
1632 your own actions)
1633 $action: action name
1634 $article: article "acted on"
1635
1636 'UnitTestsList': Called when building a list of files with PHPUnit tests
1637 &$files: list of files
1638
1639 'UnwatchArticle': before a watch is removed from an article
1640 $user: user watching
1641 $article: article object to be removed
1642
1643 'UnwatchArticle': after a watch is removed from an article
1644 $user: user that was watching
1645 $article: article object removed
1646
1647 'UnwatchArticleComplete': after a watch is removed from an article
1648 $user: user that watched
1649 $article: article object that was watched
1650
1651 'UploadForm:initial': before the upload form is generated
1652 $form: UploadForm object
1653 You might set the member-variables $uploadFormTextTop and
1654 $uploadFormTextAfterSummary to inject text (HTML) either before
1655 or after the editform.
1656
1657 'UploadForm:BeforeProcessing': DEPRECATED! at the beginning of processUpload()
1658 $form: UploadForm object
1659 Lets you poke at member variables like $mUploadDescription before the
1660 file is saved.
1661
1662 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1663 $type: (string) the requested upload type
1664 &$className: the class name of the Upload instance to be created
1665
1666 'UploadComplete': when Upload completes an upload
1667 &$upload: an UploadBase child instance
1668
1669 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1670 assembled
1671 $descriptor: (array) the HTMLForm descriptor
1672
1673 'UploadFormSourceDescriptors': after the standard source inputs have been
1674 added to the descriptor
1675 $descriptor: (array) the HTMLForm descriptor
1676
1677 'UploadVerification': additional chances to reject an uploaded file. Consider
1678 using UploadVerifyFile instead.
1679 string $saveName: destination file name
1680 string $tempName: filesystem path to the temporary file for checks
1681 string &$error: output: message key for message to show if upload canceled
1682 by returning false. May also be an array, where the first element
1683 is the message key and the remaining elements are used as parameters to
1684 the message.
1685
1686 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1687 in most cases over UploadVerification.
1688 object $upload: an instance of UploadBase, with all info about the upload
1689 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1690 will typically only apply for specific mime types.
1691 object &$error: output: true if the file is valid. Otherwise, an indexed array
1692 representing the problem with the file, where the first element
1693 is the message key and the remaining elements are used as parameters to
1694 the message.
1695
1696 'UploadComplete': Upon completion of a file upload
1697 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1698 $uploadBase->getLocalFile().
1699
1700 'User::mailPasswordInternal': before creation and mailing of a user's new
1701 temporary password
1702 $user: the user who sent the message out
1703 $ip: IP of the user who sent the message out
1704 $u: the account whose new password will be set
1705
1706 'UserArrayFromResult': called when creating an UserArray object from a
1707 database result
1708 &$userArray: set this to an object to override the default object returned
1709 $res: database result used to create the object
1710
1711 'userCan': To interrupt/advise the "user can do X to Y article" check.
1712 If you want to display an error message, try getUserPermissionsErrors.
1713 $title: Title object being checked against
1714 $user : Current user object
1715 $action: Action being checked
1716 $result: Pointer to result returned if hook returns false. If null is returned,
1717 userCan checks are continued by internal code.
1718
1719 'UserCanSendEmail': To override User::canSendEmail() permission check
1720 $user: User (object) whose permission is being checked
1721 &$canSend: bool set on input, can override on output
1722
1723 'UserClearNewTalkNotification': called when clearing the
1724 "You have new messages!" message, return false to not delete it
1725 $user: User (object) that'll clear the message
1726
1727 'UserComparePasswords': called when checking passwords, return false to
1728 override the default password checks
1729 &$hash: String of the password hash (from the database)
1730 &$password: String of the plaintext password the user entered
1731 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1732 supplied
1733 &$result: If the hook returns false, this Boolean value will be checked to
1734 determine if the password was valid
1735
1736 'UserCreateForm': change to manipulate the login form
1737 $template: SimpleTemplate instance for the form
1738
1739 'UserCryptPassword': called when hashing a password, return false to implement
1740 your own hashing method
1741 &$password: String of the plaintext password to encrypt
1742 &$salt: String of the password salt or Boolean false if no salt is provided
1743 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1744 hashing method
1745 &$hash: If the hook returns false, this String will be used as the hash
1746
1747 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1748 $user: User to get groups for
1749 &$groups: Current effective groups
1750
1751 'UserGetAllRights': after calculating a list of all available rights
1752 &$rights: Array of rights, which may be added to.
1753
1754 'UserGetEmail': called when getting an user email address
1755 $user: User object
1756 &$email: email, change this to override local email
1757
1758 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1759 email authentification
1760 $user: User object
1761 &$timestamp: timestamp, change this to override local email authentification
1762 timestamp
1763
1764 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1765 &$groups: List of implicit (automatically-assigned) groups
1766
1767 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1768 &$reservedUsernames: $wgReservedUsernames
1769
1770 'UserGetRights': Called in User::getRights()
1771 $user: User to get rights for
1772 &$rights: Current rights
1773
1774 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1775 exemptions).
1776 $user: User in question
1777 $title: Title of the page in question
1778 &$blocked: Out-param, whether or not the user is blocked from that page.
1779 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1780 own user talk pages.
1781
1782 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1783 &$user: User object
1784 $ip: User's IP address
1785 &$blocked: Whether the user is blocked, to be modified by the hook
1786
1787 'UserLoadAfterLoadFromSession': called to authenticate users on
1788 external/environmental means; occurs after session is loaded
1789 $user: user object being loaded
1790
1791 'UserLoadDefaults': called when loading a default user
1792 $user: user object
1793 $name: user name
1794
1795 'UserLoadFromDatabase': called when loading a user from the database
1796 $user: user object
1797 &$s: database query object
1798
1799 'UserLoadFromSession': called to authenticate users on external/environmental
1800 means; occurs before session is loaded
1801 $user: user object being loaded
1802 &$result: set this to a boolean value to abort the normal authentification
1803 process
1804
1805 'UserLoadOptions': when user options/preferences are being loaded from
1806 the database.
1807 $user: User object
1808 &$options: Options, can be modified.
1809
1810 'UserLoginComplete': after a user has logged in
1811 $user: the user object that was created on login
1812 $inject_html: Any HTML to inject after the "logged in" message.
1813
1814 'UserLoginForm': change to manipulate the login form
1815 $template: SimpleTemplate instance for the form
1816
1817 'UserLoginMailPassword': Block users from emailing passwords
1818 $name: the username to email the password of.
1819 &$error: out-param - the error message to return.
1820
1821 'UserLogout': before a user logs out
1822 $user: the user object that is about to be logged out
1823
1824 'UserLogoutComplete': after a user has logged out
1825 $user: the user object _after_ logout (won't have name, ID, etc.)
1826 $inject_html: Any HTML to inject after the "logged out" message.
1827 $oldName: name of the user before logout (string)
1828
1829 'UserRights': After a user's group memberships are changed
1830 $user : User object that was changed
1831 $add : Array of strings corresponding to groups added
1832 $remove: Array of strings corresponding to groups removed
1833
1834 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1835 message(s)
1836 $user: user retrieving new talks messages
1837 $talks: array of new talks page(s)
1838
1839 'UserSaveSettings': called when saving user settings
1840 $user: User object
1841
1842 'UserSaveOptions': Called just before saving user preferences/options.
1843 $user: User object
1844 &$options: Options, modifiable
1845
1846 'UserSetCookies': called when setting user cookies
1847 $user: User object
1848 &$session: session array, will be added to $_SESSION
1849 &$cookies: cookies array mapping cookie name to its value
1850
1851 'UserSetEmail': called when changing user email address
1852 $user: User object
1853 &$email: new email, change this to override new email address
1854
1855 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1856 of email authentification
1857 $user: User object
1858 &$timestamp: new timestamp, change this to override local email
1859 authentification timestamp
1860
1861 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1862 alter the SQL query which gets the list of wanted pages
1863 &$wantedPages: WantedPagesPage object
1864 &$sql: raw SQL query used to get the list of wanted pages
1865
1866 'WatchArticle': before a watch is added to an article
1867 $user: user that will watch
1868 $article: article object to be watched
1869
1870 'WatchArticleComplete': after a watch is added to an article
1871 $user: user that watched
1872 $article: article object watched
1873
1874 'WatchlistEditorBuildRemoveLine': when building remove lines in
1875 Special:Watchlist/edit
1876 &$tools: array of extra links
1877 $title: Title object
1878 $redirect: whether the page is a redirect
1879 $skin: Skin object
1880
1881 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1882 dumps
1883 One, and only one hook should set this, and return false.
1884 &$tables: Database tables to use in the SELECT query
1885 &$opts: Options to use for the query
1886 &$join: Join conditions
1887
1888 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1889 query pages to be updated with maintenance/updateSpecialPages.php
1890 $query: $wgQueryPages itself
1891
1892 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1893 metadata to be added.
1894 $obj: The XmlDumpWriter object.
1895 &$out: The output string.
1896 $row: The database row for the page.
1897 $title: The title of the page.
1898
1899 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1900 metadata.
1901 $obj: The XmlDumpWriter object.
1902 &$out: The text being output.
1903 $row: The database row for the revision.
1904 $text: The revision text.
1905
1906 More hooks might be available but undocumented, you can execute
1907 ./maintenance/findhooks.php to find hidden one.