Merge "Fixed doc typo"
[mediawiki.git] / docs / hooks.txt
blobd455fd28800b0acb5a59494190a119bc2fd8565a
1 hooks.txt
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.
6 ==Glossary==
8 event
9      Something that happens with the wiki. For example: a user logs in. A wiki
10      page is saved. A wiki page is deleted. Often there are two events
11      associated with a single action: one before the code is run to make the
12      event happen, and one after. Each event has a name, preferably in
13      CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
14      'ArticleDelete'.
16 hook
17      A clump of code and data that should be run when an event happens. This can
18      be either a function and a chunk of data, or an object and a method.
20 hook function
21      The function part of a hook.
23 ==Rationale==
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);
42                 }
44                 if ($wgCapitalizeTitle) {
45                         wfCapitalizeTitle($article);
46                 }
48                 # code to actually show the article goes here
49         }
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);
60                 }
62                 if ($wgCapitalizeTitle) {
63                         wfCapitalizeTitle($article);
64                 }
66                 # code to actually show the article goes here
68                 if ($wgNotifyArticle) {
69                         wfNotifyArticleShow($article));
70                 }
71         }
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));
83                 }
84         }
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
94 file:
96         function reverseArticleTitle($article) {
97                 # ...
98         }
100         function reverseForExport($article) {
101                 # ...
102         }
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
107         setupTitleReversingExtension() {
108                 global $wgHooks;
110                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112                 $wgHooks['ArticleExport'][] = 'reverseForExport';
113         }
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
126 just leave it out.
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.
131 ==Writing hooks==
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:
154         # function, no data
155         someFunction($param1, $param2)
156         # function with data
157         someFunction($someData, $param1, $param2)
159         # object only
160         $object->onEventName($param1, $param2)
161         # object with method
162         $object->someMethod($param1, $param2)
163         # object with method and data
164         $object->someMethod($someData, $param1, $param2)
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
185            function should skip
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) {
194                 # log user into LDAP
195                 return false;
196         }
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.
205 ==Using hooks==
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
210         class Article {
211                 # ...
212                 function protect() {
213                         global $wgUser;
214                         if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215                                 # protect the article
216                                 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217                         }
218                 }
219         }
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
230 MediaWiki 1.4rc1.
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
239 a local account.
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.
254 'AbortLogin': Return false to cancel account login.
255 $user: the User object being authenticated against
256 $password: the password being submitted, not yet checked for validity
257 &$retval: a LoginForm class constant to return from authenticateUserData();
258           default is LoginForm::ABORTED. Note that the client may be using
259           a machine API rather than the HTML user interface.
260 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
262 'AbortMove': Allows to abort moving an article (title).
263 $old: old title
264 $nt: new title
265 $user: user who is doing the move
266 $err: error message
267 $reason: the reason for the move (added in 1.13)
269 'AbortNewAccount': Return false to cancel explicit account creation.
270 $user: the User object about to be created (read-only, incomplete)
271 &$msg: out parameter: HTML to display on abort
272 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
273           Create the object with Status::newFatal() to ensure proper API error messages
274           are returned when creating account through API clients.
276 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
277 $targetUser: the user whom to send talk page email notification
278 $title: the page title
280 'SendWatchlistEmailNotification': Return true to send watchlist email notification
281 $targetUser: the user whom to send watchlist email notification
282 $title: the page title
283 $this: EmailNotification object
285 'AbortChangePassword': Return false to cancel password change.
286 $user: the User object to which the password change is occuring
287 $mOldpass: the old password provided by the user
288 $newpass: the new password provided by the user
289 &$abortMsg: the message identifier for abort reason
291 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
292 $name: name of the action
293 &$form: HTMLForm object
294 $article: Article object
296 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
297 Allows to change the fields on the form that will be generated.
298 $name: name of the action
299 &$fields: HTMLForm descriptor array
300 $article: Article object
302 'AddNewAccount': After a user account is created.
303 $user: the User object that was created. (Parameter added in 1.7)
304 $byEmail: true when account was created "by email" (added in 1.12)
306 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
307 $apiModule: the ApiCreateAccount module calling
308 $loginForm: the LoginForm used
310 'AddNewAccountApiResult': Modify API output when creating a new account via API.
311 $apiModule: the ApiCreateAccount module calling
312 $loginForm: the LoginForm used
313 &$result: associative array for API result data
315 'AfterFinalPageOutput': At the end of OutputPage::output() but before final
316 ob_end_flush() which will send the buffered output to the client. This allows
317 for last-minute modification of the output within the buffer by using
318 ob_get_clean().
319 &$output: OutputPage object
321 'AfterImportPage': When a page import is completed.
322 $title: Title under which the revisions were imported
323 $origTitle: Title provided by the XML file
324 $revCount: Number of revisions in the XML file
325 $sRevCount: Number of successfully imported revisions
326 $pageInfo: associative array of page information
328 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
329 before OutputPage::sendCacheControl() and final ob_end_flush() which
330 will send the buffered output to the client. This allows for last-minute
331 modification of the output within the buffer by using ob_get_clean().
332 $output: The OutputPage object where output() was called
334 'AjaxAddScript': Called in output page just before the initialisation
335 of the javascript ajax engine. The hook is only called when ajax
336 is enabled ( $wgUseAjax = true; ).
337 &$output: OutputPage object
339 'AlternateEdit': Before checking if a user can edit a page and before showing
340 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
341 $editPage: the EditPage object
343 'AlternateEditPreview': Before generating the preview of the page when editing
344 ( EditPage::getPreviewText() ).
345 $editPage: the EditPage object
346 &$content: the Content object for the text field from the edit page
347 &$previewHTML: Text to be placed into the page for the preview
348 &$parserOutput: the ParserOutput object for the preview
349 return false and set $previewHTML and $parserOutput to output custom page
350 preview HTML.
352 'AlternateUserMailer': Called before mail is sent so that mail could be logged
353 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
354 the regular method of sending mail.  Return a string to return a php-mail-error
355 message containing the error. Returning true will continue with sending email
356 in the regular way.
357 $headers: Associative array of headers for the email
358 $to: MailAddress object or array
359 $from: From address
360 $subject: Subject of the email
361 $body: Body of the message
363 'APIAfterExecute': After calling the execute() method of an API module. Use
364 this to extend core API modules.
365 &$module: Module object
367 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
368 &$main: ApiMain object
370 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
371 authenticate and authorize API clients before executing the module. Return
372 false and set a message to cancel the request.
373 $module: Module object
374 $user: Current user
375 &$message: API usage message to die with, as a message key or array
376 as accepted by ApiBase::dieUsageMsg.
378 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
379 processing request parameters. Return false to let the request fail, returning
380 an error message or an <edit result="Failure"> tag if $resultArr was filled.
381 $editPage : the EditPage object
382 $text : the new text of the article (has yet to be saved)
383 &$resultArr : data in this array will be added to the API result
385 'APIGetAllowedParams': Use this hook to modify a module's parameters.
386 &$module: ApiBase Module object
387 &$params: Array of parameters
388 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
390 'APIGetDescription': Use this hook to modify a module's description.
391 &$module: ApiBase Module object
392 &$desc: Array of descriptions
394 'APIGetParamDescription': Use this hook to modify a module's parameter
395 descriptions.
396 &$module: ApiBase Module object
397 &$desc: Array of parameter descriptions
399 'APIGetResultProperties': Use this hook to modify the properties in a module's
400 result.
401 &$module: ApiBase Module object
402 &$properties: Array of properties
404 'APIGetPossibleErrors': Use this hook to modify the module's list of possible
405 errors.
406 $module: ApiBase Module object
407 &$possibleErrors: Array of possible errors
409 'APIQueryAfterExecute': After calling the execute() method of an
410 action=query submodule. Use this to extend core API modules.
411 &$module: Module object
413 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
414 an action=query submodule. Use this to extend core API modules.
415 &$module: Module object
416 &$resultPageSet: ApiPageSet object
418 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
419 token has an action, which will be used in the intoken parameter and in the
420 output (actiontoken="..."), and a callback function which should return the
421 token, or false if the user isn't allowed to obtain it. The prototype of the
422 callback function is func($pageid, $title), where $pageid is the page ID of the
423 page the token is requested for and $title is the associated Title object. In
424 the hook, just add your callback to the $tokenFunctions array and return true
425 (returning false makes no sense).
426 $tokenFunctions: array(action => callback)
428 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
429 Every token has an action, which will be used in the rvtoken parameter and in
430 the output (actiontoken="..."), and a callback function which should return the
431 token, or false if the user isn't allowed to obtain it. The prototype of the
432 callback function is func($pageid, $title, $rev), where $pageid is the page ID
433 of the page associated to the revision the token is requested for, $title the
434 associated Title object and $rev the associated Revision object. In the hook,
435 just add your callback to the $tokenFunctions array and return true (returning
436 false makes no sense).
437 $tokenFunctions: array(action => callback)
439 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
440 list=recentchanges. Every token has an action, which will be used in the rctoken
441 parameter and in the output (actiontoken="..."), and a callback function which
442 should return the token, or false if the user isn't allowed to obtain it. The
443 prototype of the callback function is func($pageid, $title, $rc), where $pageid
444 is the page ID of the page associated to the revision the token is requested
445 for, $title the associated Title object and $rc the associated RecentChange
446 object. In the hook, just add your callback to the $tokenFunctions array and
447 return true (returning false makes no sense).
448 $tokenFunctions: array(action => callback)
450 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
451 sites general information.
452 $module: the current ApiQuerySiteInfo module
453 &$results: array of results, add things here
455 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
456 sites statistics information.
457 &$results: array of results, add things here
459 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
460 token has an action, which will be used in the ustoken parameter and in the
461 output (actiontoken="..."), and a callback function which should return the
462 token, or false if the user isn't allowed to obtain it. The prototype of the
463 callback function is func($user) where $user is the User object. In the hook,
464 just add your callback to the $tokenFunctions array and return true (returning
465 false makes no sense).
466 $tokenFunctions: array(action => callback)
468 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
469 an exception is thrown during API action execution.
470 $apiMain: Calling ApiMain instance.
471 $e: Exception object.
473 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
474 should have its own entry in the $apis array and have a unique name, passed as
475 key for the array that represents the service data. In this data array, the
476 key-value-pair identified by the apiLink key is required.
477 &$apis: array of services
479 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
480 types.
481 &$tokenTypes: supported token types in format 'type' => callback function
482 used to retrieve this type of tokens.
484 'Article::MissingArticleConditions': Before fetching deletion & move log entries
485 to display a message of a non-existing page being deleted/moved, give extensions
486 a chance to hide their (unrelated) log entries.
487 &$conds: Array of query conditions (all of which have to be met; conditions will
488 AND in the final query)
489 $logTypes: Array of log types being queried
491 'ArticleAfterFetchContent': After fetching content of an article from the
492 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
493 $article: the article (object) being loaded from the database
494 &$content: the content (string) of the article
496 'ArticleAfterFetchContentObject': After fetching content of an article from the
497 database.
498 $article: the article (object) being loaded from the database
499 &$content: the content of the article, as a Content object
501 'ArticleConfirmDelete': Before writing the confirmation form for article
502 deletion.
503 $article: the article (object) being deleted
504 $output: the OutputPage object
505 &$reason: the reason (string) the article is being deleted
507 'ArticleContentOnDiff': Before showing the article content below a diff. Use
508 this to change the content in this area or how it is loaded.
509 $diffEngine: the DifferenceEngine
510 $output: the OutputPage object
512 'ArticleDelete': Before an article is deleted.
513 $wikiPage: the WikiPage (object) being deleted
514 $user: the user (object) deleting the article
515 $reason: the reason (string) the article is being deleted
516 $error: if the deletion was prohibited, the (raw HTML) error message to display
517   (added in 1.13)
518 $status: Status object, modify this to throw an error. Overridden by $error
519   (added in 1.20)
521 'ArticleDeleteComplete': After an article is deleted.
522 $wikiPage: the WikiPage that was deleted
523 $user: the user that deleted the article
524 $reason: the reason the article was deleted
525 $id: id of the article that was deleted
526 $content: the Content of the deleted page
527 $logEntry: the ManualLogEntry used to record the deletion
529 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
530 was changed.
531 &$wikiPage: WikiPage (object) of the user talk page
532 $recipient: User (object) who's talk page was edited
534 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
535 article has been changed.
536 $wikiPage: the WikiPage (object)
537 $editInfo: data holder that includes the parser output ($editInfo->output) for
538 that page after the change
539 $changed: bool for if the page was changed
541 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
542 recentchanges table, return false to not delete old entries.
543 $wikiPage: WikiPage (object) being modified
545 'ArticleFromTitle': when creating an article object from a title object using
546 Wiki::articleFromTitle().
547 $title: Title (object) used to create the article object
548 $article: Article (object) that will be returned
549 $context: IContextSource (object)
551 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
552 PageContentInsertComplete.
553 $wikiPage: WikiPage created
554 $user: User creating the article
555 $text: New content
556 $summary: Edit summary/comment
557 $isMinor: Whether or not the edit was marked as minor
558 $isWatch: (No longer used)
559 $section: (No longer used)
560 $flags: Flags passed to WikiPage::doEditContent()
561 $revision: New Revision of the article
563 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
564 $targetTitle: target title (object)
565 $destTitle: destination title (object)
567 'ArticlePageDataAfter': After loading data of an article from the database.
568 $wikiPage: WikiPage (object) whose data were loaded
569 $row: row (object) returned from the database server
571 'ArticlePageDataBefore': Before loading data of an article from the database.
572 $wikiPage: WikiPage (object) that data will be loaded
573 $fields: fields (array) to load from the database
575 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
576 $wikiPage: the WikiPage being saved
577 $popts: parser options to be used for pre-save transformation
579 'ArticleProtect': Before an article is protected.
580 $wikiPage: the WikiPage being protected
581 $user: the user doing the protection
582 $protect: boolean whether this is a protect or an unprotect
583 $reason: Reason for protect
584 $moveonly: boolean whether this is for move only or not
586 'ArticleProtectComplete': After an article is protected.
587 $wikiPage: the WikiPage that was protected
588 $user: the user who did the protection
589 $protect: boolean whether it was a protect or an unprotect
590 $reason: Reason for protect
591 $moveonly: boolean whether it was for move only or not
593 'ArticlePurge': Before executing "&action=purge".
594 $wikiPage: WikiPage (object) to purge
596 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
597 revisions of an article.
598 &$title: Title object of the article
600 'ArticleRevisionUndeleted': After an article revision is restored.
601 $title: the article title
602 $revision: the revision
603 $oldPageID: the page ID of the revision when archived (may be null)
605 'ArticleRollbackComplete': After an article rollback is completed.
606 $wikiPage: the WikiPage that was edited
607 $user: the user who did the rollback
608 $revision: the revision the page was reverted back to
609 $current: the reverted revision
611 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
612 instead.
613 $wikiPage: the WikiPage (object) being saved
614 $user: the user (object) saving the article
615 $text: the new article text
616 $summary: the article summary (comment)
617 $isminor: minor flag
618 $iswatch: watch flag
619 $section: section #
621 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
622 PageContentSaveComplete instead.
623 $wikiPage: WikiPage modified
624 $user: User performing the modification
625 $text: New content
626 $summary: Edit summary/comment
627 $isMinor: Whether or not the edit was marked as minor
628 $isWatch: (No longer used)
629 $section: (No longer used)
630 $flags: Flags passed to WikiPage::doEditContent()
631 $revision: New Revision of the article
632 $status: Status object about to be returned by doEditContent()
633 $baseRevId: the rev ID (or false) this edit was based on
635 'ArticleUndelete': When one or more revisions of an article are restored.
636 $title: Title corresponding to the article restored
637 $create: Whether or not the restoration caused the page to be created (i.e. it
638   didn't exist before).
639 $comment: The comment associated with the undeletion.
641 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
642 $pageArchive: the PageArchive object
643 &$logEntry: ManualLogEntry object
644 $user: User who is performing the log action
646 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
647 the user is redirected back to the page.
648 &$article: the article
649 &$sectionanchor: The section anchor link (e.g. "#overview" )
650 &$extraq: Extra query parameters which can be added via hooked functions
652 'ArticleViewFooter': After showing the footer section of an ordinary page view
653 $article: Article object
654 $patrolFooterShown: boolean whether patrol footer is shown
656 'ArticleViewHeader': Before the parser cache is about to be tried for article
657 viewing.
658 &$article: the article
659 &$pcache: whether to try the parser cache or not
660 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
661 object to both indicate that the output is done and what parser output was used.
663 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
664 redirect was followed.
665 $article: target article (object)
667 'ArticleViewCustom': Allows to output the text of the article in a different
668 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
669 that it is preferable to implement proper handing for a custom data type using
670 the ContentHandler facility.
671 $text: text of the page
672 $title: title of the page
673 $output: reference to $wgOut
675 'ArticleContentViewCustom': Allows to output the text of the article in a
676 different format than wikitext. Note that it is preferable to implement proper
677 handing for a custom data type using the ContentHandler facility.
678 $content: content of the page, as a Content object
679 $title: title of the page
680 $output: reference to $wgOut
682 'AuthPluginAutoCreate': Called when creating a local account for an user logged
683 in from an external authentication method.
684 $user: User object created locally
686 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
687 Gives a chance for an extension to set it programmatically to a variable class.
688 &$auth: the $wgAuth object, probably a stub
690 'AutopromoteCondition': Check autopromote condition for user.
691 $type: condition type
692 $args: arguments
693 $user: user
694 $result: result of checking autopromote condition
696 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
697 $table: table name
698 &$prefix: prefix
700 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
701 certain title are fetched.
702 $table: table name
703 $title: title of the page to which backlinks are sought
704 &$conds: query conditions
706 'BadImage': When checking against the bad image list. Change $bad and return
707 false to override. If an image is "bad", it is not rendered inline in wiki
708 pages or galleries in category pages.
709 $name: Image name being checked
710 &$bad: Whether or not the image is "bad"
712 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
713 custom HTML after the section. Any uses of the hook need to handle escaping.
714 $template BaseTemplate
715 $portlet: string portlet name
716 &$html: string
718 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
719 "noarticletext-nopermission" at Article::showMissingArticle().
720 $article: article object
722 'BeforeInitialize': Before anything is initialized in
723 MediaWiki::performRequest().
724 &$title: Title being used for request
725 $unused: null
726 &$output: OutputPage object
727 &$user: User
728 $request: WebRequest object
729 $mediaWiki: Mediawiki object
731 'BeforePageDisplay': Prior to outputting a page.
732 &$out: OutputPage object
733 &$skin: Skin object
735 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
736 override how the redirect is output by modifying, or by returning false and
737 taking over the output.
738 $out: OutputPage object
739 &$redirect: URL, modifiable
740 &$code: HTTP code (eg '301' or '302'), modifiable
742 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
743 $parser: Parser object
744 $nt: the image title
745 &$options: array of options to RepoGroup::findFile
746 &$descQuery: query string to add to thumbnail URL
748 FIXME: Where does the below sentence fit in?
749 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
751 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
752 $parser: Parser object
753 $title: title of the template
754 &$skip: skip this template and link it?
755 &$id: the id of the revision being parsed
757 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
758 &$parser: Parser object
759 &$ig: ImageGallery object
761 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
762 newly created user.
763 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
764   to a newly created user account.
765 &$injected_html: Any HTML to inject after the "logged in" message of a newly
766   created user account
768 'BitmapHandlerTransform': before a file is transformed, gives extension the
769 possibility to transform it themselves
770 $handler: BitmapHandler
771 $image: File
772 &$scalerParams: Array with scaler parameters
773 &$mto: null, set to a MediaTransformOutput
775 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
776 normalizations have been performed, except for the $wgMaxImageArea check.
777 $image: File
778 &$params: Array of parameters
779 &$checkImageAreaHookResult: null, set to true or false to override the
780   $wgMaxImageArea check result.
782 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
783 to a user.
784 $block: Block object (which is set to be autoblocking)
785 &$blockIds: Array of block IDs of the autoblock
787 'BlockIp': Before an IP address or user is blocked.
788 $block: the Block object about to be saved
789 $user: the user _doing_ the block (not the one being blocked)
790 &$reason: if the hook is aborted, the error message to be returned in an array
792 'BlockIpComplete': After an IP address or user is blocked.
793 $block: the Block object that was saved
794 $user: the user who did the block (not the one being blocked)
796 'BookInformation': Before information output on Special:Booksources.
797 $isbn: ISBN to show information for
798 $output: OutputPage object in use
800 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
801 to be able to access the wiki via HTTPS.
802 $ip: The IP address in human-readable form
803 &$canDo: This reference should be set to false if the client may not be able
804 to use HTTPS
806 'CanonicalNamespaces': For extensions adding their own namespaces or altering
807 the defaults.
808 Note that if you need to specify namespace protection or content model for
809 a namespace that is added in a CanonicalNamespaces hook handler, you
810 should do so by altering $wgNamespaceProtection and
811 $wgNamespaceContentModels outside the handler, in top-level scope. The
812 point at which the CanonicalNamespaces hook fires is too late for altering
813 these variables. This applies even if the namespace addition is
814 conditional; it is permissible to declare a content model and protection
815 for a namespace and then decline to actually register it.
816 &$namespaces: Array of namespace numbers with corresponding canonical names
818 'CategoryAfterPageAdded': After a page is added to a category.
819 $category: Category that page was added to
820 $wikiPage: WikiPage that was added
822 'CategoryAfterPageRemoved': After a page is removed from a category.
823 $category: Category that page was removed from
824 $wikiPage: WikiPage that was removed
826 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
827 $catpage: CategoryPage instance
829 'ChangePasswordForm': For extensions that need to add a field to the
830 ChangePassword form via the Preferences form.
831 &$extraFields: An array of arrays that hold fields like would be passed to the
832   pretty function.
834 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
835 &$changesList: ChangesList instance.
836 &$articlelink: HTML of link to article (already filled-in).
837 &$s: HTML of row that is being constructed.
838 &$rc: RecentChange instance.
839 $unpatrolled: Whether or not we are showing unpatrolled changes.
840 $watched: Whether or not the change is watched by the user.
842 'ChangesListInitRows': Batch process change list rows prior to rendering.
843 $changesList: ChangesList instance
844 $rows: The data that will be rendered. May be a ResultWrapper instance or
845   an array.
847 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
848 $special: ChangesListSpecialPage instance
849 &$filters: associative array of filter definitions. The keys are the HTML
850   name/URL parameters. Each key maps to an associative array with a 'msg'
851   (message key) and a 'default' value.
853 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
854 $name: name of the special page, e.g. 'Watchlist'
855 &$tables: array of tables to be queried
856 &$fields: array of columns to select
857 &$conds: array of WHERE conditionals for query
858 &$query_options: array of options for the database request
859 &$join_conds: join conditions for the tables
860 $opts: FormOptions for this request
862 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
863 $collationName: Name of the collation in question
864 &$collationObject: Null. Replace with a subclass of the Collation class that
865   implements the collation given in $collationName.
867 'ConfirmEmailComplete': Called after a user's email has been confirmed
868 successfully.
869 $user: user (object) whose email is being confirmed
871 'ContentHandlerDefaultModelFor': Called when the default content model is determined
872 for a given title. May be used to assign a different model for that title.
873 $title: the Title in question
874 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
876 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
877 content model name, but no entry for that model exists in $wgContentHandlers.
878 $modeName: the requested content model name
879 &$handler: set this to a ContentHandler object, if desired.
881 'ContentModelCanBeUsedOn': Called to determine whether that content model can
882 be used on a given page. This is especially useful to prevent some content models
883 to be used in some special location.
884 $contentModel: ID of the content model in question
885 $title: the Title in question.
886 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
887 Handler functions that modify $ok should generally return false to prevent further
888 hooks from further modifying $ok.
890 'ContentGetParserOutput': Customize parser output for a given content object,
891 called by AbstractContent::getParserOutput. May be used to override the normal
892 model-specific rendering of page content.
893 $content: The Content to render
894 $title: Title of the page, as context
895 $revId: The revision ID, as context
896 $options: ParserOptions for rendering. To avoid confusing the parser cache,
897 the output can only depend on parameters provided to this hook function, not on global state.
898 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
899 generation of HTML may be skipped, but other information should still be present in the
900 ParserOutput object.
901 &$output: ParserOutput, to manipulate or replace
903 'ConvertContent': Called by AbstractContent::convert when a conversion to another
904 content model is requested.
905 $content: The Content object to be converted.
906 $toModel: The ID of the content model to convert to.
907 $lossy:   boolean indicating whether lossy conversion is allowed.
908 &$result: Output parameter, in case the handler function wants to provide a
909 converted Content object. Note that $result->getContentModel() must return $toModel.
910 Handler functions that modify $result should generally return false to further
911 attempts at conversion.
913 'ContribsPager::getQueryInfo': Before the contributions query is about to run
914 &$pager: Pager object for contributions
915 &$queryInfo: The query for the contribs Pager
917 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
918 &$data: an array of results of all contribs queries
919 $pager: The ContribsPager object hooked into
920 $offset: Index offset, inclusive
921 $limit: Exact query limit
922 $descending: Query direction, false for ascending, true for descending
924 'ContributionsLineEnding': Called before a contributions HTML line is finished
925 $page: SpecialPage object for contributions
926 &$ret: the HTML line
927 $row: the DB row for this line
928 &$classes: the classes to add to the surrounding <li>
930 'ContributionsToolLinks': Change tool links above Special:Contributions
931 $id: User identifier
932 $title: User page title
933 &$tools: Array of tool links
935 'CustomEditor': When invoking the page editor
936 $article: Article being edited
937 $user: User performing the edit
939 Return true to allow the normal editor to be used, or false
940 if implementing a custom editor, e.g. for a special namespace,
941 etc.
943 'DatabaseOraclePostInit': Called after initialising an Oracle database
944 &$db: the DatabaseOracle object
946 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
947 $title: the diff page title (nullable)
948 &$oldId: the actual old Id to use in the diff
949 &$newId: the actual new Id to use in the diff (0 means current)
950 $old: the ?old= param value from the url
951 $new: the ?new= param value from the url
953 'DiffRevisionTools': Override or extend the revision tools available from the
954 diff view, i.e. undo, etc.
955 $newRev: Revision object of the "new" revision
956 &$links: Array of HTML links
957 $oldRev: Revision object of the "old" revision (may be null)
959 'DiffViewHeader': Called before diff display
960 $diff: DifferenceEngine object that's calling
961 $oldRev: Revision object of the "old" revision (may be null/invalid)
962 $newRev: Revision object of the "new" revision
964 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
965 an article
966 $article: article (object) being viewed
967 $oldid: oldid (int) being viewed
969 'DoEditSectionLink': Override the HTML generated for section edit links
970 $skin: Skin object rendering the UI
971 $title: Title object for the title being linked to (may not be the same as
972   the page title, if the section is included from a template)
973 $section: The designation of the section being pointed to, to be included in
974   the link, like "&section=$section"
975 $tooltip: The default tooltip.  Escape before using.
976   By default, this is wrapped in the 'editsectionhint' message.
977 &$result: The HTML to return, prefilled with the default plus whatever other
978   changes earlier hooks have made
979 $lang: The language code to use for the link in the wfMessage function
981 'EditFilter': Perform checks on an edit
982 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
983 $text: Contents of the edit box
984 $section: Section being edited
985 &$error: Error message to return
986 $summary: Edit summary for page
988 'EditFilterMerged': Post-section-merge edit filter.
989 DEPRECATED, use EditFilterMergedContent instead.
990 $editor: EditPage instance (object)
991 $text: content of the edit box
992 &$error: error message to return
993 $summary: Edit summary for page
995 'EditFilterMergedContent': Post-section-merge edit filter.
996 This may be triggered by the EditPage or any other facility that modifies page content.
997 Use the $status object to indicate whether the edit should be allowed, and to provide
998 a reason for disallowing it. Return false to abort the edit, and true to continue.
999 Returning true if $status->isOK() returns false means "don't save but continue user
1000 interaction", e.g. show the edit form.
1001 $context: object implementing the IContextSource interface.
1002 $content: content of the edit box, as a Content object.
1003 $status: Status object to represent errors, etc.
1004 $summary: Edit summary for page
1005 $user: the User object representing the user whois performing the edit.
1006 $minoredit: whether the edit was marked as minor by the user.
1008 'EditFormPreloadText': Allows population of the edit form when creating
1009 new pages
1010 &$text: Text to preload with
1011 &$title: Title object representing the page being created
1013 'EditFormInitialText': Allows modifying the edit form when editing existing
1014 pages
1015 $editPage: EditPage     object
1017 'EditPage::attemptSave': Called before an article is
1018 saved, that is before WikiPage::doEditContent() is called
1019 $editpage_Obj: the current EditPage object
1021 'EditPage::importFormData': allow extensions to read additional data
1022 posted in the form
1023 $editpage: EditPage instance
1024 $request: Webrequest
1025 return value is ignored (should always return true)
1027 'EditPage::showEditForm:fields': allows injection of form field into edit form
1028 $editor: the EditPage instance for reference
1029 $out: an OutputPage instance to write to
1030 return value is ignored (should always return true)
1032 'EditPage::showEditForm:initial': before showing the edit form
1033 $editor: EditPage instance (object)
1034 $out: an OutputPage instance to write to
1036 Return false to halt editing; you'll need to handle error messages, etc.
1037 yourself. Alternatively, modifying $error and returning true will cause the
1038 contents of $error to be echoed at the top of the edit form as wikitext.
1039 Return true without altering $error to allow the edit to proceed.
1041 'EditPage::showReadOnlyForm:initial: similar to EditPage::showEditForm:initial
1042 but for the readonly 'view source' variant of the edit form.
1043 $editor: EditPage instance (object)
1044 &$out: an OutputPage instance to write to
1045 return value is ignored (should alway return true)
1047 'EditPage::showStandardInputs:options': allows injection of form fields into
1048 the editOptions area
1049 $editor: EditPage instance (object)
1050 $out: an OutputPage instance to write to
1051 &$tabindex: HTML tabindex of the last edit check/button
1052 return value is ignored (should always be true)
1054 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1055 when there's an edit conflict.  Return false to halt normal diff output; in
1056 this case you're responsible for computing and outputting the entire "conflict"
1057 part, i.e., the "difference between revisions" and "your text" headers and
1058 sections.
1059 &$editor: EditPage instance
1060 &$out: OutputPage instance
1062 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1063 textarea in the edit form.
1064 &$editpage: The current EditPage object
1065 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1066 &$tabindex: HTML tabindex of the last edit check/button
1068 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1069 in the edit form.
1070 &$editpage: The current EditPage object
1071 &$checks: Array of edit checks like "watch this page"/"minor edit"
1072 &$tabindex: HTML tabindex of the last edit check/button
1074 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1075 textarea in the edit form.
1076 &$toolbar: The toolbar HTMl
1078 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1079 contribution/copyright notice.
1080 $title: title of page being edited
1081 &$msg: localization message name, overridable. Default is either
1082   'copyrightwarning' or 'copyrightwarning2'.
1084 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1085 modifying the wikitext that will be used in "Show changes". Note that it is
1086 preferable to implement diff handling for different data types using the
1087 ContentHandler facility.
1088 $editPage: EditPage object
1089 &$newtext: wikitext that will be used as "your version"
1091 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1092 "Show changes". Note that it is preferable to implement diff handling for
1093 different data types using the ContentHandler facility.
1094 $editPage: EditPage object
1095 &$newtext: wikitext that will be used as "your version"
1097 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1098 Allow modifying the wikitext that will be previewed. Note that it is preferable
1099 to implement previews for different data types using the ContentHandler
1100 facility.
1101 $editPage: EditPage object
1102 &$toparse: wikitext that will be parsed
1104 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1105 previewed. Note that it is preferable to implement previews for different data
1106 types using the ContentHandler facility.
1107 $editPage: EditPage object
1108 &$content: Content object to be previewed (may be replaced by hook function)
1110 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1111 &$editpage: The current EditPage object
1112 &$res: the HTML of the error text
1114 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1115 of terms of service summary link that might exist separately from the copyright
1116 notice.
1117 $title: title of page being edited
1118 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1120 'EmailConfirmed': When checking that the user's email address is "confirmed".
1121 $user: User being checked
1122 $confirmed: Whether or not the email address is confirmed
1123 This runs before the other checks, such as anonymity and the real check; return
1124 true to allow those checks to occur, and false if checking is done.
1126 'EmailUser': Before sending email from one user to another.
1127 $to: address of receiving user
1128 $from: address of sending user
1129 $subject: subject of the mail
1130 $text: text of the mail
1132 'EmailUserCC': Before sending the copy of the email to the author.
1133 $to: address of receiving user
1134 $from: address of sending user
1135 $subject: subject of the mail
1136 $text: text of the mail
1138 'EmailUserComplete': After sending email from one user to another.
1139 $to: address of receiving user
1140 $from: address of sending user
1141 $subject: subject of the mail
1142 $text: text of the mail
1144 'EmailUserForm': After building the email user form object.
1145 $form: HTMLForm object
1147 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1148 user.
1149 $user: The user who is trying to email another user.
1150 $editToken: The user's edit token.
1151 &$hookErr: Out-param for the error. Passed as the parameters to
1152   OutputPage::showErrorPage.
1154 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1155 throttle.
1156 $ip: The ip address of the user
1158 'ExtensionTypes': Called when generating the extensions credits, use this to
1159 change the tables headers.
1160 &$extTypes: associative array of extensions types
1162 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1163 thumbnail file name.
1164 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1165 $thumbname: the base name of the thumbnail file
1166 &$params: the currently extracted params (has source name, temp or archived zone)
1168 'FetchChangesList': When fetching the ChangesList derivative for a particular
1169 user.
1170 $user: User the list is being fetched for
1171 &$skin: Skin object to be used with the list
1172 &$list: List object (defaults to NULL, change it to an object instance and
1173   return false override the list derivative used)
1175 'FileDeleteComplete': When a file is deleted.
1176 $file: reference to the deleted file
1177 $oldimage: in case of the deletion of an old image, the name of the old file
1178 $article: in case all revisions of the file are deleted a reference to the
1179   WikiFilePage associated with the file.
1180 $user: user who performed the deletion
1181 $reason: reason
1183 'FileTransformed': When a file is transformed and moved into storage.
1184 $file: reference to the File object
1185 $thumb: the MediaTransformOutput object
1186 $tmpThumbPath: The temporary file system path of the transformed file
1187 $thumbPath: The permanent storage path of the transformed file
1189 'FileUpload': When a file upload occurs.
1190 $file : Image object representing the file that was uploaded
1191 $reupload : Boolean indicating if there was a previously another image there or
1192   not (since 1.17)
1193 $hasDescription : Boolean indicating that there was already a description page
1194   and a new one from the comment wasn't created (since 1.17)
1196 'FileUndeleteComplete': When a file is undeleted
1197 $title: title object to the file
1198 $fileVersions: array of undeleted versions. Empty if all versions were restored
1199 $user: user who performed the undeletion
1200 $reason: reason
1202 'FormatAutocomments': When an autocomment is formatted by the Linker.
1203  &$comment: Reference to the accumulated comment. Initially null, when set the
1204    default code will be skipped.
1205  $pre: Initial part of the parsed comment before the call to the hook.
1206  $auto: The extracted part of the parsed comment before the call to the hook.
1207  $post: The final part of the parsed comment before the call to the hook.
1208  $title: An optional title object used to links to sections. Can be null.
1209  $local: Boolean indicating whether section links should refer to local page.
1211 'GalleryGetModes': Get list of classes that can render different modes of a
1212  gallery
1213 $modeArray: An associative array mapping mode names to classes that implement
1214  that mode. It is expected all registered classes are a subclass of
1215  ImageGalleryBase.
1217 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1218 entitled to be in.
1219 &$user: user to promote.
1220 &$promote: groups that will be added.
1222 'GetBlockedStatus': after loading blocking status of an user from the database
1223 $user: user (object) being checked
1225 'GetCacheVaryCookies': Get cookies that should vary cache options.
1226 $out: OutputPage object
1227 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1228   that have to vary cache options
1230 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1231 notifications.
1232 $title: Title object of page
1233 $url: string value as output (out parameter, can modify)
1234 $query: query options passed to Title::getCanonicalURL()
1236 'GetDefaultSortkey': Override the default sortkey for a page.
1237 $title: Title object that we need to get a sortkey for
1238 &$sortkey: Sortkey to use.
1240 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1241 underscore) magic words. Called by MagicWord.
1242 &$doubleUnderscoreIDs: array of strings
1244 'GetExtendedMetadata': Get extended file metadata for the API
1245 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1246 'value' => prop value, 'source' => 'name of hook' ).
1247 $file: File object of file in question
1248 $context: RequestContext (including language to use)
1249 $single: Only extract the current language; if false, the prop value should
1250 be in the metadata multi-language array format:
1251 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1252 &$maxCacheTime: how long the results can be cached
1254 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1255 $title: Title object of page
1256 $url: string value as output (out parameter, can modify)
1257 $query: query options passed to Title::getFullURL()
1259 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1260 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1261 output.
1262 &$output: string for the output timestamp
1263 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1264 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1265 $user: User whose preferences are being used to make timestamp
1266 $lang: Language that will be used to render the timestamp
1268 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1269 $title: Title object of page
1270 $url: string value as output (out parameter, can modify)
1271 $query: query options passed to Title::getInternalURL()
1273 'GetIP': modify the ip of the current user (called only once).
1274 &$ip: string holding the ip as determined so far
1276 'GetLinkColours': modify the CSS class of an array of page links.
1277 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1278         indexed by page_id.
1279 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1281 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1282 working with internal urls (non-interwiki) then it may be preferable to work
1283 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1284 be buggy for internal urls on render if you do not re-implement the horrible
1285 hack that Title::getLocalURL uses in your own extension.
1286 $title: Title object of page
1287 &$url: string value as output (out parameter, can modify)
1288 $query: query options passed to Title::getLocalURL()
1290 'GetLocalURL::Internal': Modify local URLs to internal pages.
1291 $title: Title object of page
1292 &$url: string value as output (out parameter, can modify)
1293 $query: query options passed to Title::getLocalURL()
1295 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1296 without any fancy queries or variants.
1297 $title: Title object of page
1298 &$url: string value as output (out parameter, can modify)
1300 'GetLogTypesOnUser': Add log types where the target is a userpage
1301 &$types: Array of log types
1303 'GetMetadataVersion': Modify the image metadata version currently in use. This
1304 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1305 that need to have versioned metadata should add an element to the end of the
1306 version array of the form 'handler_name=version'. Most media handlers won't need
1307 to do this unless they broke backwards compatibility with a previous version of
1308 the media handler metadata output.
1309 &$version: Array of version strings
1311 'GetNewMessagesAlert': Disable or modify the new messages alert
1312 &$newMessagesAlert: An empty string by default. If the user has new talk page
1313 messages, this should be populated with an alert message to that effect
1314 $newtalks: An empty array if the user has no new messages or an array containing
1315 links and revisions if there are new messages (See User::getNewMessageLinks)
1316 $user: The user object of the user who is loading the page
1317 $out: OutputPage object (to check what type of page the user is on)
1319 'GetPreferences': Modify user preferences.
1320 $user: User whose preferences are being modified.
1321 &$preferences: Preferences description array, to be fed to an HTMLForm object
1323 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1324 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1325 output.
1326 &$output: string for the output timestamp
1327 &$diff: DateInterval representing the difference between the timestamps
1328 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1329 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1330 $user: User whose preferences are being used to make timestamp
1331 $lang: Language that will be used to render the timestamp
1333 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1334 checked for. Use instead of userCan for most cases. Return false if the user
1335 can't do it, and populate $result with the reason in the form of
1336 array( messagename, param1, param2, ... ). For consistency, error messages
1337 should be plain text with no special coloring, bolding, etc. to show that
1338 they're errors; presenting them properly to the user as errors is done by the
1339 caller.
1340 $title: Title object being checked against
1341 $user : Current user object
1342 $action: Action being checked
1343 $result: User permissions error to add. If none, return true.
1345 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1346 called only if expensive checks are enabled. Add a permissions error when
1347 permissions errors are checked for. Return false if the user can't do it, and
1348 populate $result with the reason in the form of array( messagename, param1,
1349 param2, ... ). For consistency, error messages should be plain text with no
1350 special coloring, bolding, etc. to show that they're errors; presenting them
1351 properly to the user as errors is done by the caller.
1353 $title: Title object being checked against
1354 $user : Current user object
1355 $action: Action being checked
1356 $result: User permissions error to add. If none, return true.
1358 'GitViewers': Called when generating the list of git viewers for
1359 Special:Version, use this to change the list.
1360 &$extTypes: associative array of repo URLS to viewer URLs.
1362 'HistoryRevisionTools': Override or extend the revision tools available from the
1363 page history view, i.e. undo, rollback, etc.
1364 $rev: Revision object
1365 &$links: Array of HTML links
1367 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1368 image insertion. You can skip the default logic entirely by returning false, or
1369 just modify a few things using call-by-reference.
1370 &$skin: Skin object
1371 &$title: Title object of the image
1372 &$file: File object, or false if it doesn't exist
1373 &$frameParams: Various parameters with special meanings; see documentation in
1374   includes/Linker.php for Linker::makeImageLink
1375 &$handlerParams: Various parameters with special meanings; see documentation in
1376   includes/Linker.php for Linker::makeImageLink
1377 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1378 &$res: Final HTML output, used if you return false
1381 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1382 the image on an image page.
1383 $imagePage: ImagePage object ($this)
1384 $output: $wgOut
1386 'ImagePageAfterImageLinks': Called after the image links section on an image
1387 page is built.
1388 $imagePage: ImagePage object ($this)
1389 &$html: HTML for the hook to add
1391 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1392 $file: the file
1393 $line: the HTML of the history line
1394 $css: the line CSS class
1396 'ImagePageFindFile': Called when fetching the file associated with an image
1397 page.
1398 $page: ImagePage object
1399 &$file: File object
1400 &$displayFile: displayed File object
1402 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1403 $page: ImagePage object
1404 &$toc: Array of <li> strings
1406 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1407 using img_auth.php.
1408 &$title: the Title object of the file as it would appear for the upload page
1409 &$path: the original file and path name when img_auth was invoked by the the web
1410   server
1411 &$name: the name only component of the file
1412 &$result: The location to pass back results of the hook routine (only used if
1413   failed)
1414   $result[0]=The index of the header message
1415   $result[1]=The index of the body text message
1416   $result[2 through n]=Parameters passed to body text message. Please note the
1417   header message cannot receive/use parameters.
1419 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1420 $reader: XMLReader object
1421 $logInfo: Array of information
1422 Return false to stop further processing of the tag
1424 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1425 $reader: XMLReader object
1426 $pageInfo: Array of information
1427 Return false to stop further processing of the tag
1429 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1430 $reader: XMLReader object
1431 $pageInfo: Array of page information
1432 $revisionInfo: Array of revision information
1433 Return false to stop further processing of the tag
1435 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1436 $reader: XMLReader object
1437 Return false to stop further processing of the tag
1439 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1440 $reader: XMLReader object
1441 $revisionInfo: Array of information
1442 Return false to stop further processing of the tag
1444 'InfoAction': When building information to display on the action=info page.
1445 $context: IContextSource object
1446 &$pageInfo: Array of information
1448 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1449 $title: Title object for the current page
1450 $request: WebRequest
1451 $ignoreRedirect: boolean to skip redirect check
1452 $target: Title/string of redirect target
1453 $article: Article object
1455 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1456 Return true without providing an interwiki to continue interwiki search.
1457 $prefix: interwiki prefix we are looking for.
1458 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1459   iw_trans and optionally iw_api and iw_wikiid.
1461 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1462 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1463 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1464 template/parser function execution which respect nowiki and HTML-comments.
1465 &$parser: Parser object
1466 &$text: string containing partially parsed text
1467 &$stripState: Parser's internal StripState object
1469 'InternalParseBeforeLinks': during Parser's internalParse method before links
1470 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1471 &$parser: Parser object
1472 &$text: string containing partially parsed text
1473 &$stripState: Parser's internal StripState object
1475 'InvalidateEmailComplete': Called after a user's email has been invalidated
1476 successfully.
1477 $user: user (object) whose email is being invalidated
1479 'IRCLineURL': When constructing the URL to use in an IRC notification.
1480 Callee may modify $url and $query, URL will be constructed as $url . $query
1481 &$url: URL to index.php
1482 &$query: Query string
1483 $rc: RecentChange object that triggered url generation
1485 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1486 $article: article (object) being checked
1488 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1489 $ip: IP being check
1490 $result: Change this value to override the result of wfIsTrustedProxy()
1492 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1493 $url: URL used to upload from
1494 &$allowed: Boolean indicating if uploading is allowed for given URL
1496 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1497 instance to return false if the domain name doesn't match your organization.
1498 $addr: The e-mail address entered by the user
1499 &$result: Set this and return false to override the internal checks
1501 'isValidPassword': Override the result of User::isValidPassword()
1502 $password: The password entered by the user
1503 &$result: Set this and return false to override the internal checks
1504 $user: User the password is being validated for
1506 'Language::getMessagesFileName':
1507 $code: The language code or the language we're looking for a messages file for
1508 &$file: The messages file path, you can override this to change the location.
1510 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1511 remove namespaces. Do not use this hook to add namespaces. Use
1512 CanonicalNamespaces for that.
1513 &$namespaces: Array of namespaces indexed by their numbers
1515 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1516 $wgExtensionMessagesFiles instead.
1517 Use this to define synonyms of magic words depending of the language
1518 $magicExtensions: associative array of magic words synonyms
1519 $lang: language code (string)
1521 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1522 listed in $wgExtensionMessagesFiles instead.
1523 Use to define aliases of special pages names depending of the language
1524 $specialPageAliases: associative array of magic words synonyms
1525 $lang: language code (string)
1527 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1528 &$names: array of language code => language name
1529 $code language of the preferred translations
1531 'LanguageLinks': Manipulate a page's language links. This is called
1532 in various places to allow extensions to define the effective language
1533 links for a page.
1534 $title: The page's Title.
1535 &$links: Associative array mapping language codes to prefixed links of the
1536   form "language:title".
1537 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1538   Currently unused, but planned to provide support for marking individual
1539   language links in the UI, e.g. for featured articles.
1541 'LinkBegin': Used when generating internal and interwiki links in
1542 Linker::link(), before processing starts.  Return false to skip default
1543 processing and return $ret. See documentation for Linker::link() for details on
1544 the expected meanings of parameters.
1545 $skin: the Skin object
1546 $target: the Title that the link is pointing to
1547 &$html: the contents that the <a> tag should have (raw HTML); null means
1548   "default".
1549 &$customAttribs: the HTML attributes that the <a> tag should have, in
1550 associative array form, with keys and values unescaped.  Should be merged with
1551 default values, with a value of false meaning to suppress the attribute.
1552 &$query: the query string to add to the generated URL (the bit after the "?"),
1553   in associative array form, with keys and values unescaped.
1554 &$options: array of options.  Can include 'known', 'broken', 'noclasses'.
1555 &$ret: the value to return if your hook returns false.
1557 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1558 just before the function returns a value.  If you return true, an <a> element
1559 with HTML attributes $attribs and contents $html will be returned.  If you
1560 return false, $ret will be returned.
1561 $skin: the Skin object
1562 $target: the Title object that the link is pointing to
1563 $options: the options.  Will always include either 'known' or 'broken', and may
1564   include 'noclasses'.
1565 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1566 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1567   associative array form.
1568 &$ret: the value to return if your hook returns false.
1570 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1571 before the return.
1572 &$url: the image url
1573 &$alt: the image's alt text
1574 &$img: the new image HTML (if returning false)
1576 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1577 before the return.
1578 &$url: the link url
1579 &$text: the link text
1580 &$link: the new link HTML (if returning false)
1581 &$attribs: the attributes to be applied.
1582 $linkType: The external link type
1584 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1585 before the return.
1586 $title: the Title object that the link is pointing to
1587 $file: the File object or false if broken link
1588 &$html: the link text
1589 &$attribs: the attributes to be applied
1590 &$ret: the value to return if your hook returns false
1592 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1593 actual update.
1594 &$linksUpdate: the LinksUpdate object
1596 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1597 each link table insert.  For example, pagelinks, imagelinks, externallinks.
1598 $linksUpdate: LinksUpdate object
1599 $table: the table to insert links to
1600 $insertions: an array of links to insert
1602 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1603 including delete and insert, has completed for all link tables
1604 &$linksUpdate: the LinksUpdate object
1606 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1607 &$linksUpdate: the LinksUpdate object
1609 'ListDefinedTags': When trying to find all defined tags.
1610 &$tags: The list of tags.
1612 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1613 &updater: A DatabaseUpdater subclass
1615 'LocalFile::getHistory': Called before file history query performed.
1616 $file: the File object
1617 $tables: tables
1618 $fields: select fields
1619 $conds: conditions
1620 $opts: query options
1621 $join_conds: JOIN conditions
1623 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1624 $file: the File object
1625 $archiveName: name of an old file version or false if it's the current one
1627 'LocalisationCacheRecache': Called when loading the localisation data into
1628 cache.
1629 $cache: The LocalisationCache object
1630 $code: language code
1631 &$alldata: The localisation data from core and extensions
1632 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1634 'LocalisationChecksBlacklist': When fetching the blacklist of
1635 localisation checks.
1636 &$blacklist: array of checks to blacklist. See the bottom of
1637   maintenance/language/checkLanguage.inc for the format of this variable.
1639 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1640 Returning false will prevent the string from being added to the OutputPage.
1641 &$s: html string to show for the log extract
1642 $types: String or Array Log types to show
1643 $page: String or Title The page title to show log entries for
1644 $user: String The user who made the log entries
1645 $param: Associative Array with the following additional options:
1646   - lim Integer Limit of items to show, default is 50
1647   - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1648   - showIfEmpty boolean Set to false if you don't want any output in case the
1649     loglist is empty if set to true (default), "No matching items in log" is
1650     displayed if loglist is empty
1651   - msgKey Array If you want a nice box with a message, set this to the key of
1652     the message. First element is the message key, additional optional elements
1653     are parameters for the key that are processed with
1654     wfMessage()->params()->parseAsBlock()
1655   - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1656     offset
1657   - wrap String Wrap the message in html (usually something like
1658     "&lt;div ...>$1&lt;/div>").
1659   - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1661 'LoginAuthenticateAudit': A login attempt for a valid user account either
1662 succeeded or failed. No return data is accepted; this hook is for auditing only.
1663 $user: the User object being authenticated against
1664 $password: the password being submitted and found wanting
1665 $retval: a LoginForm class constant with authenticateUserData() return
1666   value (SUCCESS, WRONG_PASS, etc.).
1668 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1669 Use this hook to change the Message that will be output on Special:ChangePassword.
1670 &$msg: Message object that will be shown to the user
1671 $username: Username of the user who's password was expired.
1673 'LogLine': Processes a single log entry on Special:Log.
1674 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1675   logging.log_type database field.
1676 $log_action: string for the type of log action (e.g. 'delete', 'block',
1677   'create2'). Corresponds to logging.log_action database field.
1678 $title: Title object that corresponds to logging.log_namespace and
1679   logging.log_title database fields.
1680 $paramArray: Array of parameters that corresponds to logging.log_params field.
1681   Note that only $paramArray[0] appears to contain anything.
1682 &$comment: string that corresponds to logging.log_comment database field, and
1683   which is displayed in the UI.
1684 &$revert: string that is displayed in the UI, similar to $comment.
1685 $time: timestamp of the log entry (added in 1.12)
1687 'LonelyPagesQuery': Allow extensions to modify the query used by
1688 Special:LonelyPages.
1689 &$tables: tables to join in the query
1690 &$conds: conditions for the query
1691 &$joinConds: join conditions for the query
1693 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1694 script.
1695 $refreshLinks: RefreshLinks object
1697 'MagicWordwgVariableIDs': When defining new magic words IDs.
1698 $variableIDs: array of strings
1700 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1701 executed. Ideally, this hook should only be used to add variables that depend on
1702 the current page/request; static configuration should be added through
1703 ResourceLoaderGetConfigVars instead.
1704 &$vars: variable (or multiple variables) to be added into the output of
1705   Skin::makeVariablesScript
1706 $out: The OutputPage which called the hook, can be used to get the real title.
1708 'MarkPatrolled': Before an edit is marked patrolled.
1709 $rcid: ID of the revision to be marked patrolled
1710 $user: the user (object) marking the revision as patrolled
1711 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1712   sysop in order to mark an edit patrolled.
1714 'MarkPatrolledComplete': After an edit is marked patrolled.
1715 $rcid: ID of the revision marked as patrolled
1716 $user: user (object) who marked the edit patrolled
1717 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1718   sysop to patrol the edit.
1720 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1721 something completely different, after the basic globals have been set up, but
1722 before ordinary actions take place.
1723 $output: $wgOut
1724 $article: Article on which the action will be performed
1725 $title: Title on which the action will be performed
1726 $user: $wgUser
1727 $request: $wgRequest
1728 $mediaWiki: The $mediawiki object
1730 'MessagesPreLoad': When loading a message from the database.
1731 $title: title of the message (string)
1732 $message: value (string), change it to the message you want to define
1734 'MessageCache::get': When fetching a message. Can be used to override the key
1735 for customisations. Given and returned message key must be in special format:
1736 1) first letter must be in lower case according to the content language.
1737 2) spaces must be replaced with underscores
1738 &$key: message key (string)
1740 'MessageCacheReplace': When a message page is changed. Useful for updating
1741 caches.
1742 $title: name of the page changed.
1743 $text: new contents of the page.
1745 'ModifyExportQuery': Modify the query used by the exporter.
1746 $db: The database object to be queried.
1747 &$tables: Tables in the query.
1748 &$conds: Conditions in the query.
1749 &$opts: Options for the query.
1750 &$join_conds: Join conditions for the query.
1752 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1753 links have been rendered (useful for adding more). Note: this is only run for
1754 the Monobook skin. To add items to the toolbox you should use the
1755 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1756 skins.
1757 $tools: array of tools
1759 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1760 and returning it for the skin to output. You can add items to the toolbox while
1761 still letting the skin make final decisions on skin-specific markup conventions
1762 using this hook.
1763 &$sk: The BaseTemplate base skin template
1764 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1765   BaseTemplate::makeListItem for details on the format of individual items
1766   inside of this array.
1768 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1769 namespace.
1770 $index: Integer; the index of the namespace being checked.
1771 $result: Boolean; whether MediaWiki currently thinks that pages in this
1772   namespace are movable. Hooks may change this value to override the return
1773   value of MWNamespace::isMovable().
1775 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1776 edit.
1777 $wikiPage: the WikiPage edited
1778 $rev: the new revision
1779 $baseID: the revision ID this was based off, if any
1780 $user: the editing user
1782 'NormalizeMessageKey': Called before the software gets the text of a message
1783 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1784 displayed.
1785 &$key: the message being looked up. Change this to something else to change
1786   what message gets displayed (string)
1787 &$useDB: whether or not to look up the message in the database (bool)
1788 &$langCode: the language code to get the message for (string) - or -
1789   whether to use the content language (true) or site language (false) (bool)
1790 &$transform: whether or not to expand variables and templates
1791   in the message (bool)
1793 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1794 return false to omit the line from RecentChanges and Watchlist special pages.
1795 &$changeslist: The OldChangesList instance.
1796 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1797 &$rc: The RecentChange object.
1798 &$classes: array of css classes for the <li> element
1800 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1801 can alter or append to the array of URLs for search & suggestion formats.
1802 &$urls: array of associative arrays with Url element attributes
1804 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1805 users and/or IP addresses too.
1806 $otherBlockLink: An array with links to other block logs
1807 $ip: The requested IP address or username
1809 'OutputPageBeforeHTML': A page has been processed by the parser and the
1810 resulting HTML is about to be displayed.
1811 $parserOutput: the parserOutput (object) that corresponds to the page
1812 $text: the text that will be displayed, in HTML (string)
1814 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1815 body tag to allow for extensions to add attributes to the body of the page they
1816 might need. Or to allow building extensions to add body classes that aren't of
1817 high enough demand to be included in core.
1818 $out: The OutputPage which called the hook, can be used to get the real title
1819 $sk: The Skin that called OutputPage::headElement
1820 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1822 'OutputPageCheckLastModified': when checking if the page has been modified
1823 since the last visit.
1824 &$modifiedTimes: array of timestamps.
1825         The following keys are set: page, user, epoch
1827 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1828 $out: OutputPage instance (object)
1829 $parserOutput: parserOutput instance being added in $out
1831 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1832 categories. Implementations should return false if they generate the category
1833 links, so the default link generation is skipped.
1834 $out: OutputPage instance (object)
1835 $categories: associative array, keys are category names, values are category
1836   types ("normal" or "hidden")
1837 $links: array, intended to hold the result. Must be an associative array with
1838   category types as keys and arrays of HTML links as values.
1840 'PageContentInsertComplete': After a new article is created.
1841 $wikiPage: WikiPage created
1842 $user: User creating the article
1843 $content: New content as a Content object
1844 $summary: Edit summary/comment
1845 $isMinor: Whether or not the edit was marked as minor
1846 $isWatch: (No longer used)
1847 $section: (No longer used)
1848 $flags: Flags passed to WikiPage::doEditContent()
1849 $revision: New Revision of the article
1851 'PageContentLanguage': Allows changing the language in which the content of a
1852 page is written. Defaults to the wiki content language ($wgContLang).
1853 $title: Title object
1854 &$pageLang: the page content language (either an object or a language code)
1855 $wgLang: the user language
1857 'PageContentSave': Before an article is saved.
1858 $wikiPage: the WikiPage (object) being saved
1859 $user: the user (object) saving the article
1860 $content: the new article content, as a Content object
1861 $summary: the article summary (comment)
1862 $isminor: minor flag
1863 $iswatch: watch flag
1864 $section: section #
1866 'PageContentSaveComplete': After an article has been updated.
1867 $wikiPage: WikiPage modified
1868 $user: User performing the modification
1869 $content: New content, as a Content object
1870 $summary: Edit summary/comment
1871 $isMinor: Whether or not the edit was marked as minor
1872 $isWatch: (No longer used)
1873 $section: (No longer used)
1874 $flags: Flags passed to WikiPage::doEditContent()
1875 $revision: New Revision of the article (can be null for edits that change nothing)
1876 $status: Status object about to be returned by doEditContent()
1877 $baseRevId: the rev ID (or false) this edit was based on
1879 'PageHistoryBeforeList': When a history page list is about to be constructed.
1880 $article: the article that the history is loading for
1881 $context: RequestContext object
1883 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1884 $row: the revision row for this line
1885 $s: the string representing this parsed line
1886 $classes: array containing the <li> element classes
1888 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1889 constructed.
1890 $pager: the pager
1891 $queryInfo: the query parameters
1893 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1894 which depends on user options should install this hook and append its values to
1895 the key.
1896 &$confstr: reference to a hash key string which can be modified
1897 $user: User (object) requesting the page
1899 'ParserAfterParse': Called from Parser::parse() just after the call to
1900 Parser::internalParse() returns.
1901 $parser: parser object
1902 $text: text being parsed
1903 $stripState: stripState used (object)
1905 'ParserAfterStrip': Called at end of parsing time.
1906 TODO: No more strip, deprecated ?
1907 $parser: parser object
1908 $text: text being parsed
1909 $stripState: stripState used (object)
1911 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1912 $parser: Parser object being used
1913 $text: text that will be returned
1915 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1916 $parser: Parser object
1917 $text: text to parse
1918 $stripState: StripState instance being used
1920 'ParserBeforeStrip': Called at start of parsing time.
1921 TODO: No more strip, deprecated ?
1922 $parser: parser object
1923 $text: text being parsed
1924 $stripState: stripState used (object)
1926 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1927 $parser: Parser object being used
1928 $text: actual text
1930 'ParserClearState': Called at the end of Parser::clearState().
1931 $parser: Parser object being cleared
1933 'ParserCloned': Called when the parser is cloned.
1934 $parser: Newly-cloned Parser object
1936 'ParserFirstCallInit': Called when the parser initialises for the first time.
1937 &$parser: Parser object being cleared
1939 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1940 custom magic word
1941 $parser: Parser object
1942 $varCache: array to store the value in case of multiples calls of the
1943         same magic word
1944 $index: index (string) of the magic
1945 $ret: value of the magic word (the hook should set it)
1946 $frame: PPFrame object to use for expanding any template variables
1948 'ParserGetVariableValueTs': Use this to change the value of the time for the
1949 {{LOCAL...}} magic word.
1950 $parser: Parser object
1951 $time: actual time (timestamp)
1953 'ParserGetVariableValueVarCache': use this to change the value of the variable
1954 cache or return false to not use it.
1955 $parser: Parser object
1956 $varCache: variable cache (array)
1958 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
1959 ParserLimitReportFormat instead.
1960 Called at the end of Parser:parse() when the parser will
1961 include comments about size of the text parsed.
1962 $parser: Parser object
1963 &$limitReport: text that will be included (without comment tags)
1965 'ParserLimitReportFormat': Called for each row in the parser limit report that
1966 needs formatting. If nothing handles this hook, the default is to use "$key" to
1967 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
1968 format the value.
1969 $key: Key for the limit report item (string)
1970 &$value: Value of the limit report item
1971 &$report: String onto which to append the data
1972 $isHTML: If true, $report is an HTML table with two columns; if false, it's
1973         text intended for display in a monospaced font.
1974 $localize: If false, $report should be output in English.
1976 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
1977 include comments about size of the text parsed. Hooks should use
1978 $output->setLimitReportData() to populate data. Functions for this hook should
1979 not use $wgLang; do that in ParserLimitReportFormat instead.
1980 $parser: Parser object
1981 $output: ParserOutput object
1983 'ParserMakeImageParams': Called before the parser make an image link, use this
1984 to modify the parameters of the image.
1985 $title: title object representing the file
1986 $file: file object that will be used to create the image
1987 &$params: 2-D array of parameters
1988 $parser: Parser object that called the hook
1990 'ParserSectionCreate': Called each time the parser creates a document section
1991 from wikitext. Use this to apply per-section modifications to HTML (like
1992 wrapping the section in a DIV).  Caveat: DIVs are valid wikitext, and a DIV
1993 can begin in one section and end in another. Make sure your code can handle
1994 that case gracefully. See the EditSectionClearerLink extension for an example.
1995 $parser: the calling Parser instance
1996 $section: the section number, zero-based, but section 0 is usually empty
1997 &$sectionContent: ref to the content of the section. modify this.
1998 $showEditLinks: boolean describing whether this section has an edit link
2000 'ParserTestParser': Called when creating a new instance of Parser in
2001 tests/parser/parserTest.inc.
2002 $parser: Parser object created
2004 'ParserTestGlobals': Allows to define globals for parser tests.
2005 &$globals: Array with all the globals which should be set for parser tests.
2006   The arrays keys serve as the globals names, its values are the globals values.
2008 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2009 run. Use when page save hooks require the presence of custom tables to ensure
2010 that tests continue to run properly.
2011 &$tables: array of table names
2013 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2014 my talk page, my contributions" etc).
2015 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2016 &$title: Title object representing the current page
2017 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2019 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2020 &$user : User performing the action
2021 $action : Action being performed
2022 &$result : Whether or not the action should be prevented
2023 Change $result and return false to give a definitive answer, otherwise
2024 the built-in rate limiting checks are used, if enabled.
2025 $incrBy: Amount to increment counter by
2027 'PlaceNewSection': Override placement of new sections. Return false and put the
2028 merged text into $text to override the default behavior.
2029 $wikipage : WikiPage object
2030 $oldtext : the text of the article before editing
2031 $subject : subject of the new section
2032 &$text : text of the new section
2034 'PreferencesGetLegend': Override the text used for the <legend> of a
2035 preferences section.
2036 $form: the PreferencesForm object. This is a ContextSource as well
2037 $key: the section name
2038 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2040 'PreferencesFormPreSave': Override preferences being saved
2041  $formData: array of user submitted data
2042  $form: PreferencesForm object, also a ContextSource
2043  $user: User object with preferences to be saved set
2044  &$result: boolean indicating success
2046 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2047 AJAX search suggestions. Put results into &$results outparam and return false.
2048 $ns : array of int namespace keys to search in
2049 $search : search term (not guaranteed to be conveniently normalized)
2050 $limit : maximum number of results to return
2051 &$results : out param: array of page names (strings)
2053 'PrefsEmailAudit': Called when user changes their email address.
2054 $user: User (object) changing his email address
2055 $oldaddr: old email address (string)
2056 $newaddr: new email address (string)
2058 'PrefsPasswordAudit': Called when user changes his password.
2059 $user: User (object) changing his password
2060 $newPass: new password
2061 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2063 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2064 in the form.
2065 $article: the title being (un)protected
2066 $output: a string of the form HTML so far
2068 'ProtectionForm::save': Called when a protection form is submitted.
2069 $article: the Page being (un)protected
2070 &$errorMsg: an html message string of an error or an array of message name and
2071   its parameters
2072 $reasonstr: a string describing the reason page protection level is altered
2074 'ProtectionForm::showLogExtract': Called after the protection log extract is
2075 shown.
2076 $article: the page the form is shown for
2077 $out: OutputPage object
2079 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2080 &$obj: RawPage object
2081 &$text: The text that's going to be the output
2083 'RecentChange_save': Called at the end of RecentChange::save().
2084 $recentChange: RecentChange object
2086 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2087 names such as "oldid" that are preserved when using redirecting special pages
2088 such as Special:MyPage and Special:MyTalk.
2089 &$redirectParams: An array of parameters preserved by redirecting special pages.
2091 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2092 instance. Can be used by an extension override what skin is used in certain
2093 contexts.
2094 IContextSource $context: The RequestContext the skin is being created for.
2095 &$skin: A variable reference you may set a Skin instance or string key on to
2096   override the skin that will be used for the context.
2098 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2099 $user: The user having their password expiration reset
2100 &$newExpire: The new expiration date
2102 'ResetSessionID': Called from wfResetSessionID
2103 $oldSessionID: old session id
2104 $newSessionID: new session id
2106 'ResourceLoaderGetConfigVars': Called at the end of
2107 ResourceLoaderStartUpModule::getConfig(). Use this to export static
2108 configuration variables to JavaScript. Things that depend on the current page
2109 or request state must be added through MakeGlobalVariablesScript instead.
2110 &$vars: array( variable name => value )
2112 'ResourceLoaderGetStartupModules': DEPRECATED. Run once the startup module is being
2113 generated. This allows you to add modules to the startup module. This hook
2114 should be used sparingly since any module added here will be loaded on all
2115 pages. This hook is useful if you want to make code available to module loader
2116 scripts.
2118 'ResourceLoaderRegisterModules': Right before modules information is required,
2119 such as when responding to a resource
2120 loader request or generating HTML output.
2121 &$resourceLoader: ResourceLoader object
2123 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2124 called after the addition of 'qunit' and MediaWiki testing resources.
2125 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2126   included in core, is fed using tests/qunit/QUnitTestResources.php.
2127 &ResourceLoader object
2129 To add a new qunit module named 'myext.tests':
2130 testModules['qunit']['myext.tests'] = array(
2131         'script' => 'extension/myext/tests.js',
2132         'dependencies' => <any module dependency you might have>
2134 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2135 added to any module.
2137 'RevisionInsertComplete': Called after a revision is inserted into the database.
2138 &$revision: the Revision
2139 $data: the data stored in old_text.  The meaning depends on $flags: if external
2140   is set, it's the URL of the revision text in external storage; otherwise,
2141   it's the revision text itself.  In either case, if gzip is set, the revision
2142   text is gzipped.
2143 $flags: a comma-delimited list of strings representing the options used.  May
2144   include: utf8 (this will always be set for new revisions); gzip; external.
2146 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2147 the normal operations.
2148 $allSearchTerms : Array of the search terms in all content languages
2149 &$titleResult : Outparam; the value to return. A Title object or null.
2151 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2152 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2153 runs after.
2154 $term : Search term string
2155 &$title : Outparam; set to $title object and return false for a match
2157 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2158 if nothing was found.
2159 $term : Search term string
2160 &$title : Outparam; set to $title object and return false for a match
2162 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2163 searches.
2164 $term : Search term string
2165 &$title : Current Title object that is being returned (null if none found).
2167 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
2168 $searchEngine : The SearchEngine object. Users of this hooks will be interested
2169 in the $searchEngine->namespaces array.
2170 $query : Original query.
2171 &$parsed : Resultant query with the prefixes stripped.
2173 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2174 search results.
2175 $title : Current Title object being displayed in search results.
2176 &$id: Revision ID (default is false, for latest)
2178 'SearchableNamespaces': An option to modify which namespaces are searchable.
2179 &$arr : Array of namespaces ($nsId => $name) which will be used.
2181 'SetupAfterCache': Called in Setup.php, after cache objects are set
2183 'ShowMissingArticle': Called when generating the output for a non-existent page.
2184 $article: The article object corresponding to the page
2186 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2187 DEPRECATED, use the ContentGetParserOutput hook instead!
2188 $text: Text being shown
2189 $title: Title of the custom script/stylesheet page
2190 $output: Current OutputPage object
2192 'ShowSearchHitTitle': Customise display of search hit title/link.
2193 &$title: Title to link to
2194 &$text: Text to use for the link
2195 $result: The search result
2196 $terms: The search terms entered
2197 $page: The SpecialSearch object.
2199 'ShowSearchHit': Customize display of search hit.
2200 $searchPage: The SpecialSearch instance.
2201 $result: The SearchResult to show
2202 $terms: Search terms, for highlighting
2203 &$link: HTML of link to the matching page. May be modified.
2204 &$redirect: HTML of redirect info. May be modified.
2205 &$section: HTML of matching section. May be modified.
2206 &$extract: HTML of content extract. May be modified.
2207 &$score: HTML of score. May be modified.
2208 &$size: HTML of page size. May be modified.
2209 &$date: HTML of of page modification date. May be modified.
2210 &$related: HTML of additional info for the matching page. May be modified.
2211 &$html: May be set to the full HTML that should be used to represent the search
2212   hit. Must include the <li> ... </li> tags. Will only be used if the hook
2213   function returned false.
2215 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2216 allow the normal method of notice selection/rendering to work, or change the
2217 value of $siteNotice and return false to alter it.
2218 &$siteNotice: HTML returned as the sitenotice
2219 $skin: Skin object
2221 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2222 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2223   the sitenotice/anonnotice.
2224 $skin: Skin object
2226 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2227 $skin: Skin object
2228 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2229   the stock bottom scripts.
2231 'SkinAfterContent': Allows extensions to add text after the page content and
2232 article metadata. This hook should work in all skins. Set the &$data variable to
2233 the text you're going to add.
2234 &$data: (string) Text to be printed out directly (without parsing)
2235 $skin: Skin object
2237 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2238 $skin: Skin object
2239 &$bar: Sidebar contents
2240 Modify $bar to add or modify sidebar portlets.
2242 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2243 $skin Skin object
2244 &$bar: Sidebar content
2245 Modify $bar to add or modify sidebar portlets.
2246 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2248 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2249 copyright notice.
2250 $title: displayed page title
2251 $type: 'normal' or 'history' for old/diff views
2252 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2253   message must be in HTML format, not wikitext!
2254 &$link: overridable HTML link to be passed into the message as $1
2255 &$forContent: overridable flag if copyright footer is shown in content language.
2257 'SkinGetPoweredBy': TODO
2258 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2259 the MediaWiki icon but plain text instead.
2260 $skin: Skin object
2262 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2263 &$subpages: Subpage links HTML
2264 $skin: Skin object
2265 $out: OutputPage object
2266 If false is returned $subpages will be used instead of the HTML
2267 subPageSubtitle() generates.
2268 If true is returned, $subpages will be ignored and the rest of
2269 subPageSubtitle() will run.
2271 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2272 link" tab.
2273 $sktemplate: SkinTemplate object
2274 $nav_urls: array of tabs
2276 'SkinTemplateGetLanguageLink': After building the data for a language link from
2277 which the actual html is constructed.
2278 &$languageLink: array containing data about the link. The following keys can be
2279   modified: href, text, title, class, lang, hreflang. Each of them is a string.
2280 $languageLinkTitle: Title object belonging to the external language link
2281 $title: Title object of the page the link belongs to
2283 To alter the structured navigation links in SkinTemplates, there are three
2284 hooks called in different spots:
2286 'SkinTemplateNavigation': Called on content pages after the tabs have been
2287 added, but before variants have been added.
2288 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2289 tab is added but before variants have been added.
2290 'SkinTemplateNavigation::Universal': Called on both content and special pages
2291 after variants have been added.
2292 &$sktemplate: SkinTemplate object
2293 &$links: Structured navigation links. This is used to alter the navigation for
2294   skins which use buildNavigationUrls such as Vector.
2296 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2297 page output.
2298 &$sktemplate: SkinTemplate object
2299 &$tpl: Template engine object
2301 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2302 $sktemplate: SkinTemplate object
2303 $res: set to true to prevent active tabs
2305 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2306 You can either create your own array, or alter the parameters for
2307 the normal one.
2308 &$sktemplate: The SkinTemplate instance.
2309 $title: Title instance for the page.
2310 $message: Visible label of tab.
2311 $selected: Whether this is a selected tab.
2312 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2313 &$classes: Array of CSS classes to apply.
2314 &$query: Query string to add to link.
2315 &$text: Link text.
2316 &$result: Complete assoc. array if you want to return true.
2318 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2319 been rendered (useful for adding more).
2320 $sk: The QuickTemplate based skin template running the hook.
2321 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2322   extensions that add support for BaseTemplateToolbox should watch for this
2323   dummy parameter with "$dummy=false" in their code and return without echoing
2324   any HTML to avoid creating duplicate toolbox items.
2326 'SkinVectorStyleModules': Called when defining the list of module styles to be
2327 loaded by the Vector skin.
2328 $skin: SkinVector object
2329 &$styles: Array of module names whose style will be loaded for the skin
2331 'SoftwareInfo': Called by Special:Version for returning information about the
2332 software.
2333 $software: The array of software in format 'name' => 'version'. See
2334   SpecialVersion::softwareInformation().
2336 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2337 $sp: SpecialPage object, for context
2338 &$fields: Current HTMLForm fields
2340 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2341 $id: User id number, only provided for backwards-compatability
2342 $user: User object representing user contributions are being fetched for
2343 $sp: SpecialPage instance, providing context
2345 'SpecialListusersDefaultQuery': Called right before the end of
2346 UsersPager::getDefaultQuery().
2347 $pager: The UsersPager instance
2348 $query: The query array to be returned
2350 'SpecialListusersFormatRow': Called right before the end of
2351 UsersPager::formatRow().
2352 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2353 $row: Database row object
2355 'SpecialListusersHeader': Called before closing the <fieldset> in
2356 UsersPager::getPageHeader().
2357 $pager: The UsersPager instance
2358 $out: The header HTML
2360 'SpecialListusersHeaderForm': Called before adding the submit button in
2361 UsersPager::getPageHeader().
2362 $pager: The UsersPager instance
2363 $out: The header HTML
2365 'SpecialListusersQueryInfo': Called right before the end of.
2366 UsersPager::getQueryInfo()
2367 $pager: The UsersPager instance
2368 $query: The query array to be returned
2370 'SpecialMovepageAfterMove': Called after moving a page.
2371 $movePage: MovePageForm object
2372 $oldTitle: old title (object)
2373 $newTitle: new title (object)
2375 'SpecialNewpagesConditions': Called when building sql query for
2376 Special:NewPages.
2377 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2378 $opts: FormOptions object containing special page options
2379 &$conds: array of WHERE conditionals for query
2380 &tables: array of tables to be queried
2381 &$fields: array of columns to select
2382 &$join_conds: join conditions for the tables
2384 'SpecialNewPagesFilters': Called after building form options at NewPages.
2385 $special: the special page object
2386 &$filters: associative array of filter definitions. The keys are the HTML
2387   name/URL parameters. Each key maps to an associative array with a 'msg'
2388   (message key) and a 'default' value.
2390 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2391 hook to remove a core special page.
2392 $list: list (array) of core special pages
2394 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2395 $special: the SpecialPage object
2396 $subPage: the subpage string or null if no subpage was specified
2398 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2399 $special: the SpecialPage object
2400 $subPage: the subpage string or null if no subpage was specified
2402 'SpecialPasswordResetOnSubmit': When executing a form submission on
2403 Special:PasswordReset.
2404 $users: array of User objects.
2405 $data: array of data submitted by the user
2406 &$error: string, error code (message key) used to describe to error (out
2407   parameter). The hook needs to return false when setting this, otherwise it
2408   will have no effect.
2410 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2411 use this to change some selection criteria or substitute a different title.
2412 &$randstr: The random number from wfRandom()
2413 &$isRedir: Boolean, whether to select a redirect or non-redirect
2414 &$namespaces: An array of namespace indexes to get the title from
2415 &$extra: An array of extra SQL statements
2416 &$title: If the hook returns false, a Title object to use instead of the
2417   result from the normal query
2419 'SpecialRecentChangesFilters': Called after building form options at
2420 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2421 $special: the special page object
2422 &$filters: associative array of filter definitions. The keys are the HTML
2423   name/URL parameters. Each key maps to an associative array with a 'msg'
2424   (message key) and a 'default' value.
2426 'SpecialRecentChangesPanel': Called when building form options in
2427 SpecialRecentChanges.
2428 &$extraOpts: array of added items, to which can be added
2429 $opts: FormOptions for this request
2431 'SpecialRecentChangesQuery': Called when building SQL query for
2432 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2433 ChangesListSpecialPageQuery instead.
2434 &$conds: array of WHERE conditionals for query
2435 &$tables: array of tables to be queried
2436 &$join_conds: join conditions for the tables
2437 $opts: FormOptions for this request
2438 &$query_options: array of options for the database request
2439 &$select: Array of columns to select
2441 'SpecialResetTokensTokens': Called when building token list for
2442 SpecialResetTokens.
2443 &$tokens: array of token information arrays in the format of
2444   array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2446 'SpecialSearchCreateLink': Called when making the message to create a page or
2447 go to the existing page.
2448 $t: title object searched for
2449 &$params: an array of the default message name and page title (as parameter)
2451 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2452 target doesn't exist.
2453 &$title: title object generated from the text entered by the user
2455 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2456 the advanced form, a.k.a. power search box.
2457 &$showSections: an array to add values with more options to
2458 $term: the search term (not a title object)
2459 $opts: an array of hidden options (containing 'redirs' and 'profile')
2461 'SpecialSearchProfiles': Allows modification of search profiles.
2462 &$profiles: profiles, which can be modified.
2464 'SpecialSearchProfileForm': Allows modification of search profile forms.
2465 $search: special page object
2466 &$form: String: form html
2467 $profile: String: current search profile
2468 $term: String: search term
2469 $opts: Array: key => value of hidden options for inclusion in custom forms
2471 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2472 $search: SpecialSearch special page object
2473 $profile: String: current search profile
2474 $engine: the search engine
2476 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2477 on the search results page.  Useful for including an external search
2478 provider.  To disable the output of MediaWiki search output, return
2479 false.
2480 $specialSearch: SpecialSearch object ($this)
2481 $output: $wgOut
2482 $term: Search term specified by the user
2484 'SpecialSearchResults': Called before search result display when there are
2485 matches.
2486 $term: string of search term
2487 &$titleMatches: empty or SearchResultSet object
2488 &$textMatches: empty or SearchResultSet object
2490 'SpecialSearchNoResults': Called before search result display when there are no
2491 matches.
2492 $term: string of search term
2494 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2495 &$extraStats: Array to save the new stats
2496   ( $extraStats['<name of statistic>'] => <value>; )
2498 'SpecialUploadComplete': Called after successfully uploading a file from
2499 Special:Upload.
2500 $form: The SpecialUpload object
2502 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2503 use this to change the tables headers. Deprecated since MediaWiki 1.17, use the
2504 ExtensionTypes hook instead.
2505 $extTypes: associative array of extensions types
2507 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2508 $wgVersion: Current $wgVersion for you to use
2509 &$versionUrl: Raw url to link to (eg: release notes)
2511 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2512 Deprecated, use ChangesListSpecialPageFilters instead.
2513 $special: the special page object
2514 &$filters: associative array of filter definitions. The keys are the HTML
2515   name/URL parameters. Each key maps to an associative array with a 'msg'
2516   (message key) and a 'default' value.
2518 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2519 Deprecated, use ChangesListSpecialPageQuery instead.
2520 &$conds: array of WHERE conditionals for query
2521 &$tables: array of tables to be queried
2522 &$join_conds: join conditions for the tables
2523 &$fields: array of query fields
2524 $opts: A FormOptions object with watchlist options for the current request
2526 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2527 SpecialWatchlist. Allows extensions to register custom values they have
2528 inserted to rc_type so they can be returned as part of the watchlist.
2529 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2531 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2532 URL for a title when we have no other parameters on the URL. Gives a chance for
2533 extensions that alter page view behavior radically to abort that redirect or
2534 handle it manually.
2535 $request: WebRequest
2536 $title: Title of the currently found title obj
2537 $output: OutputPage object
2539 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2540 rendered (by ThumbnailImage:toHtml method).
2541 $thumbnail: the ThumbnailImage object
2542 &$attribs: image attribute array
2543 &$linkAttribs: image link attribute array
2545 'TitleArrayFromResult': Called when creating an TitleArray object from a
2546 database result.
2547 &$titleArray: set this to an object to override the default object returned
2548 $res: database result used to create the object
2550 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2551 or override the quick permissions check.
2552 $title: The Title object being accessed
2553 $user: The User performing the action
2554 $action: Action being performed
2555 &$errors: Array of errors
2556 $doExpensiveQueries: Whether to do expensive DB queries
2557 $short: Whether to return immediately on first error
2559 'TitleGetEditNotices': Allows extensions to add edit notices
2560 $title: The Title object for the page the edit notices are for
2561 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2562 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2564 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2565 that can be applied.
2566 $title: The title in question.
2567 &$types: The types of protection available.
2569 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2570 $title: Title object that is being checked
2571 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2572   Hooks may change this value to override the return value of
2573   Title::isCssOrJsPage().
2575 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2576 overriding default behavior for determining if a page exists. If $isKnown is
2577 kept as null, regular checks happen. If it's a boolean, this value is returned
2578 by the isKnown method.
2579 $title: Title object that is being checked
2580 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2582 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2583 that this hook is not called for interwiki pages or pages in immovable
2584 namespaces: for these, isMovable() always returns false.
2585 $title: Title object that is being checked
2586 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2587   Hooks may change this value to override the return value of
2588   Title::isMovable().
2590 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2591 be handled by separate handler (via ArticleViewCustom).
2592 $title: Title object that is being checked
2593 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2594   Hooks may change this value to override the return value of
2595   Title::isWikitextPage()
2597 'TitleMove': Before moving an article (title).
2598 $old: old title
2599 $nt: new title
2600 $user: user who does the move
2602 'TitleMoveComplete': After moving an article (title).
2603 $old: old title
2604 $nt: new title
2605 $user: user who did the move
2606 $pageid: database ID of the page that's been moved
2607 $redirid: database ID of the created redirect
2608 $reason: reason for the move
2610 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2611 adding the default error message if nothing allows the user to read the page. If
2612 a handler wants a title to *not* be whitelisted, it should also return false.
2613 $title: Title object being checked against
2614 $user: Current user object
2615 &$whitelisted: Boolean value of whether this title is whitelisted
2617 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2618 $this: Title object to purge
2619 &$urls: An array of URLs to purge from the caches, to be manipulated.
2621 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2622 PageArchive object has been created but before any further processing is done.
2623 &$archive: PageArchive object
2624 $title: Title object of the page that we're viewing
2626 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2627 PageArchive object has been created but before any further processing is done.
2628 &$archive: PageArchive object
2629 $title: Title object of the page that we're viewing
2631 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2632 the site is not in read-only mode, that the Title object is not null and after
2633 a PageArchive object has been constructed but before performing any further
2634 processing.
2635 &$archive: PageArchive object
2636 $title: Title object of the page that we're about to undelete
2638 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2639 $title: title object related to the revision
2640 $rev: revision (object) that will be viewed
2642 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2643 actions).
2644 $action: action name
2645 $article: article "acted on"
2647 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2648 &$files: list of files
2650 'UnwatchArticle': Before a watch is removed from an article.
2651 $user: user watching
2652 $page: WikiPage object to be removed
2653 &$status: Status object to be returned if the hook returns false
2655 'UnwatchArticleComplete': After a watch is removed from an article.
2656 $user: user that watched
2657 $page: WikiPage object that was watched
2659 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2660 $formattedPageStatus: list of valid page states
2662 'UploadForm:initial': Before the upload form is generated. You might set the
2663 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2664 text (HTML) either before or after the editform.
2665 $form: UploadForm object
2667 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2668 poke at member variables like $mUploadDescription before the file is saved. Do
2669 not use this hook to break upload processing. This will return the user to a
2670 blank form with no error message; use UploadVerification and UploadVerifyFile
2671 instead.
2672 $form: UploadForm object
2674 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2675 $type: (string) the requested upload type
2676 &$className: the class name of the Upload instance to be created
2678 'UploadComplete': when Upload completes an upload.
2679 &$upload: an UploadBase child instance
2681 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2682 assembled.
2683 $descriptor: (array) the HTMLForm descriptor
2685 'UploadFormSourceDescriptors': after the standard source inputs have been
2686 added to the descriptor
2687 $descriptor: (array) the HTMLForm descriptor
2689 'UploadVerification': Additional chances to reject an uploaded file. Consider
2690 using UploadVerifyFile instead.
2691 string $saveName: destination file name
2692 string $tempName: filesystem path to the temporary file for checks
2693 string &$error: output: message key for message to show if upload canceled by
2694   returning false. May also be an array, where the first element is the message
2695   key and the remaining elements are used as parameters to the message.
2697 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2698 in most cases over UploadVerification.
2699 object $upload: an instance of UploadBase, with all info about the upload
2700 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2701   will typically only apply for specific mime types.
2702 object &$error: output: true if the file is valid. Otherwise, an indexed array
2703   representing the problem with the file, where the first element is the message
2704   key and the remaining elements are used as parameters to the message.
2706 'UploadComplete': Upon completion of a file upload.
2707 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2708   $uploadBase->getLocalFile().
2710 'User::mailPasswordInternal': before creation and mailing of a user's new
2711 temporary password
2712 $user: the user who sent the message out
2713 $ip: IP of the user who sent the message out
2714 $u: the account whose new password will be set
2716 'UserAddGroup': Called when adding a group; return false to override
2717 stock group addition.
2718 $user: the user object that is to have a group added
2719 &$group: the group to add, can be modified
2721 'UserArrayFromResult': Called when creating an UserArray object from a database
2722 result.
2723 &$userArray: set this to an object to override the default object returned
2724 $res: database result used to create the object
2726 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2727 want to display an error message, try getUserPermissionsErrors.
2728 $title: Title object being checked against
2729 $user : Current user object
2730 $action: Action being checked
2731 $result: Pointer to result returned if hook returns false. If null is returned,
2732   userCan checks are continued by internal code.
2734 'UserCanSendEmail': To override User::canSendEmail() permission check.
2735 $user: User (object) whose permission is being checked
2736 &$canSend: bool set on input, can override on output
2738 'UserClearNewTalkNotification': Called when clearing the "You have new
2739 messages!" message, return false to not delete it.
2740 $user: User (object) that will clear the message
2741 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2743 'UserComparePasswords': Called when checking passwords, return false to
2744 override the default password checks.
2745 &$hash: String of the password hash (from the database)
2746 &$password: String of the plaintext password the user entered
2747 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2748   supplied
2749 &$result: If the hook returns false, this Boolean value will be checked to
2750   determine if the password was valid
2752 'UserCreateForm': change to manipulate the login form
2753 $template: SimpleTemplate instance for the form
2755 'UserCryptPassword': Called when hashing a password, return false to implement
2756 your own hashing method.
2757 &$password: String of the plaintext password to encrypt
2758 &$salt: String of the password salt or Boolean false if no salt is provided
2759 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2760   method
2761 &$hash: If the hook returns false, this String will be used as the hash
2763 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2764 $user: User to get groups for
2765 &$groups: Current effective groups
2767 'UserGetAllRights': After calculating a list of all available rights.
2768 &$rights: Array of rights, which may be added to.
2770 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2771 before returning the options to the caller. Warning: This hook is called for
2772 every call to User::getDefaultOptions(), which means it's potentially called
2773 dozens or hundreds of times. You may want to cache the results of non-trivial
2774 operations in your hook function for this reason.
2775 &$defaultOptions: Array of preference keys and their default values.
2777 'UserGetEmail': Called when getting an user email address.
2778 $user: User object
2779 &$email: email, change this to override local email
2781 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2782 email authentication.
2783 $user: User object
2784 &$timestamp: timestamp, change this to override local email authentication
2785   timestamp
2787 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2788 &$groups: List of implicit (automatically-assigned) groups
2790 'UserGetLanguageObject': Called when getting user's interface language object.
2791 $user: User object
2792 &$code: Language code that will be used to create the object
2793 $context: RequestContext object
2795 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2796 &$reservedUsernames: $wgReservedUsernames
2798 'UserGetRights': Called in User::getRights().
2799 $user: User to get rights for
2800 &$rights: Current rights
2802 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2803 specific block exemptions).
2804 $user: User in question
2805 $title: Title of the page in question
2806 &$blocked: Out-param, whether or not the user is blocked from that page.
2807 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2808   to edit their own user talk pages.
2810 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2811 &$user: User object
2812 $ip: User's IP address
2813 &$blocked: Whether the user is blocked, to be modified by the hook
2815 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2816 false if a UserGetRights hook might remove the named right.
2817 $right: The user right being checked
2819 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2820 environmental means; occurs after session is loaded.
2821 $user: user object being loaded
2823 'UserLoadDefaults': Called when loading a default user.
2824 $user: user object
2825 $name: user name
2827 'UserLoadFromDatabase': Called when loading a user from the database.
2828 $user: user object
2829 &$s: database query object
2831 'UserLoadFromSession': Called to authenticate users on external/environmental
2832 means; occurs before session is loaded.
2833 $user: user object being loaded
2834 &$result: set this to a boolean value to abort the normal authentication
2835   process
2837 'UserLoadOptions': When user options/preferences are being loaded from the
2838 database.
2839 $user: User object
2840 &$options: Options, can be modified.
2842 'UserLoginComplete': After a user has logged in.
2843 $user: the user object that was created on login
2844 $inject_html: Any HTML to inject after the "logged in" message.
2846 'UserLoginForm': change to manipulate the login form
2847 $template: SimpleTemplate instance for the form
2849 'UserLogout': Before a user logs out.
2850 $user: the user object that is about to be logged out
2852 'UserLogoutComplete': After a user has logged out.
2853 $user: the user object _after_ logout (won't have name, ID, etc.)
2854 $inject_html: Any HTML to inject after the "logged out" message.
2855 $oldName: name of the user before logout (string)
2857 'UserRemoveGroup': Called when removing a group; return false to override stock
2858 group removal.
2859 $user: the user object that is to have a group removed
2860 &$group: the group to be removed, can be modified
2862 'UserRights': After a user's group memberships are changed.
2863 $user  : User object that was changed
2864 $add   : Array of strings corresponding to groups added
2865 $remove: Array of strings corresponding to groups removed
2867 'UserRequiresHTTPS': Called to determine whether a user needs
2868 to be switched to HTTPS.
2869 $user: User in question.
2870 &$https: Boolean whether $user should be switched to HTTPS.
2873 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2874 message(s).
2875 $user: user retrieving new talks messages
2876 $talks: array of new talks page(s)
2878 'UserSaveSettings': Called when saving user settings.
2879 $user: User object
2881 'UserSaveOptions': Called just before saving user preferences/options.
2882 $user: User object
2883 &$options: Options, modifiable
2885 'UserSetCookies': Called when setting user cookies.
2886 $user: User object
2887 &$session: session array, will be added to $_SESSION
2888 &$cookies: cookies array mapping cookie name to its value
2890 'UserSetEmail': Called when changing user email address.
2891 $user: User object
2892 &$email: new email, change this to override new email address
2894 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2895 email authentication.
2896 $user: User object
2897 &$timestamp: new timestamp, change this to override local email
2898 authentication timestamp
2900 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2901 "Foobar (Talk | Contribs | Block)".
2902 $userId: User id of the current user
2903 $userText: User name of the current user
2904 &$items: Array of user tool links as HTML fragments
2906 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
2907 FormatMetadata::getExtendedMeta (return false means cache will be
2908 invalidated and GetExtendedMetadata hook called again).
2909 $timestamp: The timestamp metadata was generated
2910 $file: The file the metadata is for
2912 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2913 used to alter the SQL query which gets the list of wanted pages.
2914 &$wantedPages: WantedPagesPage object
2915 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2917 'WatchArticle': Before a watch is added to an article.
2918 $user: user that will watch
2919 $page: WikiPage object to be watched
2920 &$status: Status object to be returned if the hook returns false
2922 'WatchArticleComplete': After a watch is added to an article.
2923 $user: user that watched
2924 $page: WikiPage object watched
2926 'WatchlistEditorBuildRemoveLine': when building remove lines in
2927 Special:Watchlist/edit.
2928 &$tools: array of extra links
2929 $title: Title object
2930 $redirect: whether the page is a redirect
2931 $skin: Skin object
2933 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2934 REQUEST_URI.
2935 $router: The PathRouter instance
2937 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
2938 Return false to prevent setting of the cookie.
2939 &$name: Cookie name passed to WebResponse::setcookie()
2940 &$value: Cookie value passed to WebResponse::setcookie()
2941 &$expire: Cookie expiration, as for PHP's setcookie()
2942 $options: Options passed to WebResponse::setcookie()
2944 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
2945 $row: The DB row of the entry.
2946 $title: The Title of the page where the link comes FROM
2947 $target: The Title of the page where the link goes TO
2948 &$props: Array of HTML strings to display after the title.
2950 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2951 dumps. One, and only one hook should set this, and return false.
2952 &$tables: Database tables to use in the SELECT query
2953 &$opts: Options to use for the query
2954 &$join: Join conditions
2956 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2957 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2958 specific to a content model should be provided by the respective Content's
2959 getDeletionUpdates() method.
2960 $page: the WikiPage
2961 $content: the Content to generate updates for
2962 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2964 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2965 run a MediaWiki cli script.
2966 &$script: MediaWiki cli script path
2967 &$parameters: Array of arguments and options to the script
2968 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2969   keys
2971 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
2972 to add new query pages to be updated with maintenance/updateSpecialPages.php.
2973 $qp: The list of QueryPages
2975 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2976 extra metadata to be added.
2977 $obj: The XmlDumpWriter object.
2978 &$out: The output string.
2979 $row: The database row for the page.
2980 $title: The title of the page.
2982 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2983 add extra metadata.
2984 $obj: The XmlDumpWriter object.
2985 &$out: The text being output.
2986 $row: The database row for the revision.
2987 $text: The revision text.
2989 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2990 to add additional tags to extract.
2991 &$items: Array containing information on which items to extract. See XMPInfo for
2992   details on the format.
2994 'XMPGetResults': Called just before returning the results array of parsing xmp
2995 data. Can be used to post-process the results.
2996 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2997   is an array of metadata tags returned (each tag is either a value, or an array
2998   of values).
3000 More hooks might be available but undocumented, you can execute
3001 "php maintenance/findHooks.php" to find hidden ones.