Merge "Remove unused $wgDebugDBTransactions"
[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 'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
240
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
244
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
247
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252 default is LoginForm::ABORTED. Note that the client may be using
253 a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
255
256 'AbortMove': allows to abort moving an article (title)
257 $old: old title
258 $nt: new title
259 $user: user who is doing the move
260 $err: error message
261 $reason: the reason for the move (added in 1.13)
262
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: name of error message to display on abort
266
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
271
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273 allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
277
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
281
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
288
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
292
293 'AlternateEdit': before checking if a user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
295 on &action=edit.
296 $EditPage: the EditPage object
297
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or PHP's mail().
300 Return false to skip the regular method of sending mail. Return a
301 string to return a php-mail-error message containing the error.
302 Returning true will continue with sending email in the regular way.
303 $headers: Associative array of headers for the email
304 $to: MailAddress object or array
305 $from: From address
306 $subject: Subject of the email
307 $body: Body of the message
308
309 'APIAfterExecute': after calling the execute() method of an API module.
310 Use this to extend core API modules.
311 &$module: Module object
312
313 'APIEditBeforeSave': before saving a page with api.php?action=edit,
314 after processing request parameters. Return false to let the request
315 fail, returning an error message or an <edit result="Failure"> tag
316 if $resultArr was filled.
317 $EditPage : the EditPage object
318 $text : the new text of the article (has yet to be saved)
319 &$resultArr : data in this array will be added to the API result
320
321 'APIGetAllowedParams': use this hook to modify a module's parameters.
322 &$module: ApiBase Module object
323 &$params: Array of parameters
324
325 'APIGetDescription': use this hook to modify a module's description
326 &$module: ApiBase Module object
327 &$desc: Array of descriptions
328
329 'APIGetParamDescription': use this hook to modify a module's parameter
330 descriptions.
331 &$module: ApiBase Module object
332 &$desc: Array of parameter descriptions
333
334 'APIQueryAfterExecute': after calling the execute() method of an
335 action=query submodule. Use this to extend core API modules.
336 &$module: Module object
337
338 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
339 method of an action=query submodule. Use this to extend core API modules.
340 &$module: Module object
341 &$resultPageSet: ApiPageSet object
342
343 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
344 Every token has an action, which will be used in the intoken parameter
345 and in the output (actiontoken="..."), and a callback function which
346 should return the token, or false if the user isn't allowed to obtain
347 it. The prototype of the callback function is func($pageid, $title)
348 where $pageid is the page ID of the page the token is requested for
349 and $title is the associated Title object. In the hook, just add
350 your callback to the $tokenFunctions array and return true (returning
351 false makes no sense)
352 $tokenFunctions: array(action => callback)
353
354 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
355 Every token has an action, which will be used in the rvtoken parameter
356 and in the output (actiontoken="..."), and a callback function which
357 should return the token, or false if the user isn't allowed to obtain
358 it. The prototype of the callback function is func($pageid, $title, $rev)
359 where $pageid is the page ID of the page associated to the revision the
360 token is requested for, $title the associated Title object and $rev the
361 associated Revision object. In the hook, just add your callback to the
362 $tokenFunctions array and return true (returning false makes no sense)
363 $tokenFunctions: array(action => callback)
364
365 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
366 list=recentchanges.
367 Every token has an action, which will be used in the rctoken parameter
368 and in the output (actiontoken="..."), and a callback function which
369 should return the token, or false if the user isn't allowed to obtain
370 it. The prototype of the callback function is func($pageid, $title, $rc)
371 where $pageid is the page ID of the page associated to the revision the
372 token is requested for, $title the associated Title object and $rc the
373 associated RecentChange object. In the hook, just add your callback to the
374 $tokenFunctions array and return true (returning false makes no sense)
375 $tokenFunctions: array(action => callback)
376
377 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
378 the sites general information.
379 $module: the current ApiQuerySiteInfo module
380 &$results: array of results, add things here
381
382 'APIQueryUsersTokens': use this hook to add custom token to list=users.
383 Every token has an action, which will be used in the ustoken parameter
384 and in the output (actiontoken="..."), and a callback function which
385 should return the token, or false if the user isn't allowed to obtain
386 it. The prototype of the callback function is func($user) where $user
387 is the User object. In the hook, just add your callback to the
388 $tokenFunctions array and return true (returning false makes no sense)
389 $tokenFunctions: array(action => callback)
390
391 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
392 Each service should have its own entry in the $apis array and have a
393 unique name, passed as key for the array that represents the service data.
394 In this data array, the key-value-pair identified by the apiLink key is
395 required.
396 &$apis: array of services
397
398 'ArticleAfterFetchContent': after fetching content of an article from
399 the database
400 $article: the article (object) being loaded from the database
401 $content: the content (string) of the article
402
403 'ArticleConfirmDelete': before writing the confirmation form for article
404 deletion
405 $article: the article (object) being deleted
406 $output: the OutputPage object ($wgOut)
407 &$reason: the reason (string) the article is being deleted
408
409 'ArticleContentOnDiff': before showing the article content below a diff.
410 Use this to change the content in this area or how it is loaded.
411 $diffEngine: the DifferenceEngine
412 $output: the OutputPage object ($wgOut)
413
414 'ArticleDelete': before an article is deleted
415 $article: the WikiPage (object) being deleted
416 $user: the user (object) deleting the article
417 $reason: the reason (string) the article is being deleted
418 $error: if the deletion was prohibited, the (raw HTML) error message to display
419 (added in 1.13)
420
421 'ArticleDeleteComplete': after an article is deleted
422 $article: the WikiPage that was deleted
423 $user: the user that deleted the article
424 $reason: the reason the article was deleted
425 $id: id of the article that was deleted
426
427 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
428 was changed
429 $article: WikiPage (object) of the user talk page
430
431 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
432 article has been changed
433 $article: the WikiPage (object)
434 $editInfo: data holder that includes the parser output ($editInfo->output) for
435 that page after the change
436 $changed: bool for if the page was changed
437
438 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
439 recentchanges table, return false to not delete old entries
440 $article: WikiPage (object) being modified
441
442 'ArticleFromTitle': when creating an article object from a title object using
443 Wiki::articleFromTitle()
444 $title: title (object) used to create the article object
445 $article: article (object) that will be returned
446
447 'ArticleInsertComplete': After a new article is created
448 $article: WikiPage created
449 $user: User creating the article
450 $text: New content
451 $summary: Edit summary/comment
452 $isMinor: Whether or not the edit was marked as minor
453 $isWatch: (No longer used)
454 $section: (No longer used)
455 $flags: Flags passed to Article::doEdit()
456 $revision: New Revision of the article
457
458 'ArticleMergeComplete': after merging to article using Special:Mergehistory
459 $targetTitle: target title (object)
460 $destTitle: destination title (object)
461
462 'ArticlePageDataAfter': after loading data of an article from the database
463 $article: WikiPage (object) whose data were loaded
464 $row: row (object) returned from the database server
465
466 'ArticlePageDataBefore': before loading data of an article from the database
467 $article: WikiPage (object) that data will be loaded
468 $fields: fileds (array) to load from the database
469
470 'ArticlePrepareTextForEdit': called when preparing text to be saved
471 $article: the WikiPage being saved
472 $popts: parser options to be used for pre-save transformation
473
474 'ArticleProtect': before an article is protected
475 $article: the WikiPage being protected
476 $user: the user doing the protection
477 $protect: boolean whether this is a protect or an unprotect
478 $reason: Reason for protect
479 $moveonly: boolean whether this is for move only or not
480
481 'ArticleProtectComplete': after an article is protected
482 $article: the WikiPage that was protected
483 $user: the user who did the protection
484 $protect: boolean whether it was a protect or an unprotect
485 $reason: Reason for protect
486 $moveonly: boolean whether it was for move only or not
487
488 'ArticlePurge': before executing "&action=purge"
489 $article: WikiPage (object) to purge
490
491 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
492 revision of an article
493 &$title: title object of the article
494
495 'ArticleRevisionUndeleted': after an article revision is restored
496 $title: the article title
497 $revision: the revision
498 $oldPageID: the page ID of the revision when archived (may be null)
499
500 'ArticleRollbackComplete': after an article rollback is completed
501 $article: the WikiPage that was edited
502 $user: the user who did the rollback
503 $revision: the revision the page was reverted back to
504 $current: the reverted revision
505
506 'ArticleSave': before an article is saved
507 $article: the WikiPage (object) being saved
508 $user: the user (object) saving the article
509 $text: the new article text
510 $summary: the article summary (comment)
511 $isminor: minor flag
512 $iswatch: watch flag
513 $section: section #
514
515 'ArticleSaveComplete': After an article has been updated
516 $article: WikiPage modified
517 $user: User performing the modification
518 $text: New content
519 $summary: Edit summary/comment
520 $isMinor: Whether or not the edit was marked as minor
521 $isWatch: (No longer used)
522 $section: (No longer used)
523 $flags: Flags passed to Article::doEdit()
524 $revision: New Revision of the article
525 $status: Status object about to be returned by doEdit()
526 $baseRevId: the rev ID (or false) this edit was based on
527
528 'ArticleUndelete': When one or more revisions of an article are restored
529 $title: Title corresponding to the article restored
530 $create: Whether or not the restoration caused the page to be created
531 (i.e. it didn't exist before)
532 $comment: The comment associated with the undeletion.
533
534 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
535 before the user is redirected back to the page
536 &$article: the article
537 &$sectionanchor: The section anchor link (e.g. "#overview" )
538 &$extraq: Extra query parameters which can be added via hooked functions
539
540 'ArticleViewFooter': After showing the footer section of an ordinary page view
541 $article: Article object
542
543 'ArticleViewHeader': Before the parser cache is about to be tried for article
544 viewing.
545 &$article: the article
546 &$pcache: whether to try the parser cache or not
547 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
548 object to both indicate that the output is done and what parser output was used.
549
550 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
551 follwed an redirect
552 $article: target article (object)
553
554 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext
555 $text: text of the page
556 $title: title of the page
557 $output: reference to $wgOut
558
559 'AuthPluginAutoCreate': Called when creating a local account for an user logged
560 in from an external authentication method
561 $user: User object created locally
562
563 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
564 Gives a chance for an extension to set it programattically to a variable class.
565 &$auth: the $wgAuth object, probably a stub
566
567 'AutopromoteCondition': check autopromote condition for user.
568 $type: condition type
569 $args: arguments
570 $user: user
571 $result: result of checking autopromote condition
572
573 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
574 $table: table name
575 &$prefix: prefix
576
577 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
578 are fetched
579 $table: table name
580 $title: title of the page to which backlinks are sought
581 &$conds: query conditions
582
583 'BadImage': When checking against the bad image list
584 $name: Image name being checked
585 &$bad: Whether or not the image is "bad"
586
587 Change $bad and return false to override. If an image is "bad", it is not
588 rendered inline in wiki pages or galleries in category pages.
589
590 'BeforeDisplayNoArticleText': before displaying noarticletext or noarticletext-nopermission
591 at Article::showMissingArticle()
592
593 $article: article object
594
595 'BeforeInitialize': before anything is initialized in MediaWiki::performRequest()
596 &$title: Title being used for request
597 $unused: null
598 &$output: OutputPage object
599 &$user: User
600 $request: WebRequest object
601 $mediaWiki: Mediawiki object
602
603 'BeforePageDisplay': Prior to outputting a page
604 &$out: OutputPage object
605 &$skin: Skin object
606
607 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
608 override how the redirect is output by modifying, or by returning false and
609 taking over the output.
610 $out: OutputPage object
611 &$redirect: URL, modifiable
612 &$code: HTTP code (eg '301' or '302'), modifiable
613
614 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
615 $parser: Parser object
616 $nt: the image title
617 &$options: array of options to RepoGroup::findFile
618 &$descQuery: query string to add to thumbnail URL
619
620 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
621
622 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
623 $parser: Parser object
624 $title: title of the template
625 &$skip: skip this template and link it?
626 &$id: the id of the revision being parsed
627
628 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
629 &$parser: Parser object
630 &$ig: ImageGallery object
631
632 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
633 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
634 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
635
636 'BitmapHandlerTransform': before a file is transformed, gives extension the
637 possibility to transform it themselves
638 $handler: BitmapHandler
639 $image: File
640 &$scalerParams: Array with scaler parameters
641 &$mto: null, set to a MediaTransformOutput
642
643 'BitmapHandlerCheckImageArea': by BitmapHandler::normaliseParams, after all normalizations have been performed, except for the $wgMaxImageArea check
644 $image: File
645 &$params: Array of parameters
646 &$checkImageAreaHookResult: null, set to true or false to override the $wgMaxImageArea check result
647
648 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
649 $block: Block object (which is set to be autoblocking)
650 &$blockIds: Array of block IDs of the autoblock
651
652 'BlockIp': before an IP address or user is blocked
653 $block: the Block object about to be saved
654 $user: the user _doing_ the block (not the one being blocked)
655
656 'BlockIpComplete': after an IP address or user is blocked
657 $block: the Block object that was saved
658 $user: the user who did the block (not the one being blocked)
659
660 'BookInformation': Before information output on Special:Booksources
661 $isbn: ISBN to show information for
662 $output: OutputPage object in use
663
664 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
665 &$namespaces: Array of namespace numbers with corresponding canonical names
666
667 'CategoryPageView': before viewing a categorypage in CategoryPage::view
668 $catpage: CategoryPage instance
669
670 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
671 &$changesList: ChangesList instance.
672 &$articlelink: HTML of link to article (already filled-in).
673 &$s: HTML of row that is being constructed.
674 &$rc: RecentChange instance.
675 $unpatrolled: Whether or not we are showing unpatrolled changes.
676 $watched: Whether or not the change is watched by the user.
677
678 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
679 $collationName: Name of the collation in question
680 &$collationObject: Null. Replace with a subclass of the Collation class that implements
681 the collation given in $collationName.
682
683 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
684 $user: user (object) whose email is being confirmed
685
686 'ContribsPager::getQueryInfo': Before the contributions query is about to run
687 &$pager: Pager object for contributions
688 &$queryInfo: The query for the contribs Pager
689
690 'ContributionsLineEnding': Called before a contributions HTML line is finished
691 $page: SpecialPage object for contributions
692 $ret: the HTML line
693 $row: the DB row for this line
694
695 'ContributionsToolLinks': Change tool links above Special:Contributions
696 $id: User identifier
697 $title: User page title
698 &$tools: Array of tool links
699
700 'CustomEditor': When invoking the page editor
701 $article: Article being edited
702 $user: User performing the edit
703
704 Return true to allow the normal editor to be used, or false
705 if implementing a custom editor, e.g. for a special namespace,
706 etc.
707
708 'DatabaseOraclePostInit': Called after initialising an Oracle database
709 &$db: the DatabaseOracle object
710
711 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
712 $text: plaintext string to be output
713 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
714
715 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
716 $title: the diff page title (nullable)
717 &$oldId: the actual old Id to use in the diff
718 &$newId: the actual new Id to use in the diff (0 means current)
719 $old: the ?old= param value from the url
720 $new: the ?new= param value from the url
721
722 'DiffViewHeader': called before diff display
723 $diff: DifferenceEngine object that's calling
724 $oldRev: Revision object of the "old" revision (may be null/invalid)
725 $newRev: Revision object of the "new" revision
726
727 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
728 an article
729 $article: article (object) being viewed
730 $oldid: oldid (int) being viewed
731
732 'DoEditSectionLink': Override the HTML generated for section edit links
733 $skin: Skin object rendering the UI
734 $title: Title object for the title being linked to (may not be the same as
735 $wgTitle, if the section is included from a template)
736 $section: The designation of the section being pointed to, to be included in
737 the link, like "&section=$section"
738 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
739 By default, this is wrapped in the 'editsectionhint' message.
740 &$result: The HTML to return, prefilled with the default plus whatever other
741 changes earlier hooks have made
742 $lang: The language code to use for the link in the wfMsg* functions
743
744 'EditFilter': Perform checks on an edit
745 $editor: Edit form (see includes/EditPage.php)
746 $text: Contents of the edit box
747 $section: Section being edited
748 &$error: Error message to return
749 $summary: Edit summary for page
750
751 'EditFilterMerged': Post-section-merge edit filter
752 $editor: EditPage instance (object)
753 $text: content of the edit box
754 &$error: error message to return
755 $summary: Edit summary for page
756
757 'EditFormPreloadText': Allows population of the edit form when creating
758 new pages
759 &$text: Text to preload with
760 &$title: Title object representing the page being created
761
762 'EditFormInitialText': Allows modifying the edit form when editing existing
763 pages
764 $editPage: EditPage object
765
766 'EditPage::attemptSave': called before an article is
767 saved, that is before Article::doEdit() is called
768 $editpage_Obj: the current EditPage object
769
770 'EditPage::importFormData': allow extensions to read additional data
771 posted in the form
772 $editpage: EditPage instance
773 $request: Webrequest
774 return value is ignored (should always return true)
775
776 'EditPage::showEditForm:fields': allows injection of form field into edit form
777 $editor: the EditPage instance for reference
778 $out: an OutputPage instance to write to
779 return value is ignored (should always return true)
780
781 'EditPage::showEditForm:initial': before showing the edit form
782 $editor: EditPage instance (object)
783 $out: an OutputPage instance to write to
784
785 Return false to halt editing; you'll need to handle error messages, etc.
786 yourself. Alternatively, modifying $error and returning true will cause the
787 contents of $error to be echoed at the top of the edit form as wikitext.
788 Return true without altering $error to allow the edit to proceed.
789
790 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
791 when there's an edit conflict. Return false to halt normal diff output; in
792 this case you're responsible for computing and outputting the entire "conflict"
793 part, i.e., the "difference between revisions" and "your text" headers and
794 sections.
795 &$editor: EditPage instance
796 &$out: OutputPage instance
797
798 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
799 textarea in the edit form
800 &$editpage: The current EditPage object
801 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
802 &$tabindex: HTML tabindex of the last edit check/button
803
804 'EditPageBeforeEditChecks': allows modifying the edit checks below the
805 textarea in the edit form
806 &$editpage: The current EditPage object
807 &$checks: Array of edit checks like "watch this page"/"minor edit"
808 &$tabindex: HTML tabindex of the last edit check/button
809
810 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
811 textarea in the edit form
812 &$toolbar: The toolbar HTMl
813
814 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
815 $title: title of page being edited
816 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
817
818 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
819 "Show changes"
820 $editPage: EditPage object
821 &$newtext: wikitext that will be used as "your version"
822
823 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
824 $editPage: EditPage object
825 &$toparse: wikitext that will be parsed
826
827 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
828 &$editpage: The current EditPage object
829 &$res: the HTML of the error text
830
831 'EditPageTosSummary': Give a chance for site and per-namespace customizations
832 of terms of service summary link that might exist separately from the copyright
833 notice.
834 $title: title of page being edited
835 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
836
837 'EditSectionLink': Do not use, use DoEditSectionLink instead.
838 $skin: Skin rendering the UI
839 $title: Title being linked to
840 $section: Section to link to
841 $link: Default link
842 &$result: Result (alter this to override the generated links)
843 $lang: The language code to use for the link in the wfMsg* functions
844
845 'EmailConfirmed': When checking that the user's email address is "confirmed"
846 $user: User being checked
847 $confirmed: Whether or not the email address is confirmed
848 This runs before the other checks, such as anonymity and the real check; return
849 true to allow those checks to occur, and false if checking is done.
850
851 'EmailUser': before sending email from one user to another
852 $to: address of receiving user
853 $from: address of sending user
854 $subject: subject of the mail
855 $text: text of the mail
856
857 'EmailUserCC': before sending the copy of the email to the author
858 $to: address of receiving user
859 $from: address of sending user
860 $subject: subject of the mail
861 $text: text of the mail
862
863 'EmailUserComplete': after sending email from one user to another
864 $to: address of receiving user
865 $from: address of sending user
866 $subject: subject of the mail
867 $text: text of the mail
868
869 'EmailUserForm': after building the email user form object
870 $form: HTMLForm object
871
872 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
873 $user: The user who is trying to email another user.
874 $editToken: The user's edit token.
875 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
876
877 'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle
878 $ip: The ip address of the user
879
880 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
881 &$extTypes: associative array of extensions types
882
883 'ExtractThumbParameters': called when extracting thumbnail parameters from a thumbnail file name
884 $thumbname: the base name of the thumbnail file
885 &$params: the currently extracted params (has source name, temp or archived zone)
886
887 'FetchChangesList': When fetching the ChangesList derivative for
888 a particular user
889 $user: User the list is being fetched for
890 &$skin: Skin object to be used with the list
891 &$list: List object (defaults to NULL, change it to an object
892 instance and return false override the list derivative used)
893
894 'FileDeleteComplete': When a file is deleted
895 $file: reference to the deleted file
896 $oldimage: in case of the deletion of an old image, the name of the old file
897 $article: in case all revisions of the file are deleted a reference to the
898 WikiFilePage associated with the file.
899 $user: user who performed the deletion
900 $reason: reason
901
902 'FileUpload': When a file upload occurs
903 $file : Image object representing the file that was uploaded
904 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
905 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
906
907 'FileUndeleteComplete': When a file is undeleted
908 $title: title object to the file
909 $fileVersions: array of undeleted versions. Empty if all versions were restored
910 $user: user who performed the undeletion
911 $reason: reason
912
913 'GetAutoPromoteGroups': When determining which autopromote groups a user
914 is entitled to be in.
915 &$user: user to promote.
916 &$promote: groups that will be added.
917
918 'GetBlockedStatus': after loading blocking status of an user from the database
919 $user: user (object) being checked
920
921 'GetCacheVaryCookies': get cookies that should vary cache options
922 $out: OutputPage object
923 &$cookies: array of cookies name, add a value to it if you want to add a cookie
924 that have to vary cache options
925
926 'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
927 $title: Title object of page
928 $url: string value as output (out parameter, can modify)
929 $query: query options passed to Title::getCanonicalURL()
930
931 'GetDefaultSortkey': Override the default sortkey for a page.
932 $title: Title object that we need to get a sortkey for
933 &$sortkey: Sortkey to use.
934
935 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
936 $title: Title object of page
937 $url: string value as output (out parameter, can modify)
938 $query: query options passed to Title::getFullURL()
939
940 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
941 $title: Title object of page
942 $url: string value as output (out parameter, can modify)
943 $query: query options passed to Title::getInternalURL()
944
945 'GetIP': modify the ip of the current user (called only once)
946 &$ip: string holding the ip as determined so far
947
948 'GetLinkColours': modify the CSS class of an array of page links
949 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
950 indexed by page_id.
951 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
952
953 'GetLocalURL': modify local URLs as output into page links. Note that if you
954 are working with internal urls (non-interwiki) then it may be preferable
955 to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
956 GetLocalURL can be buggy for internal urls on render if you do not
957 re-implement the horrible hack that Title::getLocalURL uses
958 in your own extension.
959 $title: Title object of page
960 &$url: string value as output (out parameter, can modify)
961 $query: query options passed to Title::getLocalURL()
962
963 'GetLocalURL::Internal': modify local URLs to internal pages.
964 $title: Title object of page
965 &$url: string value as output (out parameter, can modify)
966 $query: query options passed to Title::getLocalURL()
967
968 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
969 without any fancy queries or variants.
970 $title: Title object of page
971 &$url: string value as output (out parameter, can modify)
972
973 'GetMetadataVersion': modify the image metadata version currently in use. This is
974 used when requesting image metadata from a ForiegnApiRepo. Media handlers
975 that need to have versioned metadata should add an element to the end of
976 the version array of the form 'handler_name=version'. Most media handlers
977 won't need to do this unless they broke backwards compatibility with a
978 previous version of the media handler metadata output.
979 &$version: Array of version strings
980
981 'GetPreferences': modify user preferences
982 $user: User whose preferences are being modified.
983 &$preferences: Preferences description array, to be fed to an HTMLForm object
984
985 'getUserPermissionsErrors': Add a permissions error when permissions errors are
986 checked for. Use instead of userCan for most cases. Return false if the
987 user can't do it, and populate $result with the reason in the form of
988 array( messagename, param1, param2, ... ). For consistency, error messages
989 should be plain text with no special coloring, bolding, etc. to show that
990 they're errors; presenting them properly to the user as errors is done by
991 the caller.
992 $title: Title object being checked against
993 $user : Current user object
994 $action: Action being checked
995 $result: User permissions error to add. If none, return true.
996
997 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
998 if expensive checks are enabled.
999
1000 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1001 image insertion. You can skip the default logic entirely by returning
1002 false, or just modify a few things using call-by-reference.
1003 &$skin: Skin object
1004 &$title: Title object of the image
1005 &$file: File object, or false if it doesn't exist
1006 &$frameParams: Various parameters with special meanings; see documentation in
1007 includes/Linker.php for Linker::makeImageLink2
1008 &$handlerParams: Various parameters with special meanings; see documentation in
1009 includes/Linker.php for Linker::makeImageLink2
1010 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1011 &$res: Final HTML output, used if you return false
1012
1013
1014 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1015 the image on an image page
1016 $imagePage: ImagePage object ($this)
1017 $output: $wgOut
1018
1019 'ImagePageAfterImageLinks': called after the image links section on an image
1020 page is built
1021 $imagePage: ImagePage object ($this)
1022 &$html: HTML for the hook to add
1023
1024 'ImagePageFileHistoryLine': called when a file history line is contructed
1025 $file: the file
1026 $line: the HTML of the history line
1027 $css: the line CSS class
1028
1029 'ImagePageFindFile': called when fetching the file associated with an image page
1030 $page: ImagePage object
1031 &$file: File object
1032 &$displayFile: displayed File object
1033
1034 'ImagePageShowTOC': called when the file toc on an image page is generated
1035 $page: ImagePage object
1036 &$toc: Array of <li> strings
1037
1038 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1039 using img_auth.php
1040 &$title: the Title object of the file as it would appear for the upload page
1041 &$path: the original file and path name when img_auth was invoked by the the web
1042 server
1043 &$name: the name only component of the file
1044 &$result: The location to pass back results of the hook routine (only used if
1045 failed)
1046 $result[0]=The index of the header message
1047 $result[1]=The index of the body text message
1048 $result[2 through n]=Parameters passed to body text message. Please note the
1049 header message cannot receive/use parameters.
1050
1051 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1052 $reader: XMLReader object
1053 $logInfo: Array of information
1054 Return false to stop further processing of the tag
1055
1056 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1057 $reader: XMLReader object
1058 $pageInfo: Array of information
1059 Return false to stop further processing of the tag
1060
1061 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1062 $reader: XMLReader object
1063 $pageInfo: Array of page information
1064 $revisionInfo: Array of revision information
1065 Return false to stop further processing of the tag
1066
1067 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1068 $reader: XMLReader object
1069 Return false to stop further processing of the tag
1070
1071 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1072 $reader: XMLReader object
1073 $revisionInfo: Array of information
1074 Return false to stop further processing of the tag
1075
1076 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1077 $title: Title object ($wgTitle)
1078 $request: WebRequest
1079 $ignoreRedirect: boolean to skip redirect check
1080 $target: Title/string of redirect target
1081 $article: Article object
1082
1083 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1084 Return true without providing an interwiki to continue interwiki search.
1085 $prefix: interwiki prefix we are looking for.
1086 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1087 iw_trans and optionally iw_api and iw_wikiid.
1088
1089 'InternalParseBeforeLinks': during Parser's internalParse method before links
1090 but after noinclude/includeonly/onlyinclude and other processing.
1091 &$parser: Parser object
1092 &$text: string containing partially parsed text
1093 &$stripState: Parser's internal StripState object
1094
1095 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1096 $user: user (object) whose email is being invalidated
1097
1098 'IRCLineURL': When constructing the URL to use in an IRC notification.
1099 Callee may modify $url and $query, URL will be constructed as $url . $query
1100 &$url: URL to index.php
1101 &$query: Query string
1102
1103 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1104 $article: article (object) being checked
1105
1106 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1107 $ip: IP being check
1108 $result: Change this value to override the result of wfIsTrustedProxy()
1109
1110 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1111 tance to return false if the domain name doesn't match your organization
1112 $addr: The e-mail address entered by the user
1113 &$result: Set this and return false to override the internal checks
1114
1115 'isValidPassword': Override the result of User::isValidPassword()
1116 $password: The password entered by the user
1117 &$result: Set this and return false to override the internal checks
1118 $user: User the password is being validated for
1119
1120 'Language::getMessagesFileName':
1121 $code: The language code or the language we're looking for a messages file for
1122 &$file: The messages file path, you can override this to change the location.
1123
1124 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1125 remove namespaces. Do not use this hook to add namespaces. Use
1126 CanonicalNamespaces for that.
1127 &$namespaces: Array of namespaces indexed by their numbers
1128
1129 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1130 $wgExtensionMessagesFiles instead.
1131 Use this to define synonyms of magic words depending of the language
1132 $magicExtensions: associative array of magic words synonyms
1133 $lang: laguage code (string)
1134
1135 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1136 listed in $wgExtensionMessagesFiles instead.
1137 Use to define aliases of special pages names depending of the language
1138 $specialPageAliases: associative array of magic words synonyms
1139 $lang: laguage code (string)
1140
1141 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1142 &$names: array of language code => language name
1143 $code language of the preferred translations
1144
1145 'LinkBegin': Used when generating internal and interwiki links in
1146 Linker::link(), before processing starts. Return false to skip default proces-
1147 sing and return $ret. See documentation for Linker::link() for details on the
1148 expected meanings of parameters.
1149 $skin: the Skin object
1150 $target: the Title that the link is pointing to
1151 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1152 fault"
1153 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1154 tive array form, with keys and values unescaped. Should be merged with de-
1155 fault values, with a value of false meaning to suppress the attribute.
1156 &$query: the query string to add to the generated URL (the bit after the "?"),
1157 in associative array form, with keys and values unescaped.
1158 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1159 &$ret: the value to return if your hook returns false.
1160
1161 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1162 just before the function returns a value. If you return true, an <a> element
1163 with HTML attributes $attribs and contents $html will be returned. If you re-
1164 turn false, $ret will be returned.
1165 $skin: the Skin object
1166 $target: the Title object that the link is pointing to
1167 $options: the options. Will always include either 'known' or 'broken', and may
1168 include 'noclasses'.
1169 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1170 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1171 ciative array form.
1172 &$ret: the value to return if your hook returns false.
1173
1174 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1175 before the return
1176 &$url: the image url
1177 &$alt: the image's alt text
1178 &$img: the new image HTML (if returning false)
1179
1180 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1181 before the return
1182 &$url: the link url
1183 &$text: the link text
1184 &$link: the new link HTML (if returning false)
1185 &$attribs: the attributes to be applied.
1186 $linkType: The external link type
1187
1188 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1189 actual update
1190 &$linksUpdate: the LinksUpdate object
1191
1192 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1193 completed
1194 &$linksUpdate: the LinksUpdate object
1195
1196 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1197 &$linksUpdate: the LinksUpdate object
1198
1199 'ListDefinedTags': When trying to find all defined tags.
1200 &$tags: The list of tags.
1201
1202 'LoadExtensionSchemaUpdates': called during database installation and updates
1203 &updater: A DatabaseUpdater subclass
1204
1205 'LocalFile::getHistory': called before file history query performed
1206 $file: the File object
1207 $tables: tables
1208 $fields: select fields
1209 $conds: conditions
1210 $opts: query options
1211 $join_conds: JOIN conditions
1212
1213 'LocalFilePurgeThumbnails': called before thumbnails for a local file a purged
1214 $file: the File object
1215 $archiveName: name of an old file version or false if it's the current one
1216
1217 'LocalisationCacheRecache': Called when loading the localisation data into cache
1218 $cache: The LocalisationCache object
1219 $code: language code
1220 &$alldata: The localisation data from core and extensions
1221
1222 'LogEventsListShowLogExtract': called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage
1223 &$s: html string to show for the log extract
1224 $types: String or Array Log types to show
1225 $page: String or Title The page title to show log entries for
1226 $user: String The user who made the log entries
1227 $param: Associative Array with the following additional options:
1228 - lim Integer Limit of items to show, default is 50
1229 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1230 - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
1231 - msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wfMsgExt and option 'parse'
1232 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset
1233 - wrap String Wrap the message in html (usually something like "&lt;div ...>$1&lt;/div>").
1234 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1235
1236 'LoggableUserIPData': called when IP data for a user action can be logged by extensions like CheckUser.
1237 This is intended for when users do things that do not already create edits or log entries.
1238 $context: The context the of the action, which includes the user and request
1239 $data: Associative array of data for handlers to record. It must include values for:
1240 - 'namespace' Integer namespace for target title (NS_SPECIAL is allowed)
1241 - 'title' Database key string for target title (empty string if not applicable)
1242 - 'pageid' Integer page ID for target title (zero if not applicable)
1243 - 'action' Wikitext string in the same format as an edit summary
1244 - 'comment' Wikitext string in the same format as an edit summary
1245 - 'timestamp' Timestamp when the action occured
1246
1247 'LoginAuthenticateAudit': a login attempt for a valid user account either
1248 succeeded or failed. No return data is accepted; this hook is for auditing only.
1249 $user: the User object being authenticated against
1250 $password: the password being submitted and found wanting
1251 $retval: a LoginForm class constant with authenticateUserData() return
1252 value (SUCCESS, WRONG_PASS, etc)
1253
1254 'LogLine': Processes a single log entry on Special:Log
1255 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1256 logging.log_type database field.
1257 $log_action: string for the type of log action (e.g. 'delete', 'block',
1258 'create2'). Corresponds to logging.log_action database field.
1259 $title: Title object that corresponds to logging.log_namespace and
1260 logging.log_title database fields.
1261 $paramArray: Array of parameters that corresponds to logging.log_params field.
1262 Note that only $paramArray[0] appears to contain anything.
1263 &$comment: string that corresponds to logging.log_comment database field, and
1264 which is displayed in the UI.
1265 &$revert: string that is displayed in the UI, similar to $comment.
1266 $time: timestamp of the log entry (added in 1.12)
1267
1268 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1269 $refreshLinks: RefreshLinks object
1270
1271 'MagicWordwgVariableIDs': When definig new magic words IDs.
1272 $variableIDs: array of strings
1273
1274 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1275 is executed. Ideally, this hook should only be used to add variables that
1276 depend on the current page/request; static configuration should be added
1277 through ResourceLoaderGetConfigVars instead.
1278 &$vars: variable (or multiple variables) to be added into the output
1279 of Skin::makeVariablesScript
1280 $out: The OutputPage which called the hook,
1281 can be used to get the real title
1282
1283 'MarkPatrolled': before an edit is marked patrolled
1284 $rcid: ID of the revision to be marked patrolled
1285 $user: the user (object) marking the revision as patrolled
1286 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1287 needs to be a sysop in order to mark an edit patrolled
1288
1289 'MarkPatrolledComplete': after an edit is marked patrolled
1290 $rcid: ID of the revision marked as patrolled
1291 $user: user (object) who marked the edit patrolled
1292 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1293 must be a sysop to patrol the edit
1294
1295 'MediaWikiPerformAction': Override MediaWiki::performAction().
1296 Use this to do something completely different, after the basic
1297 globals have been set up, but before ordinary actions take place.
1298 $output: $wgOut
1299 $article: $wgArticle
1300 $title: $wgTitle
1301 $user: $wgUser
1302 $request: $wgRequest
1303 $mediaWiki: The $mediawiki object
1304
1305 'MessagesPreLoad': When loading a message from the database
1306 $title: title of the message (string)
1307 $message: value (string), change it to the message you want to define
1308
1309 'MessageCacheReplace': When a message page is changed.
1310 Useful for updating caches.
1311 $title: name of the page changed.
1312 $text: new contents of the page.
1313
1314 'ModifyExportQuery': Modify the query used by the exporter.
1315 $db: The database object to be queried.
1316 &$tables: Tables in the query.
1317 &$conds: Conditions in the query.
1318 &$opts: Options for the query.
1319 &$join_conds: Join conditions for the query.
1320
1321 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1322 been rendered (useful for adding more)
1323 Note: this is only run for the Monobook skin. This hook is deprecated and
1324 may be removed in the future. To add items to the toolbox you should use
1325 the SkinTemplateToolboxEnd hook instead, which works for all
1326 "SkinTemplate"-type skins.
1327 $tools: array of tools
1328
1329 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1330 and returning it for the skin to output. You can add items to the toolbox while
1331 still letting the skin make final decisions on skin-specific markup conventions
1332 using this hook.
1333 &$sk: The BaseTemplate base skin template
1334 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1335 BaseTemplate::makeListItem for details on the format of individual
1336 items inside of this array
1337
1338 'NewRevisionFromEditComplete': called when a revision was inserted
1339 due to an edit
1340 $article: the WikiPage edited
1341 $rev: the new revision
1342 $baseID: the revision ID this was based off, if any
1343 $user: the editing user
1344
1345 'NormalizeMessageKey': Called before the software gets the text of a message
1346 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1347 displayed
1348 &$key: the message being looked up. Change this to something else to change
1349 what message gets displayed (string)
1350 &$useDB: whether or not to look up the message in the database (bool)
1351 &$langCode: the language code to get the message for (string) - or -
1352 whether to use the content language (true) or site language (false) (bool)
1353 &$transform: whether or not to expand variables and templates
1354 in the message (bool)
1355
1356 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1357 &$changeslist: The OldChangesList instance.
1358 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1359 &$rc: The RecentChange object.
1360
1361 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1362 Hooks can alter or append to the array of URLs for search & suggestion formats.
1363 &$urls: array of associative arrays with Url element attributes
1364
1365 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1366 users and/or IP addresses too
1367 $otherBlockLink: An array with links to other block logs
1368 $ip: The requested IP address or username
1369
1370 'OutputPageBeforeHTML': a page has been processed by the parser and
1371 the resulting HTML is about to be displayed.
1372 $parserOutput: the parserOutput (object) that corresponds to the page
1373 $text: the text that will be displayed, in HTML (string)
1374
1375 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1376 tag to allow for extensions to add attributes to the body of the page they might
1377 need. Or to allow building extensions to add body classes that aren't of high
1378 enough demand to be included in core.
1379 $out: The OutputPage which called the hook, can be used to get the real title
1380 $sk: The Skin that called OutputPage::headElement
1381 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1382
1383 'OutputPageCheckLastModified': when checking if the page has been modified
1384 since the last visit
1385 &$modifiedTimes: array of timestamps.
1386 The following keys are set: page, user, epoch
1387
1388 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1389 $out: OutputPage instance (object)
1390 $parserOutput: parserOutput instance being added in $out
1391
1392 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1393 categories. Implementations should return false if they generate the category
1394 links, so the default link generation is skipped.
1395 $out: OutputPage instance (object)
1396 $categories: associative array, keys are category names, values are category
1397 types ("normal" or "hidden")
1398 $links: array, intended to hold the result. Must be an associative array with
1399 category types as keys and arrays of HTML links as values.
1400
1401 'PageContentLanguage': allows changing the language in which the content of
1402 a page is written. Defaults to the wiki content language ($wgContLang).
1403 $title: Title object
1404 &$pageLang: the page content language (either an object or a language code)
1405 $wgLang: the user language
1406
1407 'PageHistoryBeforeList': When a history page list is about to be constructed.
1408 $article: the article that the history is loading for
1409
1410 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1411 $row: the revision row for this line
1412 $s: the string representing this parsed line
1413 $classes: array containing the <li> element classes
1414
1415 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1416 is constructed
1417 $pager: the pager
1418 $queryInfo: the query parameters
1419
1420 'PageRenderingHash': alter the parser cache option hash key
1421 A parser extension which depends on user options should install
1422 this hook and append its values to the key.
1423 $hash: reference to a hash key string which can be modified
1424
1425 'ParserAfterStrip': Same as ParserBeforeStrip
1426
1427 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1428 $parser: Parser object being used
1429 $text: text that'll be returned
1430
1431 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1432 $parser: Parser object
1433 $text: text to parse
1434 $stripState: StripState instance being used
1435
1436 'ParserBeforeStrip': Called at start of parsing time
1437 (no more strip, deprecated ?)
1438 $parser: parser object
1439 $text: text being parsed
1440 $stripState: stripState used (object)
1441
1442 'ParserBeforeTidy': called before tidy and custom tags replacements
1443 $parser: Parser object being used
1444 $text: actual text
1445
1446 'ParserClearState': called at the end of Parser::clearState()
1447 $parser: Parser object being cleared
1448
1449 'ParserFirstCallInit': called when the parser initialises for the first time
1450 &$parser: Parser object being cleared
1451
1452 'ParserGetVariableValueSwitch': called when the parser need the value of a
1453 custom magic word
1454 $parser: Parser object
1455 $varCache: array to store the value in case of multiples calls of the
1456 same magic word
1457 $index: index (string) of the magic
1458 $ret: value of the magic word (the hook should set it)
1459 $frame: PPFrame object to use for expanding any template variables
1460
1461 'ParserGetVariableValueTs': use this to change the value of the time for the
1462 {{LOCAL...}} magic word
1463 $parser: Parser object
1464 $time: actual time (timestamp)
1465
1466 'ParserGetVariableValueVarCache': use this to change the value of the
1467 variable cache or return false to not use it
1468 $parser: Parser object
1469 $varCache: varaiable cache (array)
1470
1471 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1472 include comments about size of the text parsed
1473 $parser: Parser object
1474 $limitReport: text that will be included (without comment tags)
1475
1476 'ParserMakeImageParams': Called before the parser make an image link, use this
1477 to modify the parameters of the image.
1478 $title: title object representing the file
1479 $file: file object that will be used to create the image
1480 &$params: 2-D array of parameters
1481 $parser: Parser object that called the hook
1482
1483 'ParserSectionCreate': Called each time the parser creates a document section
1484 from wikitext. Use this to apply per-section modifications to HTML (like
1485 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1486 can begin in one section and end in another. Make sure your code can handle
1487 that case gracefully. See the EditSectionClearerLink extension for an
1488 example.
1489 $parser: the calling Parser instance
1490 $section: the section number, zero-based, but section 0 is usually empty
1491 &$sectionContent: ref to the content of the section. modify this.
1492 $showEditLinks: boolean describing whether this section has an edit link
1493
1494 'ParserTestParser': called when creating a new instance of Parser in
1495 maintenance/parserTests.inc
1496 $parser: Parser object created
1497
1498 'ParserTestTables': alter the list of tables to duplicate when parser tests
1499 are run. Use when page save hooks require the presence of custom tables
1500 to ensure that tests continue to run properly.
1501 &$tables: array of table names
1502
1503 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1504 my talk page, my contributions" etc).
1505 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1506 &$title: Title object representing the current page
1507
1508 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1509 &$user : User performing the action
1510 $action : Action being performed
1511 &$result : Whether or not the action should be prevented
1512 Change $result and return false to give a definitive answer, otherwise
1513 the built-in rate limiting checks are used, if enabled.
1514
1515 'PlaceNewSection': Override placement of new sections.
1516 $wikipage : WikiPage object
1517 $oldtext : the text of the article before editing
1518 $subject : subject of the new section
1519 &$text : text of the new section
1520 Return false and put the merged text into $text to override the default behavior.
1521
1522 'PreferencesGetLegend': Override the text used for the <legend> of a preferences section
1523 $form: the PreferencesForm object. This is a ContextSource as well
1524 $key: the section name
1525 &$legend: the legend text. Defaults to wfMsg( "prefs-$key" ) but may be overridden
1526
1527 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1528 AJAX search suggestions. Put results into &$results outparam and return false.
1529 $ns : array of int namespace keys to search in
1530 $search : search term (not guaranteed to be conveniently normalized)
1531 $limit : maximum number of results to return
1532 &$results : out param: array of page names (strings)
1533
1534 'PrefsEmailAudit': called when user changes his email address
1535 $user: User (object) changing his email address
1536 $oldaddr: old email address (string)
1537 $newaddr: new email address (string)
1538
1539 'PrefsPasswordAudit': called when user changes his password
1540 $user: User (object) changing his passoword
1541 $newPass: new password
1542 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1543
1544 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1545 $article: the title being (un)protected
1546 $output: a string of the form HTML so far
1547
1548 'ProtectionForm::save': called when a protection form is submitted
1549 $article: the title being (un)protected
1550 $errorMsg: an html message string of an error or an array of message name and its parameters
1551
1552 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1553 $article: the page the form is shown for
1554 $out: OutputPage object
1555
1556 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1557 &$obj: RawPage object
1558 &$text: The text that's going to be the output
1559
1560 'RecentChange_save': called at the end of RecentChange::save()
1561 $recentChange: RecentChange object
1562
1563 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin instance.
1564 Can be used by an extension override what skin is used in certain contexts.
1565 IContextSource $context: The RequestContext the skin is being created for.
1566 &$skin: A variable reference you may set a Skin instance or string key on to override the skin that will be used for the context.
1567
1568 'ResourceLoaderGetConfigVars': called at the end of
1569 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1570 configuration variables to JavaScript. Things that depend on the current
1571 page/request state must be added through MakeGlobalVariablesScript instead.
1572 &$vars: array( variable name => value )
1573
1574 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1575 to add modules to the startup module. This hook should be used sparingly since any module added here
1576 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1577 scripts.
1578
1579 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1580 loader request or generating HTML output.
1581 &$resourceLoader: ResourceLoader object
1582
1583 'ResourceLoaderTestModules': let you add new JavaScript testing modules. This is called after the addition of 'qunit' and MediaWiki testing resources.
1584 &testModules: array of JavaScript testing modules. The 'qunit' framework, included in core, is fed using tests/qunit/QUnitTestResources.php.
1585 &ResourceLoader object
1586 To add a new qunit module named 'myext.tests':
1587 testModules['qunit']['myext.tests'] = array(
1588 'script' => 'extension/myext/tests.js',
1589 'dependencies' => <any module dependency you might have>
1590 );
1591 For qunit framework, the mediawiki.tests.qunit.testrunner dependency will be added to any module.
1592
1593 'RevisionInsertComplete': called after a revision is inserted into the DB
1594 &$revision: the Revision
1595 $data: the data stored in old_text. The meaning depends on $flags: if external
1596 is set, it's the URL of the revision text in external storage; otherwise,
1597 it's the revision text itself. In either case, if gzip is set, the revision
1598 text is gzipped.
1599 $flags: a comma-delimited list of strings representing the options used. May
1600 include: utf8 (this will always be set for new revisions); gzip; external.
1601
1602 'SearchUpdate': Prior to search update completion
1603 $id : Page id
1604 $namespace : Page namespace
1605 $title : Page title
1606 $text : Current text being indexed
1607
1608 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1609 $allSearchTerms : Array of the search terms in all content languages
1610 &$titleResult : Outparam; the value to return. A Title object or null.
1611
1612 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1613 $term : Search term string
1614 &$title : Outparam; set to $title object and return false for a match
1615
1616 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1617 $term : Search term string
1618 &$title : Current Title object that is being returned (null if none found).
1619
1620 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1621 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1622 in the $searchEngine->namespaces array.
1623 $query : Original query.
1624 &$parsed : Resultant query with the prefixes stripped.
1625
1626 'SearchableNamespaces': An option to modify which namespaces are searchable.
1627 &$arr : Array of namespaces ($nsId => $name) which will be used.
1628
1629 'SetupAfterCache': Called in Setup.php, after cache objects are set
1630
1631 'ShowMissingArticle': Called when generating the output for a non-existent page
1632 $article: The article object corresponding to the page
1633
1634 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1635 $text: Text being shown
1636 $title: Title of the custom script/stylesheet page
1637 $output: Current OutputPage object
1638
1639 'ShowSearchHitTitle': Customise display of search hit title/link.
1640 &$title: Title to link to
1641 &$text: Text to use for the link
1642 $result: The search result
1643 $terms: The search terms entered
1644 $page: The SpecialSearch object.
1645
1646 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1647 &$siteNotice: HTML returned as the sitenotice
1648 $skin: Skin object
1649 Return true to allow the normal method of notice selection/rendering to work,
1650 or change the value of $siteNotice and return false to alter it.
1651
1652 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1653 &$siteNotice: HTML sitenotice
1654 $skin: Skin object
1655 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1656
1657 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1658 $skin: Skin object
1659 &$text: bottomScripts Text
1660 Append to $text to add additional text/scripts after the stock bottom scripts.
1661
1662 'SkinAfterContent': Allows extensions to add text after the page content and
1663 article metadata.
1664 &$data: (string) Text to be printed out directly (without parsing)
1665 $skin: Skin object
1666 This hook should work in all skins. Just set the &$data variable to the text
1667 you're going to add.
1668
1669 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1670 $skin: Skin object
1671 &$bar: Sidebar contents
1672 Modify $bar to add or modify sidebar portlets.
1673
1674 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1675 $title: displayed page title
1676 $type: 'normal' or 'history' for old/diff views
1677 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1678 &$link: overridable HTML link to be passed into the message as $1
1679 &$forContent: overridable flag if copyright footer is shown in content language.
1680
1681 'SkinGetPoweredBy'
1682 &$text: additional 'powered by' icons in HTML.
1683 Note: Modern skin does not use the MediaWiki icon but plain text instead
1684 $skin: Skin object
1685
1686 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1687 &$subpages: Subpage links HTML
1688 $skin: Skin object
1689 $out: OutputPage object
1690 If false is returned $subpages will be used instead of the HTML
1691 subPageSubtitle() generates.
1692 If true is returned, $subpages will be ignored and the rest of
1693 subPageSubtitle() will run.
1694
1695 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1696 "permanent link" tab
1697 $sktemplate: SkinTemplate object
1698 $nav_urls: array of tabs
1699
1700 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1701 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1702 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1703 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1704 &$sktemplate: SkinTemplate object
1705 &$links: Structured navigation links
1706 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1707
1708 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1709 starts page output
1710 &$sktemplate: SkinTemplate object
1711 &$tpl: Template engine object
1712
1713 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1714 $sktemplate: SkinTemplate object
1715 $res: set to true to prevent active tabs
1716
1717 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1718 You can either create your own array, or alter the parameters for
1719 the normal one.
1720 &$sktemplate: The SkinTemplate instance.
1721 $title: Title instance for the page.
1722 $message: Visible label of tab.
1723 $selected: Whether this is a selected tab.
1724 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1725 &$classes: Array of CSS classes to apply.
1726 &$query: Query string to add to link.
1727 &$text: Link text.
1728 &$result: Complete assoc. array if you want to return true.
1729
1730 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1731 been rendered (useful for adding more)
1732 $sk: The QuickTemplate based skin template running the hook.
1733 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
1734 extensions that add support for BaseTemplateToolbox should watch for this dummy
1735 parameter with "$dummy=false" in their code and return without echoing any html
1736 to avoid creating duplicate toolbox items.
1737
1738 'SoftwareInfo': Called by Special:Version for returning information about
1739 the software
1740 $software: The array of software in format 'name' => 'version'.
1741 See SpecialVersion::softwareInformation()
1742
1743 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1744 $id: User identifier
1745
1746 'SpecialListusersDefaultQuery': called right before the end of
1747 UsersPager::getDefaultQuery()
1748 $pager: The UsersPager instance
1749 $query: The query array to be returned
1750
1751 'SpecialListusersFormatRow': called right before the end of
1752 UsersPager::formatRow()
1753 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1754 $row: Database row object
1755
1756 'SpecialListusersHeader': called before closing the <fieldset> in
1757 UsersPager::getPageHeader()
1758 $pager: The UsersPager instance
1759 $out: The header HTML
1760
1761 'SpecialListusersHeaderForm': called before adding the submit button in
1762 UsersPager::getPageHeader()
1763 $pager: The UsersPager instance
1764 $out: The header HTML
1765
1766 'SpecialListusersQueryInfo': called right before the end of
1767 UsersPager::getQueryInfo()
1768 $pager: The UsersPager instance
1769 $query: The query array to be returned
1770
1771 'SpecialMovepageAfterMove': called after moving a page
1772 $movePage: MovePageForm object
1773 $oldTitle: old title (object)
1774 $newTitle: new title (object)
1775
1776 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1777 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1778 $opts: FormOptions object containing special page options
1779 &$conds: array of WHERE conditionals for query
1780 &tables: array of tables to be queried
1781 &$fields: array of columns to select
1782 &$join_conds: join conditions for the tables
1783
1784 'SpecialNewPagesFilters': called after building form options at NewPages
1785 $special: the special page object
1786 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1787 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1788
1789 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1790 hook to remove a core special page
1791 $list: list (array) of core special pages
1792
1793 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1794 $users: array of User objects
1795 $data: array of data submitted by the user
1796 &$error: string, error code (message name) used to describe to error (out paramater).
1797 The hook needs to return false when setting this, otherwise it will have no effect.
1798
1799 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1800 use this to change some selection criteria or substitute a different title
1801 &$randstr: The random number from wfRandom()
1802 &$isRedir: Boolean, whether to select a redirect or non-redirect
1803 &$namespaces: An array of namespace indexes to get the title from
1804 &$extra: An array of extra SQL statements
1805 &$title: If the hook returns false, a Title object to use instead of the
1806 result from the normal query
1807
1808 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1809 $special: the special page object
1810 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1811 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1812
1813 'SpecialRecentChangesPanel': called when building form options in
1814 SpecialRecentChanges
1815 &$extraOpts: array of added items, to which can be added
1816 $opts: FormOptions for this request
1817
1818 'SpecialRecentChangesQuery': called when building sql query for
1819 SpecialRecentChanges and SpecialRecentChangesLinked
1820 &$conds: array of WHERE conditionals for query
1821 &$tables: array of tables to be queried
1822 &$join_conds: join conditions for the tables
1823 $opts: FormOptions for this request
1824 &$query_options: array of options for the database request
1825 &$select: Array of columns to select
1826
1827 'SpecialSearchCreateLink': called when making the message to create a page or
1828 go to the existing page
1829 $t: title object searched for
1830 &$params: an array of the default message name and page title (as parameter)
1831
1832 'SpecialSearchGo': called when user clicked the "Go"
1833 &$title: title object generated from the text entered by the user
1834 &$term: the search term entered by the user
1835
1836 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1837 target doesn't exist
1838 &$title: title object generated from the text entered by the user
1839
1840 'SpecialSearchPowerBox': the equivalent of SpecialSearchProfileForm for
1841 the advanced form, a.k.a. power search box
1842 &$showSections: an array to add values with more options to
1843 $term: the search term (not a title object)
1844 $opts: an array of hidden options (containing 'redirs' and 'profile')
1845
1846 'SpecialSearchProfiles': allows modification of search profiles
1847 &$profiles: profiles, which can be modified.
1848
1849 'SpecialSearchProfileForm': allows modification of search profile forms
1850 $search: special page object
1851 &$form: String: form html
1852 $profile: String: current search profile
1853 $term: String: search term
1854 $opts: Array: key => value of hidden options for inclusion in custom forms
1855
1856 'SpecialSearchSetupEngine': allows passing custom data to search engine
1857 $search: special page object
1858 $profile: String: current search profile
1859 $engine: the search engine
1860
1861 'SpecialSearchResults': called before search result display when there
1862 are matches
1863 $term: string of search term
1864 &$titleMatches: empty or SearchResultSet object
1865 &$textMatches: empty or SearchResultSet object
1866
1867 'SpecialSearchNoResults': called before search result display when there are
1868 no matches
1869 $term: string of search term
1870
1871 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1872 &$extraStats: Array to save the new stats
1873 ( $extraStats['<name of statistic>'] => <value>; )
1874
1875 'SpecialUploadComplete': Called after successfully uploading a file from
1876 Special:Upload
1877 $form: The SpecialUpload object
1878
1879 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1880 use this to change the tables headers
1881 $extTypes: associative array of extensions types
1882
1883 'SpecialWatchlistFilters': called after building form options at Watchlist
1884 $special: the special page object
1885 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1886 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1887
1888 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1889 &$conds: array of WHERE conditionals for query
1890 &$tables: array of tables to be queried
1891 &$join_conds: join conditions for the tables
1892 &$fields: array of query fields
1893
1894 'TestCanonicalRedirect': called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. Gives a chance for extensions that alter page view behavior radically to abort that redirect or handle it manually.
1895 $request: WebRequest
1896 $title: Title of the currently found title obj
1897 $output: OutputPage object
1898
1899 'TitleArrayFromResult': called when creating an TitleArray object from a
1900 database result
1901 &$titleArray: set this to an object to override the default object returned
1902 $res: database result used to create the object
1903
1904 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1905 that can be applied.
1906 $title: The title in question.
1907 &$types: The types of protection available.
1908
1909 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1910 $title: Title object that is being checked
1911 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
1912
1913 'TitleIsAlwaysKnown': Called when determining if a page exists.
1914 Allows overriding default behaviour for determining if a page exists.
1915 If $isKnown is kept as null, regular checks happen. If it's a boolean, this value is returned by the isKnown method.
1916 $title: Title object that is being checked
1917 $result: Boolean|null; whether MediaWiki currently thinks this page is known
1918
1919 'TitleIsMovable': Called when determining if it is possible to move a page.
1920 Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
1921 $title: Title object that is being checked
1922 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
1923
1924 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
1925 be handled by seperate handler (via ArticleViewCustom)
1926 $title: Title object that is being checked
1927 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
1928
1929 'TitleMoveComplete': after moving an article (title)
1930 $old: old title
1931 $nt: new title
1932 $user: user who did the move
1933 $pageid: database ID of the page that's been moved
1934 $redirid: database ID of the created redirect
1935
1936 'TitleReadWhitelist': called at the end of read permissions checks, just before
1937 adding the default error message if nothing allows the user to read the page.
1938 If a handler wants a title to *not* be whitelisted, it should also return false.
1939 $title: Title object being checked against
1940 $user: Current user object
1941 &$whitelisted: Boolean value of whether this title is whitelisted
1942
1943 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1944 PageArchive object has been created but before any further processing is done.
1945 &$archive: PageArchive object
1946 $title: Title object of the page that we're viewing
1947
1948 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1949 PageArchive object has been created but before any further processing is done.
1950 &$archive: PageArchive object
1951 $title: Title object of the page that we're viewing
1952
1953 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1954 the site is not in read-only mode, that the Title object is not null and after
1955 a PageArchive object has been constructed but before performing any further
1956 processing.
1957 &$archive: PageArchive object
1958 $title: Title object of the page that we're about to undelete
1959
1960 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1961 $title: title object related to the revision
1962 $rev: revision (object) that will be viewed
1963
1964 'UnknownAction': An unknown "action" has occured (useful for defining
1965 your own actions)
1966 $action: action name
1967 $article: article "acted on"
1968
1969 'UnitTestsList': Called when building a list of files with PHPUnit tests
1970 &$files: list of files
1971
1972 'UnwatchArticle': before a watch is removed from an article
1973 $user: user watching
1974 $page: WikiPage object to be removed
1975
1976 'UnwatchArticleComplete': after a watch is removed from an article
1977 $user: user that watched
1978 $page: WikiPage object that was watched
1979
1980 'UploadForm:initial': before the upload form is generated
1981 $form: UploadForm object
1982 You might set the member-variables $uploadFormTextTop and
1983 $uploadFormTextAfterSummary to inject text (HTML) either before
1984 or after the editform.
1985
1986 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1987 $form: UploadForm object
1988 Lets you poke at member variables like $mUploadDescription before the
1989 file is saved.
1990 Do not use this hook to break upload processing. This will return the user to
1991 a blank form with no error message; use UploadVerification and
1992 UploadVerifyFile instead
1993
1994 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1995 $type: (string) the requested upload type
1996 &$className: the class name of the Upload instance to be created
1997
1998 'UploadComplete': when Upload completes an upload
1999 &$upload: an UploadBase child instance
2000
2001 'UploadFormInitDescriptor': after the descriptor for the upload form as been
2002 assembled
2003 $descriptor: (array) the HTMLForm descriptor
2004
2005 'UploadFormSourceDescriptors': after the standard source inputs have been
2006 added to the descriptor
2007 $descriptor: (array) the HTMLForm descriptor
2008
2009 'UploadVerification': additional chances to reject an uploaded file. Consider
2010 using UploadVerifyFile instead.
2011 string $saveName: destination file name
2012 string $tempName: filesystem path to the temporary file for checks
2013 string &$error: output: message key for message to show if upload canceled
2014 by returning false. May also be an array, where the first element
2015 is the message key and the remaining elements are used as parameters to
2016 the message.
2017
2018 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2019 in most cases over UploadVerification.
2020 object $upload: an instance of UploadBase, with all info about the upload
2021 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
2022 will typically only apply for specific mime types.
2023 object &$error: output: true if the file is valid. Otherwise, an indexed array
2024 representing the problem with the file, where the first element
2025 is the message key and the remaining elements are used as parameters to
2026 the message.
2027
2028 'UploadComplete': Upon completion of a file upload
2029 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2030 $uploadBase->getLocalFile().
2031
2032 'User::mailPasswordInternal': before creation and mailing of a user's new
2033 temporary password
2034 $user: the user who sent the message out
2035 $ip: IP of the user who sent the message out
2036 $u: the account whose new password will be set
2037
2038 'UserAddGroup': called when adding a group; return false to override
2039 stock group addition.
2040 $user: the user object that is to have a group added
2041 &$group: the group to add, can be modified
2042
2043 'UserArrayFromResult': called when creating an UserArray object from a
2044 database result
2045 &$userArray: set this to an object to override the default object returned
2046 $res: database result used to create the object
2047
2048 'userCan': To interrupt/advise the "user can do X to Y article" check.
2049 If you want to display an error message, try getUserPermissionsErrors.
2050 $title: Title object being checked against
2051 $user : Current user object
2052 $action: Action being checked
2053 $result: Pointer to result returned if hook returns false. If null is returned,
2054 userCan checks are continued by internal code.
2055
2056 'UserCanSendEmail': To override User::canSendEmail() permission check
2057 $user: User (object) whose permission is being checked
2058 &$canSend: bool set on input, can override on output
2059
2060 'UserClearNewTalkNotification': called when clearing the
2061 "You have new messages!" message, return false to not delete it
2062 $user: User (object) that'll clear the message
2063
2064 'UserComparePasswords': called when checking passwords, return false to
2065 override the default password checks
2066 &$hash: String of the password hash (from the database)
2067 &$password: String of the plaintext password the user entered
2068 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2069 supplied
2070 &$result: If the hook returns false, this Boolean value will be checked to
2071 determine if the password was valid
2072
2073 'UserCreateForm': change to manipulate the login form
2074 $template: SimpleTemplate instance for the form
2075
2076 'UserCryptPassword': called when hashing a password, return false to implement
2077 your own hashing method
2078 &$password: String of the plaintext password to encrypt
2079 &$salt: String of the password salt or Boolean false if no salt is provided
2080 &$wgPasswordSalt: Boolean of whether the salt is used in the default
2081 hashing method
2082 &$hash: If the hook returns false, this String will be used as the hash
2083
2084 'UserEffectiveGroups': Called in User::getEffectiveGroups()
2085 $user: User to get groups for
2086 &$groups: Current effective groups
2087
2088 'UserGetAllRights': after calculating a list of all available rights
2089 &$rights: Array of rights, which may be added to.
2090
2091 'UserGetDefaultOptions': after fetching the core default, this hook is ran
2092 right before returning the options to the caller. WARNING: this hook is
2093 called for every call to User::getDefaultOptions(), which means it's
2094 potentially called dozens or hundreds of times. You may want to cache
2095 the results of non-trivial operations in your hook function for this reason.
2096 &$defaultOptions: Array of preference keys and their default values.
2097
2098 'UserGetEmail': called when getting an user email address
2099 $user: User object
2100 &$email: email, change this to override local email
2101
2102 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
2103 email authentification
2104 $user: User object
2105 &$timestamp: timestamp, change this to override local email authentification
2106 timestamp
2107
2108 'UserGetImplicitGroups': Called in User::getImplicitGroups()
2109 &$groups: List of implicit (automatically-assigned) groups
2110
2111 'UserGetLanguageObject': Called when getting user's interface language object
2112 $user: User object
2113 &$code: Langauge code that will be used to create the object
2114
2115 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2116 &$reservedUsernames: $wgReservedUsernames
2117
2118 'UserGetRights': Called in User::getRights()
2119 $user: User to get rights for
2120 &$rights: Current rights
2121
2122 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
2123 exemptions).
2124 $user: User in question
2125 $title: Title of the page in question
2126 &$blocked: Out-param, whether or not the user is blocked from that page.
2127 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2128 own user talk pages.
2129
2130 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2131 &$user: User object
2132 $ip: User's IP address
2133 &$blocked: Whether the user is blocked, to be modified by the hook
2134
2135 'UserLoadAfterLoadFromSession': called to authenticate users on
2136 external/environmental means; occurs after session is loaded
2137 $user: user object being loaded
2138
2139 'UserLoadDefaults': called when loading a default user
2140 $user: user object
2141 $name: user name
2142
2143 'UserLoadFromDatabase': called when loading a user from the database
2144 $user: user object
2145 &$s: database query object
2146
2147 'UserLoadFromSession': called to authenticate users on external/environmental
2148 means; occurs before session is loaded
2149 $user: user object being loaded
2150 &$result: set this to a boolean value to abort the normal authentification
2151 process
2152
2153 'UserLoadOptions': when user options/preferences are being loaded from
2154 the database.
2155 $user: User object
2156 &$options: Options, can be modified.
2157
2158 'UserLoginComplete': after a user has logged in
2159 $user: the user object that was created on login
2160 $inject_html: Any HTML to inject after the "logged in" message.
2161
2162 'UserLoginForm': change to manipulate the login form
2163 $template: SimpleTemplate instance for the form
2164
2165 'UserLogout': before a user logs out
2166 $user: the user object that is about to be logged out
2167
2168 'UserLogoutComplete': after a user has logged out
2169 $user: the user object _after_ logout (won't have name, ID, etc.)
2170 $inject_html: Any HTML to inject after the "logged out" message.
2171 $oldName: name of the user before logout (string)
2172
2173 'UserRemoveGroup': called when removing a group; return false to override
2174 stock group removal.
2175 $user: the user object that is to have a group removed
2176 &$group: the group to be removed, can be modified
2177
2178 'UserRights': After a user's group memberships are changed
2179 $user : User object that was changed
2180 $add : Array of strings corresponding to groups added
2181 $remove: Array of strings corresponding to groups removed
2182
2183 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2184 message(s)
2185 $user: user retrieving new talks messages
2186 $talks: array of new talks page(s)
2187
2188 'UserSaveSettings': called when saving user settings
2189 $user: User object
2190
2191 'UserSaveOptions': Called just before saving user preferences/options.
2192 $user: User object
2193 &$options: Options, modifiable
2194
2195 'UserSetCookies': called when setting user cookies
2196 $user: User object
2197 &$session: session array, will be added to $_SESSION
2198 &$cookies: cookies array mapping cookie name to its value
2199
2200 'UserSetEmail': called when changing user email address
2201 $user: User object
2202 &$email: new email, change this to override new email address
2203
2204 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2205 of email authentification
2206 $user: User object
2207 &$timestamp: new timestamp, change this to override local email
2208 authentification timestamp
2209
2210 'UserToolLinksEdit': Called when generating a list of user tool links, eg "Foobar (Talk | Contribs | Block)"
2211 $userId: User id of the current user
2212 $userText: User name of the current user
2213 &$items: Array of user tool links as HTML fragments
2214
2215 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2216 used to alter the SQL query which gets the list of wanted pages
2217 &$wantedPages: WantedPagesPage object
2218 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2219
2220 'WatchArticle': before a watch is added to an article
2221 $user: user that will watch
2222 $page: WikiPage object to be watched
2223
2224 'WatchArticleComplete': after a watch is added to an article
2225 $user: user that watched
2226 $page: WikiPage object watched
2227
2228 'WatchlistEditorBuildRemoveLine': when building remove lines in
2229 Special:Watchlist/edit
2230 &$tools: array of extra links
2231 $title: Title object
2232 $redirect: whether the page is a redirect
2233 $skin: Skin object
2234
2235 'WebRequestPathInfoRouter': While building the PathRouter to parse the REQUEST_URI.
2236 $router: The PathRouter instance
2237
2238 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2239 dumps
2240 One, and only one hook should set this, and return false.
2241 &$tables: Database tables to use in the SELECT query
2242 &$opts: Options to use for the query
2243 &$join: Join conditions
2244
2245 'wfShellMaintenanceCmd': Called when generating a shell-escaped command line
2246 string to run a maintenance script.
2247 &$script: MediaWiki maintenance script path
2248 &$parameters: Array of arguments and options to the script
2249 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2250 keys
2251
2252 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2253 query pages to be updated with maintenance/updateSpecialPages.php
2254 $query: $wgQueryPages itself
2255
2256 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2257 metadata to be added.
2258 $obj: The XmlDumpWriter object.
2259 &$out: The output string.
2260 $row: The database row for the page.
2261 $title: The title of the page.
2262
2263 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2264 metadata.
2265 $obj: The XmlDumpWriter object.
2266 &$out: The text being output.
2267 $row: The database row for the revision.
2268 $text: The revision text.
2269
2270 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2271 additional tags to extract.
2272 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2273
2274 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2275 used to post-process the results.
2276 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2277 metadata tags returned (each tag is either a value, or an array of values).
2278
2279 More hooks might be available but undocumented, you can execute
2280 ./maintenance/findhooks.php to find hidden one.