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