Apply ^demon's patch. Reason was: fixes mismatched <tbody> issue from when child...
[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 'AjaxAddScript': Called in output page just before the initialisation
267 of the javascript ajax engine. The hook is only called when ajax
268 is enabled ( $wgUseAjax = true; ).
269
270 'AlternateEdit': before checking if an user can edit a page and
271 before showing the edit form ( EditPage::edit() ). This is triggered
272 on &action=edit.
273 $EditPage: the EditPage object
274
275 'APIAfterExecute': after calling the execute() method of an API module.
276 Use this to extend core API modules.
277 &$module: Module object
278
279 'APIEditBeforeSave': before saving a page with api.php?action=edit,
280 after processing request parameters. Return false to let the request
281 fail, returning an error message or an <edit result="Failure"> tag
282 if $resultArr was filled.
283 $EditPage : the EditPage object
284 $text : the new text of the article (has yet to be saved)
285 $resultArr : data in this array will be added to the API result
286
287 'APIGetAllowedParams': use this hook to modify a module's parameters.
288 &$module: Module object
289 &$params: Array of parameters
290
291 'APIGetParamDescription': use this hook to modify a module's parameter
292 descriptions.
293 &$module: Module object
294 &$desc: Array of parameter descriptions
295
296 'APIQueryAfterExecute': after calling the execute() method of an
297 action=query submodule. Use this to extend core API modules.
298 &$module: Module object
299
300 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
301 method of an action=query submodule. Use this to extend core API modules.
302 &$module: Module object
303 &$resultPageSet: ApiPageSet object
304
305 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
306 Every token has an action, which will be used in the intoken parameter
307 and in the output (actiontoken="..."), and a callback function which
308 should return the token, or false if the user isn't allowed to obtain
309 it. The prototype of the callback function is func($pageid, $title)
310 where $pageid is the page ID of the page the token is requested for
311 and $title is the associated Title object. In the hook, just add
312 your callback to the $tokenFunctions array and return true (returning
313 false makes no sense)
314 $tokenFunctions: array(action => callback)
315
316 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
317 Every token has an action, which will be used in the rvtoken parameter
318 and in the output (actiontoken="..."), and a callback function which
319 should return the token, or false if the user isn't allowed to obtain
320 it. The prototype of the callback function is func($pageid, $title, $rev)
321 where $pageid is the page ID of the page associated to the revision the
322 token is requested for, $title the associated Title object and $rev the
323 associated Revision object. In the hook, just add your callback to the
324 $tokenFunctions array and return true (returning false makes no sense)
325 $tokenFunctions: array(action => callback)
326
327 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
328 list=recentchanges.
329 Every token has an action, which will be used in the rctoken parameter
330 and in the output (actiontoken="..."), and a callback function which
331 should return the token, or false if the user isn't allowed to obtain
332 it. The prototype of the callback function is func($pageid, $title, $rc)
333 where $pageid is the page ID of the page associated to the revision the
334 token is requested for, $title the associated Title object and $rc the
335 associated RecentChange object. In the hook, just add your callback to the
336 $tokenFunctions array and return true (returning false makes no sense)
337 $tokenFunctions: array(action => callback)
338
339 'APIQueryUsersTokens': use this hook to add custom token to list=users.
340 Every token has an action, which will be used in the ustoken parameter
341 and in the output (actiontoken="..."), and a callback function which
342 should return the token, or false if the user isn't allowed to obtain
343 it. The prototype of the callback function is func($user) where $user
344 is the User object. In the hook, just add your callback to the
345 $tokenFunctions array and return true (returning false makes no sense)
346 $tokenFunctions: array(action => callback)
347
348 'ArticleAfterFetchContent': after fetching content of an article from
349 the database
350 $article: the article (object) being loaded from the database
351 $content: the content (string) of the article
352
353 'ArticleDelete': before an article is deleted
354 $article: the article (object) being deleted
355 $user: the user (object) deleting the article
356 $reason: the reason (string) the article is being deleted
357 $error: if the deletion was prohibited, the (raw HTML) error message to display
358 (added in 1.13)
359
360 'ArticleDeleteComplete': after an article is deleted
361 $article: the article that was deleted
362 $user: the user that deleted the article
363 $reason: the reason the article was deleted
364 $id: id of the article that was deleted
365
366 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
367 was changed
368 $article: article (object) of the user talk page
369
370 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
371 article has been changed
372 $article: the article (object)
373 $editInfo: data holder that includes the parser output ($editInfo->output) for
374 that page after the change
375 $changed: bool for if the page was changed
376
377 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
378 recentchanges table, return false to not delete old entries
379 $article: article (object) being modified
380
381 'ArticleFromTitle': when creating an article object from a title object using
382 Wiki::articleFromTitle()
383 $title: title (object) used to create the article object
384 $article: article (object) that will be returned
385
386 'ArticleInsertComplete': After a new article is created
387 $article: Article created
388 $user: User creating the article
389 $text: New content
390 $summary: Edit summary/comment
391 $isMinor: Whether or not the edit was marked as minor
392 $isWatch: (No longer used)
393 $section: (No longer used)
394 $flags: Flags passed to Article::doEdit()
395 $revision: New Revision of the article
396
397 'ArticleMergeComplete': after merging to article using Special:Mergehistory
398 $targetTitle: target title (object)
399 $destTitle: destination title (object)
400
401 'ArticlePageDataAfter': after loading data of an article from the database
402 $article: article (object) whose data were loaded
403 $row: row (object) returned from the database server
404
405 'ArticlePageDataBefore': before loading data of an article from the database
406 $article: article (object) that data will be loaded
407 $fields: fileds (array) to load from the database
408
409 'ArticleProtect': before an article is protected
410 $article: the article being protected
411 $user: the user doing the protection
412 $protect: boolean whether this is a protect or an unprotect
413 $reason: Reason for protect
414 $moveonly: boolean whether this is for move only or not
415
416 'ArticleProtectComplete': after an article is protected
417 $article: the article that was protected
418 $user: the user who did the protection
419 $protect: boolean whether it was a protect or an unprotect
420 $reason: Reason for protect
421 $moveonly: boolean whether it was for move only or not
422
423 'ArticlePurge': before executing "&action=purge"
424 $article: article (object) to purge
425
426 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
427 revision of an article
428 &$title: title object of the article
429
430 'ArticleRevisionUndeleted': after an article revision is restored
431 $title: the article title
432 $revision: the revision
433 $oldPageID: the page ID of the revision when archived (may be null)
434
435 'ArticleRollbackComplete': after an article rollback is completed
436 $article: the article that was edited
437 $user: the user who did the rollback
438 $revision: the revision the page was reverted back to
439 $current: the reverted revision
440
441 'ArticleSave': before an article is saved
442 $article: the article (object) being saved
443 $user: the user (object) saving the article
444 $text: the new article text
445 $summary: the article summary (comment)
446 $isminor: minor flag
447 $iswatch: watch flag
448 $section: section #
449
450 'ArticleSaveComplete': After an article has been updated
451 $article: Article modified
452 $user: User performing the modification
453 $text: New content
454 $summary: Edit summary/comment
455 $isMinor: Whether or not the edit was marked as minor
456 $isWatch: (No longer used)
457 $section: (No longer used)
458 $flags: Flags passed to Article::doEdit()
459 $revision: New Revision of the article
460 $baseRevId: the rev ID (or false) this edit was based on
461
462 'ArticleUndelete': When one or more revisions of an article are restored
463 $title: Title corresponding to the article restored
464 $create: Whether or not the restoration caused the page to be created
465 (i.e. it didn't exist before)
466 $comment: The comment associated with the undeletion.
467
468 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
469 before the user is redirected back to the page
470 &$article: the article
471 &$sectionanchor: The section anchor link (e.g. "#overview" )
472 &$extraq: Extra query parameters which can be added via hooked functions
473
474 'ArticleViewHeader': Before the parser cache is about to be tried for article
475 viewing.
476 &$article: the article
477 &$pcache: whether to try the parser cache or not
478 &$outputDone: whether the output for this page finished or not
479
480 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
481 follwed an redirect
482 $article: target article (object)
483
484 'AuthPluginAutoCreate': Called when creating a local account for an user logged
485 in from an external authentication method
486 $user: User object created locally
487
488 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
489 Gives a chance for an extension to set it programattically to a variable class.
490 &$auth: the $wgAuth object, probably a stub
491
492 'AutopromoteCondition': check autopromote condition for user.
493 $type: condition type
494 $args: arguments
495 $user: user
496 $result: result of checking autopromote condition
497
498 'BadImage': When checking against the bad image list
499 $name: Image name being checked
500 &$bad: Whether or not the image is "bad"
501
502 Change $bad and return false to override. If an image is "bad", it is not
503 rendered inline in wiki pages or galleries in category pages.
504
505 'BeforeGalleryFindFile': before an image is fetched for a gallery
506 &$gallery,: the gallery object
507 &$nt: the image title
508 &$time: image timestamp
509
510 'BeforePageDisplay': Prior to outputting a page
511 &$out: OutputPage object
512 &$skin: Skin object
513
514 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
515 &$parser: Parser object
516 &$title: title of the template
517 &$skip: skip this template and link it?
518 &$id: the id of the revision being parsed
519
520 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
521 &$parser: Parser object
522 &$nt: the image title
523 &$skip: skip this image and link it?
524 &$time: the image timestamp
525
526 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
527 &$parser: Parser object
528 &$ig: ImageGallery object
529
530 'BlockIp': before an IP address or user is blocked
531 $block: the Block object about to be saved
532 $user: the user _doing_ the block (not the one being blocked)
533
534 'BlockIpComplete': after an IP address or user is blocked
535 $block: the Block object that was saved
536 $user: the user who did the block (not the one being blocked)
537
538 'BookInformation': Before information output on Special:Booksources
539 $isbn: ISBN to show information for
540 $output: OutputPage object in use
541
542 'CategoryPageView': before viewing a categorypage in CategoryPage::view
543 $catpage: CategoryPage instance
544
545 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
546 &$this: ChangesList instance.
547 &$articlelink: HTML of link to article (already filled-in).
548 &$s: HTML of row that is being constructed.
549 &$rc: RecentChange instance.
550 $unpatrolled: Whether or not we are showing unpatrolled changes.
551 $watched: Whether or not the change is watched by the user.
552
553 'ContribsPager::getQueryInfo': Before the contributions query is about to run
554 &$pager: Pager object for contributions
555 &queryInfo: The query for the contribs Pager
556
557 'ContributionsLineEnding': Called before a contributions HTML line is finished
558 $page: SpecialPage object for contributions
559 $ret: the HTML line
560 $row: the DB row for this line
561
562 'ContributionsToolLinks': Change tool links above Special:Contributions
563 $id: User identifier
564 $title: User page title
565 &$tools: Array of tool links
566
567 'CustomEditor': When invoking the page editor
568 $article: Article being edited
569 $user: User performing the edit
570
571 Return true to allow the normal editor to be used, or false
572 if implementing a custom editor, e.g. for a special namespace,
573 etc.
574
575 'DatabaseOraclePostInit': Called after initialising an Oracle database
576 &$db: the DatabaseOracle object
577
578 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
579 $title: the diff page title (nullable)
580 &$oldId: the actual old Id to use in the diff
581 &$newId: the actual new Id to use in the diff (0 means current)
582 $old: the ?old= param value from the url
583 $new: the ?new= param value from the url
584
585 'DiffViewHeader': called before diff display
586 $diff: DifferenceEngine object that's calling
587 $oldRev: Revision object of the "old" revision (may be null/invalid)
588 $newRev: Revision object of the "new" revision
589
590 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
591 an article
592 $article: article (object) being viewed
593 $oldid: oldid (int) being viewed
594
595 'DoEditSectionLink': Override the HTML generated for section edit links
596 $skin: Skin object rendering the UI
597 $title: Title object for the title being linked to (may not be the same as
598 $wgTitle, if the section is included from a template)
599 $section: The designation of the section being pointed to, to be included in
600 the link, like "&section=$section"
601 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
602 By default, this is wrapped in the 'editsectionhint' message.
603 $result: The HTML to return, prefilled with the default plus whatever other
604 changes earlier hooks have made
605
606 'EditFilter': Perform checks on an edit
607 $editor: Edit form (see includes/EditPage.php)
608 $text: Contents of the edit box
609 $section: Section being edited
610 &$error: Error message to return
611 $summary: Edit summary for page
612
613 'EditFilterMerged': Post-section-merge edit filter
614 $editor: EditPage instance (object)
615 $text: content of the edit box
616 $error: error message to return
617 $summary: Edit summary for page
618
619 'EditFormPreloadText': Allows population of the edit form when creating
620 new pages
621 &$text: Text to preload with
622 &$title: Title object representing the page being created
623
624 'EditPage::attemptSave': called before an article is
625 saved, that is before insertNewArticle() is called
626 &$editpage_Obj: the current EditPage object
627
628 'EditPage::importFormData': allow extensions to read additional data
629 posted in the form
630 $editpage: EditPage instance
631 $request: Webrequest
632 return value is ignored (should always return true)
633
634 'EditPage::showEditForm:fields': allows injection of form field into edit form
635 &$editor: the EditPage instance for reference
636 &$out: an OutputPage instance to write to
637 return value is ignored (should always return true)
638
639 'EditPage::showEditForm:initial': before showing the edit form
640 $editor: EditPage instance (object)
641
642 Return false to halt editing; you'll need to handle error messages, etc.
643 yourself. Alternatively, modifying $error and returning true will cause the
644 contents of $error to be echoed at the top of the edit form as wikitext.
645 Return true without altering $error to allow the edit to proceed.
646
647 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
648 when there's an edit conflict. Return false to halt normal diff output; in
649 this case you're responsible for computing and outputting the entire "conflict"
650 part, i.e., the "difference between revisions" and "your text" headers and
651 sections.
652 &$editor: EditPage instance
653 &$out: OutputPage instance
654
655 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
656 textarea in the edit form
657 &$editpage: The current EditPage object
658 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
659 &$tabindex: HTML tabindex of the last edit check/button
660
661 'EditPageBeforeEditChecks': allows modifying the edit checks below the
662 textarea in the edit form
663 &$editpage: The current EditPage object
664 &$checks: Array of edit checks like "watch this page"/"minor edit"
665 &$tabindex: HTML tabindex of the last edit check/button
666
667 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
668 textarea in the edit form
669 &$toolbar: The toolbar HTMl
670
671 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
672 $title: title of page being edited
673 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
674
675 'EditPageTosSummary': Give a chance for site and per-namespace customizations
676 of terms of service summary link that might exist separately from the copyright
677 notice.
678 $title: title of page being edited
679 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
680
681 'EditSectionLink': Do not use, use DoEditSectionLink instead.
682 $skin: Skin rendering the UI
683 $title: Title being linked to
684 $section: Section to link to
685 $link: Default link
686 $result: Result (alter this to override the generated links)
687
688 'EmailConfirmed': When checking that the user's email address is "confirmed"
689 $user: User being checked
690 $confirmed: Whether or not the email address is confirmed
691 This runs before the other checks, such as anonymity and the real check; return
692 true to allow those checks to occur, and false if checking is done.
693
694 'EmailUser': before sending email from one user to another
695 $to: address of receiving user
696 $from: address of sending user
697 $subject: subject of the mail
698 $text: text of the mail
699
700 'EmailUserComplete': after sending email from one user to another
701 $to: address of receiving user
702 $from: address of sending user
703 $subject: subject of the mail
704 $text: text of the mail
705
706 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
707 $user: The user who is trying to email another user.
708 $editToken: The user's edit token.
709 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
710
711 'FetchChangesList': When fetching the ChangesList derivative for
712 a particular user
713 &$user: User the list is being fetched for
714 &$skin: Skin object to be used with the list
715 &$list: List object (defaults to NULL, change it to an object
716 instance and return false override the list derivative used)
717
718 'FileDeleteComplete': When a file is deleted
719 $file: reference to the deleted file
720 $oldimage: in case of the deletion of an old image, the name of the old file
721 $article: in case all revisions of the file are deleted a reference to the
722 article associated with the file.
723 $user: user who performed the deletion
724 $reason: reason
725
726 'FileUpload': When a file upload occurs
727 $file : Image object representing the file that was uploaded
728
729 'FileUndeleteComplete': When a file is undeleted
730 $title: title object to the file
731 $fileVersions: array of undeleted versions. Empty if all versions were restored
732 $user: user who performed the undeletion
733 $reason: reason
734
735 'GetAutoPromoteGroups': When determining which autopromote groups a user
736 is entitled to be in.
737 &$user: user to promote.
738 &$promote: groups that will be added.
739
740 'GetBlockedStatus': after loading blocking status of an user from the database
741 $user: user (object) being checked
742
743 'GetCacheVaryCookies': get cookies that should vary cache options
744 $out: OutputPage object
745 &$cookies: array of cookies name, add a value to it if you want to add a cookie
746 that have to vary cache options
747
748 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
749 $title: Title object of page
750 $url: string value as output (out parameter, can modify)
751 $query: query options passed to Title::getFullURL()
752
753 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
754 $title: Title object of page
755 $url: string value as output (out parameter, can modify)
756 $query: query options passed to Title::getInternalURL()
757
758 'GetLinkColours': modify the CSS class of an array of page links
759 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
760 indexed by page_id.
761 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
762
763 'GetLocalURL': modify local URLs as output into page links
764 $title: Title object of page
765 $url: string value as output (out parameter, can modify)
766 $query: query options passed to Title::getLocalURL()
767
768 'GetPreferences': modify user preferences
769 $user: User whose preferences are being modified.
770 &$preferences: Preferences description array, to be fed to an HTMLForm object
771
772 'getUserPermissionsErrors': Add a permissions error when permissions errors are
773 checked for. Use instead of userCan for most cases. Return false if the
774 user can't do it, and populate $result with the reason in the form of
775 array( messagename, param1, param2, ... ). For consistency, error messages
776 should be plain text with no special coloring, bolding, etc. to show that
777 they're errors; presenting them properly to the user as errors is done by
778 the caller.
779 $title: Title object being checked against
780 $user : Current user object
781 $action: Action being checked
782 $result: User permissions error to add. If none, return true.
783
784 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
785 if expensive checks are enabled.
786
787 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
788 into the job queue.
789 $title: Title object, pages linked to this title are purged.
790
791 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
792 image insertion. You can skip the default logic entirely by returning
793 false, or just modify a few things using call-by-reference.
794 &$this: Skin object
795 &$title: Title object of the image
796 &$file: File object, or false if it doesn't exist
797 &$frameParams: Various parameters with special meanings; see documentation in
798 includes/Linker.php for Linker::makeImageLink2
799 &$handlerParams: Various parameters with special meanings; see documentation in
800 includes/Linker.php for Linker::makeImageLink2
801 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
802 &$res: Final HTML output, used if you return false
803
804
805 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
806 the image on an image page
807 $imagePage: ImagePage object ($this)
808 $output: $wgOut
809
810 'ImagePageFileHistoryLine': called when a file history line is contructed
811 $file: the file
812 $line: the HTML of the history line
813 $css: the line CSS class
814
815 'ImagePageFindFile': called when fetching the file associated with an image page
816 $page: ImagePage object
817 &$file: File object
818 &$displayFile: displayed File object
819
820 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
821 $title: Title object ($wgTitle)
822 $request: WebRequest
823 $ignoreRedirect: boolean to skip redirect check
824 $target: Title/string of redirect target
825 $article: Article object
826
827 'InternalParseBeforeLinks': during Parser's internalParse method before links
828 but after noinclude/includeonly/onlyinclude and other processing.
829 &$this: Parser object
830 &$text: string containing partially parsed text
831 &$this->mStripState: Parser's internal StripState object
832
833 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
834 $article: article (object) being checked
835
836 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
837 $ip: IP being check
838 $result: Change this value to override the result of wfIsTrustedProxy()
839
840 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
841 tance to return false if the domain name doesn't match your organization
842 $addr: The e-mail address entered by the user
843 &$result: Set this and return false to override the internal checks
844
845 'isValidPassword': Override the result of User::isValidPassword()
846 $password: The password entered by the user
847 &$result: Set this to either true (passes) or the key for a message error
848 $user: User the password is being validated for
849
850 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
851 $wgExtensionMessagesFiles instead.
852 Use this to define synonyms of magic words depending of the language
853 $magicExtensions: associative array of magic words synonyms
854 $lang: laguage code (string)
855
856 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
857 listed in $wgExtensionMessagesFiles instead.
858 Use to define aliases of special pages names depending of the language
859 $specialPageAliases: associative array of magic words synonyms
860 $lang: laguage code (string)
861
862 'LinkBegin': Used when generating internal and interwiki links in
863 Linker::link(), before processing starts. Return false to skip default proces-
864 sing and return $ret. See documentation for Linker::link() for details on the
865 expected meanings of parameters.
866 $skin: the Skin object
867 $target: the Title that the link is pointing to
868 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
869 fault"
870 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
871 tive array form, with keys and values unescaped. Should be merged with de-
872 fault values, with a value of false meaning to suppress the attribute.
873 &$query: the query string to add to the generated URL (the bit after the "?"),
874 in associative array form, with keys and values unescaped.
875 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
876 &$ret: the value to return if your hook returns false.
877
878 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
879 just before the function returns a value. If you return true, an <a> element
880 with HTML attributes $attribs and contents $text will be returned. If you re-
881 turn false, $ret will be returned.
882 $skin: the Skin object
883 $target: the Title object that the link is pointing to
884 $options: the options. Will always include either 'known' or 'broken', and may
885 include 'noclasses'.
886 &$text: the final (raw HTML) contents of the <a> tag, after processing.
887 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
888 ciative array form.
889 &$ret: the value to return if your hook returns false.
890
891 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
892 before the return
893 &$url: the image url
894 &$alt: the image's alt text
895 &$img: the new image HTML (if returning false)
896
897 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
898 before the return
899 &$url: the link url
900 &$text: the link text
901 &$link: the new link HTML (if returning false)
902 &$attribs: the attributes to be applied.
903 $linkType: The external link type
904
905 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
906 actual update
907 &$linksUpdate: the LinkUpdate object
908
909 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
910 completed
911 &$linksUpdate: the LinkUpdate object
912
913 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
914 &$linksUpdate: the LinkUpdate object
915
916 'ListDefinedTags': When trying to find all defined tags.
917 &$tags: The list of tags.
918
919 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
920 database schema
921
922 'LocalFile::getHistory': called before file history query performed
923 $file: the file
924 $tables: tables
925 $fields: select fields
926 $conds: conditions
927 $opts: query options
928 $join_conds: JOIN conditions
929
930 'LocalisationCacheRecache': Called when loading the localisation data into cache
931 $cache: The LocalisationCache object
932 $code: language code
933 &$alldata: The localisation data from core and extensions
934
935 'LoginAuthenticateAudit': a login attempt for a valid user account either
936 succeeded or failed. No return data is accepted; this hook is for auditing only.
937 $user: the User object being authenticated against
938 $password: the password being submitted and found wanting
939 $retval: a LoginForm class constant with authenticateUserData() return
940 value (SUCCESS, WRONG_PASS, etc)
941
942 'LogLine': Processes a single log entry on Special:Log
943 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
944 logging.log_type database field.
945 $log_action: string for the type of log action (e.g. 'delete', 'block',
946 'create2'). Corresponds to logging.log_action database field.
947 $title: Title object that corresponds to logging.log_namespace and
948 logging.log_title database fields.
949 $paramArray: Array of parameters that corresponds to logging.log_params field.
950 Note that only $paramArray[0] appears to contain anything.
951 &$comment: string that corresponds to logging.log_comment database field, and
952 which is displayed in the UI.
953 &$revert: string that is displayed in the UI, similar to $comment.
954 $time: timestamp of the log entry (added in 1.12)
955
956 'LogPageValidTypes': action being logged.
957 DEPRECATED: Use $wgLogTypes
958 &$type: array of strings
959
960 'LogPageLogName': name of the logging page(s).
961 DEPRECATED: Use $wgLogNames
962 &$typeText: array of strings
963
964 'LogPageLogHeader': strings used by wfMsg as a header.
965 DEPRECATED: Use $wgLogHeaders
966 &$headerText: array of strings
967
968 'LogPageActionText': strings used by wfMsg as a header.
969 DEPRECATED: Use $wgLogActions
970 &$actionText: array of strings
971
972 'MagicWordMagicWords': When defining new magic word.
973 DEPRECATED: Use LanguageGetMagic hook instead
974 $magicWords: array of strings
975
976 'MagicWordwgVariableIDs': When definig new magic words IDs.
977 $variableIDs: array of strings
978
979 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
980 is executed
981 &$vars: variable (or multiple variables) to be added into the output
982 of Skin::makeVariablesScript
983
984 'MarkPatrolled': before an edit is marked patrolled
985 $rcid: ID of the revision to be marked patrolled
986 $user: the user (object) marking the revision as patrolled
987 $wcOnlySysopsCanPatrol: config setting indicating whether the user
988 needs to be a sysop in order to mark an edit patrolled
989
990 'MarkPatrolledComplete': after an edit is marked patrolled
991 $rcid: ID of the revision marked as patrolled
992 $user: user (object) who marked the edit patrolled
993 $wcOnlySysopsCanPatrol: config setting indicating whether the user
994 must be a sysop to patrol the edit
995
996 'MathAfterTexvc': after texvc is executed when rendering mathematics
997 $mathRenderer: instance of MathRenderer
998 $errmsg: error message, in HTML (string). Nonempty indicates failure
999 of rendering the formula
1000
1001 'MediaWikiPerformAction': Override MediaWiki::performAction().
1002 Use this to do something completely different, after the basic
1003 globals have been set up, but before ordinary actions take place.
1004 $output: $wgOut
1005 $article: $wgArticle
1006 $title: $wgTitle
1007 $user: $wgUser
1008 $request: $wgRequest
1009 $this: The $mediawiki object
1010
1011 'MessagesPreLoad': When loading a message from the database
1012 $title: title of the message (string)
1013 $message: value (string), change it to the message you want to define
1014
1015 'MessageCacheReplace': When a message page is changed.
1016 Useful for updating caches.
1017 $title: name of the page changed.
1018 $text: new contents of the page.
1019
1020 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1021 been rendered (useful for adding more)
1022 Note: this is only run for the Monobook skin. To add items to the toolbox
1023 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1024 instead.
1025 $tools: array of tools
1026
1027 'NewRevisionFromEditComplete': called when a revision was inserted
1028 due to an edit
1029 $article: the article edited
1030 $rev: the new revision
1031 $baseID: the revision ID this was based off, if any
1032 $user: the editing user
1033
1034 'NormalizeMessageKey': Called before the software gets the text of a message
1035 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1036 displayed
1037 &$key: the message being looked up. Change this to something else to change
1038 what message gets displayed (string)
1039 &$useDB: whether or not to look up the message in the database (bool)
1040 &$langCode: the language code to get the message for (string) - or -
1041 whether to use the content language (true) or site language (false) (bool)
1042 &$transform: whether or not to expand variables and templates
1043 in the message (bool)
1044
1045 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1046 &$changeslist: The OldChangesList instance.
1047 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1048 &$rc: The RecentChange object.
1049
1050 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1051 Hooks can alter or append to the array of URLs for search & suggestion formats.
1052 &$urls: array of associative arrays with Url element attributes
1053
1054 'OutputPageBeforeHTML': a page has been processed by the parser and
1055 the resulting HTML is about to be displayed.
1056 $parserOutput: the parserOutput (object) that corresponds to the page
1057 $text: the text that will be displayed, in HTML (string)
1058
1059 'OutputPageCheckLastModified': when checking if the page has been modified
1060 since the last visit
1061 &$modifiedTimes: array of timestamps.
1062 The following keys are set: page, user, epoch
1063
1064 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1065 $out: OutputPage instance (object)
1066 $parserOutput: parserOutput instance being added in $out
1067
1068 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1069 categories. Implementations should return false if they generate the category
1070 links, so the default link generation is skipped.
1071 $out: OutputPage instance (object)
1072 $categories: associative array, keys are category names, values are category
1073 types ("normal" or "hidden")
1074 $links: array, intended to hold the result. Must be an associative array with
1075 category types as keys and arrays of HTML links as values.
1076
1077 'PageHistoryBeforeList': When a history page list is about to be constructed.
1078 $article: the article that the history is loading for
1079
1080 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1081 $row: the revision row for this line
1082 $s: the string representing this parsed line
1083
1084 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1085 is constructed
1086 $pager: the pager
1087 $queryInfo: the query parameters
1088
1089 'PageRenderingHash': alter the parser cache option hash key
1090 A parser extension which depends on user options should install
1091 this hook and append its values to the key.
1092 $hash: reference to a hash key string which can be modified
1093
1094 'ParserAfterStrip': Same as ParserBeforeStrip
1095
1096 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1097 $parser: Parser object being used
1098 $text: text that'll be returned
1099
1100 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1101 $parser: Parser object
1102 $text: text to parse
1103 $stripState: StripState instance being used
1104
1105 'ParserBeforeStrip': Called at start of parsing time
1106 (no more strip, deprecated ?)
1107 $parser: parser object
1108 $text: text being parsed
1109 $stripState: stripState used (object)
1110
1111 'ParserBeforeTidy': called before tidy and custom tags replacements
1112 $parser: Parser object being used
1113 $text: actual text
1114
1115 'ParserClearState': called at the end of Parser::clearState()
1116 $parser: Parser object being cleared
1117
1118 'ParserFirstCallInit': called when the parser initialises for the first time
1119 &$parser: Parser object being cleared
1120
1121 'ParserGetVariableValueSwitch': called when the parser need the value of a
1122 custom magic word
1123 $parser: Parser object
1124 $varCache: array to store the value in case of multiples calls of the
1125 same magic word
1126 $index: index (string) of the magic
1127 $ret: value of the magic word (the hook should set it)
1128
1129 'ParserGetVariableValueTs': use this to change the value of the time for the
1130 {{LOCAL...}} magic word
1131 $parser: Parser object
1132 $time: actual time (timestamp)
1133
1134 'ParserGetVariableValueVarCache': use this to change the value of the
1135 variable cache or return false to not use it
1136 $parser: Parser object
1137 $varCache: varaiable cache (array)
1138
1139 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1140 include comments about size of the text parsed
1141 $parser: Parser object
1142 $limitReport: text that will be included (without comment tags)
1143
1144 'ParserMakeImageParams': Called before the parser make an image link, use this
1145 to modify the parameters of the image.
1146 $title: title object representing the file
1147 $file: file object that will be used to create the image
1148 &$params: 2-D array of parameters
1149
1150 'ParserTestParser': called when creating a new instance of Parser in
1151 maintenance/parserTests.inc
1152 $parser: Parser object created
1153
1154 'ParserTestTables': alter the list of tables to duplicate when parser tests
1155 are run. Use when page save hooks require the presence of custom tables
1156 to ensure that tests continue to run properly.
1157 &$tables: array of table names
1158
1159 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1160 my talk page, my contributions" etc).
1161
1162 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1163 &$title: Title object representing the current page
1164
1165 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1166 &$user : User performing the action
1167 $action : Action being performed
1168 &$result : Whether or not the action should be prevented
1169 Change $result and return false to give a definitive answer, otherwise
1170 the built-in rate limiting checks are used, if enabled.
1171
1172 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1173 AJAX search suggestions. Put results into &$results outparam and return false.
1174 $ns : array of int namespace keys to search in
1175 $search : search term (not guaranteed to be conveniently normalized)
1176 $limit : maximum number of results to return
1177 &$results : out param: array of page names (strings)
1178
1179 'PrefsEmailAudit': called when user changes his email address
1180 $user: User (object) changing his email address
1181 $oldaddr: old email address (string)
1182 $newaddr: new email address (string)
1183
1184 'PrefsPasswordAudit': called when user changes his password
1185 $user: User (object) changing his passoword
1186 $newPass: new password
1187 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1188
1189 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1190 &$obj: RawPage object
1191 &$text: The text that's going to be the output
1192
1193 'RecentChange_save': called at the end of RecenChange::save()
1194 $recentChange: RecentChange object
1195
1196 'RevisionInsertComplete': called after a revision is inserted into the DB
1197 &$revision: the Revision
1198 $data: the data stored in old_text. The meaning depends on $flags: if external
1199 is set, it's the URL of the revision text in external storage; otherwise,
1200 it's the revision text itself. In either case, if gzip is set, the revision
1201 text is gzipped.
1202 $flags: a comma-delimited list of strings representing the options used. May
1203 include: utf8 (this will always be set for new revisions); gzip; external.
1204
1205 'SearchUpdate': Prior to search update completion
1206 $id : Page id
1207 $namespace : Page namespace
1208 $title : Page title
1209 $text : Current text being indexed
1210
1211 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1212 $term : Search term string
1213 &$title : Outparam; set to $title object and return false for a match
1214
1215 'SetupAfterCache': Called in Setup.php, after cache objects are set
1216
1217 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1218 $text: Text being shown
1219 $title: Title of the custom script/stylesheet page
1220 $output: Current OutputPage object
1221
1222 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1223 &$siteNotice: HTML returned as the sitenotice
1224 Return true to allow the normal method of notice selection/rendering to work,
1225 or change the value of $siteNotice and return false to alter it.
1226
1227 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1228 &$siteNotice: HTML sitenotice
1229 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1230
1231 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1232 $skin: Skin object
1233 &$text: bottomScripts Text
1234 Append to $text to add additional text/scripts after the stock bottom scripts.
1235
1236 'SkinAfterContent': Allows extensions to add text after the page content and
1237 article metadata.
1238 &$data: (string) Text to be printed out directly (without parsing)
1239 This hook should work in all skins. Just set the &$data variable to the text
1240 you're going to add.
1241
1242 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1243 $skin: Skin object
1244 &$bar: Sidebar contents
1245 Modify $bar to add or modify sidebar portlets.
1246
1247 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1248 $title: displayed page title
1249 $type: 'normal' or 'history' for old/diff views
1250 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1251 &$link: overridable HTML link to be passed into the message as $1
1252
1253 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1254 $skin: Skin object
1255 &$subpages: Subpage links HTML
1256 If false is returned $subpages will be used instead of the HTML
1257 subPageSubtitle() generates.
1258 If true is returned, $subpages will be ignored and the rest of
1259 subPageSubtitle() will run.
1260
1261 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1262 when showing a special page
1263 $sktemplate: SkinTemplate object
1264 $content_actions: array of tabs
1265
1266 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1267 "permanent link" tab
1268 $sktemplate: SkinTemplate object
1269 $nav_urls: array of tabs
1270
1271 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1272 &$content_actions: Content actions
1273 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1274 for an example]
1275
1276 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1277 &$sktemplate: SkinTemplate object
1278 &$links: Structured navigation links
1279 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1280
1281 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1282 starts page output
1283 &$sktemplate: SkinTemplate object
1284 &$tpl: Template engine object
1285
1286 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1287 $sktemplate: SkinTemplate object
1288 $res: set to true to prevent active tabs
1289
1290 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1291 $out: Css to return
1292
1293 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1294 You can either create your own array, or alter the parameters for
1295 the normal one.
1296 &$this: The SkinTemplate instance.
1297 $title: Title instance for the page.
1298 $message: Visible label of tab.
1299 $selected: Whether this is a selected tab.
1300 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1301 &$classes: Array of CSS classes to apply.
1302 &$query: Query string to add to link.
1303 &$text: Link text.
1304 &$result: Complete assoc. array if you want to return true.
1305
1306 'SkinTemplateTabs': called when finished to build the actions tabs
1307 $sktemplate: SkinTemplate object
1308 $content_actions: array of tabs
1309
1310 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1311 been rendered (useful for adding more)
1312 $tools: array of tools
1313
1314 'SoftwareInfo': Called by Special:Version for returning information about
1315 the software
1316 $software: The array of software in format 'name' => 'version'.
1317 See SpecialVersion::softwareInformation()
1318
1319 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1320 $id: User identifier
1321
1322 'SpecialListusersDefaultQuery': called right before the end of
1323 UsersPager::getDefaultQuery()
1324 $pager: The UsersPager instance
1325 $query: The query array to be returned
1326
1327 'SpecialListusersFormatRow': called right before the end of
1328 UsersPager::formatRow()
1329 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1330 $row: Database row object
1331
1332 'SpecialListusersHeader': called before closing the <fieldset> in
1333 UsersPager::getPageHeader()
1334 $pager: The UsersPager instance
1335 $out: The header HTML
1336
1337 'SpecialListusersHeaderForm': called before adding the submit button in
1338 UsersPager::getPageHeader()
1339 $pager: The UsersPager instance
1340 $out: The header HTML
1341
1342 'SpecialListusersQueryInfo': called right before the end of
1343 UsersPager::getQueryInfo()
1344 $pager: The UsersPager instance
1345 $query: The query array to be returned
1346
1347 'SpecialMovepageAfterMove': called after moving a page
1348 $movePage: MovePageForm object
1349 $oldTitle: old title (object)
1350 $newTitle: new title (object)
1351
1352 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1353 hook to remove a core special page
1354 $list: list (array) of core special pages
1355
1356 'SpecialRecentChangesPanel': called when building form options in
1357 SpecialRecentChanges
1358 &$extraOpts: array of added items, to which can be added
1359 $opts: FormOptions for this request
1360
1361 'SpecialRecentChangesQuery': called when building sql query for
1362 SpecialRecentChanges
1363 &$conds: array of WHERE conditionals for query
1364 &$tables: array of tables to be queried
1365 &$join_conds: join conditions for the tables
1366 $opts: FormOptions for this request
1367
1368 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1369 target doesn't exist
1370 $title: title object generated from the text entred by the user
1371
1372 'SpecialSearchResults': called before search result display when there
1373 are matches
1374 $term: string of search term
1375 &$titleMatches: empty or SearchResultSet object
1376 &$textMatches: empty or SearchResultSet object
1377
1378 'SpecialSearchNoResults': called before search result display when there are
1379 no matches
1380 $term: string of search term
1381
1382 'SpecialUploadComplete': Called after successfully uploading a file from
1383 Special:Upload
1384 $form: The UploadForm object
1385
1386 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1387 use this to change the tables headers
1388 $extTypes: associative array of extensions types
1389
1390 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1391 &$conds: array of WHERE conditionals for query
1392 &$tables: array of tables to be queried
1393 &$join_conds: join conditions for the tables
1394 &$fields: array of query fields
1395
1396 'TitleArrayFromResult': called when creating an TitleArray object from a
1397 database result
1398 &$titleArray: set this to an object to override the default object returned
1399 $res: database result used to create the object
1400
1401 'TitleMoveComplete': after moving an article (title)
1402 $old: old title
1403 $nt: new title
1404 $user: user who did the move
1405 $pageid: database ID of the page that's been moved
1406 $redirid: database ID of the created redirect
1407
1408 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1409 $title: title object related to the revision
1410 $rev: revision (object) that will be viewed
1411
1412 'UnknownAction': An unknown "action" has occured (useful for defining
1413 your own actions)
1414 $action: action name
1415 $article: article "acted on"
1416
1417 'UnwatchArticle': before a watch is removed from an article
1418 $user: user watching
1419 $article: article object to be removed
1420
1421 'UnwatchArticle': after a watch is removed from an article
1422 $user: user that was watching
1423 $article: article object removed
1424
1425 'UnwatchArticleComplete': after a watch is removed from an article
1426 $user: user that watched
1427 $article: article object that was watched
1428
1429 'UploadForm:initial': before the upload form is generated
1430 $form: UploadForm object
1431 You might set the member-variables $uploadFormTextTop and
1432 $uploadFormTextAfterSummary to inject text (HTML) either before
1433 or after the editform.
1434
1435 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1436 $form: UploadForm object
1437 Lets you poke at member variables like $mUploadDescription before the
1438 file is saved.
1439
1440 'UploadVerification': additional chances to reject an uploaded file
1441 string $saveName: destination file name
1442 string $tempName: filesystem path to the temporary file for checks
1443 string &$error: output: HTML error to show if upload canceled by returning false
1444
1445 'UploadComplete': Upon completion of a file upload
1446 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1447 $uploadBase->getLocalFile().
1448
1449 'User::mailPasswordInternal': before creation and mailing of a user's new
1450 temporary password
1451 $user: the user who sent the message out
1452 $ip: IP of the user who sent the message out
1453 $u: the account whose new password will be set
1454
1455 'UserArrayFromResult': called when creating an UserArray object from a
1456 database result
1457 &$userArray: set this to an object to override the default object returned
1458 $res: database result used to create the object
1459
1460 'userCan': To interrupt/advise the "user can do X to Y article" check.
1461 If you want to display an error message, try getUserPermissionsErrors.
1462 $title: Title object being checked against
1463 $user : Current user object
1464 $action: Action being checked
1465 $result: Pointer to result returned if hook returns false. If null is returned,
1466 userCan checks are continued by internal code.
1467
1468 'UserCanSendEmail': To override User::canSendEmail() permission check
1469 $user: User (object) whose permission is being checked
1470 &$canSend: bool set on input, can override on output
1471
1472 'UserClearNewTalkNotification': called when clearing the
1473 "You have new messages!" message, return false to not delete it
1474 $user: User (object) that'll clear the message
1475
1476 'UserComparePasswords': called when checking passwords, return false to
1477 override the default password checks
1478 &$hash: String of the password hash (from the database)
1479 &$password: String of the plaintext password the user entered
1480 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1481 supplied
1482 &$result: If the hook returns false, this Boolean value will be checked to
1483 determine if the password was valid
1484
1485 'UserCreateForm': change to manipulate the login form
1486 $template: SimpleTemplate instance for the form
1487
1488 'UserCryptPassword': called when hashing a password, return false to implement
1489 your own hashing method
1490 &$password: String of the plaintext password to encrypt
1491 &$salt: String of the password salt or Boolean false if no salt is provided
1492 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1493 hashing method
1494 &$hash: If the hook returns false, this String will be used as the hash
1495
1496 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1497 $user: User to get groups for
1498 &$groups: Current effective groups
1499
1500 'UserGetAllRights': after calculating a list of all available rights
1501 &$rights: Array of rights, which may be added to.
1502
1503 'UserGetEmail': called when getting an user email address
1504 $user: User object
1505 &$email: email, change this to override local email
1506
1507 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1508 email authentification
1509 $user: User object
1510 &$timestamp: timestamp, change this to override local email authentification
1511 timestamp
1512
1513 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1514 &$groups: List of implicit (automatically-assigned) groups
1515
1516 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1517 &$reservedUsernames: $wgReservedUsernames
1518
1519 'UserGetRights': Called in User::getRights()
1520 $user: User to get rights for
1521 &$rights: Current rights
1522
1523 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1524 &$user: User object
1525 $ip: User's IP address
1526 &$blocked: Whether the user is blocked, to be modified by the hook
1527
1528 'UserLoadAfterLoadFromSession': called to authenticate users on
1529 external/environmental means; occurs after session is loaded
1530 $user: user object being loaded
1531
1532 'UserLoadDefaults': called when loading a default user
1533 $user: user object
1534 $name: user name
1535
1536 'UserLoadFromDatabase': called when loading a user from the database
1537 $user: user object
1538 &$s: database query object
1539
1540 'UserLoadFromSession': called to authenticate users on external/environmental
1541 means; occurs before session is loaded
1542 $user: user object being loaded
1543 &$result: set this to a boolean value to abort the normal authentification
1544 process
1545
1546 'UserLoadOptions': when user options/preferences are being loaded from
1547 the database.
1548 $user: User object
1549 &$options: Options, can be modified.
1550
1551 'UserLoginComplete': after a user has logged in
1552 $user: the user object that was created on login
1553 $inject_html: Any HTML to inject after the "logged in" message.
1554
1555 'UserLoginForm': change to manipulate the login form
1556 $template: SimpleTemplate instance for the form
1557
1558 'UserLoginMailPassword': Block users from emailing passwords
1559 $name: the username to email the password of.
1560 &$error: out-param - the error message to return.
1561
1562 'UserLogout': before a user logs out
1563 $user: the user object that is about to be logged out
1564
1565 'UserLogoutComplete': after a user has logged out
1566 $user: the user object _after_ logout (won't have name, ID, etc.)
1567 $inject_html: Any HTML to inject after the "logged out" message.
1568 $oldName: name of the user before logout (string)
1569
1570 'UserRights': After a user's group memberships are changed
1571 $user : User object that was changed
1572 $add : Array of strings corresponding to groups added
1573 $remove: Array of strings corresponding to groups removed
1574
1575 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1576 message(s)
1577 $user: user retrieving new talks messages
1578 $talks: array of new talks page(s)
1579
1580 'UserSaveSettings': called when saving user settings
1581 $user: User object
1582
1583 'UserSaveOptions': Called just before saving user preferences/options.
1584 $user: User object
1585 &$options: Options, modifiable
1586
1587 'UserSetCookies': called when setting user cookies
1588 $user: User object
1589 &$session: session array, will be added to $_SESSION
1590 &$cookies: cookies array mapping cookie name to its value
1591
1592 'UserSetEmail': called when changing user email address
1593 $user: User object
1594 &$email: new email, change this to override new email address
1595
1596 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1597 of email authentification
1598 $user: User object
1599 &$timestamp: new timestamp, change this to override local email
1600 authentification timestamp
1601
1602 'UserToggles': called when initialising User::$mToggles, use this to add
1603 new toggles
1604 $toggles: array of toggles to add
1605
1606 'VectorTemplateToolboxEnd': Called by Vector skin after toolbox links have
1607 been rendered (useful for adding more)
1608 Note: this is only run for the Vector skin. To add items to the toolbox
1609 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1610 instead.
1611 $tools: array of tools
1612
1613 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1614 alter the SQL query which gets the list of wanted pages
1615 &$wantedPages: WantedPagesPage object
1616 &$sql: raw SQL query used to get the list of wanted pages
1617
1618 'WatchArticle': before a watch is added to an article
1619 $user: user that will watch
1620 $article: article object to be watched
1621
1622 'WatchArticleComplete': after a watch is added to an article
1623 $user: user that watched
1624 $article: article object watched
1625
1626 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1627 dumps
1628 One, and only one hook should set this, and return false.
1629 &$tables: Database tables to use in the SELECT query
1630 &$opts: Options to use for the query
1631 &$join: Join conditions
1632
1633 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1634 query pages to be updated with maintenance/updateSpecialPages.php
1635 $query: $wgQueryPages itself
1636
1637 More hooks might be available but undocumented, you can execute
1638 ./maintenance/findhooks.php to find hidden one.