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