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