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