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