Remove $wgIP global, but add a hook instead.
[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 'GetIP': modify the ip of the current user (called only once)
830 &$ip: string holding the ip as determined so far
831
832 'GetLinkColours': modify the CSS class of an array of page links
833 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
834 indexed by page_id.
835 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
836
837 'GetLocalURL': modify local URLs as output into page links
838 $title: Title object of page
839 $url: string value as output (out parameter, can modify)
840 $query: query options passed to Title::getLocalURL()
841
842 'GetPreferences': modify user preferences
843 $user: User whose preferences are being modified.
844 &$preferences: Preferences description array, to be fed to an HTMLForm object
845
846 'getUserPermissionsErrors': Add a permissions error when permissions errors are
847 checked for. Use instead of userCan for most cases. Return false if the
848 user can't do it, and populate $result with the reason in the form of
849 array( messagename, param1, param2, ... ). For consistency, error messages
850 should be plain text with no special coloring, bolding, etc. to show that
851 they're errors; presenting them properly to the user as errors is done by
852 the caller.
853 $title: Title object being checked against
854 $user : Current user object
855 $action: Action being checked
856 $result: User permissions error to add. If none, return true.
857
858 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
859 if expensive checks are enabled.
860
861 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
862 into the job queue.
863 $title: Title object, pages linked to this title are purged.
864
865 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
866 image insertion. You can skip the default logic entirely by returning
867 false, or just modify a few things using call-by-reference.
868 &$skin: Skin object
869 &$title: Title object of the image
870 &$file: File object, or false if it doesn't exist
871 &$frameParams: Various parameters with special meanings; see documentation in
872 includes/Linker.php for Linker::makeImageLink2
873 &$handlerParams: Various parameters with special meanings; see documentation in
874 includes/Linker.php for Linker::makeImageLink2
875 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
876 &$res: Final HTML output, used if you return false
877
878
879 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
880 the image on an image page
881 $imagePage: ImagePage object ($this)
882 $output: $wgOut
883
884 'ImagePageAfterImageLinks': called after the image links section on an image
885 page is built
886 $imagePage: ImagePage object ($this)
887 &$html: HTML for the hook to add
888
889 'ImagePageFileHistoryLine': called when a file history line is contructed
890 $file: the file
891 $line: the HTML of the history line
892 $css: the line CSS class
893
894 'ImagePageFindFile': called when fetching the file associated with an image page
895 $page: ImagePage object
896 &$file: File object
897 &$displayFile: displayed File object
898
899 'ImagePageShowTOC': called when the file toc on an image page is generated
900 $page: ImagePage object
901 &$toc: Array of <li> strings
902
903 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
904 using img_auth.php
905 &$title: the Title object of the file as it would appear for the upload page
906 &$path: the original file and path name when img_auth was invoked by the the web
907 server
908 &$name: the name only component of the file
909 &$result: The location to pass back results of the hook routine (only used if
910 failed)
911 $result[0]=The index of the header message
912 $result[1]=The index of the body text message
913 $result[2 through n]=Parameters passed to body text message. Please note the
914 header message cannot receive/use parameters.
915
916 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
917 $reader: XMLReader object
918 $logInfo: Array of information
919 Return false to stop further processing of the tag
920
921 'ImportHandlePageXMLTag': When parsing a XML tag in a page
922 $reader: XMLReader object
923 $pageInfo: Array of information
924 Return false to stop further processing of the tag
925
926 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
927 $reader: XMLReader object
928 $revInfo: Array of information
929 Return false to stop further processing of the tag
930
931 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
932 $reader: XMLReader object
933 Return false to stop further processing of the tag
934
935 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
936 $reader: XMLReader object
937 $revisionInfo: Array of information
938 Return false to stop further processing of the tag
939
940 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
941 $title: Title object ($wgTitle)
942 $request: WebRequest
943 $ignoreRedirect: boolean to skip redirect check
944 $target: Title/string of redirect target
945 $article: Article object
946
947 'InternalParseBeforeLinks': during Parser's internalParse method before links
948 but after noinclude/includeonly/onlyinclude and other processing.
949 &$parser: Parser object
950 &$text: string containing partially parsed text
951 &$stripState: Parser's internal StripState object
952
953 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
954 $user: user (object) whose email is being invalidated
955
956 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
957 $article: article (object) being checked
958
959 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
960 $ip: IP being check
961 $result: Change this value to override the result of wfIsTrustedProxy()
962
963 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
964 tance to return false if the domain name doesn't match your organization
965 $addr: The e-mail address entered by the user
966 &$result: Set this and return false to override the internal checks
967
968 'isValidPassword': Override the result of User::isValidPassword()
969 $password: The password entered by the user
970 &$result: Set this and return false to override the internal checks
971 $user: User the password is being validated for
972
973 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
974 $wgExtensionMessagesFiles instead.
975 Use this to define synonyms of magic words depending of the language
976 $magicExtensions: associative array of magic words synonyms
977 $lang: laguage code (string)
978
979 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
980 listed in $wgExtensionMessagesFiles instead.
981 Use to define aliases of special pages names depending of the language
982 $specialPageAliases: associative array of magic words synonyms
983 $lang: laguage code (string)
984
985 'LinkBegin': Used when generating internal and interwiki links in
986 Linker::link(), before processing starts. Return false to skip default proces-
987 sing and return $ret. See documentation for Linker::link() for details on the
988 expected meanings of parameters.
989 $skin: the Skin object
990 $target: the Title that the link is pointing to
991 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
992 fault"
993 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
994 tive array form, with keys and values unescaped. Should be merged with de-
995 fault values, with a value of false meaning to suppress the attribute.
996 &$query: the query string to add to the generated URL (the bit after the "?"),
997 in associative array form, with keys and values unescaped.
998 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
999 &$ret: the value to return if your hook returns false.
1000
1001 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1002 just before the function returns a value. If you return true, an <a> element
1003 with HTML attributes $attribs and contents $text will be returned. If you re-
1004 turn false, $ret will be returned.
1005 $skin: the Skin object
1006 $target: the Title object that the link is pointing to
1007 $options: the options. Will always include either 'known' or 'broken', and may
1008 include 'noclasses'.
1009 &$text: the final (raw HTML) contents of the <a> tag, after processing.
1010 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1011 ciative array form.
1012 &$ret: the value to return if your hook returns false.
1013
1014 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1015 before the return
1016 &$url: the image url
1017 &$alt: the image's alt text
1018 &$img: the new image HTML (if returning false)
1019
1020 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1021 before the return
1022 &$url: the link url
1023 &$text: the link text
1024 &$link: the new link HTML (if returning false)
1025 &$attribs: the attributes to be applied.
1026 $linkType: The external link type
1027
1028 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1029 actual update
1030 &$linksUpdate: the LinksUpdate object
1031
1032 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1033 completed
1034 &$linksUpdate: the LinksUpdate object
1035
1036 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1037 &$linksUpdate: the LinksUpdate object
1038
1039 'ListDefinedTags': When trying to find all defined tags.
1040 &$tags: The list of tags.
1041
1042 'LoadExtensionSchemaUpdates': called during database installation and updates
1043 &updater: A DatabaseUpdater subclass
1044
1045 'LocalFile::getHistory': called before file history query performed
1046 $file: the file
1047 $tables: tables
1048 $fields: select fields
1049 $conds: conditions
1050 $opts: query options
1051 $join_conds: JOIN conditions
1052
1053 'LocalisationCacheRecache': Called when loading the localisation data into cache
1054 $cache: The LocalisationCache object
1055 $code: language code
1056 &$alldata: The localisation data from core and extensions
1057
1058 'LoginAuthenticateAudit': a login attempt for a valid user account either
1059 succeeded or failed. No return data is accepted; this hook is for auditing only.
1060 $user: the User object being authenticated against
1061 $password: the password being submitted and found wanting
1062 $retval: a LoginForm class constant with authenticateUserData() return
1063 value (SUCCESS, WRONG_PASS, etc)
1064
1065 'LogLine': Processes a single log entry on Special:Log
1066 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1067 logging.log_type database field.
1068 $log_action: string for the type of log action (e.g. 'delete', 'block',
1069 'create2'). Corresponds to logging.log_action database field.
1070 $title: Title object that corresponds to logging.log_namespace and
1071 logging.log_title database fields.
1072 $paramArray: Array of parameters that corresponds to logging.log_params field.
1073 Note that only $paramArray[0] appears to contain anything.
1074 &$comment: string that corresponds to logging.log_comment database field, and
1075 which is displayed in the UI.
1076 &$revert: string that is displayed in the UI, similar to $comment.
1077 $time: timestamp of the log entry (added in 1.12)
1078
1079 'LogPageValidTypes': action being logged.
1080 DEPRECATED: Use $wgLogTypes
1081 &$type: array of strings
1082
1083 'LogPageLogName': name of the logging page(s).
1084 DEPRECATED: Use $wgLogNames
1085 &$typeText: array of strings
1086
1087 'LogPageLogHeader': strings used by wfMsg as a header.
1088 DEPRECATED: Use $wgLogHeaders
1089 &$headerText: array of strings
1090
1091 'LogPageActionText': strings used by wfMsg as a header.
1092 DEPRECATED: Use $wgLogActions
1093 &$actionText: array of strings
1094
1095 'MagicWordMagicWords': When defining new magic word.
1096 DEPRECATED: use $magicWords in a file listed in
1097 $wgExtensionMessagesFiles instead.
1098 $magicWords: array of strings
1099
1100 'MagicWordwgVariableIDs': When definig new magic words IDs.
1101 $variableIDs: array of strings
1102
1103 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1104 is executed
1105 &$vars: variable (or multiple variables) to be added into the output
1106 of Skin::makeVariablesScript
1107
1108 'MarkPatrolled': before an edit is marked patrolled
1109 $rcid: ID of the revision to be marked patrolled
1110 $user: the user (object) marking the revision as patrolled
1111 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1112 needs to be a sysop in order to mark an edit patrolled
1113
1114 'MarkPatrolledComplete': after an edit is marked patrolled
1115 $rcid: ID of the revision marked as patrolled
1116 $user: user (object) who marked the edit patrolled
1117 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1118 must be a sysop to patrol the edit
1119
1120 'MathAfterTexvc': after texvc is executed when rendering mathematics
1121 $mathRenderer: instance of MathRenderer
1122 $errmsg: error message, in HTML (string). Nonempty indicates failure
1123 of rendering the formula
1124
1125 'MediaWikiPerformAction': Override MediaWiki::performAction().
1126 Use this to do something completely different, after the basic
1127 globals have been set up, but before ordinary actions take place.
1128 $output: $wgOut
1129 $article: $wgArticle
1130 $title: $wgTitle
1131 $user: $wgUser
1132 $request: $wgRequest
1133 $mediaWiki: The $mediawiki object
1134
1135 'MessagesPreLoad': When loading a message from the database
1136 $title: title of the message (string)
1137 $message: value (string), change it to the message you want to define
1138
1139 'MessageCacheReplace': When a message page is changed.
1140 Useful for updating caches.
1141 $title: name of the page changed.
1142 $text: new contents of the page.
1143
1144 'ModifyExportQuery': Modify the query used by the exporter.
1145 $db: The database object to be queried.
1146 &$tables: Tables in the query.
1147 &$conds: Conditions in the query.
1148 &$opts: Options for the query.
1149 &$join_conds: Join conditions for the query.
1150
1151 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1152 been rendered (useful for adding more)
1153 Note: this is only run for the Monobook skin. This hook is deprecated and
1154 may be removed in the future. To add items to the toolbox you should use
1155 the SkinTemplateToolboxEnd hook instead, which works for all
1156 "SkinTemplate"-type skins.
1157 $tools: array of tools
1158
1159 'NewRevisionFromEditComplete': called when a revision was inserted
1160 due to an edit
1161 $article: the article edited
1162 $rev: the new revision
1163 $baseID: the revision ID this was based off, if any
1164 $user: the editing user
1165
1166 'NormalizeMessageKey': Called before the software gets the text of a message
1167 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1168 displayed
1169 &$key: the message being looked up. Change this to something else to change
1170 what message gets displayed (string)
1171 &$useDB: whether or not to look up the message in the database (bool)
1172 &$langCode: the language code to get the message for (string) - or -
1173 whether to use the content language (true) or site language (false) (bool)
1174 &$transform: whether or not to expand variables and templates
1175 in the message (bool)
1176
1177 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1178 &$changeslist: The OldChangesList instance.
1179 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1180 &$rc: The RecentChange object.
1181
1182 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1183 Hooks can alter or append to the array of URLs for search & suggestion formats.
1184 &$urls: array of associative arrays with Url element attributes
1185
1186 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1187 users and/or IP addresses too
1188 $otherBlockLink: An array with links to other block logs
1189 $ip: The requested IP address or username
1190
1191 'OutputPageBeforeHTML': a page has been processed by the parser and
1192 the resulting HTML is about to be displayed.
1193 $parserOutput: the parserOutput (object) that corresponds to the page
1194 $text: the text that will be displayed, in HTML (string)
1195
1196 'OutputPageCheckLastModified': when checking if the page has been modified
1197 since the last visit
1198 &$modifiedTimes: array of timestamps.
1199 The following keys are set: page, user, epoch
1200
1201 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1202 $out: OutputPage instance (object)
1203 $parserOutput: parserOutput instance being added in $out
1204
1205 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1206 categories. Implementations should return false if they generate the category
1207 links, so the default link generation is skipped.
1208 $out: OutputPage instance (object)
1209 $categories: associative array, keys are category names, values are category
1210 types ("normal" or "hidden")
1211 $links: array, intended to hold the result. Must be an associative array with
1212 category types as keys and arrays of HTML links as values.
1213
1214 'PageHistoryBeforeList': When a history page list is about to be constructed.
1215 $article: the article that the history is loading for
1216
1217 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1218 $row: the revision row for this line
1219 $s: the string representing this parsed line
1220 $classes: array containing the <li> element classes
1221
1222 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1223 is constructed
1224 $pager: the pager
1225 $queryInfo: the query parameters
1226
1227 'PageRenderingHash': alter the parser cache option hash key
1228 A parser extension which depends on user options should install
1229 this hook and append its values to the key.
1230 $hash: reference to a hash key string which can be modified
1231
1232 'ParserAfterStrip': Same as ParserBeforeStrip
1233
1234 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1235 $parser: Parser object being used
1236 $text: text that'll be returned
1237
1238 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1239 $parser: Parser object
1240 $text: text to parse
1241 $stripState: StripState instance being used
1242
1243 'ParserBeforeStrip': Called at start of parsing time
1244 (no more strip, deprecated ?)
1245 $parser: parser object
1246 $text: text being parsed
1247 $stripState: stripState used (object)
1248
1249 'ParserBeforeTidy': called before tidy and custom tags replacements
1250 $parser: Parser object being used
1251 $text: actual text
1252
1253 'ParserClearState': called at the end of Parser::clearState()
1254 $parser: Parser object being cleared
1255
1256 'ParserFirstCallInit': called when the parser initialises for the first time
1257 &$parser: Parser object being cleared
1258
1259 'ParserGetVariableValueSwitch': called when the parser need the value of a
1260 custom magic word
1261 $parser: Parser object
1262 $varCache: array to store the value in case of multiples calls of the
1263 same magic word
1264 $index: index (string) of the magic
1265 $ret: value of the magic word (the hook should set it)
1266 $frame: PPFrame object to use for expanding any template variables
1267
1268 'ParserGetVariableValueTs': use this to change the value of the time for the
1269 {{LOCAL...}} magic word
1270 $parser: Parser object
1271 $time: actual time (timestamp)
1272
1273 'ParserGetVariableValueVarCache': use this to change the value of the
1274 variable cache or return false to not use it
1275 $parser: Parser object
1276 $varCache: varaiable cache (array)
1277
1278 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1279 include comments about size of the text parsed
1280 $parser: Parser object
1281 $limitReport: text that will be included (without comment tags)
1282
1283 'ParserMakeImageParams': Called before the parser make an image link, use this
1284 to modify the parameters of the image.
1285 $title: title object representing the file
1286 $file: file object that will be used to create the image
1287 &$params: 2-D array of parameters
1288
1289 'ParserTestParser': called when creating a new instance of Parser in
1290 maintenance/parserTests.inc
1291 $parser: Parser object created
1292
1293 'ParserTestTables': alter the list of tables to duplicate when parser tests
1294 are run. Use when page save hooks require the presence of custom tables
1295 to ensure that tests continue to run properly.
1296 &$tables: array of table names
1297
1298 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1299 my talk page, my contributions" etc).
1300
1301 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1302 &$title: Title object representing the current page
1303
1304 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1305 &$user : User performing the action
1306 $action : Action being performed
1307 &$result : Whether or not the action should be prevented
1308 Change $result and return false to give a definitive answer, otherwise
1309 the built-in rate limiting checks are used, if enabled.
1310
1311 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1312 AJAX search suggestions. Put results into &$results outparam and return false.
1313 $ns : array of int namespace keys to search in
1314 $search : search term (not guaranteed to be conveniently normalized)
1315 $limit : maximum number of results to return
1316 &$results : out param: array of page names (strings)
1317
1318 'PrefsEmailAudit': called when user changes his email address
1319 $user: User (object) changing his email address
1320 $oldaddr: old email address (string)
1321 $newaddr: new email address (string)
1322
1323 'PrefsPasswordAudit': called when user changes his password
1324 $user: User (object) changing his passoword
1325 $newPass: new password
1326 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1327
1328 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1329 $article: the title being (un)protected
1330 $output: a string of the form HTML so far
1331
1332 'ProtectionForm::save': called when a protection form is submitted
1333 $article: the title being (un)protected
1334 $errorMsg: an html message string of an error
1335
1336 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1337 $article: the page the form is shown for
1338 $out: OutputPage object
1339
1340 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1341 &$obj: RawPage object
1342 &$text: The text that's going to be the output
1343
1344 'RecentChange_save': called at the end of RecenChange::save()
1345 $recentChange: RecentChange object
1346
1347 'RevisionInsertComplete': called after a revision is inserted into the DB
1348 &$revision: the Revision
1349 $data: the data stored in old_text. The meaning depends on $flags: if external
1350 is set, it's the URL of the revision text in external storage; otherwise,
1351 it's the revision text itself. In either case, if gzip is set, the revision
1352 text is gzipped.
1353 $flags: a comma-delimited list of strings representing the options used. May
1354 include: utf8 (this will always be set for new revisions); gzip; external.
1355
1356 'SearchUpdate': Prior to search update completion
1357 $id : Page id
1358 $namespace : Page namespace
1359 $title : Page title
1360 $text : Current text being indexed
1361
1362 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1363 $allSearchTerms : Array of the search terms in all content languages
1364 &$titleResult : Outparam; the value to return. A Title object or null.
1365
1366 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1367 $term : Search term string
1368 &$title : Outparam; set to $title object and return false for a match
1369
1370 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1371 $term : Search term string
1372 &$title : Current Title object that is being returned (null if none found).
1373
1374 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1375 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1376 in the $searchEngine->namespaces array.
1377 $query : Original query.
1378 &$parsed : Resultant query with the prefixes stripped.
1379
1380 'SearchableNamespaces': An option to modify which namespaces are searchable.
1381 &$arr : Array of namespaces ($nsId => $name) which will be used.
1382
1383 'SetupAfterCache': Called in Setup.php, after cache objects are set
1384
1385 'SetupUserMessageArticle': Called in User::leaveUserMessage() before
1386 anything has been posted to the article.
1387 $user: The user who we left the message for.
1388 &$article: The article that will be posted to.
1389 $subject: The subject of the message
1390 $text: The text of the message.
1391 $signature: The signature we used.
1392 $summary: The edit summary.
1393 $editor: The editor that performed the edit.
1394
1395 'ShowMissingArticle': Called when generating the output for a non-existent page
1396 $article: The article object corresponding to the page
1397
1398 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1399 $text: Text being shown
1400 $title: Title of the custom script/stylesheet page
1401 $output: Current OutputPage object
1402
1403 'ShowSearchHitTitle': Customise display of search hit title/link.
1404 &$title: Title to link to
1405 &$text: Text to use for the link
1406 $result: The search result
1407 $terms: The search terms entered
1408 $page: The SpecialSearch object.
1409
1410 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1411 &$siteNotice: HTML returned as the sitenotice
1412 Return true to allow the normal method of notice selection/rendering to work,
1413 or change the value of $siteNotice and return false to alter it.
1414
1415 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1416 &$siteNotice: HTML sitenotice
1417 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1418
1419 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1420 $skin: Skin object
1421 &$text: bottomScripts Text
1422 Append to $text to add additional text/scripts after the stock bottom scripts.
1423
1424 'SkinAfterContent': Allows extensions to add text after the page content and
1425 article metadata.
1426 &$data: (string) Text to be printed out directly (without parsing)
1427 $skin: Skin object
1428 This hook should work in all skins. Just set the &$data variable to the text
1429 you're going to add.
1430
1431 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1432 $skin: Skin object
1433 &$bar: Sidebar contents
1434 Modify $bar to add or modify sidebar portlets.
1435
1436 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1437 $title: displayed page title
1438 $type: 'normal' or 'history' for old/diff views
1439 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1440 &$link: overridable HTML link to be passed into the message as $1
1441 &$forContent: overridable flag if copyright footer is shown in content language.
1442
1443 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1444 $skin: Skin object
1445 &$subpages: Subpage links HTML
1446 If false is returned $subpages will be used instead of the HTML
1447 subPageSubtitle() generates.
1448 If true is returned, $subpages will be ignored and the rest of
1449 subPageSubtitle() will run.
1450
1451 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1452 when showing a special page
1453 $sktemplate: SkinTemplate object
1454 $content_actions: array of tabs
1455
1456 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1457 "permanent link" tab
1458 $sktemplate: SkinTemplate object
1459 $nav_urls: array of tabs
1460
1461 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1462 &$content_actions: Content actions
1463 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1464 for an example]
1465
1466 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1467 &$sktemplate: SkinTemplate object
1468 &$links: Structured navigation links
1469 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1470
1471 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1472 starts page output
1473 &$sktemplate: SkinTemplate object
1474 &$tpl: Template engine object
1475
1476 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1477 $sktemplate: SkinTemplate object
1478 $res: set to true to prevent active tabs
1479
1480 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1481 $out: Css to return
1482
1483 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1484 You can either create your own array, or alter the parameters for
1485 the normal one.
1486 &$sktemplate: The SkinTemplate instance.
1487 $title: Title instance for the page.
1488 $message: Visible label of tab.
1489 $selected: Whether this is a selected tab.
1490 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1491 &$classes: Array of CSS classes to apply.
1492 &$query: Query string to add to link.
1493 &$text: Link text.
1494 &$result: Complete assoc. array if you want to return true.
1495
1496 'SkinTemplateTabs': called when finished to build the actions tabs
1497 $sktemplate: SkinTemplate object
1498 $content_actions: array of tabs
1499
1500 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1501 been rendered (useful for adding more)
1502 $tools: array of tools
1503
1504 'SoftwareInfo': Called by Special:Version for returning information about
1505 the software
1506 $software: The array of software in format 'name' => 'version'.
1507 See SpecialVersion::softwareInformation()
1508
1509 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1510 $id: User identifier
1511
1512 'SpecialListusersDefaultQuery': called right before the end of
1513 UsersPager::getDefaultQuery()
1514 $pager: The UsersPager instance
1515 $query: The query array to be returned
1516
1517 'SpecialListusersFormatRow': called right before the end of
1518 UsersPager::formatRow()
1519 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1520 $row: Database row object
1521
1522 'SpecialListusersHeader': called before closing the <fieldset> in
1523 UsersPager::getPageHeader()
1524 $pager: The UsersPager instance
1525 $out: The header HTML
1526
1527 'SpecialListusersHeaderForm': called before adding the submit button in
1528 UsersPager::getPageHeader()
1529 $pager: The UsersPager instance
1530 $out: The header HTML
1531
1532 'SpecialListusersQueryInfo': called right before the end of
1533 UsersPager::getQueryInfo()
1534 $pager: The UsersPager instance
1535 $query: The query array to be returned
1536
1537 'SpecialMovepageAfterMove': called after moving a page
1538 $movePage: MovePageForm object
1539 $oldTitle: old title (object)
1540 $newTitle: new title (object)
1541
1542 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1543 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1544 $opts: FormOptions object containing special page options
1545 &$conds: array of WHERE conditionals for query
1546
1547 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1548 hook to remove a core special page
1549 $list: list (array) of core special pages
1550
1551 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1552 use this to change some selection criteria or substitute a different title
1553 &$randstr: The random number from wfRandom()
1554 &$isRedir: Boolean, whether to select a redirect or non-redirect
1555 &$namespaces: An array of namespace indexes to get the title from
1556 &$extra: An array of extra SQL statements
1557 &$title: If the hook returns false, a Title object to use instead of the
1558 result from the normal query
1559
1560 'SpecialRecentChangesPanel': called when building form options in
1561 SpecialRecentChanges
1562 &$extraOpts: array of added items, to which can be added
1563 $opts: FormOptions for this request
1564
1565 'SpecialRecentChangesQuery': called when building sql query for
1566 SpecialRecentChanges and SpecialRecentChangesLinked
1567 &$conds: array of WHERE conditionals for query
1568 &$tables: array of tables to be queried
1569 &$join_conds: join conditions for the tables
1570 $opts: FormOptions for this request
1571 &$query_options: array of options for the database request
1572 &$select: String '*' or array of columns to select
1573
1574 'SpecialSearchGomatch': called when user clicked the "Go" button and the target
1575 exists
1576 &$title: title object generated from the text entred by the user
1577
1578 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1579 target doesn't exist
1580 &$title: title object generated from the text entred by the user
1581
1582 'SpecialSearchProfiles': allows modification of search profiles
1583 &$profiles: profiles, which can be modified.
1584
1585 'SpecialSearchResults': called before search result display when there
1586 are matches
1587 $term: string of search term
1588 &$titleMatches: empty or SearchResultSet object
1589 &$textMatches: empty or SearchResultSet object
1590
1591 'SpecialSearchNoResults': called before search result display when there are
1592 no matches
1593 $term: string of search term
1594
1595 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1596 &$extraStats: Array to save the new stats
1597 ( $extraStats['<name of statistic>'] => <value>; )
1598
1599 'SpecialUploadComplete': Called after successfully uploading a file from
1600 Special:Upload
1601 $form: The SpecialUpload object
1602
1603 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1604 use this to change the tables headers
1605 $extTypes: associative array of extensions types
1606
1607 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1608 &$conds: array of WHERE conditionals for query
1609 &$tables: array of tables to be queried
1610 &$join_conds: join conditions for the tables
1611 &$fields: array of query fields
1612
1613 'TitleArrayFromResult': called when creating an TitleArray object from a
1614 database result
1615 &$titleArray: set this to an object to override the default object returned
1616 $res: database result used to create the object
1617
1618 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1619 that can be applied.
1620 $title: The title in question.
1621 &$types: The types of protection available.
1622
1623 'TitleMoveComplete': after moving an article (title)
1624 $old: old title
1625 $nt: new title
1626 $user: user who did the move
1627 $pageid: database ID of the page that's been moved
1628 $redirid: database ID of the created redirect
1629
1630 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1631 $title: title object related to the revision
1632 $rev: revision (object) that will be viewed
1633
1634 'UnknownAction': An unknown "action" has occured (useful for defining
1635 your own actions)
1636 $action: action name
1637 $article: article "acted on"
1638
1639 'UnitTestsList': Called when building a list of files with PHPUnit tests
1640 &$files: list of files
1641
1642 'UnwatchArticle': before a watch is removed from an article
1643 $user: user watching
1644 $article: article object to be removed
1645
1646 'UnwatchArticle': after a watch is removed from an article
1647 $user: user that was watching
1648 $article: article object removed
1649
1650 'UnwatchArticleComplete': after a watch is removed from an article
1651 $user: user that watched
1652 $article: article object that was watched
1653
1654 'UploadForm:initial': before the upload form is generated
1655 $form: UploadForm object
1656 You might set the member-variables $uploadFormTextTop and
1657 $uploadFormTextAfterSummary to inject text (HTML) either before
1658 or after the editform.
1659
1660 'UploadForm:BeforeProcessing': DEPRECATED! at the beginning of processUpload()
1661 $form: UploadForm object
1662 Lets you poke at member variables like $mUploadDescription before the
1663 file is saved.
1664
1665 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1666 $type: (string) the requested upload type
1667 &$className: the class name of the Upload instance to be created
1668
1669 'UploadComplete': when Upload completes an upload
1670 &$upload: an UploadBase child instance
1671
1672 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1673 assembled
1674 $descriptor: (array) the HTMLForm descriptor
1675
1676 'UploadFormSourceDescriptors': after the standard source inputs have been
1677 added to the descriptor
1678 $descriptor: (array) the HTMLForm descriptor
1679
1680 'UploadVerification': additional chances to reject an uploaded file. Consider
1681 using UploadVerifyFile instead.
1682 string $saveName: destination file name
1683 string $tempName: filesystem path to the temporary file for checks
1684 string &$error: output: message key for message to show if upload canceled
1685 by returning false. May also be an array, where the first element
1686 is the message key and the remaining elements are used as parameters to
1687 the message.
1688
1689 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1690 in most cases over UploadVerification.
1691 object $upload: an instance of UploadBase, with all info about the upload
1692 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1693 will typically only apply for specific mime types.
1694 object &$error: output: true if the file is valid. Otherwise, an indexed array
1695 representing the problem with the file, where the first element
1696 is the message key and the remaining elements are used as parameters to
1697 the message.
1698
1699 'UploadComplete': Upon completion of a file upload
1700 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1701 $uploadBase->getLocalFile().
1702
1703 'User::mailPasswordInternal': before creation and mailing of a user's new
1704 temporary password
1705 $user: the user who sent the message out
1706 $ip: IP of the user who sent the message out
1707 $u: the account whose new password will be set
1708
1709 'UserArrayFromResult': called when creating an UserArray object from a
1710 database result
1711 &$userArray: set this to an object to override the default object returned
1712 $res: database result used to create the object
1713
1714 'userCan': To interrupt/advise the "user can do X to Y article" check.
1715 If you want to display an error message, try getUserPermissionsErrors.
1716 $title: Title object being checked against
1717 $user : Current user object
1718 $action: Action being checked
1719 $result: Pointer to result returned if hook returns false. If null is returned,
1720 userCan checks are continued by internal code.
1721
1722 'UserCanSendEmail': To override User::canSendEmail() permission check
1723 $user: User (object) whose permission is being checked
1724 &$canSend: bool set on input, can override on output
1725
1726 'UserClearNewTalkNotification': called when clearing the
1727 "You have new messages!" message, return false to not delete it
1728 $user: User (object) that'll clear the message
1729
1730 'UserComparePasswords': called when checking passwords, return false to
1731 override the default password checks
1732 &$hash: String of the password hash (from the database)
1733 &$password: String of the plaintext password the user entered
1734 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1735 supplied
1736 &$result: If the hook returns false, this Boolean value will be checked to
1737 determine if the password was valid
1738
1739 'UserCreateForm': change to manipulate the login form
1740 $template: SimpleTemplate instance for the form
1741
1742 'UserCryptPassword': called when hashing a password, return false to implement
1743 your own hashing method
1744 &$password: String of the plaintext password to encrypt
1745 &$salt: String of the password salt or Boolean false if no salt is provided
1746 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1747 hashing method
1748 &$hash: If the hook returns false, this String will be used as the hash
1749
1750 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1751 $user: User to get groups for
1752 &$groups: Current effective groups
1753
1754 'UserGetAllRights': after calculating a list of all available rights
1755 &$rights: Array of rights, which may be added to.
1756
1757 'UserGetEmail': called when getting an user email address
1758 $user: User object
1759 &$email: email, change this to override local email
1760
1761 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1762 email authentification
1763 $user: User object
1764 &$timestamp: timestamp, change this to override local email authentification
1765 timestamp
1766
1767 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1768 &$groups: List of implicit (automatically-assigned) groups
1769
1770 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1771 &$reservedUsernames: $wgReservedUsernames
1772
1773 'UserGetRights': Called in User::getRights()
1774 $user: User to get rights for
1775 &$rights: Current rights
1776
1777 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1778 exemptions).
1779 $user: User in question
1780 $title: Title of the page in question
1781 &$blocked: Out-param, whether or not the user is blocked from that page.
1782 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1783 own user talk pages.
1784
1785 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1786 &$user: User object
1787 $ip: User's IP address
1788 &$blocked: Whether the user is blocked, to be modified by the hook
1789
1790 'UserLoadAfterLoadFromSession': called to authenticate users on
1791 external/environmental means; occurs after session is loaded
1792 $user: user object being loaded
1793
1794 'UserLoadDefaults': called when loading a default user
1795 $user: user object
1796 $name: user name
1797
1798 'UserLoadFromDatabase': called when loading a user from the database
1799 $user: user object
1800 &$s: database query object
1801
1802 'UserLoadFromSession': called to authenticate users on external/environmental
1803 means; occurs before session is loaded
1804 $user: user object being loaded
1805 &$result: set this to a boolean value to abort the normal authentification
1806 process
1807
1808 'UserLoadOptions': when user options/preferences are being loaded from
1809 the database.
1810 $user: User object
1811 &$options: Options, can be modified.
1812
1813 'UserLoginComplete': after a user has logged in
1814 $user: the user object that was created on login
1815 $inject_html: Any HTML to inject after the "logged in" message.
1816
1817 'UserLoginForm': change to manipulate the login form
1818 $template: SimpleTemplate instance for the form
1819
1820 'UserLoginMailPassword': Block users from emailing passwords
1821 $name: the username to email the password of.
1822 &$error: out-param - the error message to return.
1823
1824 'UserLogout': before a user logs out
1825 $user: the user object that is about to be logged out
1826
1827 'UserLogoutComplete': after a user has logged out
1828 $user: the user object _after_ logout (won't have name, ID, etc.)
1829 $inject_html: Any HTML to inject after the "logged out" message.
1830 $oldName: name of the user before logout (string)
1831
1832 'UserRights': After a user's group memberships are changed
1833 $user : User object that was changed
1834 $add : Array of strings corresponding to groups added
1835 $remove: Array of strings corresponding to groups removed
1836
1837 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1838 message(s)
1839 $user: user retrieving new talks messages
1840 $talks: array of new talks page(s)
1841
1842 'UserSaveSettings': called when saving user settings
1843 $user: User object
1844
1845 'UserSaveOptions': Called just before saving user preferences/options.
1846 $user: User object
1847 &$options: Options, modifiable
1848
1849 'UserSetCookies': called when setting user cookies
1850 $user: User object
1851 &$session: session array, will be added to $_SESSION
1852 &$cookies: cookies array mapping cookie name to its value
1853
1854 'UserSetEmail': called when changing user email address
1855 $user: User object
1856 &$email: new email, change this to override new email address
1857
1858 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1859 of email authentification
1860 $user: User object
1861 &$timestamp: new timestamp, change this to override local email
1862 authentification timestamp
1863
1864 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1865 alter the SQL query which gets the list of wanted pages
1866 &$wantedPages: WantedPagesPage object
1867 &$sql: raw SQL query used to get the list of wanted pages
1868
1869 'WatchArticle': before a watch is added to an article
1870 $user: user that will watch
1871 $article: article object to be watched
1872
1873 'WatchArticleComplete': after a watch is added to an article
1874 $user: user that watched
1875 $article: article object watched
1876
1877 'WatchlistEditorBuildRemoveLine': when building remove lines in
1878 Special:Watchlist/edit
1879 &$tools: array of extra links
1880 $title: Title object
1881 $redirect: whether the page is a redirect
1882 $skin: Skin object
1883
1884 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1885 dumps
1886 One, and only one hook should set this, and return false.
1887 &$tables: Database tables to use in the SELECT query
1888 &$opts: Options to use for the query
1889 &$join: Join conditions
1890
1891 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1892 query pages to be updated with maintenance/updateSpecialPages.php
1893 $query: $wgQueryPages itself
1894
1895 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1896 metadata to be added.
1897 $obj: The XmlDumpWriter object.
1898 &$out: The output string.
1899 $row: The database row for the page.
1900 $title: The title of the page.
1901
1902 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1903 metadata.
1904 $obj: The XmlDumpWriter object.
1905 &$out: The text being output.
1906 $row: The database row for the revision.
1907 $text: The revision text.
1908
1909 More hooks might be available but undocumented, you can execute
1910 ./maintenance/findhooks.php to find hidden one.