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