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