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