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