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