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