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,
238 where normally authentication against an external auth plugin would be creating
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
253 $rc: The current RecentChange object.
255 'AbortLogin': Return false to cancel account login.
256 $user: the User object being authenticated against
257 $password: the password being submitted, not yet checked for validity
258 &$retval: a LoginForm class constant to return from authenticateUserData();
259 default is LoginForm::ABORTED. Note that the client may be using
260 a machine API rather than the HTML user interface.
261 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
263 'AbortMove': Allows to abort moving an article (title).
266 $user: user who is doing the move
268 $reason: the reason for the move (added in 1.13)
270 'AbortNewAccount': Return false to cancel explicit account creation.
271 $user: the User object about to be created (read-only, incomplete)
272 &$msg: out parameter: HTML to display on abort
273 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
274 Create the object with Status::newFatal() to ensure proper API error messages
275 are returned when creating account through API clients.
277 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
278 $targetUser: the user whom to send talk page email notification
279 $title: the page title
281 'SendWatchlistEmailNotification': Return true to send watchlist email notification
282 $targetUser: the user whom to send watchlist email notification
283 $title: the page title
284 $enotif: EmailNotification object
286 'AbortChangePassword': Return false to cancel password change.
287 $user: the User object to which the password change is occuring
288 $mOldpass: the old password provided by the user
289 $newpass: the new password provided by the user
290 &$abortMsg: the message identifier for abort reason
292 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
293 $name: name of the action
294 &$form: HTMLForm object
295 $article: Article object
297 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
298 Allows to change the fields on the form that will be generated.
299 $name: name of the action
300 &$fields: HTMLForm descriptor array
301 $article: Article object
303 'AddNewAccount': After a user account is created.
304 $user: the User object that was created. (Parameter added in 1.7)
305 $byEmail: true when account was created "by email" (added in 1.12)
307 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
308 $apiModule: the ApiCreateAccount module calling
309 $loginForm: the LoginForm used
311 'AddNewAccountApiResult': Modify API output when creating a new account via API.
312 $apiModule: the ApiCreateAccount module calling
313 $loginForm: the LoginForm used
314 &$result: associative array for API result data
316 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
317 before OutputPage::sendCacheControl() and final ob_end_flush() which
318 will send the buffered output to the client. This allows for last-minute
319 modification of the output within the buffer by using ob_get_clean().
320 $output: The OutputPage object where output() was called
322 'AfterImportPage': When a page import is completed.
323 $title: Title under which the revisions were imported
324 $origTitle: Title provided by the XML file
325 $revCount: Number of revisions in the XML file
326 $sRevCount: Number of successfully imported revisions
327 $pageInfo: associative array of page information
329 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
330 just before adding its HTML to parser output.
331 $parser: Parser object that called the hook
332 $ig: Gallery, an object of one of the gallery classes (inheriting from
334 $html: HTML generated by the gallery
336 'AlternateEdit': Before checking if a user can edit a page and before showing
337 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
338 $editPage: the EditPage object
340 'AlternateEditPreview': Before generating the preview of the page when editing
341 ( EditPage::getPreviewText() ).
342 $editPage: the EditPage object
343 &$content: the Content object for the text field from the edit page
344 &$previewHTML: Text to be placed into the page for the preview
345 &$parserOutput: the ParserOutput object for the preview
346 return false and set $previewHTML and $parserOutput to output custom page
349 'AlternateUserMailer': Called before mail is sent so that mail could be logged
350 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
351 the regular method of sending mail. Return a string to return a php-mail-error
352 message containing the error. Returning true will continue with sending email
354 $headers: Associative array of headers for the email
355 $to: MailAddress object or array
357 $subject: Subject of the email
358 $body: Body of the message
360 'APIAfterExecute': After calling the execute() method of an API module. Use
361 this to extend core API modules.
362 &$module: Module object
364 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
365 &$main: ApiMain object
367 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
368 authenticate and authorize API clients before executing the module. Return
369 false and set a message to cancel the request.
370 $module: Module object
372 &$message: API usage message to die with, as a message key or array
373 as accepted by ApiBase::dieUsageMsg.
375 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
376 processing request parameters. Return false to let the request fail, returning
377 an error message or an <edit result="Failure"> tag if $resultArr was filled.
378 $editPage : the EditPage object
379 $text : the new text of the article (has yet to be saved)
380 &$resultArr : data in this array will be added to the API result
382 'APIGetAllowedParams': Use this hook to modify a module's parameters.
383 &$module: ApiBase Module object
384 &$params: Array of parameters
385 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
387 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
388 Use this hook to modify a module's description.
389 &$module: ApiBase Module object
390 &$desc: String description, or array of description strings
392 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
393 $module: ApiBase Module object
394 &$msg: Array of Message objects
396 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages instead.
397 Use this hook to modify a module's parameter descriptions.
398 &$module: ApiBase Module object
399 &$desc: Array of parameter descriptions
401 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter descriptions.
402 $module: ApiBase Module object
403 &$msg: Array of arrays of Message objects
405 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
406 $module: ApiBase Module object
407 &$help: Array of HTML strings to be joined for the output.
408 $options: Array Options passed to ApiHelp::getHelp
410 'APIQueryAfterExecute': After calling the execute() method of an
411 action=query submodule. Use this to extend core API modules.
412 &$module: Module object
414 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
415 an action=query submodule. Use this to extend core API modules.
416 &$module: Module object
417 &$resultPageSet: ApiPageSet object
419 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
420 Use this hook to add custom tokens to prop=info. Every token has an action,
421 which will be used in the intoken parameter and in the output
422 (actiontoken="..."), and a callback function which should return the token, or
423 false if the user isn't allowed to obtain it. The prototype of the callback
424 function is func($pageid, $title), where $pageid is the page ID of the page the
425 token is requested for and $title is the associated Title object. In the hook,
426 just add your callback to the $tokenFunctions array and return true (returning
427 false makes no sense).
428 $tokenFunctions: array(action => callback)
430 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
431 Use this hook to add custom tokens to prop=revisions. Every token has an
432 action, which will be used in the rvtoken parameter and in the output
433 (actiontoken="..."), and a callback function which should return the token, or
434 false if the user isn't allowed to obtain it. The prototype of the callback
435 function is func($pageid, $title, $rev), where $pageid is the page ID of the
436 page associated to the revision the token is requested for, $title the
437 associated Title object and $rev the associated Revision object. In the hook,
438 just add your callback to the $tokenFunctions array and return true (returning
439 false makes no sense).
440 $tokenFunctions: array(action => callback)
442 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
443 Use this hook to add custom tokens to list=recentchanges. Every token has an
444 action, which will be used in the rctoken parameter and in the output
445 (actiontoken="..."), and a callback function which should return the token, or
446 false if the user isn't allowed to obtain it. The prototype of the callback
447 function is func($pageid, $title, $rc), where $pageid is the page ID of the
448 page associated to the revision the token is requested for, $title the
449 associated Title object and $rc the associated RecentChange object. In the
450 hook, just add your callback to the $tokenFunctions array and return true
451 (returning false makes no sense).
452 $tokenFunctions: array(action => callback)
454 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
455 sites general information.
456 $module: the current ApiQuerySiteInfo module
457 &$results: array of results, add things here
459 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
460 sites statistics information.
461 &$results: array of results, add things here
463 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
464 action=query&meta=tokens. Note that most modules will probably be able to use
465 the 'csrf' token instead of creating their own token types.
466 &$salts: array( type => salt to pass to User::getEditToken() )
468 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
469 Use this hook to add custom token to list=users. Every token has an action,
470 which will be used in the ustoken parameter and in the output
471 (actiontoken="..."), and a callback function which should return the token, or
472 false if the user isn't allowed to obtain it. The prototype of the callback
473 function is func($user) where $user is the User object. In the hook, just add
474 your callback to the $tokenFunctions array and return true (returning false
476 $tokenFunctions: array(action => callback)
478 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
479 an exception is thrown during API action execution.
480 $apiMain: Calling ApiMain instance.
481 $e: Exception object.
483 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
484 should have its own entry in the $apis array and have a unique name, passed as
485 key for the array that represents the service data. In this data array, the
486 key-value-pair identified by the apiLink key is required.
487 &$apis: array of services
489 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
490 Use this hook to extend action=tokens with new token types.
491 &$tokenTypes: supported token types in format 'type' => callback function
492 used to retrieve this type of tokens.
494 'Article::MissingArticleConditions': Before fetching deletion & move log entries
495 to display a message of a non-existing page being deleted/moved, give extensions
496 a chance to hide their (unrelated) log entries.
497 &$conds: Array of query conditions (all of which have to be met; conditions will
498 AND in the final query)
499 $logTypes: Array of log types being queried
501 'ArticleAfterFetchContent': After fetching content of an article from the
502 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
503 $article: the article (object) being loaded from the database
504 &$content: the content (string) of the article
506 'ArticleAfterFetchContentObject': After fetching content of an article from the
508 $article: the article (object) being loaded from the database
509 &$content: the content of the article, as a Content object
511 'ArticleConfirmDelete': Before writing the confirmation form for article
513 $article: the article (object) being deleted
514 $output: the OutputPage object
515 &$reason: the reason (string) the article is being deleted
517 'ArticleContentOnDiff': Before showing the article content below a diff. Use
518 this to change the content in this area or how it is loaded.
519 $diffEngine: the DifferenceEngine
520 $output: the OutputPage object
522 'ArticleDelete': Before an article is deleted.
523 $wikiPage: the WikiPage (object) being deleted
524 $user: the user (object) deleting the article
525 $reason: the reason (string) the article is being deleted
526 $error: if the deletion was prohibited, the (raw HTML) error message to display
528 $status: Status object, modify this to throw an error. Overridden by $error
531 'ArticleDeleteComplete': After an article is deleted.
532 $wikiPage: the WikiPage that was deleted
533 $user: the user that deleted the article
534 $reason: the reason the article was deleted
535 $id: id of the article that was deleted
536 $content: the Content of the deleted page
537 $logEntry: the ManualLogEntry used to record the deletion
539 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
541 &$wikiPage: WikiPage (object) of the user talk page
542 $recipient: User (object) who's talk page was edited
544 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
545 article has been changed.
546 $wikiPage: the WikiPage (object)
547 $editInfo: data holder that includes the parser output ($editInfo->output) for
548 that page after the change
549 $changed: bool for if the page was changed
551 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
552 recentchanges table, return false to not delete old entries.
553 $wikiPage: WikiPage (object) being modified
555 'ArticleFromTitle': when creating an article object from a title object using
556 Wiki::articleFromTitle().
557 $title: Title (object) used to create the article object
558 $article: Article (object) that will be returned
559 $context: IContextSource (object)
561 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
562 PageContentInsertComplete.
563 $wikiPage: WikiPage created
564 $user: User creating the article
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
573 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
574 $targetTitle: target title (object)
575 $destTitle: destination title (object)
577 'ArticlePageDataAfter': After loading data of an article from the database.
578 $wikiPage: WikiPage (object) whose data were loaded
579 $row: row (object) returned from the database server
581 'ArticlePageDataBefore': Before loading data of an article from the database.
582 $wikiPage: WikiPage (object) that data will be loaded
583 $fields: fields (array) to load from the database
585 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
586 $wikiPage: the WikiPage being saved
587 $popts: parser options to be used for pre-save transformation
589 'ArticleProtect': Before an article is protected.
590 $wikiPage: the WikiPage being protected
591 $user: the user doing the protection
592 $protect: boolean whether this is a protect or an unprotect
593 $reason: Reason for protect
594 $moveonly: boolean whether this is for move only or not
596 'ArticleProtectComplete': After an article is protected.
597 $wikiPage: the WikiPage that was protected
598 $user: the user who did the protection
599 $protect: boolean whether it was a protect or an unprotect
600 $reason: Reason for protect
601 $moveonly: boolean whether it was for move only or not
603 'ArticlePurge': Before executing "&action=purge".
604 $wikiPage: WikiPage (object) to purge
606 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
607 revisions of an article.
608 &$title: Title object of the article
610 'ArticleRevisionUndeleted': After an article revision is restored.
611 $title: the article title
612 $revision: the revision
613 $oldPageID: the page ID of the revision when archived (may be null)
615 'ArticleRollbackComplete': After an article rollback is completed.
616 $wikiPage: the WikiPage that was edited
617 $user: the user who did the rollback
618 $revision: the revision the page was reverted back to
619 $current: the reverted revision
621 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
623 $wikiPage: the WikiPage (object) being saved
624 $user: the user (object) saving the article
625 $text: the new article text
626 $summary: the article summary (comment)
631 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
632 PageContentSaveComplete instead.
633 $wikiPage: WikiPage modified
634 $user: User performing the modification
636 $summary: Edit summary/comment
637 $isMinor: Whether or not the edit was marked as minor
638 $isWatch: (No longer used)
639 $section: (No longer used)
640 $flags: Flags passed to WikiPage::doEditContent()
641 $revision: New Revision of the article
642 $status: Status object about to be returned by doEditContent()
643 $baseRevId: the rev ID (or false) this edit was based on
645 'ArticleUndelete': When one or more revisions of an article are restored.
646 $title: Title corresponding to the article restored
647 $create: Whether or not the restoration caused the page to be created (i.e. it
648 didn't exist before).
649 $comment: The comment associated with the undeletion.
650 $oldPageId: ID of page previously deleted (from archive table)
652 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
653 $pageArchive: the PageArchive object
654 &$logEntry: ManualLogEntry object
655 $user: User who is performing the log action
657 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
658 the user is redirected back to the page.
659 &$article: the article
660 &$sectionanchor: The section anchor link (e.g. "#overview" )
661 &$extraq: Extra query parameters which can be added via hooked functions
663 'ArticleViewFooter': After showing the footer section of an ordinary page view
664 $article: Article object
665 $patrolFooterShown: boolean whether patrol footer is shown
667 'ArticleViewHeader': Before the parser cache is about to be tried for article
669 &$article: the article
670 &$pcache: whether to try the parser cache or not
671 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
672 object to both indicate that the output is done and what parser output was used.
674 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
675 redirect was followed.
676 $article: target article (object)
678 'ArticleViewCustom': Allows to output the text of the article in a different
679 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
680 that it is preferable to implement proper handing for a custom data type using
681 the ContentHandler facility.
682 $text: text of the page
683 $title: title of the page
684 $output: reference to $wgOut
686 'ArticleContentViewCustom': Allows to output the text of the article in a
687 different format than wikitext. Note that it is preferable to implement proper
688 handing for a custom data type using the ContentHandler facility.
689 $content: content of the page, as a Content object
690 $title: title of the page
691 $output: reference to $wgOut
693 'AuthPluginAutoCreate': Called when creating a local account for an user logged
694 in from an external authentication method.
695 $user: User object created locally
697 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
698 Gives a chance for an extension to set it programmatically to a variable class.
699 &$auth: the $wgAuth object, probably a stub
701 'AutopromoteCondition': Check autopromote condition for user.
702 $type: condition type
705 $result: result of checking autopromote condition
707 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
711 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
712 certain title are fetched.
714 $title: title of the page to which backlinks are sought
715 &$conds: query conditions
717 'BadImage': When checking against the bad image list. Change $bad and return
718 false to override. If an image is "bad", it is not rendered inline in wiki
719 pages or galleries in category pages.
720 $name: Image name being checked
721 &$bad: Whether or not the image is "bad"
723 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
724 custom HTML after the section. Any uses of the hook need to handle escaping.
725 $template BaseTemplate
726 $portlet: string portlet name
729 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
730 "noarticletext-nopermission" at Article::showMissingArticle().
731 $article: article object
733 'BeforeInitialize': Before anything is initialized in
734 MediaWiki::performRequest().
735 &$title: Title being used for request
737 &$output: OutputPage object
739 $request: WebRequest object
740 $mediaWiki: Mediawiki object
742 'BeforePageDisplay': Prior to outputting a page.
743 &$out: OutputPage object
746 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
747 override how the redirect is output by modifying, or by returning false, and
748 letting standard HTTP rendering take place.
749 ATTENTION: This hook is likely to be removed soon due to overall design of the system.
750 $context: IContextSource object
751 &$redirect: string URL, modifiable
753 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
754 override how the redirect is output by modifying, or by returning false and
755 taking over the output.
756 $out: OutputPage object
757 &$redirect: URL, modifiable
758 &$code: HTTP code (eg '301' or '302'), modifiable
760 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
761 $parser: Parser object
763 &$options: array of options to RepoGroup::findFile
764 &$descQuery: query string to add to thumbnail URL
766 FIXME: Where does the below sentence fit in?
767 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
769 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
770 $parser: Parser object
771 $title: title of the template
772 &$skip: skip this template and link it?
773 &$id: the id of the revision being parsed
775 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
776 &$parser: Parser object
777 &$ig: ImageGallery object
779 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
781 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
782 to a newly created user account.
783 &$injected_html: Any HTML to inject after the "logged in" message of a newly
786 'BitmapHandlerTransform': before a file is transformed, gives extension the
787 possibility to transform it themselves
788 $handler: BitmapHandler
790 &$scalerParams: Array with scaler parameters
791 &$mto: null, set to a MediaTransformOutput
793 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
794 normalizations have been performed, except for the $wgMaxImageArea check.
796 &$params: Array of parameters
797 &$checkImageAreaHookResult: null, set to true or false to override the
798 $wgMaxImageArea check result.
800 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
802 $block: Block object (which is set to be autoblocking)
803 &$blockIds: Array of block IDs of the autoblock
805 'BlockIp': Before an IP address or user is blocked.
806 $block: the Block object about to be saved
807 $user: the user _doing_ the block (not the one being blocked)
808 &$reason: if the hook is aborted, the error message to be returned in an array
810 'BlockIpComplete': After an IP address or user is blocked.
811 $block: the Block object that was saved
812 $user: the user who did the block (not the one being blocked)
814 'BookInformation': Before information output on Special:Booksources.
815 $isbn: ISBN to show information for
816 $output: OutputPage object in use
818 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
819 to be able to access the wiki via HTTPS.
820 $ip: The IP address in human-readable form
821 &$canDo: This reference should be set to false if the client may not be able
824 'CanonicalNamespaces': For extensions adding their own namespaces or altering
826 Note that if you need to specify namespace protection or content model for
827 a namespace that is added in a CanonicalNamespaces hook handler, you
828 should do so by altering $wgNamespaceProtection and
829 $wgNamespaceContentModels outside the handler, in top-level scope. The
830 point at which the CanonicalNamespaces hook fires is too late for altering
831 these variables. This applies even if the namespace addition is
832 conditional; it is permissible to declare a content model and protection
833 for a namespace and then decline to actually register it.
834 &$namespaces: Array of namespace numbers with corresponding canonical names
836 'CategoryAfterPageAdded': After a page is added to a category.
837 $category: Category that page was added to
838 $wikiPage: WikiPage that was added
840 'CategoryAfterPageRemoved': After a page is removed from a category.
841 $category: Category that page was removed from
842 $wikiPage: WikiPage that was removed
844 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
845 $catpage: CategoryPage instance
847 'ChangePasswordForm': For extensions that need to add a field to the
848 ChangePassword form via the Preferences form.
849 &$extraFields: An array of arrays that hold fields like would be passed to the
852 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
853 &$changesList: ChangesList instance.
854 &$articlelink: HTML of link to article (already filled-in).
855 &$s: HTML of row that is being constructed.
856 &$rc: RecentChange instance.
857 $unpatrolled: Whether or not we are showing unpatrolled changes.
858 $watched: Whether or not the change is watched by the user.
860 'ChangesListInitRows': Batch process change list rows prior to rendering.
861 $changesList: ChangesList instance
862 $rows: The data that will be rendered. May be a ResultWrapper instance or
865 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
866 $special: ChangesListSpecialPage instance
867 &$filters: associative array of filter definitions. The keys are the HTML
868 name/URL parameters. Each key maps to an associative array with a 'msg'
869 (message key) and a 'default' value.
871 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
872 $name: name of the special page, e.g. 'Watchlist'
873 &$tables: array of tables to be queried
874 &$fields: array of columns to select
875 &$conds: array of WHERE conditionals for query
876 &$query_options: array of options for the database request
877 &$join_conds: join conditions for the tables
878 $opts: FormOptions for this request
880 'LoginUserMigrated': Called during login to allow extensions the opportunity to
881 inform a user that their username doesn't exist for a specific reason, instead
882 of letting the login form give the generic error message that the account does
883 not exist. For example, when the account has been renamed or deleted.
884 $user: the User object being authenticated against.
885 &$msg: the message identifier for abort reason, or an array to pass a message
888 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
889 $collationName: Name of the collation in question
890 &$collationObject: Null. Replace with a subclass of the Collation class that
891 implements the collation given in $collationName.
893 'ConfirmEmailComplete': Called after a user's email has been confirmed
895 $user: user (object) whose email is being confirmed
897 'ContentHandlerDefaultModelFor': Called when the default content model is determined
898 for a given title. May be used to assign a different model for that title.
899 $title: the Title in question
900 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
902 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
903 content model name, but no entry for that model exists in $wgContentHandlers.
904 $modeName: the requested content model name
905 &$handler: set this to a ContentHandler object, if desired.
907 'ContentModelCanBeUsedOn': Called to determine whether that content model can
908 be used on a given page. This is especially useful to prevent some content models
909 to be used in some special location.
910 $contentModel: ID of the content model in question
911 $title: the Title in question.
912 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
913 Handler functions that modify $ok should generally return false to prevent further
914 hooks from further modifying $ok.
916 'ContentGetParserOutput': Customize parser output for a given content object,
917 called by AbstractContent::getParserOutput. May be used to override the normal
918 model-specific rendering of page content.
919 $content: The Content to render
920 $title: Title of the page, as context
921 $revId: The revision ID, as context
922 $options: ParserOptions for rendering. To avoid confusing the parser cache,
923 the output can only depend on parameters provided to this hook function, not on global state.
924 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
925 generation of HTML may be skipped, but other information should still be present in the
927 &$output: ParserOutput, to manipulate or replace
929 'ContentAlterParserOutput': Modify parser output for a given content object.
930 Called by Content::getParserOutput after parsing has finished. Can be used
931 for changes that depend on the result of the parsing but have to be done
932 before LinksUpdate is called (such as adding tracking categories based on
934 $content: The Content to render
935 $title: Title of the page, as context
936 $parserOutput: ParserOutput to manipulate
938 'ConvertContent': Called by AbstractContent::convert when a conversion to another
939 content model is requested.
940 $content: The Content object to be converted.
941 $toModel: The ID of the content model to convert to.
942 $lossy: boolean indicating whether lossy conversion is allowed.
943 &$result: Output parameter, in case the handler function wants to provide a
944 converted Content object. Note that $result->getContentModel() must return $toModel.
945 Handler functions that modify $result should generally return false to further
946 attempts at conversion.
948 'ContribsPager::getQueryInfo': Before the contributions query is about to run
949 &$pager: Pager object for contributions
950 &$queryInfo: The query for the contribs Pager
952 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
953 &$data: an array of results of all contribs queries
954 $pager: The ContribsPager object hooked into
955 $offset: Index offset, inclusive
956 $limit: Exact query limit
957 $descending: Query direction, false for ascending, true for descending
959 'ContributionsLineEnding': Called before a contributions HTML line is finished
960 $page: SpecialPage object for contributions
962 $row: the DB row for this line
963 &$classes: the classes to add to the surrounding <li>
965 'ContributionsToolLinks': Change tool links above Special:Contributions
967 $title: User page title
968 &$tools: Array of tool links
970 'CustomEditor': When invoking the page editor
971 $article: Article being edited
972 $user: User performing the edit
974 Return true to allow the normal editor to be used, or false
975 if implementing a custom editor, e.g. for a special namespace,
978 'DatabaseOraclePostInit': Called after initialising an Oracle database
979 &$db: the DatabaseOracle object
981 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
982 $title: the diff page title (nullable)
983 &$oldId: the actual old Id to use in the diff
984 &$newId: the actual new Id to use in the diff (0 means current)
985 $old: the ?old= param value from the url
986 $new: the ?new= param value from the url
988 'DiffRevisionTools': Override or extend the revision tools available from the
989 diff view, i.e. undo, etc.
990 $newRev: Revision object of the "new" revision
991 &$links: Array of HTML links
992 $oldRev: Revision object of the "old" revision (may be null)
994 'DiffViewHeader': Called before diff display
995 $diff: DifferenceEngine object that's calling
996 $oldRev: Revision object of the "old" revision (may be null/invalid)
997 $newRev: Revision object of the "new" revision
999 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1001 $article: article (object) being viewed
1002 $oldid: oldid (int) being viewed
1004 'DoEditSectionLink': Override the HTML generated for section edit links
1005 $skin: Skin object rendering the UI
1006 $title: Title object for the title being linked to (may not be the same as
1007 the page title, if the section is included from a template)
1008 $section: The designation of the section being pointed to, to be included in
1009 the link, like "§ion=$section"
1010 $tooltip: The default tooltip. Escape before using.
1011 By default, this is wrapped in the 'editsectionhint' message.
1012 &$result: The HTML to return, prefilled with the default plus whatever other
1013 changes earlier hooks have made
1014 $lang: The language code to use for the link in the wfMessage function
1016 'EditFilter': Perform checks on an edit
1017 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1018 $text: Contents of the edit box
1019 $section: Section being edited
1020 &$error: Error message to return
1021 $summary: Edit summary for page
1023 'EditFilterMerged': Post-section-merge edit filter.
1024 DEPRECATED, use EditFilterMergedContent instead.
1025 $editor: EditPage instance (object)
1026 $text: content of the edit box
1027 &$error: error message to return
1028 $summary: Edit summary for page
1030 'EditFilterMergedContent': Post-section-merge edit filter.
1031 This may be triggered by the EditPage or any other facility that modifies page content.
1032 Use the $status object to indicate whether the edit should be allowed, and to provide
1033 a reason for disallowing it. Return false to abort the edit, and true to continue.
1034 Returning true if $status->isOK() returns false means "don't save but continue user
1035 interaction", e.g. show the edit form.
1036 $context: object implementing the IContextSource interface.
1037 $content: content of the edit box, as a Content object.
1038 $status: Status object to represent errors, etc.
1039 $summary: Edit summary for page
1040 $user: the User object representing the user whois performing the edit.
1041 $minoredit: whether the edit was marked as minor by the user.
1043 'EditFormPreloadText': Allows population of the edit form when creating
1045 &$text: Text to preload with
1046 &$title: Title object representing the page being created
1048 'EditFormInitialText': Allows modifying the edit form when editing existing
1050 $editPage: EditPage object
1052 'EditPage::attemptSave': Called before an article is
1053 saved, that is before WikiPage::doEditContent() is called
1054 $editpage_Obj: the current EditPage object
1056 'EditPage::importFormData': allow extensions to read additional data
1058 $editpage: EditPage instance
1059 $request: Webrequest
1060 return value is ignored (should always return true)
1062 'EditPage::showEditForm:fields': allows injection of form field into edit form
1063 $editor: the EditPage instance for reference
1064 $out: an OutputPage instance to write to
1065 return value is ignored (should always return true)
1067 'EditPage::showEditForm:initial': before showing the edit form
1068 $editor: EditPage instance (object)
1069 $out: an OutputPage instance to write to
1071 Return false to halt editing; you'll need to handle error messages, etc.
1072 yourself. Alternatively, modifying $error and returning true will cause the
1073 contents of $error to be echoed at the top of the edit form as wikitext.
1074 Return true without altering $error to allow the edit to proceed.
1076 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1077 but for the read-only 'view source' variant of the edit form.
1078 $editor: EditPage instance (object)
1079 &$out: an OutputPage instance to write to
1080 return value is ignored (should always return true)
1082 'EditPage::showStandardInputs:options': allows injection of form fields into
1083 the editOptions area
1084 $editor: EditPage instance (object)
1085 $out: an OutputPage instance to write to
1086 &$tabindex: HTML tabindex of the last edit check/button
1087 return value is ignored (should always be true)
1089 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1090 when there's an edit conflict. Return false to halt normal diff output; in
1091 this case you're responsible for computing and outputting the entire "conflict"
1092 part, i.e., the "difference between revisions" and "your text" headers and
1094 &$editor: EditPage instance
1095 &$out: OutputPage instance
1097 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1098 textarea in the edit form.
1099 &$editpage: The current EditPage object
1100 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1101 &$tabindex: HTML tabindex of the last edit check/button
1103 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1105 &$editpage: The current EditPage object
1106 &$checks: Array of edit checks like "watch this page"/"minor edit"
1107 &$tabindex: HTML tabindex of the last edit check/button
1109 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1110 textarea in the edit form.
1111 &$toolbar: The toolbar HTMl
1113 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1114 contribution/copyright notice.
1115 $title: title of page being edited
1116 &$msg: localization message name, overridable. Default is either
1117 'copyrightwarning' or 'copyrightwarning2'.
1119 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1120 modifying the wikitext that will be used in "Show changes". Note that it is
1121 preferable to implement diff handling for different data types using the
1122 ContentHandler facility.
1123 $editPage: EditPage object
1124 &$newtext: wikitext that will be used as "your version"
1126 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1127 "Show changes". Note that it is preferable to implement diff handling for
1128 different data types using the ContentHandler facility.
1129 $editPage: EditPage object
1130 &$newtext: wikitext that will be used as "your version"
1132 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1133 Allow modifying the wikitext that will be previewed. Note that it is preferable
1134 to implement previews for different data types using the ContentHandler
1136 $editPage: EditPage object
1137 &$toparse: wikitext that will be parsed
1139 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1140 previewed. Note that it is preferable to implement previews for different data
1141 types using the ContentHandler facility.
1142 $editPage: EditPage object
1143 &$content: Content object to be previewed (may be replaced by hook function)
1145 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1146 &$editpage: The current EditPage object
1147 &$res: the HTML of the error text
1149 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1150 of terms of service summary link that might exist separately from the copyright
1152 $title: title of page being edited
1153 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1155 'EmailConfirmed': When checking that the user's email address is "confirmed".
1156 $user: User being checked
1157 $confirmed: Whether or not the email address is confirmed
1158 This runs before the other checks, such as anonymity and the real check; return
1159 true to allow those checks to occur, and false if checking is done.
1161 'EmailUser': Before sending email from one user to another.
1162 $to: address of receiving user
1163 $from: address of sending user
1164 $subject: subject of the mail
1165 $text: text of the mail
1167 'EmailUserCC': Before sending the copy of the email to the author.
1168 $to: address of receiving user
1169 $from: address of sending user
1170 $subject: subject of the mail
1171 $text: text of the mail
1173 'EmailUserComplete': After sending email from one user to another.
1174 $to: address of receiving user
1175 $from: address of sending user
1176 $subject: subject of the mail
1177 $text: text of the mail
1179 'EmailUserForm': After building the email user form object.
1180 $form: HTMLForm object
1182 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1184 $user: The user who is trying to email another user.
1185 $editToken: The user's edit token.
1186 &$hookErr: Out-param for the error. Passed as the parameters to
1187 OutputPage::showErrorPage.
1189 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1191 $ip: The ip address of the user
1193 'ExtensionTypes': Called when generating the extensions credits, use this to
1194 change the tables headers.
1195 &$extTypes: associative array of extensions types
1197 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1198 thumbnail file name.
1199 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1200 $thumbname: the base name of the thumbnail file
1201 &$params: the currently extracted params (has source name, temp or archived zone)
1203 'FetchChangesList': When fetching the ChangesList derivative for a particular
1205 $user: User the list is being fetched for
1206 &$skin: Skin object to be used with the list
1207 &$list: List object (defaults to NULL, change it to an object instance and
1208 return false override the list derivative used)
1210 'FileDeleteComplete': When a file is deleted.
1211 $file: reference to the deleted file
1212 $oldimage: in case of the deletion of an old image, the name of the old file
1213 $article: in case all revisions of the file are deleted a reference to the
1214 WikiFilePage associated with the file.
1215 $user: user who performed the deletion
1218 'FileTransformed': When a file is transformed and moved into storage.
1219 $file: reference to the File object
1220 $thumb: the MediaTransformOutput object
1221 $tmpThumbPath: The temporary file system path of the transformed file
1222 $thumbPath: The permanent storage path of the transformed file
1224 'FileUpload': When a file upload occurs.
1225 $file : Image object representing the file that was uploaded
1226 $reupload : Boolean indicating if there was a previously another image there or
1228 $hasDescription : Boolean indicating that there was already a description page
1229 and a new one from the comment wasn't created (since 1.17)
1231 'FileUndeleteComplete': When a file is undeleted
1232 $title: title object to the file
1233 $fileVersions: array of undeleted versions. Empty if all versions were restored
1234 $user: user who performed the undeletion
1237 'FormatAutocomments': When an autocomment is formatted by the Linker.
1238 &$comment: Reference to the accumulated comment. Initially null, when set the
1239 default code will be skipped.
1240 $pre: Initial part of the parsed comment before the call to the hook.
1241 $auto: The extracted part of the parsed comment before the call to the hook.
1242 $post: The final part of the parsed comment before the call to the hook.
1243 $title: An optional title object used to links to sections. Can be null.
1244 $local: Boolean indicating whether section links should refer to local page.
1246 'GalleryGetModes': Get list of classes that can render different modes of a
1248 $modeArray: An associative array mapping mode names to classes that implement
1249 that mode. It is expected all registered classes are a subclass of
1252 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1254 &$user: user to promote.
1255 &$promote: groups that will be added.
1257 'GetBlockedStatus': after loading blocking status of an user from the database
1258 $user: user (object) being checked
1260 'GetCacheVaryCookies': Get cookies that should vary cache options.
1261 $out: OutputPage object
1262 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1263 that have to vary cache options
1265 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1267 $title: Title object of page
1268 $url: string value as output (out parameter, can modify)
1269 $query: query options passed to Title::getCanonicalURL()
1271 'GetDefaultSortkey': Override the default sortkey for a page.
1272 $title: Title object that we need to get a sortkey for
1273 &$sortkey: Sortkey to use.
1275 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1276 underscore) magic words. Called by MagicWord.
1277 &$doubleUnderscoreIDs: array of strings
1279 'GetExtendedMetadata': Get extended file metadata for the API
1280 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1281 'value' => prop value, 'source' => 'name of hook' ).
1282 $file: File object of file in question
1283 $context: RequestContext (including language to use)
1284 $single: Only extract the current language; if false, the prop value should
1285 be in the metadata multi-language array format:
1286 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1287 &$maxCacheTime: how long the results can be cached
1289 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1290 $title: Title object of page
1291 $url: string value as output (out parameter, can modify)
1292 $query: query options passed to Title::getFullURL()
1294 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1295 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1297 &$output: string for the output timestamp
1298 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1299 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1300 $user: User whose preferences are being used to make timestamp
1301 $lang: Language that will be used to render the timestamp
1303 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1304 $title: Title object of page
1305 $url: string value as output (out parameter, can modify)
1306 $query: query options passed to Title::getInternalURL()
1308 'GetIP': modify the ip of the current user (called only once).
1309 &$ip: string holding the ip as determined so far
1311 'GetLinkColours': modify the CSS class of an array of page links.
1312 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1314 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1316 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1317 working with internal urls (non-interwiki) then it may be preferable to work
1318 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1319 be buggy for internal urls on render if you do not re-implement the horrible
1320 hack that Title::getLocalURL uses in your own extension.
1321 $title: Title object of page
1322 &$url: string value as output (out parameter, can modify)
1323 $query: query options passed to Title::getLocalURL()
1325 'GetLocalURL::Internal': Modify local URLs to internal pages.
1326 $title: Title object of page
1327 &$url: string value as output (out parameter, can modify)
1328 $query: query options passed to Title::getLocalURL()
1330 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1331 without any fancy queries or variants.
1332 $title: Title object of page
1333 &$url: string value as output (out parameter, can modify)
1335 'GetLogTypesOnUser': Add log types where the target is a userpage
1336 &$types: Array of log types
1338 'GetMetadataVersion': Modify the image metadata version currently in use. This
1339 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1340 that need to have versioned metadata should add an element to the end of the
1341 version array of the form 'handler_name=version'. Most media handlers won't need
1342 to do this unless they broke backwards compatibility with a previous version of
1343 the media handler metadata output.
1344 &$version: Array of version strings
1346 'GetNewMessagesAlert': Disable or modify the new messages alert
1347 &$newMessagesAlert: An empty string by default. If the user has new talk page
1348 messages, this should be populated with an alert message to that effect
1349 $newtalks: An empty array if the user has no new messages or an array containing
1350 links and revisions if there are new messages (See User::getNewMessageLinks)
1351 $user: The user object of the user who is loading the page
1352 $out: OutputPage object (to check what type of page the user is on)
1354 'GetPreferences': Modify user preferences.
1355 $user: User whose preferences are being modified.
1356 &$preferences: Preferences description array, to be fed to an HTMLForm object
1358 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1359 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1361 &$output: string for the output timestamp
1362 &$diff: DateInterval representing the difference between the timestamps
1363 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1364 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1365 $user: User whose preferences are being used to make timestamp
1366 $lang: Language that will be used to render the timestamp
1368 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1369 checked for. Use instead of userCan for most cases. Return false if the user
1370 can't do it, and populate $result with the reason in the form of
1371 array( messagename, param1, param2, ... ). For consistency, error messages
1372 should be plain text with no special coloring, bolding, etc. to show that
1373 they're errors; presenting them properly to the user as errors is done by the
1375 $title: Title object being checked against
1376 $user : Current user object
1377 $action: Action being checked
1378 $result: User permissions error to add. If none, return true.
1380 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1381 called only if expensive checks are enabled. Add a permissions error when
1382 permissions errors are checked for. Return false if the user can't do it, and
1383 populate $result with the reason in the form of array( messagename, param1,
1384 param2, ... ). For consistency, error messages should be plain text with no
1385 special coloring, bolding, etc. to show that they're errors; presenting them
1386 properly to the user as errors is done by the caller.
1388 $title: Title object being checked against
1389 $user : Current user object
1390 $action: Action being checked
1391 $result: User permissions error to add. If none, return true.
1393 'GitViewers': Called when generating the list of git viewers for
1394 Special:Version, use this to change the list.
1395 &$extTypes: associative array of repo URLS to viewer URLs.
1397 'HistoryRevisionTools': Override or extend the revision tools available from the
1398 page history view, i.e. undo, rollback, etc.
1399 $rev: Revision object
1400 &$links: Array of HTML links
1402 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1404 $context: An IContextSource object with information about the request being served.
1406 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1407 image insertion. You can skip the default logic entirely by returning false, or
1408 just modify a few things using call-by-reference.
1410 &$title: Title object of the image
1411 &$file: File object, or false if it doesn't exist
1412 &$frameParams: Various parameters with special meanings; see documentation in
1413 includes/Linker.php for Linker::makeImageLink
1414 &$handlerParams: Various parameters with special meanings; see documentation in
1415 includes/Linker.php for Linker::makeImageLink
1416 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1417 &$res: Final HTML output, used if you return false
1420 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1421 the image on an image page.
1422 $imagePage: ImagePage object ($this)
1425 'ImagePageAfterImageLinks': Called after the image links section on an image
1427 $imagePage: ImagePage object ($this)
1428 &$html: HTML for the hook to add
1430 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1432 $line: the HTML of the history line
1433 $css: the line CSS class
1435 'ImagePageFindFile': Called when fetching the file associated with an image
1437 $page: ImagePage object
1439 &$displayFile: displayed File object
1441 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1442 $page: ImagePage object
1443 &$toc: Array of <li> strings
1445 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1447 &$title: the Title object of the file as it would appear for the upload page
1448 &$path: the original file and path name when img_auth was invoked by the the web
1450 &$name: the name only component of the file
1451 &$result: The location to pass back results of the hook routine (only used if
1453 $result[0]=The index of the header message
1454 $result[1]=The index of the body text message
1455 $result[2 through n]=Parameters passed to body text message. Please note the
1456 header message cannot receive/use parameters.
1458 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1459 $reader: XMLReader object
1460 $logInfo: Array of information
1461 Return false to stop further processing of the tag
1463 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1464 $reader: XMLReader object
1465 $pageInfo: Array of information
1466 Return false to stop further processing of the tag
1468 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1469 $reader: XMLReader object
1470 $pageInfo: Array of page information
1471 $revisionInfo: Array of revision information
1472 Return false to stop further processing of the tag
1474 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1475 $reader: XMLReader object
1476 Return false to stop further processing of the tag
1478 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1479 $reader: XMLReader object
1480 $revisionInfo: Array of information
1481 Return false to stop further processing of the tag
1483 'InfoAction': When building information to display on the action=info page.
1484 $context: IContextSource object
1485 &$pageInfo: Array of information
1487 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1488 $title: Title object for the current page
1489 $request: WebRequest
1490 $ignoreRedirect: boolean to skip redirect check
1491 $target: Title/string of redirect target
1492 $article: Article object
1494 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1495 Return true without providing an interwiki to continue interwiki search.
1496 $prefix: interwiki prefix we are looking for.
1497 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1498 iw_trans and optionally iw_api and iw_wikiid.
1500 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1501 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1502 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1503 template/parser function execution which respect nowiki and HTML-comments.
1504 &$parser: Parser object
1505 &$text: string containing partially parsed text
1506 &$stripState: Parser's internal StripState object
1508 'InternalParseBeforeLinks': during Parser's internalParse method before links
1509 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1510 &$parser: Parser object
1511 &$text: string containing partially parsed text
1512 &$stripState: Parser's internal StripState object
1514 'InvalidateEmailComplete': Called after a user's email has been invalidated
1516 $user: user (object) whose email is being invalidated
1518 'IRCLineURL': When constructing the URL to use in an IRC notification.
1519 Callee may modify $url and $query, URL will be constructed as $url . $query
1520 &$url: URL to index.php
1521 &$query: Query string
1522 $rc: RecentChange object that triggered url generation
1524 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1525 $article: article (object) being checked
1527 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1529 $result: Change this value to override the result of wfIsTrustedProxy()
1531 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1532 $url: URL used to upload from
1533 &$allowed: Boolean indicating if uploading is allowed for given URL
1535 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1536 instance to return false if the domain name doesn't match your organization.
1537 $addr: The e-mail address entered by the user
1538 &$result: Set this and return false to override the internal checks
1540 'isValidPassword': Override the result of User::isValidPassword()
1541 $password: The password entered by the user
1542 &$result: Set this and return false to override the internal checks
1543 $user: User the password is being validated for
1545 'Language::getMessagesFileName':
1546 $code: The language code or the language we're looking for a messages file for
1547 &$file: The messages file path, you can override this to change the location.
1549 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1550 remove namespaces. Do not use this hook to add namespaces. Use
1551 CanonicalNamespaces for that.
1552 &$namespaces: Array of namespaces indexed by their numbers
1554 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1555 $wgExtensionMessagesFiles instead.
1556 Use this to define synonyms of magic words depending of the language
1557 $magicExtensions: associative array of magic words synonyms
1558 $lang: language code (string)
1560 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1561 listed in $wgExtensionMessagesFiles instead.
1562 Use to define aliases of special pages names depending of the language
1563 $specialPageAliases: associative array of magic words synonyms
1564 $lang: language code (string)
1566 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1567 &$names: array of language code => language name
1568 $code language of the preferred translations
1570 'LanguageLinks': Manipulate a page's language links. This is called
1571 in various places to allow extensions to define the effective language
1573 $title: The page's Title.
1574 &$links: Associative array mapping language codes to prefixed links of the
1575 form "language:title".
1576 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1577 Currently unused, but planned to provide support for marking individual
1578 language links in the UI, e.g. for featured articles.
1580 'LanguageSelector': Hook to change the language selector available on a page.
1581 $out: The output page.
1582 $cssClassName: CSS class name of the language selector.
1584 'LinkBegin': Used when generating internal and interwiki links in
1585 Linker::link(), before processing starts. Return false to skip default
1586 processing and return $ret. See documentation for Linker::link() for details on
1587 the expected meanings of parameters.
1588 $skin: the Skin object
1589 $target: the Title that the link is pointing to
1590 &$html: the contents that the <a> tag should have (raw HTML); null means
1592 &$customAttribs: the HTML attributes that the <a> tag should have, in
1593 associative array form, with keys and values unescaped. Should be merged with
1594 default values, with a value of false meaning to suppress the attribute.
1595 &$query: the query string to add to the generated URL (the bit after the "?"),
1596 in associative array form, with keys and values unescaped.
1597 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1598 &$ret: the value to return if your hook returns false.
1600 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1601 just before the function returns a value. If you return true, an <a> element
1602 with HTML attributes $attribs and contents $html will be returned. If you
1603 return false, $ret will be returned.
1604 $skin: the Skin object
1605 $target: the Title object that the link is pointing to
1606 $options: the options. Will always include either 'known' or 'broken', and may
1607 include 'noclasses'.
1608 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1609 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1610 associative array form.
1611 &$ret: the value to return if your hook returns false.
1613 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1615 &$url: the image url
1616 &$alt: the image's alt text
1617 &$img: the new image HTML (if returning false)
1619 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1622 &$text: the link text
1623 &$link: the new link HTML (if returning false)
1624 &$attribs: the attributes to be applied.
1625 $linkType: The external link type
1627 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1629 $title: the Title object that the link is pointing to
1630 $file: the File object or false if broken link
1631 &$html: the link text
1632 &$attribs: the attributes to be applied
1633 &$ret: the value to return if your hook returns false
1635 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1637 &$linksUpdate: the LinksUpdate object
1639 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1640 each link table insert. For example, pagelinks, imagelinks, externallinks.
1641 $linksUpdate: LinksUpdate object
1642 $table: the table to insert links to
1643 $insertions: an array of links to insert
1645 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1646 including delete and insert, has completed for all link tables
1647 &$linksUpdate: the LinksUpdate object
1649 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1650 &$linksUpdate: the LinksUpdate object
1652 'ListDefinedTags': When trying to find all defined tags.
1653 &$tags: The list of tags.
1655 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1656 &updater: A DatabaseUpdater subclass
1658 'LocalFile::getHistory': Called before file history query performed.
1659 $file: the File object
1661 $fields: select fields
1663 $opts: query options
1664 $join_conds: JOIN conditions
1666 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1667 $file: the File object
1668 $archiveName: name of an old file version or false if it's the current one
1670 'LocalisationCacheRecache': Called when loading the localisation data into
1672 $cache: The LocalisationCache object
1673 $code: language code
1674 &$alldata: The localisation data from core and extensions
1675 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1677 'LocalisationCacheRecacheFallback': Called for each language when merging
1678 fallback data into the cache.
1679 $cache: The LocalisationCache object
1680 $code: language code
1681 &$alldata: The localisation data from core and extensions. Note some keys may
1682 be omitted if they won't be merged into the final result.
1684 'LocalisationChecksBlacklist': When fetching the blacklist of
1685 localisation checks.
1686 &$blacklist: array of checks to blacklist. See the bottom of
1687 maintenance/language/checkLanguage.inc for the format of this variable.
1689 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1690 optional localisation messages
1691 &$ignored Array of ignored message keys
1692 &$optional Array of optional message keys
1694 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1695 Returning false will prevent the string from being added to the OutputPage.
1696 &$s: html string to show for the log extract
1697 $types: String or Array Log types to show
1698 $page: String or Title The page title to show log entries for
1699 $user: String The user who made the log entries
1700 $param: Associative Array with the following additional options:
1701 - lim Integer Limit of items to show, default is 50
1702 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1703 - showIfEmpty boolean Set to false if you don't want any output in case the
1704 loglist is empty if set to true (default), "No matching items in log" is
1705 displayed if loglist is empty
1706 - msgKey Array If you want a nice box with a message, set this to the key of
1707 the message. First element is the message key, additional optional elements
1708 are parameters for the key that are processed with
1709 wfMessage()->params()->parseAsBlock()
1710 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1712 - wrap String Wrap the message in html (usually something like
1713 "<div ...>$1</div>").
1714 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1716 'LoginAuthenticateAudit': A login attempt for a valid user account either
1717 succeeded or failed. No return data is accepted; this hook is for auditing only.
1718 $user: the User object being authenticated against
1719 $password: the password being submitted and found wanting
1720 $retval: a LoginForm class constant with authenticateUserData() return
1721 value (SUCCESS, WRONG_PASS, etc.).
1723 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1724 Use this hook to change the Message that will be output on Special:ChangePassword.
1725 &$msg: Message object that will be shown to the user
1726 $username: Username of the user who's password was expired.
1728 'LogLine': Processes a single log entry on Special:Log.
1729 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1730 logging.log_type database field.
1731 $log_action: string for the type of log action (e.g. 'delete', 'block',
1732 'create2'). Corresponds to logging.log_action database field.
1733 $title: Title object that corresponds to logging.log_namespace and
1734 logging.log_title database fields.
1735 $paramArray: Array of parameters that corresponds to logging.log_params field.
1736 Note that only $paramArray[0] appears to contain anything.
1737 &$comment: string that corresponds to logging.log_comment database field, and
1738 which is displayed in the UI.
1739 &$revert: string that is displayed in the UI, similar to $comment.
1740 $time: timestamp of the log entry (added in 1.12)
1742 'LonelyPagesQuery': Allow extensions to modify the query used by
1743 Special:LonelyPages.
1744 &$tables: tables to join in the query
1745 &$conds: conditions for the query
1746 &$joinConds: join conditions for the query
1748 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1750 $refreshLinks: RefreshLinks object
1752 'MagicWordwgVariableIDs': When defining new magic words IDs.
1753 $variableIDs: array of strings
1755 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1756 Ideally, this hook should only be used to add variables that depend on
1757 the current page/request; static configuration should be added through
1758 ResourceLoaderGetConfigVars instead.
1759 &$vars: variable (or multiple variables) to be added into the output of
1760 Skin::makeVariablesScript
1761 $out: The OutputPage which called the hook, can be used to get the real title.
1763 'MarkPatrolled': Before an edit is marked patrolled.
1764 $rcid: ID of the revision to be marked patrolled
1765 $user: the user (object) marking the revision as patrolled
1766 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1767 sysop in order to mark an edit patrolled.
1769 'MarkPatrolledComplete': After an edit is marked patrolled.
1770 $rcid: ID of the revision marked as patrolled
1771 $user: user (object) who marked the edit patrolled
1772 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1773 sysop to patrol the edit.
1775 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1776 something completely different, after the basic globals have been set up, but
1777 before ordinary actions take place.
1779 $article: Article on which the action will be performed
1780 $title: Title on which the action will be performed
1782 $request: $wgRequest
1783 $mediaWiki: The $mediawiki object
1785 'MessagesPreLoad': When loading a message from the database.
1786 $title: title of the message (string)
1787 $message: value (string), change it to the message you want to define
1789 'MessageCache::get': When fetching a message. Can be used to override the key
1790 for customisations. Given and returned message key must be in special format:
1791 1) first letter must be in lower case according to the content language.
1792 2) spaces must be replaced with underscores
1793 &$key: message key (string)
1795 'MessageCacheReplace': When a message page is changed. Useful for updating
1797 $title: name of the page changed.
1798 $text: new contents of the page.
1800 'MimeMagicInit': Before processing the list mapping MIME types to media types
1801 and the list mapping MIME types to file extensions.
1802 As an extension author, you are encouraged to submit patches to MediaWiki's
1803 core to add new MIME types to mime.types.
1804 $mimeMagic: Instance of MimeMagic.
1805 Use $mimeMagic->addExtraInfo( $stringOfInfo );
1806 for adding new MIME info to the list.
1807 Use $mimeMagic->addExtraTypes( $stringOfTypes );
1808 for adding new MIME types to the list.
1810 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1811 MIME type detected by considering the file extension.
1812 $mimeMagic: Instance of MimeMagic.
1813 $ext: File extension.
1814 &$mime: MIME type (in/out).
1816 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1817 $mimeMagic: Instance of MimeMagic.
1818 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1819 &$tail: More or equal than last 65558 bytes of the file in a string
1820 (in - Do not alter!).
1822 &$mime: MIME type (out).
1824 'ModifyExportQuery': Modify the query used by the exporter.
1825 $db: The database object to be queried.
1826 &$tables: Tables in the query.
1827 &$conds: Conditions in the query.
1828 &$opts: Options for the query.
1829 &$join_conds: Join conditions for the query.
1831 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1832 and returning it for the skin to output. You can add items to the toolbox while
1833 still letting the skin make final decisions on skin-specific markup conventions
1835 &$sk: The BaseTemplate base skin template
1836 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1837 BaseTemplate::makeListItem for details on the format of individual items
1838 inside of this array.
1840 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1842 $index: Integer; the index of the namespace being checked.
1843 $result: Boolean; whether MediaWiki currently thinks that pages in this
1844 namespace are movable. Hooks may change this value to override the return
1845 value of MWNamespace::isMovable().
1847 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1849 $wikiPage: the WikiPage edited
1850 $rev: the new revision
1851 $baseID: the revision ID this was based off, if any
1852 $user: the editing user
1854 'NormalizeMessageKey': Called before the software gets the text of a message
1855 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1857 &$key: the message being looked up. Change this to something else to change
1858 what message gets displayed (string)
1859 &$useDB: whether or not to look up the message in the database (bool)
1860 &$langCode: the language code to get the message for (string) - or -
1861 whether to use the content language (true) or site language (false) (bool)
1862 &$transform: whether or not to expand variables and templates
1863 in the message (bool)
1865 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1866 return false to omit the line from RecentChanges and Watchlist special pages.
1867 &$changeslist: The OldChangesList instance.
1868 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1869 &$rc: The RecentChange object.
1870 &$classes: array of css classes for the <li> element
1872 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1873 can alter or append to the array of URLs for search & suggestion formats.
1874 &$urls: array of associative arrays with Url element attributes
1876 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1877 users and/or IP addresses too.
1878 $otherBlockLink: An array with links to other block logs
1879 $ip: The requested IP address or username
1881 'OutputPageBeforeHTML': A page has been processed by the parser and the
1882 resulting HTML is about to be displayed.
1883 $parserOutput: the parserOutput (object) that corresponds to the page
1884 $text: the text that will be displayed, in HTML (string)
1886 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1887 body tag to allow for extensions to add attributes to the body of the page they
1888 might need. Or to allow building extensions to add body classes that aren't of
1889 high enough demand to be included in core.
1890 $out: The OutputPage which called the hook, can be used to get the real title
1891 $sk: The Skin that called OutputPage::headElement
1892 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1894 'OutputPageCheckLastModified': when checking if the page has been modified
1895 since the last visit.
1896 &$modifiedTimes: array of timestamps.
1897 The following keys are set: page, user, epoch
1899 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1900 $out: OutputPage instance (object)
1901 $parserOutput: parserOutput instance being added in $out
1903 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1904 categories. Implementations should return false if they generate the category
1905 links, so the default link generation is skipped.
1906 $out: OutputPage instance (object)
1907 $categories: associative array, keys are category names, values are category
1908 types ("normal" or "hidden")
1909 $links: array, intended to hold the result. Must be an associative array with
1910 category types as keys and arrays of HTML links as values.
1912 'PageContentInsertComplete': After a new article is created.
1913 $wikiPage: WikiPage created
1914 $user: User creating the article
1915 $content: New content as a Content object
1916 $summary: Edit summary/comment
1917 $isMinor: Whether or not the edit was marked as minor
1918 $isWatch: (No longer used)
1919 $section: (No longer used)
1920 $flags: Flags passed to WikiPage::doEditContent()
1921 $revision: New Revision of the article
1923 'PageContentLanguage': Allows changing the language in which the content of a
1924 page is written. Defaults to the wiki content language ($wgContLang).
1925 $title: Title object
1926 &$pageLang: the page content language (either an object or a language code)
1927 $wgLang: the user language
1929 'PageContentSave': Before an article is saved.
1930 $wikiPage: the WikiPage (object) being saved
1931 $user: the user (object) saving the article
1932 $content: the new article content, as a Content object
1933 $summary: the article summary (comment)
1934 $isminor: minor flag
1935 $iswatch: watch flag
1938 'PageContentSaveComplete': After an article has been updated.
1939 $wikiPage: WikiPage modified
1940 $user: User performing the modification
1941 $content: New content, as a Content object
1942 $summary: Edit summary/comment
1943 $isMinor: Whether or not the edit was marked as minor
1944 $isWatch: (No longer used)
1945 $section: (No longer used)
1946 $flags: Flags passed to WikiPage::doEditContent()
1947 $revision: New Revision of the article (can be null for edits that change nothing)
1948 $status: Status object about to be returned by doEditContent()
1949 $baseRevId: the rev ID (or false) this edit was based on
1951 'PageHistoryBeforeList': When a history page list is about to be constructed.
1952 $article: the article that the history is loading for
1953 $context: RequestContext object
1955 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1956 $row: the revision row for this line
1957 $s: the string representing this parsed line
1958 $classes: array containing the <li> element classes
1960 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1963 $queryInfo: the query parameters
1965 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1966 which depends on user options should install this hook and append its values to
1968 &$confstr: reference to a hash key string which can be modified
1969 $user: User (object) requesting the page
1971 'ParserAfterParse': Called from Parser::parse() just after the call to
1972 Parser::internalParse() returns.
1973 $parser: parser object
1974 $text: text being parsed
1975 $stripState: stripState used (object)
1977 'ParserAfterStrip': Called at end of parsing time.
1978 TODO: No more strip, deprecated ?
1979 $parser: parser object
1980 $text: text being parsed
1981 $stripState: stripState used (object)
1983 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1984 $parser: Parser object being used
1985 $text: text that will be returned
1987 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1988 $parser: Parser object
1989 $text: text to parse
1990 $stripState: StripState instance being used
1992 'ParserBeforeStrip': Called at start of parsing time.
1993 TODO: No more strip, deprecated ?
1994 $parser: parser object
1995 $text: text being parsed
1996 $stripState: stripState used (object)
1998 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1999 $parser: Parser object being used
2002 'ParserClearState': Called at the end of Parser::clearState().
2003 $parser: Parser object being cleared
2005 'ParserCloned': Called when the parser is cloned.
2006 $parser: Newly-cloned Parser object
2008 'ParserFirstCallInit': Called when the parser initialises for the first time.
2009 &$parser: Parser object being cleared
2011 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2013 $parser: Parser object
2014 $varCache: array to store the value in case of multiples calls of the
2016 $index: index (string) of the magic
2017 $ret: value of the magic word (the hook should set it)
2018 $frame: PPFrame object to use for expanding any template variables
2020 'ParserGetVariableValueTs': Use this to change the value of the time for the
2021 {{LOCAL...}} magic word.
2022 $parser: Parser object
2023 $time: actual time (timestamp)
2025 'ParserGetVariableValueVarCache': use this to change the value of the variable
2026 cache or return false to not use it.
2027 $parser: Parser object
2028 $varCache: variable cache (array)
2030 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
2031 ParserLimitReportFormat instead.
2032 Called at the end of Parser:parse() when the parser will
2033 include comments about size of the text parsed.
2034 $parser: Parser object
2035 &$limitReport: text that will be included (without comment tags)
2037 'ParserLimitReportFormat': Called for each row in the parser limit report that
2038 needs formatting. If nothing handles this hook, the default is to use "$key" to
2039 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2041 $key: Key for the limit report item (string)
2042 &$value: Value of the limit report item
2043 &$report: String onto which to append the data
2044 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2045 text intended for display in a monospaced font.
2046 $localize: If false, $report should be output in English.
2048 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2049 include comments about size of the text parsed. Hooks should use
2050 $output->setLimitReportData() to populate data. Functions for this hook should
2051 not use $wgLang; do that in ParserLimitReportFormat instead.
2052 $parser: Parser object
2053 $output: ParserOutput object
2055 'ParserMakeImageParams': Called before the parser make an image link, use this
2056 to modify the parameters of the image.
2057 $title: title object representing the file
2058 $file: file object that will be used to create the image
2059 &$params: 2-D array of parameters
2060 $parser: Parser object that called the hook
2062 'ParserSectionCreate': Called each time the parser creates a document section
2063 from wikitext. Use this to apply per-section modifications to HTML (like
2064 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2065 can begin in one section and end in another. Make sure your code can handle
2066 that case gracefully. See the EditSectionClearerLink extension for an example.
2067 $parser: the calling Parser instance
2068 $section: the section number, zero-based, but section 0 is usually empty
2069 &$sectionContent: ref to the content of the section. modify this.
2070 $showEditLinks: boolean describing whether this section has an edit link
2072 'ParserTestParser': Called when creating a new instance of Parser in
2073 tests/parser/parserTest.inc.
2074 $parser: Parser object created
2076 'ParserTestGlobals': Allows to define globals for parser tests.
2077 &$globals: Array with all the globals which should be set for parser tests.
2078 The arrays keys serve as the globals names, its values are the globals values.
2080 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2081 run. Use when page save hooks require the presence of custom tables to ensure
2082 that tests continue to run properly.
2083 &$tables: array of table names
2085 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2086 my talk page, my contributions" etc).
2087 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2088 &$title: Title object representing the current page
2089 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2091 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2092 &$user : User performing the action
2093 $action : Action being performed
2094 &$result : Whether or not the action should be prevented
2095 Change $result and return false to give a definitive answer, otherwise
2096 the built-in rate limiting checks are used, if enabled.
2097 $incrBy: Amount to increment counter by
2099 'PlaceNewSection': Override placement of new sections. Return false and put the
2100 merged text into $text to override the default behavior.
2101 $wikipage : WikiPage object
2102 $oldtext : the text of the article before editing
2103 $subject : subject of the new section
2104 &$text : text of the new section
2106 'PostLoginRedirect': Modify the post login redirect behavior.
2107 Occurs after signing up or logging in, allows for interception of redirect.
2108 &$returnTo: The page name to return to, as a string
2109 &$returnToQuery: array of url parameters, mapping parameter names to values
2110 &$type: type of login redirect as string;
2111 error: display a return to link ignoring $wgRedirectOnLogin
2112 signup: display a return to link using $wgRedirectOnLogin if needed
2113 success: display a return to link using $wgRedirectOnLogin if needed
2114 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2116 'PreferencesGetLegend': Override the text used for the <legend> of a
2117 preferences section.
2118 $form: the PreferencesForm object. This is a ContextSource as well
2119 $key: the section name
2120 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2122 'PreferencesFormPreSave': Override preferences being saved
2123 $formData: array of user submitted data
2124 $form: PreferencesForm object, also a ContextSource
2125 $user: User object with preferences to be saved set
2126 &$result: boolean indicating success
2128 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2129 AJAX search suggestions. Put results into &$results outparam and return false.
2130 $ns : array of int namespace keys to search in
2131 $search : search term (not guaranteed to be conveniently normalized)
2132 $limit : maximum number of results to return
2133 &$results : out param: array of page names (strings)
2135 'PrefsEmailAudit': Called when user changes their email address.
2136 $user: User (object) changing his email address
2137 $oldaddr: old email address (string)
2138 $newaddr: new email address (string)
2140 'PrefsPasswordAudit': Called when user changes his password.
2141 $user: User (object) changing his password
2142 $newPass: new password
2143 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2145 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2147 $article: the title being (un)protected
2148 $output: a string of the form HTML so far
2150 'ProtectionForm::save': Called when a protection form is submitted.
2151 $article: the Page being (un)protected
2152 &$errorMsg: an html message string of an error or an array of message name and
2154 $reasonstr: a string describing the reason page protection level is altered
2156 'ProtectionForm::showLogExtract': Called after the protection log extract is
2158 $article: the page the form is shown for
2159 $out: OutputPage object
2161 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2162 &$obj: RawAction object
2163 &$text: The text that's going to be the output
2165 'RecentChange_save': Called at the end of RecentChange::save().
2166 $recentChange: RecentChange object
2168 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2169 names such as "oldid" that are preserved when using redirecting special pages
2170 such as Special:MyPage and Special:MyTalk.
2171 &$redirectParams: An array of parameters preserved by redirecting special pages.
2173 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2174 instance. Can be used by an extension override what skin is used in certain
2176 IContextSource $context: The RequestContext the skin is being created for.
2177 &$skin: A variable reference you may set a Skin instance or string key on to
2178 override the skin that will be used for the context.
2180 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2181 $user: The user having their password expiration reset
2182 &$newExpire: The new expiration date
2184 'ResetSessionID': Called from wfResetSessionID
2185 $oldSessionID: old session id
2186 $newSessionID: new session id
2188 'ResourceLoaderGetConfigVars': Called at the end of
2189 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2190 configuration variables to JavaScript. Things that depend on the current page
2191 or request state must be added through MakeGlobalVariablesScript instead.
2192 &$vars: array( variable name => value )
2194 'ResourceLoaderRegisterModules': Right before modules information is required,
2195 such as when responding to a resource
2196 loader request or generating HTML output.
2197 &$resourceLoader: ResourceLoader object
2199 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2200 called after the addition of 'qunit' and MediaWiki testing resources.
2201 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2202 included in core, is fed using tests/qunit/QUnitTestResources.php.
2203 &ResourceLoader object
2205 To add a new qunit module named 'myext.tests':
2206 testModules['qunit']['myext.tests'] = array(
2207 'script' => 'extension/myext/tests.js',
2208 'dependencies' => <any module dependency you might have>
2210 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2211 added to any module.
2213 'RevisionInsertComplete': Called after a revision is inserted into the database.
2214 &$revision: the Revision
2215 $data: the data stored in old_text. The meaning depends on $flags: if external
2216 is set, it's the URL of the revision text in external storage; otherwise,
2217 it's the revision text itself. In either case, if gzip is set, the revision
2219 $flags: a comma-delimited list of strings representing the options used. May
2220 include: utf8 (this will always be set for new revisions); gzip; external.
2222 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2223 the normal operations.
2224 $allSearchTerms : Array of the search terms in all content languages
2225 &$titleResult : Outparam; the value to return. A Title object or null.
2227 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2228 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2230 $term : Search term string
2231 &$title : Outparam; set to $title object and return false for a match
2233 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2234 if nothing was found.
2235 $term : Search term string
2236 &$title : Outparam; set to $title object and return false for a match
2238 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2240 $term : Search term string
2241 &$title : Current Title object that is being returned (null if none found).
2243 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2245 $title : Current Title object being displayed in search results.
2246 &$id: Revision ID (default is false, for latest)
2248 'SearchableNamespaces': An option to modify which namespaces are searchable.
2249 &$arr : Array of namespaces ($nsId => $name) which will be used.
2251 'SelfLinkBegin': Called before a link to the current article is displayed to
2252 allow the display of the link to be customized.
2253 $nt: the Title object
2254 &$html: html to display for the link
2255 &$trail: optional text to display before $html
2256 &$prefix: optional text to display after $html
2257 &$ret: the value to return if your hook returns false
2259 'SetupAfterCache': Called in Setup.php, after cache objects are set
2261 'ShowMissingArticle': Called when generating the output for a non-existent page.
2262 $article: The article object corresponding to the page
2264 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2265 DEPRECATED, use the ContentGetParserOutput hook instead!
2266 $text: Text being shown
2267 $title: Title of the custom script/stylesheet page
2268 $output: Current OutputPage object
2270 'ShowSearchHitTitle': Customise display of search hit title/link.
2271 &$title: Title to link to
2272 &$text: Text to use for the link
2273 $result: The search result
2274 $terms: The search terms entered
2275 $page: The SpecialSearch object.
2277 'ShowSearchHit': Customize display of search hit.
2278 $searchPage: The SpecialSearch instance.
2279 $result: The SearchResult to show
2280 $terms: Search terms, for highlighting
2281 &$link: HTML of link to the matching page. May be modified.
2282 &$redirect: HTML of redirect info. May be modified.
2283 &$section: HTML of matching section. May be modified.
2284 &$extract: HTML of content extract. May be modified.
2285 &$score: HTML of score. May be modified.
2286 &$size: HTML of page size. May be modified.
2287 &$date: HTML of of page modification date. May be modified.
2288 &$related: HTML of additional info for the matching page. May be modified.
2289 &$html: May be set to the full HTML that should be used to represent the search
2290 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2291 function returned false.
2293 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2294 allow the normal method of notice selection/rendering to work, or change the
2295 value of $siteNotice and return false to alter it.
2296 &$siteNotice: HTML returned as the sitenotice
2299 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2300 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2301 the sitenotice/anonnotice.
2304 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2306 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2307 the stock bottom scripts.
2309 'SkinAfterContent': Allows extensions to add text after the page content and
2310 article metadata. This hook should work in all skins. Set the &$data variable to
2311 the text you're going to add.
2312 &$data: (string) Text to be printed out directly (without parsing)
2315 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2317 &$bar: Sidebar contents
2318 Modify $bar to add or modify sidebar portlets.
2320 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2322 &$bar: Sidebar content
2323 Modify $bar to add or modify sidebar portlets.
2324 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2326 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2328 $title: displayed page title
2329 $type: 'normal' or 'history' for old/diff views
2330 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2331 message must be in HTML format, not wikitext!
2332 &$link: overridable HTML link to be passed into the message as $1
2333 &$forContent: overridable flag if copyright footer is shown in content language.
2334 This parameter is deprecated.
2336 'SkinGetPoweredBy': TODO
2337 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2338 the MediaWiki icon but plain text instead.
2341 'SkinPreloadExistence': Supply titles that should be added to link existence
2342 cache before the page is rendered.
2343 &$titles: Array of Title objects
2346 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2347 &$subpages: Subpage links HTML
2349 $out: OutputPage object
2350 If false is returned $subpages will be used instead of the HTML
2351 subPageSubtitle() generates.
2352 If true is returned, $subpages will be ignored and the rest of
2353 subPageSubtitle() will run.
2355 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2357 $sktemplate: SkinTemplate object
2358 $nav_urls: array of tabs
2360 'SkinTemplateGetLanguageLink': After building the data for a language link from
2361 which the actual html is constructed.
2362 &$languageLink: array containing data about the link. The following keys can be
2363 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2364 $languageLinkTitle: Title object belonging to the external language link.
2365 $title: Title object of the page the link belongs to.
2366 $outputPage: The OutputPage object the links are built from.
2368 To alter the structured navigation links in SkinTemplates, there are three
2369 hooks called in different spots:
2371 'SkinTemplateNavigation': Called on content pages after the tabs have been
2372 added, but before variants have been added.
2373 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2374 tab is added but before variants have been added.
2375 'SkinTemplateNavigation::Universal': Called on both content and special pages
2376 after variants have been added.
2377 &$sktemplate: SkinTemplate object
2378 &$links: Structured navigation links. This is used to alter the navigation for
2379 skins which use buildNavigationUrls such as Vector.
2381 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2383 &$sktemplate: SkinTemplate object
2384 &$tpl: Template engine object
2386 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2387 $sktemplate: SkinTemplate object
2388 $res: set to true to prevent active tabs
2390 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2391 You can either create your own array, or alter the parameters for
2393 &$sktemplate: The SkinTemplate instance.
2394 $title: Title instance for the page.
2395 $message: Visible label of tab.
2396 $selected: Whether this is a selected tab.
2397 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2398 &$classes: Array of CSS classes to apply.
2399 &$query: Query string to add to link.
2401 &$result: Complete assoc. array if you want to return true.
2403 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2404 been rendered (useful for adding more).
2405 $sk: The QuickTemplate based skin template running the hook.
2406 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2407 extensions that add support for BaseTemplateToolbox should watch for this
2408 dummy parameter with "$dummy=false" in their code and return without echoing
2409 any HTML to avoid creating duplicate toolbox items.
2411 'SoftwareInfo': Called by Special:Version for returning information about the
2413 $software: The array of software in format 'name' => 'version'. See
2414 SpecialVersion::softwareInformation().
2416 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2417 $name: name of the special page
2418 &$form: HTMLForm object
2420 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2421 $sp: SpecialPage object, for context
2422 &$fields: Current HTMLForm fields
2424 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2425 $id: User id number, only provided for backwards-compatibility
2426 $user: User object representing user contributions are being fetched for
2427 $sp: SpecialPage instance, providing context
2429 'SpecialListusersDefaultQuery': Called right before the end of
2430 UsersPager::getDefaultQuery().
2431 $pager: The UsersPager instance
2432 $query: The query array to be returned
2434 'SpecialListusersFormatRow': Called right before the end of
2435 UsersPager::formatRow().
2436 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2437 $row: Database row object
2439 'SpecialListusersHeader': Called before closing the <fieldset> in
2440 UsersPager::getPageHeader().
2441 $pager: The UsersPager instance
2442 $out: The header HTML
2444 'SpecialListusersHeaderForm': Called before adding the submit button in
2445 UsersPager::getPageHeader().
2446 $pager: The UsersPager instance
2447 $out: The header HTML
2449 'SpecialListusersQueryInfo': Called right before the end of.
2450 UsersPager::getQueryInfo()
2451 $pager: The UsersPager instance
2452 $query: The query array to be returned
2454 'SpecialMovepageAfterMove': Called after moving a page.
2455 $movePage: MovePageForm object
2456 $oldTitle: old title (object)
2457 $newTitle: new title (object)
2459 'SpecialNewpagesConditions': Called when building sql query for
2461 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2462 $opts: FormOptions object containing special page options
2463 &$conds: array of WHERE conditionals for query
2464 &tables: array of tables to be queried
2465 &$fields: array of columns to select
2466 &$join_conds: join conditions for the tables
2468 'SpecialNewPagesFilters': Called after building form options at NewPages.
2469 $special: the special page object
2470 &$filters: associative array of filter definitions. The keys are the HTML
2471 name/URL parameters. Each key maps to an associative array with a 'msg'
2472 (message key) and a 'default' value.
2474 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2475 hook to remove a core special page.
2476 $list: list (array) of core special pages
2478 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2479 $special: the SpecialPage object
2480 $subPage: the subpage string or null if no subpage was specified
2482 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2483 $special: the SpecialPage object
2484 $subPage: the subpage string or null if no subpage was specified
2486 'SpecialPasswordResetOnSubmit': When executing a form submission on
2487 Special:PasswordReset.
2488 $users: array of User objects.
2489 $data: array of data submitted by the user
2490 &$error: string, error code (message key) used to describe to error (out
2491 parameter). The hook needs to return false when setting this, otherwise it
2492 will have no effect.
2494 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2495 use this to change some selection criteria or substitute a different title.
2496 &$randstr: The random number from wfRandom()
2497 &$isRedir: Boolean, whether to select a redirect or non-redirect
2498 &$namespaces: An array of namespace indexes to get the title from
2499 &$extra: An array of extra SQL statements
2500 &$title: If the hook returns false, a Title object to use instead of the
2501 result from the normal query
2503 'SpecialRecentChangesFilters': Called after building form options at
2504 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2505 $special: the special page object
2506 &$filters: associative array of filter definitions. The keys are the HTML
2507 name/URL parameters. Each key maps to an associative array with a 'msg'
2508 (message key) and a 'default' value.
2510 'SpecialRecentChangesPanel': Called when building form options in
2511 SpecialRecentChanges.
2512 &$extraOpts: array of added items, to which can be added
2513 $opts: FormOptions for this request
2515 'SpecialRecentChangesQuery': Called when building SQL query for
2516 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2517 ChangesListSpecialPageQuery instead.
2518 &$conds: array of WHERE conditionals for query
2519 &$tables: array of tables to be queried
2520 &$join_conds: join conditions for the tables
2521 $opts: FormOptions for this request
2522 &$query_options: array of options for the database request
2523 &$select: Array of columns to select
2525 'SpecialResetTokensTokens': Called when building token list for
2527 &$tokens: array of token information arrays in the format of
2528 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2530 'SpecialSearchCreateLink': Called when making the message to create a page or
2531 go to the existing page.
2532 $t: title object searched for
2533 &$params: an array of the default message name and page title (as parameter)
2535 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2536 target doesn't exist.
2537 &$title: title object generated from the text entered by the user
2539 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2540 the advanced form, a.k.a. power search box.
2541 &$showSections: an array to add values with more options to
2542 $term: the search term (not a title object)
2543 $opts: an array of hidden options (containing 'redirs' and 'profile')
2545 'SpecialSearchProfiles': Allows modification of search profiles.
2546 &$profiles: profiles, which can be modified.
2548 'SpecialSearchProfileForm': Allows modification of search profile forms.
2549 $search: special page object
2550 &$form: String: form html
2551 $profile: String: current search profile
2552 $term: String: search term
2553 $opts: Array: key => value of hidden options for inclusion in custom forms
2555 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2556 $search: SpecialSearch special page object
2557 $profile: String: current search profile
2558 $engine: the search engine
2560 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2561 on the search results page. Useful for including an external search
2562 provider. To disable the output of MediaWiki search output, return
2564 $specialSearch: SpecialSearch object ($this)
2566 $term: Search term specified by the user
2568 'SpecialSearchResults': Called before search result display
2569 $term: string of search term
2570 &$titleMatches: empty or SearchResultSet object
2571 &$textMatches: empty or SearchResultSet object
2573 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2574 &$extraStats: Array to save the new stats
2575 ( $extraStats['<name of statistic>'] => <value>; )
2577 'SpecialUploadComplete': Called after successfully uploading a file from
2579 $form: The SpecialUpload object
2581 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2582 $wgVersion: Current $wgVersion for you to use
2583 &$versionUrl: Raw url to link to (eg: release notes)
2585 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2586 Deprecated, use ChangesListSpecialPageFilters instead.
2587 $special: the special page object
2588 &$filters: associative array of filter definitions. The keys are the HTML
2589 name/URL parameters. Each key maps to an associative array with a 'msg'
2590 (message key) and a 'default' value.
2592 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2593 Deprecated, use ChangesListSpecialPageQuery instead.
2594 &$conds: array of WHERE conditionals for query
2595 &$tables: array of tables to be queried
2596 &$join_conds: join conditions for the tables
2597 &$fields: array of query fields
2598 $opts: A FormOptions object with watchlist options for the current request
2600 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2601 SpecialWatchlist. Allows extensions to register custom values they have
2602 inserted to rc_type so they can be returned as part of the watchlist.
2603 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2605 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2606 URL for a title when we have no other parameters on the URL. Gives a chance for
2607 extensions that alter page view behavior radically to abort that redirect or
2609 $request: WebRequest
2610 $title: Title of the currently found title obj
2611 $output: OutputPage object
2613 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2614 rendered (by ThumbnailImage:toHtml method).
2615 $thumbnail: the ThumbnailImage object
2616 &$attribs: image attribute array
2617 &$linkAttribs: image link attribute array
2619 'TitleArrayFromResult': Called when creating an TitleArray object from a
2621 &$titleArray: set this to an object to override the default object returned
2622 $res: database result used to create the object
2624 'TitleExists': Called when determining whether a page exists at a given title.
2625 $title: The title being tested.
2626 &$exists: Whether the title exists.
2628 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2629 or override the quick permissions check.
2630 $title: The Title object being accessed
2631 $user: The User performing the action
2632 $action: Action being performed
2633 &$errors: Array of errors
2634 $doExpensiveQueries: Whether to do expensive DB queries
2635 $short: Whether to return immediately on first error
2637 'TitleGetEditNotices': Allows extensions to add edit notices
2638 $title: The Title object for the page the edit notices are for
2639 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2640 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2642 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2643 that can be applied.
2644 $title: The title in question.
2645 &$types: The types of protection available.
2647 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2648 $title: Title object that is being checked
2649 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2650 Hooks may change this value to override the return value of
2651 Title::isCssOrJsPage().
2653 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2654 overriding default behavior for determining if a page exists. If $isKnown is
2655 kept as null, regular checks happen. If it's a boolean, this value is returned
2656 by the isKnown method.
2657 $title: Title object that is being checked
2658 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2660 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2661 that this hook is not called for interwiki pages or pages in immovable
2662 namespaces: for these, isMovable() always returns false.
2663 $title: Title object that is being checked
2664 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2665 Hooks may change this value to override the return value of
2668 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2669 be handled by separate handler (via ArticleViewCustom).
2670 $title: Title object that is being checked
2671 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2672 Hooks may change this value to override the return value of
2673 Title::isWikitextPage()
2675 'TitleMove': Before moving an article (title).
2678 $user: user who does the move
2680 'TitleMoveComplete': After moving an article (title).
2683 $user: user who did the move
2684 $pageid: database ID of the page that's been moved
2685 $redirid: database ID of the created redirect
2686 $reason: reason for the move
2688 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2689 adding the default error message if nothing allows the user to read the page. If
2690 a handler wants a title to *not* be whitelisted, it should also return false.
2691 $title: Title object being checked against
2692 $user: Current user object
2693 &$whitelisted: Boolean value of whether this title is whitelisted
2695 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2696 $title: Title object to purge
2697 &$urls: An array of URLs to purge from the caches, to be manipulated.
2699 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2700 PageArchive object has been created but before any further processing is done.
2701 &$archive: PageArchive object
2702 $title: Title object of the page that we're viewing
2704 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2705 PageArchive object has been created but before any further processing is done.
2706 &$archive: PageArchive object
2707 $title: Title object of the page that we're viewing
2709 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2710 the site is not in read-only mode, that the Title object is not null and after
2711 a PageArchive object has been constructed but before performing any further
2713 &$archive: PageArchive object
2714 $title: Title object of the page that we're about to undelete
2716 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2717 $title: title object related to the revision
2718 $rev: revision (object) that will be viewed
2720 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2722 $action: action name
2723 $article: article "acted on"
2725 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2726 &$files: list of files
2728 'UnwatchArticle': Before a watch is removed from an article.
2729 $user: user watching
2730 $page: WikiPage object to be removed
2731 &$status: Status object to be returned if the hook returns false
2733 'UnwatchArticleComplete': After a watch is removed from an article.
2734 $user: user that watched
2735 $page: WikiPage object that was watched
2737 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2738 $formattedPageStatus: list of valid page states
2740 'UploadForm:initial': Before the upload form is generated. You might set the
2741 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2742 text (HTML) either before or after the editform.
2743 $form: UploadForm object
2745 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2746 poke at member variables like $mUploadDescription before the file is saved. Do
2747 not use this hook to break upload processing. This will return the user to a
2748 blank form with no error message; use UploadVerification and UploadVerifyFile
2750 $form: UploadForm object
2752 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2753 $type: (string) the requested upload type
2754 &$className: the class name of the Upload instance to be created
2756 'UploadComplete': when Upload completes an upload.
2757 &$upload: an UploadBase child instance
2759 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2761 $descriptor: (array) the HTMLForm descriptor
2763 'UploadFormSourceDescriptors': after the standard source inputs have been
2764 added to the descriptor
2765 $descriptor: (array) the HTMLForm descriptor
2767 'UploadVerification': Additional chances to reject an uploaded file. Consider
2768 using UploadVerifyFile instead.
2769 string $saveName: destination file name
2770 string $tempName: filesystem path to the temporary file for checks
2771 string &$error: output: message key for message to show if upload canceled by
2772 returning false. May also be an array, where the first element is the message
2773 key and the remaining elements are used as parameters to the message.
2775 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
2776 in most cases over UploadVerification.
2777 object $upload: an instance of UploadBase, with all info about the upload
2778 string $mime: The uploaded file's MIME type, as detected by MediaWiki. Handlers
2779 will typically only apply for specific MIME types.
2780 object &$error: output: true if the file is valid. Otherwise, an indexed array
2781 representing the problem with the file, where the first element is the message
2782 key and the remaining elements are used as parameters to the message.
2784 'UploadComplete': Upon completion of a file upload.
2785 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2786 $uploadBase->getLocalFile().
2788 'User::mailPasswordInternal': before creation and mailing of a user's new
2790 $user: the user who sent the message out
2791 $ip: IP of the user who sent the message out
2792 $u: the account whose new password will be set
2794 'UserAddGroup': Called when adding a group; return false to override
2795 stock group addition.
2796 $user: the user object that is to have a group added
2797 &$group: the group to add, can be modified
2799 'UserArrayFromResult': Called when creating an UserArray object from a database
2801 &$userArray: set this to an object to override the default object returned
2802 $res: database result used to create the object
2804 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2805 want to display an error message, try getUserPermissionsErrors.
2806 $title: Title object being checked against
2807 $user : Current user object
2808 $action: Action being checked
2809 $result: Pointer to result returned if hook returns false. If null is returned,
2810 userCan checks are continued by internal code.
2812 'UserCanSendEmail': To override User::canSendEmail() permission check.
2813 $user: User (object) whose permission is being checked
2814 &$canSend: bool set on input, can override on output
2816 'UserClearNewTalkNotification': Called when clearing the "You have new
2817 messages!" message, return false to not delete it.
2818 $user: User (object) that will clear the message
2819 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2821 'UserCreateForm': change to manipulate the login form
2822 $template: SimpleTemplate instance for the form
2824 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2825 $user: User to get groups for
2826 &$groups: Current effective groups
2828 'UserGetAllRights': After calculating a list of all available rights.
2829 &$rights: Array of rights, which may be added to.
2831 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2832 before returning the options to the caller. Warning: This hook is called for
2833 every call to User::getDefaultOptions(), which means it's potentially called
2834 dozens or hundreds of times. You may want to cache the results of non-trivial
2835 operations in your hook function for this reason.
2836 &$defaultOptions: Array of preference keys and their default values.
2838 'UserGetEmail': Called when getting an user email address.
2840 &$email: email, change this to override local email
2842 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2843 email authentication.
2845 &$timestamp: timestamp, change this to override local email authentication
2848 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2849 &$groups: List of implicit (automatically-assigned) groups
2851 'UserGetLanguageObject': Called when getting user's interface language object.
2853 &$code: Language code that will be used to create the object
2854 $context: RequestContext object
2856 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2857 &$reservedUsernames: $wgReservedUsernames
2859 'UserGetRights': Called in User::getRights().
2860 $user: User to get rights for
2861 &$rights: Current rights
2863 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2864 specific block exemptions).
2865 $user: User in question
2866 $title: Title of the page in question
2867 &$blocked: Out-param, whether or not the user is blocked from that page.
2868 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2869 to edit their own user talk pages.
2871 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2873 $ip: User's IP address
2874 &$blocked: Whether the user is blocked, to be modified by the hook
2876 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2877 false if a UserGetRights hook might remove the named right.
2878 $right: The user right being checked
2880 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2881 environmental means; occurs after session is loaded.
2882 $user: user object being loaded
2884 'UserLoadDefaults': Called when loading a default user.
2888 'UserLoadFromDatabase': Called when loading a user from the database.
2890 &$s: database query object
2892 'UserLoadFromSession': Called to authenticate users on external/environmental
2893 means; occurs before session is loaded.
2894 $user: user object being loaded
2895 &$result: set this to a boolean value to abort the normal authentication
2898 'UserLoadOptions': When user options/preferences are being loaded from the
2901 &$options: Options, can be modified.
2903 'UserLoginComplete': After a user has logged in.
2904 $user: the user object that was created on login
2905 $inject_html: Any HTML to inject after the "logged in" message.
2907 'UserLoginForm': change to manipulate the login form
2908 $template: SimpleTemplate instance for the form
2910 'UserLogout': Before a user logs out.
2911 $user: the user object that is about to be logged out
2913 'UserLogoutComplete': After a user has logged out.
2914 $user: the user object _after_ logout (won't have name, ID, etc.)
2915 $inject_html: Any HTML to inject after the "logged out" message.
2916 $oldName: name of the user before logout (string)
2918 'UserRemoveGroup': Called when removing a group; return false to override stock
2920 $user: the user object that is to have a group removed
2921 &$group: the group to be removed, can be modified
2923 'UserRights': After a user's group memberships are changed.
2924 $user : User object that was changed
2925 $add : Array of strings corresponding to groups added
2926 $remove: Array of strings corresponding to groups removed
2928 'UserRequiresHTTPS': Called to determine whether a user needs
2929 to be switched to HTTPS.
2930 $user: User in question.
2931 &$https: Boolean whether $user should be switched to HTTPS.
2933 'UserResetAllOptions': Called in User::resetOptions() when user preferences
2934 have been requested to be reset. This hook can be used to exclude certain
2935 options from being reset even when the user has requested all prefs to be reset,
2936 because certain options might be stored in the user_properties database table
2937 despite not being visible and editable via Special:Preferences.
2938 $user: the User (object) whose preferences are being reset
2939 &$newOptions: array of new (site default) preferences
2940 $options: array of the user's old preferences
2941 $resetKinds: array containing the kinds of preferences to reset
2943 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2945 $user: user retrieving new talks messages
2946 $talks: array of new talks page(s)
2948 'UserSaveSettings': Called when saving user settings.
2951 'UserSaveOptions': Called just before saving user preferences/options.
2953 &$options: Options, modifiable
2955 'UserSetCookies': Called when setting user cookies.
2957 &$session: session array, will be added to $_SESSION
2958 &$cookies: cookies array mapping cookie name to its value
2960 'UserSetEmail': Called when changing user email address.
2962 &$email: new email, change this to override new email address
2964 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2965 email authentication.
2967 &$timestamp: new timestamp, change this to override local email
2968 authentication timestamp
2970 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2971 "Foobar (Talk | Contribs | Block)".
2972 $userId: User id of the current user
2973 $userText: User name of the current user
2974 &$items: Array of user tool links as HTML fragments
2976 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
2977 FormatMetadata::getExtendedMeta (return false means cache will be
2978 invalidated and GetExtendedMetadata hook called again).
2979 $timestamp: The timestamp metadata was generated
2980 $file: The file the metadata is for
2982 'UserMailerChangeReturnPath': Called to generate a VERP return address
2983 when UserMailer sends an email, with a bounce handling extension.
2984 $to: Array of MailAddress objects for the recipients
2985 &$returnPath: The return address string
2987 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2988 used to alter the SQL query which gets the list of wanted pages.
2989 &$wantedPages: WantedPagesPage object
2990 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2992 'WatchArticle': Before a watch is added to an article.
2993 $user: user that will watch
2994 $page: WikiPage object to be watched
2995 &$status: Status object to be returned if the hook returns false
2997 'WatchArticleComplete': After a watch is added to an article.
2998 $user: user that watched
2999 $page: WikiPage object watched
3001 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3002 form, used to manipulate the list of pages or preload data based on that list.
3003 &$watchlistInfo: array of watchlisted pages in
3004 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3006 'WatchlistEditorBuildRemoveLine': when building remove lines in
3007 Special:Watchlist/edit.
3008 &$tools: array of extra links
3009 $title: Title object
3010 $redirect: whether the page is a redirect
3012 &$link: HTML link to title
3014 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3016 $router: The PathRouter instance
3018 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3019 Return false to prevent setting of the cookie.
3020 &$name: Cookie name passed to WebResponse::setcookie()
3021 &$value: Cookie value passed to WebResponse::setcookie()
3022 &$expire: Cookie expiration, as for PHP's setcookie()
3023 $options: Options passed to WebResponse::setcookie()
3025 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3026 $row: The DB row of the entry.
3027 $title: The Title of the page where the link comes FROM
3028 $target: The Title of the page where the link goes TO
3029 &$props: Array of HTML strings to display after the title.
3031 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3032 dumps. One, and only one hook should set this, and return false.
3033 &$tables: Database tables to use in the SELECT query
3034 &$opts: Options to use for the query
3035 &$join: Join conditions
3037 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3038 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3039 specific to a content model should be provided by the respective Content's
3040 getDeletionUpdates() method.
3042 $content: the Content to generate updates for
3043 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3045 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3046 run a MediaWiki cli script.
3047 &$script: MediaWiki cli script path
3048 &$parameters: Array of arguments and options to the script
3049 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3052 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3053 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3054 $qp: The list of QueryPages
3056 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3057 extra metadata to be added.
3058 $obj: The XmlDumpWriter object.
3059 &$out: The output string.
3060 $row: The database row for the page.
3061 $title: The title of the page.
3063 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3065 $obj: The XmlDumpWriter object.
3066 &$out: The text being output.
3067 $row: The database row for the revision.
3068 $text: The revision text.
3070 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3071 to add additional tags to extract.
3072 &$items: Array containing information on which items to extract. See XMPInfo for
3073 details on the format.
3075 'XMPGetResults': Called just before returning the results array of parsing xmp
3076 data. Can be used to post-process the results.
3077 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3078 is an array of metadata tags returned (each tag is either a value, or an array
3081 More hooks might be available but undocumented, you can execute
3082 "php maintenance/findHooks.php" to find hidden ones.