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