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