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