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