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