document CacheHeadersAfterSet hook
[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 'AbortNewAccountAuto': Return false to cancel account creation when the
263 request is coming from an AuthPlugin or ExtUser, rather than a
264 manually-submitted CreateAccount form.
265 $user: the User object about to be created (read-only, incomplete)
266 $message: out parameter: error message to display on abort
267
268 'AddNewAccount': after a user account is created
269 $user: the User object that was created. (Parameter added in 1.7)
270 $byEmail: true when account was created "by email" (added in 1.12)
271
272 'AjaxAddScript': Called in output page just before the initialisation
273 of the javascript ajax engine. The hook is only called when ajax
274 is enabled ( $wgUseAjax = true; ).
275
276 'AlternateEdit': before checking if an user can edit a page and
277 before showing the edit form ( EditPage::edit() ). This is triggered
278 on &action=edit.
279 $EditPage: the EditPage object
280
281 'APIAfterExecute': after calling the execute() method of an API module.
282 Use this to extend core API modules.
283 &$module: Module object
284
285 'APIEditBeforeSave': before saving a page with api.php?action=edit,
286 after processing request parameters. Return false to let the request
287 fail, returning an error message or an <edit result="Failure"> tag
288 if $resultArr was filled.
289 $EditPage : the EditPage object
290 $text : the new text of the article (has yet to be saved)
291 &$resultArr : data in this array will be added to the API result
292
293 'APIGetAllowedParams': use this hook to modify a module's parameters.
294 &$module: Module object
295 &$params: Array of parameters
296
297 'APIGetParamDescription': use this hook to modify a module's parameter
298 descriptions.
299 &$module: Module object
300 &$desc: Array of parameter descriptions
301
302 'APIQueryAfterExecute': after calling the execute() method of an
303 action=query submodule. Use this to extend core API modules.
304 &$module: Module object
305
306 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
307 method of an action=query submodule. Use this to extend core API modules.
308 &$module: Module object
309 &$resultPageSet: ApiPageSet object
310
311 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
312 Every token has an action, which will be used in the intoken parameter
313 and in the output (actiontoken="..."), and a callback function which
314 should return the token, or false if the user isn't allowed to obtain
315 it. The prototype of the callback function is func($pageid, $title)
316 where $pageid is the page ID of the page the token is requested for
317 and $title is the associated Title object. In the hook, just add
318 your callback to the $tokenFunctions array and return true (returning
319 false makes no sense)
320 $tokenFunctions: array(action => callback)
321
322 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
323 Every token has an action, which will be used in the rvtoken parameter
324 and in the output (actiontoken="..."), and a callback function which
325 should return the token, or false if the user isn't allowed to obtain
326 it. The prototype of the callback function is func($pageid, $title, $rev)
327 where $pageid is the page ID of the page associated to the revision the
328 token is requested for, $title the associated Title object and $rev the
329 associated Revision object. In the hook, just add your callback to the
330 $tokenFunctions array and return true (returning false makes no sense)
331 $tokenFunctions: array(action => callback)
332
333 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
334 list=recentchanges.
335 Every token has an action, which will be used in the rctoken parameter
336 and in the output (actiontoken="..."), and a callback function which
337 should return the token, or false if the user isn't allowed to obtain
338 it. The prototype of the callback function is func($pageid, $title, $rc)
339 where $pageid is the page ID of the page associated to the revision the
340 token is requested for, $title the associated Title object and $rc the
341 associated RecentChange object. In the hook, just add your callback to the
342 $tokenFunctions array and return true (returning false makes no sense)
343 $tokenFunctions: array(action => callback)
344
345 'APIQueryUsersTokens': use this hook to add custom token to list=users.
346 Every token has an action, which will be used in the ustoken parameter
347 and in the output (actiontoken="..."), and a callback function which
348 should return the token, or false if the user isn't allowed to obtain
349 it. The prototype of the callback function is func($user) where $user
350 is the User object. In the hook, just add your callback to the
351 $tokenFunctions array and return true (returning false makes no sense)
352 $tokenFunctions: array(action => callback)
353
354 'ArticleAfterFetchContent': after fetching content of an article from
355 the database
356 $article: the article (object) being loaded from the database
357 $content: the content (string) of the article
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 'ImagePageFileHistoryLine': called when a file history line is contructed
838 $file: the file
839 $line: the HTML of the history line
840 $css: the line CSS class
841
842 'ImagePageFindFile': called when fetching the file associated with an image page
843 $page: ImagePage object
844 &$file: File object
845 &$displayFile: displayed File object
846
847 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
848 $title: Title object ($wgTitle)
849 $request: WebRequest
850 $ignoreRedirect: boolean to skip redirect check
851 $target: Title/string of redirect target
852 $article: Article object
853
854 'InternalParseBeforeLinks': during Parser's internalParse method before links
855 but after noinclude/includeonly/onlyinclude and other processing.
856 &$this: Parser object
857 &$text: string containing partially parsed text
858 &$this->mStripState: Parser's internal StripState object
859
860 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
861 $user: user (object) whose email is being invalidated
862
863 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
864 $article: article (object) being checked
865
866 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
867 $ip: IP being check
868 $result: Change this value to override the result of wfIsTrustedProxy()
869
870 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
871 tance to return false if the domain name doesn't match your organization
872 $addr: The e-mail address entered by the user
873 &$result: Set this and return false to override the internal checks
874
875 'isValidPassword': Override the result of User::isValidPassword()
876 $password: The password entered by the user
877 &$result: Set this and return false to override the internal checks
878 $user: User the password is being validated for
879
880 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
881 $wgExtensionMessagesFiles instead.
882 Use this to define synonyms of magic words depending of the language
883 $magicExtensions: associative array of magic words synonyms
884 $lang: laguage code (string)
885
886 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
887 listed in $wgExtensionMessagesFiles instead.
888 Use to define aliases of special pages names depending of the language
889 $specialPageAliases: associative array of magic words synonyms
890 $lang: laguage code (string)
891
892 'LinkBegin': Used when generating internal and interwiki links in
893 Linker::link(), before processing starts. Return false to skip default proces-
894 sing and return $ret. See documentation for Linker::link() for details on the
895 expected meanings of parameters.
896 $skin: the Skin object
897 $target: the Title that the link is pointing to
898 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
899 fault"
900 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
901 tive array form, with keys and values unescaped. Should be merged with de-
902 fault values, with a value of false meaning to suppress the attribute.
903 &$query: the query string to add to the generated URL (the bit after the "?"),
904 in associative array form, with keys and values unescaped.
905 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
906 &$ret: the value to return if your hook returns false.
907
908 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
909 just before the function returns a value. If you return true, an <a> element
910 with HTML attributes $attribs and contents $text will be returned. If you re-
911 turn false, $ret will be returned.
912 $skin: the Skin object
913 $target: the Title object that the link is pointing to
914 $options: the options. Will always include either 'known' or 'broken', and may
915 include 'noclasses'.
916 &$text: the final (raw HTML) contents of the <a> tag, after processing.
917 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
918 ciative array form.
919 &$ret: the value to return if your hook returns false.
920
921 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
922 before the return
923 &$url: the image url
924 &$alt: the image's alt text
925 &$img: the new image HTML (if returning false)
926
927 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
928 before the return
929 &$url: the link url
930 &$text: the link text
931 &$link: the new link HTML (if returning false)
932 &$attribs: the attributes to be applied.
933 $linkType: The external link type
934
935 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
936 actual update
937 &$linksUpdate: the LinkUpdate object
938
939 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
940 completed
941 &$linksUpdate: the LinkUpdate object
942
943 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
944 &$linksUpdate: the LinkUpdate object
945
946 'ListDefinedTags': When trying to find all defined tags.
947 &$tags: The list of tags.
948
949 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
950 database schema
951
952 'LocalFile::getHistory': called before file history query performed
953 $file: the file
954 $tables: tables
955 $fields: select fields
956 $conds: conditions
957 $opts: query options
958 $join_conds: JOIN conditions
959
960 'LocalisationCacheRecache': Called when loading the localisation data into cache
961 $cache: The LocalisationCache object
962 $code: language code
963 &$alldata: The localisation data from core and extensions
964
965 'LoginAuthenticateAudit': a login attempt for a valid user account either
966 succeeded or failed. No return data is accepted; this hook is for auditing only.
967 $user: the User object being authenticated against
968 $password: the password being submitted and found wanting
969 $retval: a LoginForm class constant with authenticateUserData() return
970 value (SUCCESS, WRONG_PASS, etc)
971
972 'LogLine': Processes a single log entry on Special:Log
973 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
974 logging.log_type database field.
975 $log_action: string for the type of log action (e.g. 'delete', 'block',
976 'create2'). Corresponds to logging.log_action database field.
977 $title: Title object that corresponds to logging.log_namespace and
978 logging.log_title database fields.
979 $paramArray: Array of parameters that corresponds to logging.log_params field.
980 Note that only $paramArray[0] appears to contain anything.
981 &$comment: string that corresponds to logging.log_comment database field, and
982 which is displayed in the UI.
983 &$revert: string that is displayed in the UI, similar to $comment.
984 $time: timestamp of the log entry (added in 1.12)
985
986 'LogPageValidTypes': action being logged.
987 DEPRECATED: Use $wgLogTypes
988 &$type: array of strings
989
990 'LogPageLogName': name of the logging page(s).
991 DEPRECATED: Use $wgLogNames
992 &$typeText: array of strings
993
994 'LogPageLogHeader': strings used by wfMsg as a header.
995 DEPRECATED: Use $wgLogHeaders
996 &$headerText: array of strings
997
998 'LogPageActionText': strings used by wfMsg as a header.
999 DEPRECATED: Use $wgLogActions
1000 &$actionText: array of strings
1001
1002 'MagicWordMagicWords': When defining new magic word.
1003 DEPRECATED: use $magicWords in a file listed in
1004 $wgExtensionMessagesFiles instead.
1005 $magicWords: array of strings
1006
1007 'MagicWordwgVariableIDs': When definig new magic words IDs.
1008 $variableIDs: array of strings
1009
1010 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1011 is executed
1012 &$vars: variable (or multiple variables) to be added into the output
1013 of Skin::makeVariablesScript
1014
1015 'MarkPatrolled': before an edit is marked patrolled
1016 $rcid: ID of the revision to be marked patrolled
1017 $user: the user (object) marking the revision as patrolled
1018 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1019 needs to be a sysop in order to mark an edit patrolled
1020
1021 'MarkPatrolledComplete': after an edit is marked patrolled
1022 $rcid: ID of the revision marked as patrolled
1023 $user: user (object) who marked the edit patrolled
1024 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1025 must be a sysop to patrol the edit
1026
1027 'MathAfterTexvc': after texvc is executed when rendering mathematics
1028 $mathRenderer: instance of MathRenderer
1029 $errmsg: error message, in HTML (string). Nonempty indicates failure
1030 of rendering the formula
1031
1032 'MediaWikiPerformAction': Override MediaWiki::performAction().
1033 Use this to do something completely different, after the basic
1034 globals have been set up, but before ordinary actions take place.
1035 $output: $wgOut
1036 $article: $wgArticle
1037 $title: $wgTitle
1038 $user: $wgUser
1039 $request: $wgRequest
1040 $this: The $mediawiki object
1041
1042 'MessagesPreLoad': When loading a message from the database
1043 $title: title of the message (string)
1044 $message: value (string), change it to the message you want to define
1045
1046 'MessageCacheReplace': When a message page is changed.
1047 Useful for updating caches.
1048 $title: name of the page changed.
1049 $text: new contents of the page.
1050
1051 'ModifyExportQuery': Modify the query used by the exporter.
1052 $db: The database object to be queried.
1053 &$tables: Tables in the query.
1054 &$conds: Conditions in the query.
1055 &$opts: Options for the query.
1056 &$join_conds: Join conditions for the query.
1057
1058 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1059 been rendered (useful for adding more)
1060 Note: this is only run for the Monobook skin. To add items to the toolbox
1061 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1062 instead.
1063 $tools: array of tools
1064
1065 'NewRevisionFromEditComplete': called when a revision was inserted
1066 due to an edit
1067 $article: the article edited
1068 $rev: the new revision
1069 $baseID: the revision ID this was based off, if any
1070 $user: the editing user
1071
1072 'NormalizeMessageKey': Called before the software gets the text of a message
1073 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1074 displayed
1075 &$key: the message being looked up. Change this to something else to change
1076 what message gets displayed (string)
1077 &$useDB: whether or not to look up the message in the database (bool)
1078 &$langCode: the language code to get the message for (string) - or -
1079 whether to use the content language (true) or site language (false) (bool)
1080 &$transform: whether or not to expand variables and templates
1081 in the message (bool)
1082
1083 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1084 &$changeslist: The OldChangesList instance.
1085 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1086 &$rc: The RecentChange object.
1087
1088 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1089 Hooks can alter or append to the array of URLs for search & suggestion formats.
1090 &$urls: array of associative arrays with Url element attributes
1091
1092 'OutputPageBeforeHTML': a page has been processed by the parser and
1093 the resulting HTML is about to be displayed.
1094 $parserOutput: the parserOutput (object) that corresponds to the page
1095 $text: the text that will be displayed, in HTML (string)
1096
1097 'OutputPageCheckLastModified': when checking if the page has been modified
1098 since the last visit
1099 &$modifiedTimes: array of timestamps.
1100 The following keys are set: page, user, epoch
1101
1102 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1103 $out: OutputPage instance (object)
1104 $parserOutput: parserOutput instance being added in $out
1105
1106 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1107 categories. Implementations should return false if they generate the category
1108 links, so the default link generation is skipped.
1109 $out: OutputPage instance (object)
1110 $categories: associative array, keys are category names, values are category
1111 types ("normal" or "hidden")
1112 $links: array, intended to hold the result. Must be an associative array with
1113 category types as keys and arrays of HTML links as values.
1114
1115 'PageHistoryBeforeList': When a history page list is about to be constructed.
1116 $article: the article that the history is loading for
1117
1118 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1119 $row: the revision row for this line
1120 $s: the string representing this parsed line
1121
1122 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1123 is constructed
1124 $pager: the pager
1125 $queryInfo: the query parameters
1126
1127 'PageRenderingHash': alter the parser cache option hash key
1128 A parser extension which depends on user options should install
1129 this hook and append its values to the key.
1130 $hash: reference to a hash key string which can be modified
1131
1132 'ParserAfterStrip': Same as ParserBeforeStrip
1133
1134 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1135 $parser: Parser object being used
1136 $text: text that'll be returned
1137
1138 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1139 $parser: Parser object
1140 $text: text to parse
1141 $stripState: StripState instance being used
1142
1143 'ParserBeforeStrip': Called at start of parsing time
1144 (no more strip, deprecated ?)
1145 $parser: parser object
1146 $text: text being parsed
1147 $stripState: stripState used (object)
1148
1149 'ParserBeforeTidy': called before tidy and custom tags replacements
1150 $parser: Parser object being used
1151 $text: actual text
1152
1153 'ParserClearState': called at the end of Parser::clearState()
1154 $parser: Parser object being cleared
1155
1156 'ParserFirstCallInit': called when the parser initialises for the first time
1157 &$parser: Parser object being cleared
1158
1159 'ParserGetVariableValueSwitch': called when the parser need the value of a
1160 custom magic word
1161 $parser: Parser object
1162 $varCache: array to store the value in case of multiples calls of the
1163 same magic word
1164 $index: index (string) of the magic
1165 $ret: value of the magic word (the hook should set it)
1166 $frame: PPFrame object to use for expanding any template variables
1167
1168 'ParserGetVariableValueTs': use this to change the value of the time for the
1169 {{LOCAL...}} magic word
1170 $parser: Parser object
1171 $time: actual time (timestamp)
1172
1173 'ParserGetVariableValueVarCache': use this to change the value of the
1174 variable cache or return false to not use it
1175 $parser: Parser object
1176 $varCache: varaiable cache (array)
1177
1178 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1179 include comments about size of the text parsed
1180 $parser: Parser object
1181 $limitReport: text that will be included (without comment tags)
1182
1183 'ParserMakeImageParams': Called before the parser make an image link, use this
1184 to modify the parameters of the image.
1185 $title: title object representing the file
1186 $file: file object that will be used to create the image
1187 &$params: 2-D array of parameters
1188
1189 'ParserTestParser': called when creating a new instance of Parser in
1190 maintenance/parserTests.inc
1191 $parser: Parser object created
1192
1193 'ParserTestTables': alter the list of tables to duplicate when parser tests
1194 are run. Use when page save hooks require the presence of custom tables
1195 to ensure that tests continue to run properly.
1196 &$tables: array of table names
1197
1198 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1199 my talk page, my contributions" etc).
1200
1201 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1202 &$title: Title object representing the current page
1203
1204 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1205 &$user : User performing the action
1206 $action : Action being performed
1207 &$result : Whether or not the action should be prevented
1208 Change $result and return false to give a definitive answer, otherwise
1209 the built-in rate limiting checks are used, if enabled.
1210
1211 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1212 AJAX search suggestions. Put results into &$results outparam and return false.
1213 $ns : array of int namespace keys to search in
1214 $search : search term (not guaranteed to be conveniently normalized)
1215 $limit : maximum number of results to return
1216 &$results : out param: array of page names (strings)
1217
1218 'PrefsEmailAudit': called when user changes his email address
1219 $user: User (object) changing his email address
1220 $oldaddr: old email address (string)
1221 $newaddr: new email address (string)
1222
1223 'PrefsPasswordAudit': called when user changes his password
1224 $user: User (object) changing his passoword
1225 $newPass: new password
1226 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1227
1228 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1229 $article: the title being (un)protected
1230 $output: a string of the form HTML so far
1231
1232 'ProtectionForm::save': called when a protection form is submitted
1233 $article: the title being (un)protected
1234 $errorMsg: an html message string of an error
1235
1236 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1237 $article: the page the form is shown for
1238 $out: OutputPage object
1239
1240 'ProtectionFormGetApplicableTypes': Allows extensions to modify the types of protection
1241 that can be applied.
1242 $title: The title in question.
1243 &$types: The types of protection available.
1244
1245 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1246 &$obj: RawPage object
1247 &$text: The text that's going to be the output
1248
1249 'RecentChange_save': called at the end of RecenChange::save()
1250 $recentChange: RecentChange object
1251
1252 'RevisionInsertComplete': called after a revision is inserted into the DB
1253 &$revision: the Revision
1254 $data: the data stored in old_text. The meaning depends on $flags: if external
1255 is set, it's the URL of the revision text in external storage; otherwise,
1256 it's the revision text itself. In either case, if gzip is set, the revision
1257 text is gzipped.
1258 $flags: a comma-delimited list of strings representing the options used. May
1259 include: utf8 (this will always be set for new revisions); gzip; external.
1260
1261 'SearchUpdate': Prior to search update completion
1262 $id : Page id
1263 $namespace : Page namespace
1264 $title : Page title
1265 $text : Current text being indexed
1266
1267 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1268 $term : Search term string
1269 &$title : Outparam; set to $title object and return false for a match
1270
1271 'SetupAfterCache': Called in Setup.php, after cache objects are set
1272
1273 'ShowMissingArticle': Called when generating the output for a non-existent page
1274 $article: The article object corresponding to the page
1275
1276 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1277 $text: Text being shown
1278 $title: Title of the custom script/stylesheet page
1279 $output: Current OutputPage object
1280
1281 'ShowSearchHitTitle': Customise display of search hit title/link.
1282 &$title: Title to link to
1283 &$text: Text to use for the link
1284 $result: The search result
1285 $terms: The search terms entered
1286 $page: The SpecialSearch object.
1287
1288 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1289 &$siteNotice: HTML returned as the sitenotice
1290 Return true to allow the normal method of notice selection/rendering to work,
1291 or change the value of $siteNotice and return false to alter it.
1292
1293 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1294 &$siteNotice: HTML sitenotice
1295 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1296
1297 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1298 $skin: Skin object
1299 &$text: bottomScripts Text
1300 Append to $text to add additional text/scripts after the stock bottom scripts.
1301
1302 'SkinAfterContent': Allows extensions to add text after the page content and
1303 article metadata.
1304 &$data: (string) Text to be printed out directly (without parsing)
1305 This hook should work in all skins. Just set the &$data variable to the text
1306 you're going to add.
1307
1308 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1309 $skin: Skin object
1310 &$bar: Sidebar contents
1311 Modify $bar to add or modify sidebar portlets.
1312
1313 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1314 $title: displayed page title
1315 $type: 'normal' or 'history' for old/diff views
1316 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1317 &$link: overridable HTML link to be passed into the message as $1
1318
1319 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1320 $skin: Skin object
1321 &$subpages: Subpage links HTML
1322 If false is returned $subpages will be used instead of the HTML
1323 subPageSubtitle() generates.
1324 If true is returned, $subpages will be ignored and the rest of
1325 subPageSubtitle() will run.
1326
1327 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1328 when showing a special page
1329 $sktemplate: SkinTemplate object
1330 $content_actions: array of tabs
1331
1332 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1333 "permanent link" tab
1334 $sktemplate: SkinTemplate object
1335 $nav_urls: array of tabs
1336
1337 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1338 &$content_actions: Content actions
1339 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1340 for an example]
1341
1342 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1343 &$sktemplate: SkinTemplate object
1344 &$links: Structured navigation links
1345 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1346
1347 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1348 starts page output
1349 &$sktemplate: SkinTemplate object
1350 &$tpl: Template engine object
1351
1352 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1353 $sktemplate: SkinTemplate object
1354 $res: set to true to prevent active tabs
1355
1356 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1357 $out: Css to return
1358
1359 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1360 You can either create your own array, or alter the parameters for
1361 the normal one.
1362 &$this: The SkinTemplate instance.
1363 $title: Title instance for the page.
1364 $message: Visible label of tab.
1365 $selected: Whether this is a selected tab.
1366 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1367 &$classes: Array of CSS classes to apply.
1368 &$query: Query string to add to link.
1369 &$text: Link text.
1370 &$result: Complete assoc. array if you want to return true.
1371
1372 'SkinTemplateTabs': called when finished to build the actions tabs
1373 $sktemplate: SkinTemplate object
1374 $content_actions: array of tabs
1375
1376 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1377 been rendered (useful for adding more)
1378 $tools: array of tools
1379
1380 'SoftwareInfo': Called by Special:Version for returning information about
1381 the software
1382 $software: The array of software in format 'name' => 'version'.
1383 See SpecialVersion::softwareInformation()
1384
1385 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1386 $id: User identifier
1387
1388 'SpecialListusersDefaultQuery': called right before the end of
1389 UsersPager::getDefaultQuery()
1390 $pager: The UsersPager instance
1391 $query: The query array to be returned
1392
1393 'SpecialListusersFormatRow': called right before the end of
1394 UsersPager::formatRow()
1395 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1396 $row: Database row object
1397
1398 'SpecialListusersHeader': called before closing the <fieldset> in
1399 UsersPager::getPageHeader()
1400 $pager: The UsersPager instance
1401 $out: The header HTML
1402
1403 'SpecialListusersHeaderForm': called before adding the submit button in
1404 UsersPager::getPageHeader()
1405 $pager: The UsersPager instance
1406 $out: The header HTML
1407
1408 'SpecialListusersQueryInfo': called right before the end of
1409 UsersPager::getQueryInfo()
1410 $pager: The UsersPager instance
1411 $query: The query array to be returned
1412
1413 'SpecialMovepageAfterMove': called after moving a page
1414 $movePage: MovePageForm object
1415 $oldTitle: old title (object)
1416 $newTitle: new title (object)
1417
1418 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1419 hook to remove a core special page
1420 $list: list (array) of core special pages
1421
1422 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1423 use this to change some selection criteria or substitute a different title
1424 &$randstr: The random number from wfRandom()
1425 &$isRedir: Boolean, whether to select a redirect or non-redirect
1426 &$namespaces: An array of namespace indexes to get the title from
1427 &$extra: An array of extra SQL statements
1428 &$title: If the hook returns false, a Title object to use instead of the
1429 result from the normal query
1430
1431 'SpecialRecentChangesPanel': called when building form options in
1432 SpecialRecentChanges
1433 &$extraOpts: array of added items, to which can be added
1434 $opts: FormOptions for this request
1435
1436 'SpecialRecentChangesQuery': called when building sql query for
1437 SpecialRecentChanges
1438 &$conds: array of WHERE conditionals for query
1439 &$tables: array of tables to be queried
1440 &$join_conds: join conditions for the tables
1441 $opts: FormOptions for this request
1442
1443 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1444 target doesn't exist
1445 $title: title object generated from the text entred by the user
1446
1447 'SpecialSearchProfiles': allows modification of search profiles
1448 &$profiles: profiles, which can be modified.
1449
1450 'SpecialSearchResults': called before search result display when there
1451 are matches
1452 $term: string of search term
1453 &$titleMatches: empty or SearchResultSet object
1454 &$textMatches: empty or SearchResultSet object
1455
1456 'SpecialSearchNoResults': called before search result display when there are
1457 no matches
1458 $term: string of search term
1459
1460 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1461 &$extraStats: Array to save the new stats
1462 ( $extraStats['<name of statistic>'] => <value>; )
1463
1464 'SpecialUploadComplete': Called after successfully uploading a file from
1465 Special:Upload
1466 $form: The SpecialUpload object
1467
1468 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1469 use this to change the tables headers
1470 $extTypes: associative array of extensions types
1471
1472 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1473 &$conds: array of WHERE conditionals for query
1474 &$tables: array of tables to be queried
1475 &$join_conds: join conditions for the tables
1476 &$fields: array of query fields
1477
1478 'TitleArrayFromResult': called when creating an TitleArray object from a
1479 database result
1480 &$titleArray: set this to an object to override the default object returned
1481 $res: database result used to create the object
1482
1483 'TitleMoveComplete': after moving an article (title)
1484 $old: old title
1485 $nt: new title
1486 $user: user who did the move
1487 $pageid: database ID of the page that's been moved
1488 $redirid: database ID of the created redirect
1489
1490 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1491 $title: title object related to the revision
1492 $rev: revision (object) that will be viewed
1493
1494 'UnknownAction': An unknown "action" has occured (useful for defining
1495 your own actions)
1496 $action: action name
1497 $article: article "acted on"
1498
1499 'UnwatchArticle': before a watch is removed from an article
1500 $user: user watching
1501 $article: article object to be removed
1502
1503 'UnwatchArticle': after a watch is removed from an article
1504 $user: user that was watching
1505 $article: article object removed
1506
1507 'UnwatchArticleComplete': after a watch is removed from an article
1508 $user: user that watched
1509 $article: article object that was watched
1510
1511 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1512 string $type: the requested upload type
1513 &$className: the class name of the Upload instance to be created
1514
1515 'UploadComplete': when Upload completes an upload
1516 &$upload: an UploadBase child instance
1517
1518 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1519 assembled
1520 array $descriptor: the HTMLForm descriptor
1521
1522 'UploadFormSourceDescriptors': after the standard source inputs have been
1523 added to the descriptor
1524 array $descriptor: the HTMLForm descriptor
1525
1526 'UploadVerification': additional chances to reject an uploaded file
1527 string $saveName: destination file name
1528 string $tempName: filesystem path to the temporary file for checks
1529 string &$error: output: HTML error to show if upload canceled by returning false
1530
1531 'UploadComplete': Upon completion of a file upload
1532 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1533 $uploadBase->getLocalFile().
1534
1535 'User::mailPasswordInternal': before creation and mailing of a user's new
1536 temporary password
1537 $user: the user who sent the message out
1538 $ip: IP of the user who sent the message out
1539 $u: the account whose new password will be set
1540
1541 'UserArrayFromResult': called when creating an UserArray object from a
1542 database result
1543 &$userArray: set this to an object to override the default object returned
1544 $res: database result used to create the object
1545
1546 'userCan': To interrupt/advise the "user can do X to Y article" check.
1547 If you want to display an error message, try getUserPermissionsErrors.
1548 $title: Title object being checked against
1549 $user : Current user object
1550 $action: Action being checked
1551 $result: Pointer to result returned if hook returns false. If null is returned,
1552 userCan checks are continued by internal code.
1553
1554 'UserCanSendEmail': To override User::canSendEmail() permission check
1555 $user: User (object) whose permission is being checked
1556 &$canSend: bool set on input, can override on output
1557
1558 'UserClearNewTalkNotification': called when clearing the
1559 "You have new messages!" message, return false to not delete it
1560 $user: User (object) that'll clear the message
1561
1562 'UserComparePasswords': called when checking passwords, return false to
1563 override the default password checks
1564 &$hash: String of the password hash (from the database)
1565 &$password: String of the plaintext password the user entered
1566 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1567 supplied
1568 &$result: If the hook returns false, this Boolean value will be checked to
1569 determine if the password was valid
1570
1571 'UserCreateForm': change to manipulate the login form
1572 $template: SimpleTemplate instance for the form
1573
1574 'UserCryptPassword': called when hashing a password, return false to implement
1575 your own hashing method
1576 &$password: String of the plaintext password to encrypt
1577 &$salt: String of the password salt or Boolean false if no salt is provided
1578 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1579 hashing method
1580 &$hash: If the hook returns false, this String will be used as the hash
1581
1582 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1583 $user: User to get groups for
1584 &$groups: Current effective groups
1585
1586 'UserGetAllRights': after calculating a list of all available rights
1587 &$rights: Array of rights, which may be added to.
1588
1589 'UserGetEmail': called when getting an user email address
1590 $user: User object
1591 &$email: email, change this to override local email
1592
1593 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1594 email authentification
1595 $user: User object
1596 &$timestamp: timestamp, change this to override local email authentification
1597 timestamp
1598
1599 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1600 &$groups: List of implicit (automatically-assigned) groups
1601
1602 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1603 &$reservedUsernames: $wgReservedUsernames
1604
1605 'UserGetRights': Called in User::getRights()
1606 $user: User to get rights for
1607 &$rights: Current rights
1608
1609 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1610 exemptions).
1611 $user: User in question
1612 $title: Title of the page in question
1613 &$blocked: Out-param, whether or not the user is blocked from that page.
1614 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1615 own user talk pages.
1616
1617 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1618 &$user: User object
1619 $ip: User's IP address
1620 &$blocked: Whether the user is blocked, to be modified by the hook
1621
1622 'UserLoadAfterLoadFromSession': called to authenticate users on
1623 external/environmental means; occurs after session is loaded
1624 $user: user object being loaded
1625
1626 'UserLoadDefaults': called when loading a default user
1627 $user: user object
1628 $name: user name
1629
1630 'UserLoadFromDatabase': called when loading a user from the database
1631 $user: user object
1632 &$s: database query object
1633
1634 'UserLoadFromSession': called to authenticate users on external/environmental
1635 means; occurs before session is loaded
1636 $user: user object being loaded
1637 &$result: set this to a boolean value to abort the normal authentification
1638 process
1639
1640 'UserLoadOptions': when user options/preferences are being loaded from
1641 the database.
1642 $user: User object
1643 &$options: Options, can be modified.
1644
1645 'UserLoginComplete': after a user has logged in
1646 $user: the user object that was created on login
1647 $inject_html: Any HTML to inject after the "logged in" message.
1648
1649 'UserLoginForm': change to manipulate the login form
1650 $template: SimpleTemplate instance for the form
1651
1652 'UserLoginMailPassword': Block users from emailing passwords
1653 $name: the username to email the password of.
1654 &$error: out-param - the error message to return.
1655
1656 'UserLogout': before a user logs out
1657 $user: the user object that is about to be logged out
1658
1659 'UserLogoutComplete': after a user has logged out
1660 $user: the user object _after_ logout (won't have name, ID, etc.)
1661 $inject_html: Any HTML to inject after the "logged out" message.
1662 $oldName: name of the user before logout (string)
1663
1664 'UserRights': After a user's group memberships are changed
1665 $user : User object that was changed
1666 $add : Array of strings corresponding to groups added
1667 $remove: Array of strings corresponding to groups removed
1668
1669 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1670 message(s)
1671 $user: user retrieving new talks messages
1672 $talks: array of new talks page(s)
1673
1674 'UserSaveSettings': called when saving user settings
1675 $user: User object
1676
1677 'UserSaveOptions': Called just before saving user preferences/options.
1678 $user: User object
1679 &$options: Options, modifiable
1680
1681 'UserSetCookies': called when setting user cookies
1682 $user: User object
1683 &$session: session array, will be added to $_SESSION
1684 &$cookies: cookies array mapping cookie name to its value
1685
1686 'UserSetEmail': called when changing user email address
1687 $user: User object
1688 &$email: new email, change this to override new email address
1689
1690 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1691 of email authentification
1692 $user: User object
1693 &$timestamp: new timestamp, change this to override local email
1694 authentification timestamp
1695
1696 'UserToggles': called when initialising User::$mToggles, use this to add
1697 new toggles
1698 $toggles: array of toggles to add
1699
1700 'VectorTemplateToolboxEnd': Called by Vector skin after toolbox links have
1701 been rendered (useful for adding more)
1702 Note: this is only run for the Vector skin. To add items to the toolbox
1703 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1704 instead.
1705 $tools: array of tools
1706
1707 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1708 alter the SQL query which gets the list of wanted pages
1709 &$wantedPages: WantedPagesPage object
1710 &$sql: raw SQL query used to get the list of wanted pages
1711
1712 'WatchArticle': before a watch is added to an article
1713 $user: user that will watch
1714 $article: article object to be watched
1715
1716 'WatchArticleComplete': after a watch is added to an article
1717 $user: user that watched
1718 $article: article object watched
1719
1720 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1721 dumps
1722 One, and only one hook should set this, and return false.
1723 &$tables: Database tables to use in the SELECT query
1724 &$opts: Options to use for the query
1725 &$join: Join conditions
1726
1727 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1728 query pages to be updated with maintenance/updateSpecialPages.php
1729 $query: $wgQueryPages itself
1730
1731 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1732 metadata to be added.
1733 $obj: The XmlDumpWriter object.
1734 &$out: The output string.
1735 $row: The database row for the page.
1736 $title: The title of the page.
1737
1738 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1739 metadata.
1740 $obj: The XmlDumpWriter object.
1741 &$out: The text being output.
1742 $row: The database row for the revision.
1743 $text: The revision text.
1744
1745 More hooks might be available but undocumented, you can execute
1746 ./maintenance/findhooks.php to find hidden one.