3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation,
238 where normally authentication against an external auth plugin would be creating
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
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).
265 $user: user who is doing the move
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 'AbortChangePassword': Return false to cancel password change.
281 $user: the User object to which the password change is occuring
282 $mOldpass: the old password provided by the user
283 $newpass: the new password provided by the user
284 &$abortMsg: the message identifier for abort reason
286 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
287 $name: name of the action
288 &$form: HTMLForm object
289 $article: Article object
291 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
292 Allows to change the fields on the form that will be generated.
293 $name: name of the action
294 &$fields: HTMLForm descriptor array
295 $article: Article object
297 'AddNewAccount': After a user account is created.
298 $user: the User object that was created. (Parameter added in 1.7)
299 $byEmail: true when account was created "by email" (added in 1.12)
301 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
302 $apiModule: the ApiCreateAccount module calling
303 $loginForm: the LoginForm used
305 'AddNewAccountApiResult': Modify API output when creating a new account via API.
306 $apiModule: the ApiCreateAccount module calling
307 $loginForm: the LoginForm used
308 &$result: associative array for API result data
310 'AfterFinalPageOutput': At the end of OutputPage::output() but before final
311 ob_end_flush() which will send the buffered output to the client. This allows
312 for last-minute modification of the output within the buffer by using
314 &$output: OutputPage object
316 'AfterImportPage': When a page import is completed.
317 $title: Title under which the revisions were imported
318 $origTitle: Title provided by the XML file
319 $revCount: Number of revisions in the XML file
320 $sRevCount: Number of successfully imported revisions
321 $pageInfo: associative array of page information
323 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
324 before OutputPage::sendCacheControl() and final ob_end_flush() which
325 will send the buffered output to the client. This allows for last-minute
326 modification of the output within the buffer by using ob_get_clean().
327 $output: The OutputPage object where output() was called
329 'AjaxAddScript': Called in output page just before the initialisation
330 of the javascript ajax engine. The hook is only called when ajax
331 is enabled ( $wgUseAjax = true; ).
332 &$output: OutputPage object
334 'AlternateEdit': Before checking if a user can edit a page and before showing
335 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
336 $editPage: the EditPage object
338 'AlternateEditPreview': Before generating the preview of the page when editing
339 ( EditPage::getPreviewText() ).
340 $editPage: the EditPage object
341 &$content: the Content object for the text field from the edit page
342 &$previewHTML: Text to be placed into the page for the preview
343 &$parserOutput: the ParserOutput object for the preview
344 return false and set $previewHTML and $parserOutput to output custom page
347 'AlternateUserMailer': Called before mail is sent so that mail could be logged
348 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
349 the regular method of sending mail. Return a string to return a php-mail-error
350 message containing the error. Returning true will continue with sending email
352 $headers: Associative array of headers for the email
353 $to: MailAddress object or array
355 $subject: Subject of the email
356 $body: Body of the message
358 'APIAfterExecute': After calling the execute() method of an API module. Use
359 this to extend core API modules.
360 &$module: Module object
362 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
363 &$main: ApiMain object
365 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
366 authenticate and authorize API clients before executing the module. Return
367 false and set a message to cancel the request.
368 $module: Module object
370 &$message: API usage message to die with, as a message key or array
371 as accepted by ApiBase::dieUsageMsg.
373 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
374 processing request parameters. Return false to let the request fail, returning
375 an error message or an <edit result="Failure"> tag if $resultArr was filled.
376 $editPage : the EditPage object
377 $text : the new text of the article (has yet to be saved)
378 &$resultArr : data in this array will be added to the API result
380 'APIGetAllowedParams': Use this hook to modify a module's parameters.
381 &$module: ApiBase Module object
382 &$params: Array of parameters
383 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
385 'APIGetDescription': Use this hook to modify a module's description.
386 &$module: ApiBase Module object
387 &$desc: Array of descriptions
389 'APIGetParamDescription': Use this hook to modify a module's parameter
391 &$module: ApiBase Module object
392 &$desc: Array of parameter descriptions
394 'APIGetResultProperties': Use this hook to modify the properties in a module's
396 &$module: ApiBase Module object
397 &$properties: Array of properties
399 'APIGetPossibleErrors': Use this hook to modify the module's list of possible
401 $module: ApiBase Module object
402 &$possibleErrors: Array of possible errors
404 'APIQueryAfterExecute': After calling the execute() method of an
405 action=query submodule. Use this to extend core API modules.
406 &$module: Module object
408 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
409 an action=query submodule. Use this to extend core API modules.
410 &$module: Module object
411 &$resultPageSet: ApiPageSet object
413 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
414 token has an action, which will be used in the intoken parameter and in the
415 output (actiontoken="..."), and a callback function which should return the
416 token, or false if the user isn't allowed to obtain it. The prototype of the
417 callback function is func($pageid, $title), where $pageid is the page ID of the
418 page the token is requested for and $title is the associated Title object. In
419 the hook, just add your callback to the $tokenFunctions array and return true
420 (returning false makes no sense).
421 $tokenFunctions: array(action => callback)
423 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
424 Every token has an action, which will be used in the rvtoken parameter and in
425 the output (actiontoken="..."), and a callback function which should return the
426 token, or false if the user isn't allowed to obtain it. The prototype of the
427 callback function is func($pageid, $title, $rev), where $pageid is the page ID
428 of the page associated to the revision the token is requested for, $title the
429 associated Title object and $rev the associated Revision object. In the hook,
430 just add your callback to the $tokenFunctions array and return true (returning
431 false makes no sense).
432 $tokenFunctions: array(action => callback)
434 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
435 list=recentchanges. Every token has an action, which will be used in the rctoken
436 parameter and in the output (actiontoken="..."), and a callback function which
437 should return the token, or false if the user isn't allowed to obtain it. The
438 prototype of the callback function is func($pageid, $title, $rc), where $pageid
439 is the page ID of the page associated to the revision the token is requested
440 for, $title the associated Title object and $rc the associated RecentChange
441 object. In the hook, just add your callback to the $tokenFunctions array and
442 return true (returning false makes no sense).
443 $tokenFunctions: array(action => callback)
445 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
446 sites general information.
447 $module: the current ApiQuerySiteInfo module
448 &$results: array of results, add things here
450 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
451 sites statistics information.
452 &$results: array of results, add things here
454 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
455 token has an action, which will be used in the ustoken parameter and in the
456 output (actiontoken="..."), and a callback function which should return the
457 token, or false if the user isn't allowed to obtain it. The prototype of the
458 callback function is func($user) where $user is the User object. In the hook,
459 just add your callback to the $tokenFunctions array and return true (returning
460 false makes no sense).
461 $tokenFunctions: array(action => callback)
463 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
464 an exception is thrown during API action execution.
465 $apiMain: Calling ApiMain instance.
466 $e: Exception object.
468 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
469 should have its own entry in the $apis array and have a unique name, passed as
470 key for the array that represents the service data. In this data array, the
471 key-value-pair identified by the apiLink key is required.
472 &$apis: array of services
474 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
476 &$tokenTypes: supported token types in format 'type' => callback function
477 used to retrieve this type of tokens.
479 'Article::MissingArticleConditions': Before fetching deletion & move log entries
480 to display a message of a non-existing page being deleted/moved, give extensions
481 a chance to hide their (unrelated) log entries.
482 &$conds: Array of query conditions (all of which have to be met; conditions will
483 AND in the final query)
484 $logTypes: Array of log types being queried
486 'ArticleAfterFetchContent': After fetching content of an article from the
487 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
488 $article: the article (object) being loaded from the database
489 &$content: the content (string) of the article
491 'ArticleAfterFetchContentObject': After fetching content of an article from the
493 $article: the article (object) being loaded from the database
494 &$content: the content of the article, as a Content object
496 'ArticleConfirmDelete': Before writing the confirmation form for article
498 $article: the article (object) being deleted
499 $output: the OutputPage object
500 &$reason: the reason (string) the article is being deleted
502 'ArticleContentOnDiff': Before showing the article content below a diff. Use
503 this to change the content in this area or how it is loaded.
504 $diffEngine: the DifferenceEngine
505 $output: the OutputPage object
507 'ArticleDelete': Before an article is deleted.
508 $wikiPage: the WikiPage (object) being deleted
509 $user: the user (object) deleting the article
510 $reason: the reason (string) the article is being deleted
511 $error: if the deletion was prohibited, the (raw HTML) error message to display
513 $status: Status object, modify this to throw an error. Overridden by $error
516 'ArticleDeleteComplete': After an article is deleted.
517 $wikiPage: the WikiPage that was deleted
518 $user: the user that deleted the article
519 $reason: the reason the article was deleted
520 $id: id of the article that was deleted
521 $content: the Content of the deleted page
522 $logEntry: the ManualLogEntry used to record the deletion
524 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
526 &$wikiPage: WikiPage (object) of the user talk page
527 $recipient: User (object) who's talk page was edited
529 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
530 article has been changed.
531 $wikiPage: the WikiPage (object)
532 $editInfo: data holder that includes the parser output ($editInfo->output) for
533 that page after the change
534 $changed: bool for if the page was changed
536 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
537 recentchanges table, return false to not delete old entries.
538 $wikiPage: WikiPage (object) being modified
540 'ArticleFromTitle': when creating an article object from a title object using
541 Wiki::articleFromTitle().
542 $title: Title (object) used to create the article object
543 $article: Article (object) that will be returned
544 $context: IContextSource (object)
546 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
547 PageContentInsertComplete.
548 $wikiPage: WikiPage created
549 $user: User creating the article
551 $summary: Edit summary/comment
552 $isMinor: Whether or not the edit was marked as minor
553 $isWatch: (No longer used)
554 $section: (No longer used)
555 $flags: Flags passed to WikiPage::doEditContent()
556 $revision: New Revision of the article
558 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
559 $targetTitle: target title (object)
560 $destTitle: destination title (object)
562 'ArticlePageDataAfter': After loading data of an article from the database.
563 $wikiPage: WikiPage (object) whose data were loaded
564 $row: row (object) returned from the database server
566 'ArticlePageDataBefore': Before loading data of an article from the database.
567 $wikiPage: WikiPage (object) that data will be loaded
568 $fields: fields (array) to load from the database
570 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
571 $wikiPage: the WikiPage being saved
572 $popts: parser options to be used for pre-save transformation
574 'ArticleProtect': Before an article is protected.
575 $wikiPage: the WikiPage being protected
576 $user: the user doing the protection
577 $protect: boolean whether this is a protect or an unprotect
578 $reason: Reason for protect
579 $moveonly: boolean whether this is for move only or not
581 'ArticleProtectComplete': After an article is protected.
582 $wikiPage: the WikiPage that was protected
583 $user: the user who did the protection
584 $protect: boolean whether it was a protect or an unprotect
585 $reason: Reason for protect
586 $moveonly: boolean whether it was for move only or not
588 'ArticlePurge': Before executing "&action=purge".
589 $wikiPage: WikiPage (object) to purge
591 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
592 revisions of an article.
593 &$title: Title object of the article
595 'ArticleRevisionUndeleted': After an article revision is restored.
596 $title: the article title
597 $revision: the revision
598 $oldPageID: the page ID of the revision when archived (may be null)
600 'ArticleRollbackComplete': After an article rollback is completed.
601 $wikiPage: the WikiPage that was edited
602 $user: the user who did the rollback
603 $revision: the revision the page was reverted back to
604 $current: the reverted revision
606 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
608 $wikiPage: the WikiPage (object) being saved
609 $user: the user (object) saving the article
610 $text: the new article text
611 $summary: the article summary (comment)
616 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
617 PageContentSaveComplete instead.
618 $wikiPage: WikiPage modified
619 $user: User performing the modification
621 $summary: Edit summary/comment
622 $isMinor: Whether or not the edit was marked as minor
623 $isWatch: (No longer used)
624 $section: (No longer used)
625 $flags: Flags passed to WikiPage::doEditContent()
626 $revision: New Revision of the article
627 $status: Status object about to be returned by doEditContent()
628 $baseRevId: the rev ID (or false) this edit was based on
630 'ArticleUndelete': When one or more revisions of an article are restored.
631 $title: Title corresponding to the article restored
632 $create: Whether or not the restoration caused the page to be created (i.e. it
633 didn't exist before).
634 $comment: The comment associated with the undeletion.
636 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
637 $pageArchive: the PageArchive object
638 &$logEntry: ManualLogEntry object
639 $user: User who is performing the log action
641 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
642 the user is redirected back to the page.
643 &$article: the article
644 &$sectionanchor: The section anchor link (e.g. "#overview" )
645 &$extraq: Extra query parameters which can be added via hooked functions
647 'ArticleViewFooter': After showing the footer section of an ordinary page view
648 $article: Article object
649 $patrolFooterShown: boolean whether patrol footer is shown
651 'ArticleViewHeader': Before the parser cache is about to be tried for article
653 &$article: the article
654 &$pcache: whether to try the parser cache or not
655 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
656 object to both indicate that the output is done and what parser output was used.
658 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
659 redirect was followed.
660 $article: target article (object)
662 'ArticleViewCustom': Allows to output the text of the article in a different
663 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
664 that it is preferable to implement proper handing for a custom data type using
665 the ContentHandler facility.
666 $text: text of the page
667 $title: title of the page
668 $output: reference to $wgOut
670 'ArticleContentViewCustom': Allows to output the text of the article in a
671 different format than wikitext. Note that it is preferable to implement proper
672 handing for a custom data type using the ContentHandler facility.
673 $content: content of the page, as a Content object
674 $title: title of the page
675 $output: reference to $wgOut
677 'AuthPluginAutoCreate': Called when creating a local account for an user logged
678 in from an external authentication method.
679 $user: User object created locally
681 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
682 Gives a chance for an extension to set it programmatically to a variable class.
683 &$auth: the $wgAuth object, probably a stub
685 'AutopromoteCondition': Check autopromote condition for user.
686 $type: condition type
689 $result: result of checking autopromote condition
691 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
695 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
696 certain title are fetched.
698 $title: title of the page to which backlinks are sought
699 &$conds: query conditions
701 'BadImage': When checking against the bad image list. Change $bad and return
702 false to override. If an image is "bad", it is not rendered inline in wiki
703 pages or galleries in category pages.
704 $name: Image name being checked
705 &$bad: Whether or not the image is "bad"
707 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
708 "noarticletext-nopermission" at Article::showMissingArticle().
709 $article: article object
711 'BeforeInitialize': Before anything is initialized in
712 MediaWiki::performRequest().
713 &$title: Title being used for request
715 &$output: OutputPage object
717 $request: WebRequest object
718 $mediaWiki: Mediawiki object
720 'BeforePageDisplay': Prior to outputting a page.
721 &$out: OutputPage object
724 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
725 override how the redirect is output by modifying, or by returning false and
726 taking over the output.
727 $out: OutputPage object
728 &$redirect: URL, modifiable
729 &$code: HTTP code (eg '301' or '302'), modifiable
731 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
732 $parser: Parser object
734 &$options: array of options to RepoGroup::findFile
735 &$descQuery: query string to add to thumbnail URL
737 FIXME: Where does the below sentence fit in?
738 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
740 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
741 $parser: Parser object
742 $title: title of the template
743 &$skip: skip this template and link it?
744 &$id: the id of the revision being parsed
746 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
747 &$parser: Parser object
748 &$ig: ImageGallery object
750 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
752 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
753 to a newly created user account.
754 &$injected_html: Any HTML to inject after the "logged in" message of a newly
757 'BitmapHandlerTransform': before a file is transformed, gives extension the
758 possibility to transform it themselves
759 $handler: BitmapHandler
761 &$scalerParams: Array with scaler parameters
762 &$mto: null, set to a MediaTransformOutput
764 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
765 normalizations have been performed, except for the $wgMaxImageArea check.
767 &$params: Array of parameters
768 &$checkImageAreaHookResult: null, set to true or false to override the
769 $wgMaxImageArea check result.
771 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
773 $block: Block object (which is set to be autoblocking)
774 &$blockIds: Array of block IDs of the autoblock
776 'BlockIp': Before an IP address or user is blocked.
777 $block: the Block object about to be saved
778 $user: the user _doing_ the block (not the one being blocked)
779 &$reason: if the hook is aborted, the error message to be returned in an array
781 'BlockIpComplete': After an IP address or user is blocked.
782 $block: the Block object that was saved
783 $user: the user who did the block (not the one being blocked)
785 'BookInformation': Before information output on Special:Booksources.
786 $isbn: ISBN to show information for
787 $output: OutputPage object in use
789 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
790 to be able to access the wiki via HTTPS.
791 $ip: The IP address in human-readable form
792 &$canDo: This reference should be set to false if the client may not be able
795 'CanonicalNamespaces': For extensions adding their own namespaces or altering
797 Note that if you need to specify namespace protection or content model for
798 a namespace that is added in a CanonicalNamespaces hook handler, you
799 should do so by altering $wgNamespaceProtection and
800 $wgNamespaceContentModels outside the handler, in top-level scope. The
801 point at which the CanonicalNamespaces hook fires is too late for altering
802 these variables. This applies even if the namespace addition is
803 conditional; it is permissible to declare a content model and protection
804 for a namespace and then decline to actually register it.
805 &$namespaces: Array of namespace numbers with corresponding canonical names
807 'CategoryAfterPageAdded': After a page is added to a category.
808 $category: Category that page was added to
809 $wikiPage: WikiPage that was added
811 'CategoryAfterPageRemoved': After a page is removed from a category.
812 $category: Category that page was removed from
813 $wikiPage: WikiPage that was removed
815 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
816 $catpage: CategoryPage instance
818 'ChangePasswordForm': For extensions that need to add a field to the
819 ChangePassword form via the Preferences form.
820 &$extraFields: An array of arrays that hold fields like would be passed to the
823 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
824 &$changesList: ChangesList instance.
825 &$articlelink: HTML of link to article (already filled-in).
826 &$s: HTML of row that is being constructed.
827 &$rc: RecentChange instance.
828 $unpatrolled: Whether or not we are showing unpatrolled changes.
829 $watched: Whether or not the change is watched by the user.
831 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
832 $collationName: Name of the collation in question
833 &$collationObject: Null. Replace with a subclass of the Collation class that
834 implements the collation given in $collationName.
836 'ConfirmEmailComplete': Called after a user's email has been confirmed
838 $user: user (object) whose email is being confirmed
840 'ContentHandlerDefaultModelFor': Called when the default content model is determined
841 for a given title. May be used to assign a different model for that title.
842 $title: the Title in question
843 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
845 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
846 content model name, but no entry for that model exists in $wgContentHandlers.
847 $modeName: the requested content model name
848 &$handler: set this to a ContentHandler object, if desired.
850 'ConvertContent': Called by AbstractContent::convert when a conversion to another
851 content model is requested.
852 $content: The Content object to be converted.
853 $toModel: The ID of the content model to convert to.
854 $lossy: boolean indicating whether lossy conversion is allowed.
855 &$result: Output parameter, in case the handler function wants to provide a
856 converted Content object. Note that $result->getContentModel() must return $toModel.
857 Handler functions that modify $result should generally return false to further
858 attempts at conversion.
860 'ContribsPager::getQueryInfo': Before the contributions query is about to run
861 &$pager: Pager object for contributions
862 &$queryInfo: The query for the contribs Pager
864 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
865 &$data: an array of results of all contribs queries
866 $pager: The ContribsPager object hooked into
867 $offset: Index offset, inclusive
868 $limit: Exact query limit
869 $descending: Query direction, false for ascending, true for descending
871 'ContributionsLineEnding': Called before a contributions HTML line is finished
872 $page: SpecialPage object for contributions
874 $row: the DB row for this line
875 &$classes: the classes to add to the surrounding <li>
877 'ContributionsToolLinks': Change tool links above Special:Contributions
879 $title: User page title
880 &$tools: Array of tool links
882 'CustomEditor': When invoking the page editor
883 $article: Article being edited
884 $user: User performing the edit
886 Return true to allow the normal editor to be used, or false
887 if implementing a custom editor, e.g. for a special namespace,
890 'DatabaseOraclePostInit': Called after initialising an Oracle database
891 &$db: the DatabaseOracle object
893 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
894 $title: the diff page title (nullable)
895 &$oldId: the actual old Id to use in the diff
896 &$newId: the actual new Id to use in the diff (0 means current)
897 $old: the ?old= param value from the url
898 $new: the ?new= param value from the url
900 'DiffRevisionTools': Override or extend the revision tools available from the
901 diff view, i.e. undo, etc.
902 $rev: Revision object
903 &$links: Array of HTML links
905 'DiffViewHeader': Called before diff display
906 $diff: DifferenceEngine object that's calling
907 $oldRev: Revision object of the "old" revision (may be null/invalid)
908 $newRev: Revision object of the "new" revision
910 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
912 $article: article (object) being viewed
913 $oldid: oldid (int) being viewed
915 'DoEditSectionLink': Override the HTML generated for section edit links
916 $skin: Skin object rendering the UI
917 $title: Title object for the title being linked to (may not be the same as
918 the page title, if the section is included from a template)
919 $section: The designation of the section being pointed to, to be included in
920 the link, like "§ion=$section"
921 $tooltip: The default tooltip. Escape before using.
922 By default, this is wrapped in the 'editsectionhint' message.
923 &$result: The HTML to return, prefilled with the default plus whatever other
924 changes earlier hooks have made
925 $lang: The language code to use for the link in the wfMessage function
927 'EditFilter': Perform checks on an edit
928 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
929 $text: Contents of the edit box
930 $section: Section being edited
931 &$error: Error message to return
932 $summary: Edit summary for page
934 'EditFilterMerged': Post-section-merge edit filter.
935 DEPRECATED, use EditFilterMergedContent instead.
936 $editor: EditPage instance (object)
937 $text: content of the edit box
938 &$error: error message to return
939 $summary: Edit summary for page
941 'EditFilterMergedContent': Post-section-merge edit filter.
942 This may be triggered by the EditPage or any other facility that modifies page content.
943 Use the $status object to indicate whether the edit should be allowed, and to provide
944 a reason for disallowing it. Return false to abort the edit, and true to continue.
945 Returning true if $status->isOK() returns false means "don't save but continue user
946 interaction", e.g. show the edit form.
947 $context: object implementing the IContextSource interface.
948 $content: content of the edit box, as a Content object.
949 $status: Status object to represent errors, etc.
950 $summary: Edit summary for page
951 $user: the User object representing the user whois performing the edit.
952 $minoredit: whether the edit was marked as minor by the user.
954 'EditFormPreloadText': Allows population of the edit form when creating
956 &$text: Text to preload with
957 &$title: Title object representing the page being created
959 'EditFormInitialText': Allows modifying the edit form when editing existing
961 $editPage: EditPage object
963 'EditPage::attemptSave': Called before an article is
964 saved, that is before WikiPage::doEditContent() is called
965 $editpage_Obj: the current EditPage object
967 'EditPage::importFormData': allow extensions to read additional data
969 $editpage: EditPage instance
971 return value is ignored (should always return true)
973 'EditPage::showEditForm:fields': allows injection of form field into edit form
974 $editor: the EditPage instance for reference
975 $out: an OutputPage instance to write to
976 return value is ignored (should always return true)
978 'EditPage::showEditForm:initial': before showing the edit form
979 $editor: EditPage instance (object)
980 $out: an OutputPage instance to write to
982 Return false to halt editing; you'll need to handle error messages, etc.
983 yourself. Alternatively, modifying $error and returning true will cause the
984 contents of $error to be echoed at the top of the edit form as wikitext.
985 Return true without altering $error to allow the edit to proceed.
987 'EditPage::showStandardInputs:options': allows injection of form fields into
989 $editor: EditPage instance (object)
990 $out: an OutputPage instance to write to
991 &$tabindex: HTML tabindex of the last edit check/button
992 return value is ignored (should always be true)
994 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
995 when there's an edit conflict. Return false to halt normal diff output; in
996 this case you're responsible for computing and outputting the entire "conflict"
997 part, i.e., the "difference between revisions" and "your text" headers and
999 &$editor: EditPage instance
1000 &$out: OutputPage instance
1002 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1003 textarea in the edit form.
1004 &$editpage: The current EditPage object
1005 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1006 &$tabindex: HTML tabindex of the last edit check/button
1008 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1010 &$editpage: The current EditPage object
1011 &$checks: Array of edit checks like "watch this page"/"minor edit"
1012 &$tabindex: HTML tabindex of the last edit check/button
1014 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1015 textarea in the edit form.
1016 &$toolbar: The toolbar HTMl
1018 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1019 contribution/copyright notice.
1020 $title: title of page being edited
1021 &$msg: localization message name, overridable. Default is either
1022 'copyrightwarning' or 'copyrightwarning2'.
1024 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1025 modifying the wikitext that will be used in "Show changes". Note that it is
1026 preferable to implement diff handling for different data types using the
1027 ContentHandler facility.
1028 $editPage: EditPage object
1029 &$newtext: wikitext that will be used as "your version"
1031 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1032 "Show changes". Note that it is preferable to implement diff handling for
1033 different data types using the ContentHandler facility.
1034 $editPage: EditPage object
1035 &$newtext: wikitext that will be used as "your version"
1037 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1038 Allow modifying the wikitext that will be previewed. Note that it is preferable
1039 to implement previews for different data types using the ContentHandler
1041 $editPage: EditPage object
1042 &$toparse: wikitext that will be parsed
1044 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1045 previewed. Note that it is preferable to implement previews for different data
1046 types using the ContentHandler facility.
1047 $editPage: EditPage object
1048 &$content: Content object to be previewed (may be replaced by hook function)
1050 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1051 &$editpage: The current EditPage object
1052 &$res: the HTML of the error text
1054 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1055 of terms of service summary link that might exist separately from the copyright
1057 $title: title of page being edited
1058 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1060 'EmailConfirmed': When checking that the user's email address is "confirmed".
1061 $user: User being checked
1062 $confirmed: Whether or not the email address is confirmed
1063 This runs before the other checks, such as anonymity and the real check; return
1064 true to allow those checks to occur, and false if checking is done.
1066 'EmailUser': Before sending email from one user to another.
1067 $to: address of receiving user
1068 $from: address of sending user
1069 $subject: subject of the mail
1070 $text: text of the mail
1072 'EmailUserCC': Before sending the copy of the email to the author.
1073 $to: address of receiving user
1074 $from: address of sending user
1075 $subject: subject of the mail
1076 $text: text of the mail
1078 'EmailUserComplete': After sending email from one user to another.
1079 $to: address of receiving user
1080 $from: address of sending user
1081 $subject: subject of the mail
1082 $text: text of the mail
1084 'EmailUserForm': After building the email user form object.
1085 $form: HTMLForm object
1087 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1089 $user: The user who is trying to email another user.
1090 $editToken: The user's edit token.
1091 &$hookErr: Out-param for the error. Passed as the parameters to
1092 OutputPage::showErrorPage.
1094 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1096 $ip: The ip address of the user
1098 'ExtensionTypes': Called when generating the extensions credits, use this to
1099 change the tables headers.
1100 &$extTypes: associative array of extensions types
1102 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1103 thumbnail file name.
1104 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1105 $thumbname: the base name of the thumbnail file
1106 &$params: the currently extracted params (has source name, temp or archived zone)
1108 'FetchChangesList': When fetching the ChangesList derivative for a particular
1110 $user: User the list is being fetched for
1111 &$skin: Skin object to be used with the list
1112 &$list: List object (defaults to NULL, change it to an object instance and
1113 return false override the list derivative used)
1115 'FileDeleteComplete': When a file is deleted.
1116 $file: reference to the deleted file
1117 $oldimage: in case of the deletion of an old image, the name of the old file
1118 $article: in case all revisions of the file are deleted a reference to the
1119 WikiFilePage associated with the file.
1120 $user: user who performed the deletion
1123 'FileTransformed': When a file is transformed and moved into storage.
1124 $file: reference to the File object
1125 $thumb: the MediaTransformOutput object
1126 $tmpThumbPath: The temporary file system path of the transformed file
1127 $thumbPath: The permanent storage path of the transformed file
1129 'FileUpload': When a file upload occurs.
1130 $file : Image object representing the file that was uploaded
1131 $reupload : Boolean indicating if there was a previously another image there or
1133 $hasDescription : Boolean indicating that there was already a description page
1134 and a new one from the comment wasn't created (since 1.17)
1136 'FileUndeleteComplete': When a file is undeleted
1137 $title: title object to the file
1138 $fileVersions: array of undeleted versions. Empty if all versions were restored
1139 $user: user who performed the undeletion
1142 'FormatAutocomments': When an autocomment is formatted by the Linker.
1143 &$comment: Reference to the accumulated comment. Initially null, when set the
1144 default code will be skipped.
1145 $pre: Initial part of the parsed comment before the call to the hook.
1146 $auto: The extracted part of the parsed comment before the call to the hook.
1147 $post: The final part of the parsed comment before the call to the hook.
1148 $title: An optional title object used to links to sections. Can be null.
1149 $local: Boolean indicating whether section links should refer to local page.
1151 'GalleryGetModes': Get list of classes that can render different modes of a
1153 $modeArray: An associative array mapping mode names to classes that implement
1154 that mode. It is expected all registered classes are a subclass of
1157 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1159 &$user: user to promote.
1160 &$promote: groups that will be added.
1162 'GetBlockedStatus': after loading blocking status of an user from the database
1163 $user: user (object) being checked
1165 'GetCacheVaryCookies': Get cookies that should vary cache options.
1166 $out: OutputPage object
1167 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1168 that have to vary cache options
1170 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1172 $title: Title object of page
1173 $url: string value as output (out parameter, can modify)
1174 $query: query options passed to Title::getCanonicalURL()
1176 'GetDefaultSortkey': Override the default sortkey for a page.
1177 $title: Title object that we need to get a sortkey for
1178 &$sortkey: Sortkey to use.
1180 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1181 underscore) magic words. Called by MagicWord.
1182 &$doubleUnderscoreIDs: array of strings
1184 'GetExtendedMetadata': Get extended file metadata for the API
1185 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1186 'value' => prop value, 'source' => 'name of hook' ).
1187 $file: File object of file in question
1188 $context: RequestContext (including language to use)
1189 $single: Only extract the current language; if false, the prop value should
1190 be in the metadata multi-language array format:
1191 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1192 &$maxCacheTime: how long the results can be cached
1194 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1195 $title: Title object of page
1196 $url: string value as output (out parameter, can modify)
1197 $query: query options passed to Title::getFullURL()
1199 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1200 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1202 &$output: string for the output timestamp
1203 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1204 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1205 $user: User whose preferences are being used to make timestamp
1206 $lang: Language that will be used to render the timestamp
1208 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1209 $title: Title object of page
1210 $url: string value as output (out parameter, can modify)
1211 $query: query options passed to Title::getInternalURL()
1213 'GetIP': modify the ip of the current user (called only once).
1214 &$ip: string holding the ip as determined so far
1216 'GetLinkColours': modify the CSS class of an array of page links.
1217 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1219 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1221 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1222 working with internal urls (non-interwiki) then it may be preferable to work
1223 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1224 be buggy for internal urls on render if you do not re-implement the horrible
1225 hack that Title::getLocalURL uses in your own extension.
1226 $title: Title object of page
1227 &$url: string value as output (out parameter, can modify)
1228 $query: query options passed to Title::getLocalURL()
1230 'GetLocalURL::Internal': Modify local URLs to internal pages.
1231 $title: Title object of page
1232 &$url: string value as output (out parameter, can modify)
1233 $query: query options passed to Title::getLocalURL()
1235 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1236 without any fancy queries or variants.
1237 $title: Title object of page
1238 &$url: string value as output (out parameter, can modify)
1240 'GetLogTypesOnUser': Add log types where the target is a userpage
1241 &$types: Array of log types
1243 'GetMetadataVersion': Modify the image metadata version currently in use. This
1244 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1245 that need to have versioned metadata should add an element to the end of the
1246 version array of the form 'handler_name=version'. Most media handlers won't need
1247 to do this unless they broke backwards compatibility with a previous version of
1248 the media handler metadata output.
1249 &$version: Array of version strings
1251 'GetNewMessagesAlert': Disable or modify the new messages alert
1252 &$newMessagesAlert: An empty string by default. If the user has new talk page
1253 messages, this should be populated with an alert message to that effect
1254 $newtalks: An empty array if the user has no new messages or an array containing
1255 links and revisions if there are new messages (See User::getNewMessageLinks)
1256 $user: The user object of the user who is loading the page
1257 $out: OutputPage object (to check what type of page the user is on)
1259 'GetPreferences': Modify user preferences.
1260 $user: User whose preferences are being modified.
1261 &$preferences: Preferences description array, to be fed to an HTMLForm object
1263 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1264 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1266 &$output: string for the output timestamp
1267 &$diff: DateInterval representing the difference between the timestamps
1268 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1269 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1270 $user: User whose preferences are being used to make timestamp
1271 $lang: Language that will be used to render the timestamp
1273 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1274 checked for. Use instead of userCan for most cases. Return false if the user
1275 can't do it, and populate $result with the reason in the form of
1276 array( messagename, param1, param2, ... ). For consistency, error messages
1277 should be plain text with no special coloring, bolding, etc. to show that
1278 they're errors; presenting them properly to the user as errors is done by the
1280 $title: Title object being checked against
1281 $user : Current user object
1282 $action: Action being checked
1283 $result: User permissions error to add. If none, return true.
1285 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1286 called only if expensive checks are enabled. Add a permissions error when
1287 permissions errors are checked for. Return false if the user can't do it, and
1288 populate $result with the reason in the form of array( messagename, param1,
1289 param2, ... ). For consistency, error messages should be plain text with no
1290 special coloring, bolding, etc. to show that they're errors; presenting them
1291 properly to the user as errors is done by the caller.
1293 $title: Title object being checked against
1294 $user : Current user object
1295 $action: Action being checked
1296 $result: User permissions error to add. If none, return true.
1298 'GitViewers': Called when generating the list of git viewers for
1299 Special:Version, use this to change the list.
1300 &$extTypes: associative array of repo URLS to viewer URLs.
1302 'HistoryRevisionTools': Override or extend the revision tools available from the
1303 page history view, i.e. undo, rollback, etc.
1304 $rev: Revision object
1305 &$links: Array of HTML links
1307 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1308 image insertion. You can skip the default logic entirely by returning false, or
1309 just modify a few things using call-by-reference.
1311 &$title: Title object of the image
1312 &$file: File object, or false if it doesn't exist
1313 &$frameParams: Various parameters with special meanings; see documentation in
1314 includes/Linker.php for Linker::makeImageLink
1315 &$handlerParams: Various parameters with special meanings; see documentation in
1316 includes/Linker.php for Linker::makeImageLink
1317 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1318 &$res: Final HTML output, used if you return false
1321 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1322 the image on an image page.
1323 $imagePage: ImagePage object ($this)
1326 'ImagePageAfterImageLinks': Called after the image links section on an image
1328 $imagePage: ImagePage object ($this)
1329 &$html: HTML for the hook to add
1331 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1333 $line: the HTML of the history line
1334 $css: the line CSS class
1336 'ImagePageFindFile': Called when fetching the file associated with an image
1338 $page: ImagePage object
1340 &$displayFile: displayed File object
1342 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1343 $page: ImagePage object
1344 &$toc: Array of <li> strings
1346 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1348 &$title: the Title object of the file as it would appear for the upload page
1349 &$path: the original file and path name when img_auth was invoked by the the web
1351 &$name: the name only component of the file
1352 &$result: The location to pass back results of the hook routine (only used if
1354 $result[0]=The index of the header message
1355 $result[1]=The index of the body text message
1356 $result[2 through n]=Parameters passed to body text message. Please note the
1357 header message cannot receive/use parameters.
1359 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1360 $reader: XMLReader object
1361 $logInfo: Array of information
1362 Return false to stop further processing of the tag
1364 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1365 $reader: XMLReader object
1366 $pageInfo: Array of information
1367 Return false to stop further processing of the tag
1369 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1370 $reader: XMLReader object
1371 $pageInfo: Array of page information
1372 $revisionInfo: Array of revision information
1373 Return false to stop further processing of the tag
1375 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1376 $reader: XMLReader object
1377 Return false to stop further processing of the tag
1379 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1380 $reader: XMLReader object
1381 $revisionInfo: Array of information
1382 Return false to stop further processing of the tag
1384 'InfoAction': When building information to display on the action=info page.
1385 $context: IContextSource object
1386 &$pageInfo: Array of information
1388 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1389 $title: Title object for the current page
1390 $request: WebRequest
1391 $ignoreRedirect: boolean to skip redirect check
1392 $target: Title/string of redirect target
1393 $article: Article object
1395 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1396 Return true without providing an interwiki to continue interwiki search.
1397 $prefix: interwiki prefix we are looking for.
1398 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1399 iw_trans and optionally iw_api and iw_wikiid.
1401 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1402 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1403 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1404 template/parser function execution which respect nowiki and HTML-comments.
1405 &$parser: Parser object
1406 &$text: string containing partially parsed text
1407 &$stripState: Parser's internal StripState object
1409 'InternalParseBeforeLinks': during Parser's internalParse method before links
1410 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1411 &$parser: Parser object
1412 &$text: string containing partially parsed text
1413 &$stripState: Parser's internal StripState object
1415 'InvalidateEmailComplete': Called after a user's email has been invalidated
1417 $user: user (object) whose email is being invalidated
1419 'IRCLineURL': When constructing the URL to use in an IRC notification.
1420 Callee may modify $url and $query, URL will be constructed as $url . $query
1421 &$url: URL to index.php
1422 &$query: Query string
1424 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1425 $article: article (object) being checked
1427 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1429 $result: Change this value to override the result of wfIsTrustedProxy()
1431 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1432 $url: URL used to upload from
1433 &$allowed: Boolean indicating if uploading is allowed for given URL
1435 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1436 instance to return false if the domain name doesn't match your organization.
1437 $addr: The e-mail address entered by the user
1438 &$result: Set this and return false to override the internal checks
1440 'isValidPassword': Override the result of User::isValidPassword()
1441 $password: The password entered by the user
1442 &$result: Set this and return false to override the internal checks
1443 $user: User the password is being validated for
1445 'Language::getMessagesFileName':
1446 $code: The language code or the language we're looking for a messages file for
1447 &$file: The messages file path, you can override this to change the location.
1449 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1450 remove namespaces. Do not use this hook to add namespaces. Use
1451 CanonicalNamespaces for that.
1452 &$namespaces: Array of namespaces indexed by their numbers
1454 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1455 $wgExtensionMessagesFiles instead.
1456 Use this to define synonyms of magic words depending of the language
1457 $magicExtensions: associative array of magic words synonyms
1458 $lang: language code (string)
1460 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1461 listed in $wgExtensionMessagesFiles instead.
1462 Use to define aliases of special pages names depending of the language
1463 $specialPageAliases: associative array of magic words synonyms
1464 $lang: language code (string)
1466 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1467 &$names: array of language code => language name
1468 $code language of the preferred translations
1470 'LanguageLinks': Manipulate a page's language links. This is called
1471 in various places to allow extensions to define the effective language
1473 $title: The page's Title.
1474 &$links: Associative array mapping language codes to prefixed links of the
1475 form "language:title".
1476 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1477 Currently unused, but planned to provide support for marking individual
1478 language links in the UI, e.g. for featured articles.
1480 'LinkBegin': Used when generating internal and interwiki links in
1481 Linker::link(), before processing starts. Return false to skip default
1482 processing and return $ret. See documentation for Linker::link() for details on
1483 the expected meanings of parameters.
1484 $skin: the Skin object
1485 $target: the Title that the link is pointing to
1486 &$html: the contents that the <a> tag should have (raw HTML); null means
1488 &$customAttribs: the HTML attributes that the <a> tag should have, in
1489 associative array form, with keys and values unescaped. Should be merged with
1490 default values, with a value of false meaning to suppress the attribute.
1491 &$query: the query string to add to the generated URL (the bit after the "?"),
1492 in associative array form, with keys and values unescaped.
1493 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1494 &$ret: the value to return if your hook returns false.
1496 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1497 just before the function returns a value. If you return true, an <a> element
1498 with HTML attributes $attribs and contents $html will be returned. If you
1499 return false, $ret will be returned.
1500 $skin: the Skin object
1501 $target: the Title object that the link is pointing to
1502 $options: the options. Will always include either 'known' or 'broken', and may
1503 include 'noclasses'.
1504 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1505 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1506 associative array form.
1507 &$ret: the value to return if your hook returns false.
1509 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1511 &$url: the image url
1512 &$alt: the image's alt text
1513 &$img: the new image HTML (if returning false)
1515 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1518 &$text: the link text
1519 &$link: the new link HTML (if returning false)
1520 &$attribs: the attributes to be applied.
1521 $linkType: The external link type
1523 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1525 &$linksUpdate: the LinksUpdate object
1527 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1528 each link table insert. For example, pagelinks, imagelinks, externallinks.
1529 $linksUpdate: LinksUpdate object
1530 $table: the table to insert links to
1531 $insertions: an array of links to insert
1533 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1534 including delete and insert, has completed for all link tables
1535 &$linksUpdate: the LinksUpdate object
1537 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1538 &$linksUpdate: the LinksUpdate object
1540 'ListDefinedTags': When trying to find all defined tags.
1541 &$tags: The list of tags.
1543 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1544 &updater: A DatabaseUpdater subclass
1546 'LocalFile::getHistory': Called before file history query performed.
1547 $file: the File object
1549 $fields: select fields
1551 $opts: query options
1552 $join_conds: JOIN conditions
1554 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1555 $file: the File object
1556 $archiveName: name of an old file version or false if it's the current one
1558 'LocalisationCacheRecache': Called when loading the localisation data into
1560 $cache: The LocalisationCache object
1561 $code: language code
1562 &$alldata: The localisation data from core and extensions
1563 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1565 'LocalisationChecksBlacklist': When fetching the blacklist of
1566 localisation checks.
1567 &$blacklist: array of checks to blacklist. See the bottom of
1568 maintenance/language/checkLanguage.inc for the format of this variable.
1570 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1571 Returning false will prevent the string from being added to the OutputPage.
1572 &$s: html string to show for the log extract
1573 $types: String or Array Log types to show
1574 $page: String or Title The page title to show log entries for
1575 $user: String The user who made the log entries
1576 $param: Associative Array with the following additional options:
1577 - lim Integer Limit of items to show, default is 50
1578 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1579 - showIfEmpty boolean Set to false if you don't want any output in case the
1580 loglist is empty if set to true (default), "No matching items in log" is
1581 displayed if loglist is empty
1582 - msgKey Array If you want a nice box with a message, set this to the key of
1583 the message. First element is the message key, additional optional elements
1584 are parameters for the key that are processed with
1585 wfMessage()->params()->parseAsBlock()
1586 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1588 - wrap String Wrap the message in html (usually something like
1589 "<div ...>$1</div>").
1590 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1592 'LoginAuthenticateAudit': A login attempt for a valid user account either
1593 succeeded or failed. No return data is accepted; this hook is for auditing only.
1594 $user: the User object being authenticated against
1595 $password: the password being submitted and found wanting
1596 $retval: a LoginForm class constant with authenticateUserData() return
1597 value (SUCCESS, WRONG_PASS, etc.).
1599 'LogLine': Processes a single log entry on Special:Log.
1600 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1601 logging.log_type database field.
1602 $log_action: string for the type of log action (e.g. 'delete', 'block',
1603 'create2'). Corresponds to logging.log_action database field.
1604 $title: Title object that corresponds to logging.log_namespace and
1605 logging.log_title database fields.
1606 $paramArray: Array of parameters that corresponds to logging.log_params field.
1607 Note that only $paramArray[0] appears to contain anything.
1608 &$comment: string that corresponds to logging.log_comment database field, and
1609 which is displayed in the UI.
1610 &$revert: string that is displayed in the UI, similar to $comment.
1611 $time: timestamp of the log entry (added in 1.12)
1613 'LonelyPagesQuery': Allow extensions to modify the query used by
1614 Special:LonelyPages.
1615 &$tables: tables to join in the query
1616 &$conds: conditions for the query
1617 &$joinConds: join conditions for the query
1619 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1621 $refreshLinks: RefreshLinks object
1623 'MagicWordwgVariableIDs': When defining new magic words IDs.
1624 $variableIDs: array of strings
1626 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1627 executed. Ideally, this hook should only be used to add variables that depend on
1628 the current page/request; static configuration should be added through
1629 ResourceLoaderGetConfigVars instead.
1630 &$vars: variable (or multiple variables) to be added into the output of
1631 Skin::makeVariablesScript
1632 $out: The OutputPage which called the hook, can be used to get the real title.
1634 'MarkPatrolled': Before an edit is marked patrolled.
1635 $rcid: ID of the revision to be marked patrolled
1636 $user: the user (object) marking the revision as patrolled
1637 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1638 sysop in order to mark an edit patrolled.
1640 'MarkPatrolledComplete': After an edit is marked patrolled.
1641 $rcid: ID of the revision marked as patrolled
1642 $user: user (object) who marked the edit patrolled
1643 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1644 sysop to patrol the edit.
1646 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1647 something completely different, after the basic globals have been set up, but
1648 before ordinary actions take place.
1650 $article: Article on which the action will be performed
1651 $title: Title on which the action will be performed
1653 $request: $wgRequest
1654 $mediaWiki: The $mediawiki object
1656 'MessagesPreLoad': When loading a message from the database.
1657 $title: title of the message (string)
1658 $message: value (string), change it to the message you want to define
1660 'MessageCacheReplace': When a message page is changed. Useful for updating
1662 $title: name of the page changed.
1663 $text: new contents of the page.
1665 'ModifyExportQuery': Modify the query used by the exporter.
1666 $db: The database object to be queried.
1667 &$tables: Tables in the query.
1668 &$conds: Conditions in the query.
1669 &$opts: Options for the query.
1670 &$join_conds: Join conditions for the query.
1672 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1673 links have been rendered (useful for adding more). Note: this is only run for
1674 the Monobook skin. To add items to the toolbox you should use the
1675 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1677 $tools: array of tools
1679 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1680 and returning it for the skin to output. You can add items to the toolbox while
1681 still letting the skin make final decisions on skin-specific markup conventions
1683 &$sk: The BaseTemplate base skin template
1684 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1685 BaseTemplate::makeListItem for details on the format of individual items
1686 inside of this array.
1688 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1690 $index: Integer; the index of the namespace being checked.
1691 $result: Boolean; whether MediaWiki currently thinks that pages in this
1692 namespace are movable. Hooks may change this value to override the return
1693 value of MWNamespace::isMovable().
1695 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1697 $wikiPage: the WikiPage edited
1698 $rev: the new revision
1699 $baseID: the revision ID this was based off, if any
1700 $user: the editing user
1702 'NormalizeMessageKey': Called before the software gets the text of a message
1703 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1705 &$key: the message being looked up. Change this to something else to change
1706 what message gets displayed (string)
1707 &$useDB: whether or not to look up the message in the database (bool)
1708 &$langCode: the language code to get the message for (string) - or -
1709 whether to use the content language (true) or site language (false) (bool)
1710 &$transform: whether or not to expand variables and templates
1711 in the message (bool)
1713 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1714 return false to omit the line from RecentChanges and Watchlist special pages.
1715 &$changeslist: The OldChangesList instance.
1716 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1717 &$rc: The RecentChange object.
1718 &$classes: array of css classes for the <li> element
1720 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1721 can alter or append to the array of URLs for search & suggestion formats.
1722 &$urls: array of associative arrays with Url element attributes
1724 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1725 users and/or IP addresses too.
1726 $otherBlockLink: An array with links to other block logs
1727 $ip: The requested IP address or username
1729 'OutputPageBeforeHTML': A page has been processed by the parser and the
1730 resulting HTML is about to be displayed.
1731 $parserOutput: the parserOutput (object) that corresponds to the page
1732 $text: the text that will be displayed, in HTML (string)
1734 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1735 body tag to allow for extensions to add attributes to the body of the page they
1736 might need. Or to allow building extensions to add body classes that aren't of
1737 high enough demand to be included in core.
1738 $out: The OutputPage which called the hook, can be used to get the real title
1739 $sk: The Skin that called OutputPage::headElement
1740 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1742 'OutputPageCheckLastModified': when checking if the page has been modified
1743 since the last visit.
1744 &$modifiedTimes: array of timestamps.
1745 The following keys are set: page, user, epoch
1747 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1748 $out: OutputPage instance (object)
1749 $parserOutput: parserOutput instance being added in $out
1751 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1752 categories. Implementations should return false if they generate the category
1753 links, so the default link generation is skipped.
1754 $out: OutputPage instance (object)
1755 $categories: associative array, keys are category names, values are category
1756 types ("normal" or "hidden")
1757 $links: array, intended to hold the result. Must be an associative array with
1758 category types as keys and arrays of HTML links as values.
1760 'PageContentInsertComplete': After a new article is created.
1761 $wikiPage: WikiPage created
1762 $user: User creating the article
1763 $content: New content as a Content object
1764 $summary: Edit summary/comment
1765 $isMinor: Whether or not the edit was marked as minor
1766 $isWatch: (No longer used)
1767 $section: (No longer used)
1768 $flags: Flags passed to WikiPage::doEditContent()
1769 $revision: New Revision of the article
1771 'PageContentLanguage': Allows changing the language in which the content of a
1772 page is written. Defaults to the wiki content language ($wgContLang).
1773 $title: Title object
1774 &$pageLang: the page content language (either an object or a language code)
1775 $wgLang: the user language
1777 'PageContentSave': Before an article is saved.
1778 $wikiPage: the WikiPage (object) being saved
1779 $user: the user (object) saving the article
1780 $content: the new article content, as a Content object
1781 $summary: the article summary (comment)
1782 $isminor: minor flag
1783 $iswatch: watch flag
1786 'PageContentSaveComplete': After an article has been updated.
1787 $wikiPage: WikiPage modified
1788 $user: User performing the modification
1789 $content: New content, as a Content object
1790 $summary: Edit summary/comment
1791 $isMinor: Whether or not the edit was marked as minor
1792 $isWatch: (No longer used)
1793 $section: (No longer used)
1794 $flags: Flags passed to WikiPage::doEditContent()
1795 $revision: New Revision of the article
1796 $status: Status object about to be returned by doEditContent()
1797 $baseRevId: the rev ID (or false) this edit was based on
1799 'PageHistoryBeforeList': When a history page list is about to be constructed.
1800 $article: the article that the history is loading for
1801 $context: RequestContext object
1803 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1804 $row: the revision row for this line
1805 $s: the string representing this parsed line
1806 $classes: array containing the <li> element classes
1808 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1811 $queryInfo: the query parameters
1813 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1814 which depends on user options should install this hook and append its values to
1816 &$confstr: reference to a hash key string which can be modified
1817 $user: User (object) requesting the page
1819 'ParserAfterParse': Called from Parser::parse() just after the call to
1820 Parser::internalParse() returns.
1821 $parser: parser object
1822 $text: text being parsed
1823 $stripState: stripState used (object)
1825 'ParserAfterStrip': Called at end of parsing time.
1826 TODO: No more strip, deprecated ?
1827 $parser: parser object
1828 $text: text being parsed
1829 $stripState: stripState used (object)
1831 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1832 $parser: Parser object being used
1833 $text: text that will be returned
1835 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1836 $parser: Parser object
1837 $text: text to parse
1838 $stripState: StripState instance being used
1840 'ParserBeforeStrip': Called at start of parsing time.
1841 TODO: No more strip, deprecated ?
1842 $parser: parser object
1843 $text: text being parsed
1844 $stripState: stripState used (object)
1846 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1847 $parser: Parser object being used
1850 'ParserClearState': Called at the end of Parser::clearState().
1851 $parser: Parser object being cleared
1853 'ParserCloned': Called when the parser is cloned.
1854 $parser: Newly-cloned Parser object
1856 'ParserFirstCallInit': Called when the parser initialises for the first time.
1857 &$parser: Parser object being cleared
1859 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1861 $parser: Parser object
1862 $varCache: array to store the value in case of multiples calls of the
1864 $index: index (string) of the magic
1865 $ret: value of the magic word (the hook should set it)
1866 $frame: PPFrame object to use for expanding any template variables
1868 'ParserGetVariableValueTs': Use this to change the value of the time for the
1869 {{LOCAL...}} magic word.
1870 $parser: Parser object
1871 $time: actual time (timestamp)
1873 'ParserGetVariableValueVarCache': use this to change the value of the variable
1874 cache or return false to not use it.
1875 $parser: Parser object
1876 $varCache: variable cache (array)
1878 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
1879 ParserLimitReportFormat instead.
1880 Called at the end of Parser:parse() when the parser will
1881 include comments about size of the text parsed.
1882 $parser: Parser object
1883 &$limitReport: text that will be included (without comment tags)
1885 'ParserLimitReportFormat': Called for each row in the parser limit report that
1886 needs formatting. If nothing handles this hook, the default is to use "$key" to
1887 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
1889 $key: Key for the limit report item (string)
1890 &$value: Value of the limit report item
1891 &$report: String onto which to append the data
1892 $isHTML: If true, $report is an HTML table with two columns; if false, it's
1893 text intended for display in a monospaced font.
1894 $localize: If false, $report should be output in English.
1896 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
1897 include comments about size of the text parsed. Hooks should use
1898 $output->setLimitReportData() to populate data. Functions for this hook should
1899 not use $wgLang; do that in ParserLimitReportFormat instead.
1900 $parser: Parser object
1901 $output: ParserOutput object
1903 'ParserMakeImageParams': Called before the parser make an image link, use this
1904 to modify the parameters of the image.
1905 $title: title object representing the file
1906 $file: file object that will be used to create the image
1907 &$params: 2-D array of parameters
1908 $parser: Parser object that called the hook
1910 'ParserSectionCreate': Called each time the parser creates a document section
1911 from wikitext. Use this to apply per-section modifications to HTML (like
1912 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1913 can begin in one section and end in another. Make sure your code can handle
1914 that case gracefully. See the EditSectionClearerLink extension for an example.
1915 $parser: the calling Parser instance
1916 $section: the section number, zero-based, but section 0 is usually empty
1917 &$sectionContent: ref to the content of the section. modify this.
1918 $showEditLinks: boolean describing whether this section has an edit link
1920 'ParserTestParser': Called when creating a new instance of Parser in
1921 tests/parser/parserTest.inc.
1922 $parser: Parser object created
1924 'ParserTestGlobals': Allows to define globals for parser tests.
1925 &$globals: Array with all the globals which should be set for parser tests.
1926 The arrays keys serve as the globals names, its values are the globals values.
1928 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
1929 run. Use when page save hooks require the presence of custom tables to ensure
1930 that tests continue to run properly.
1931 &$tables: array of table names
1933 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1934 my talk page, my contributions" etc).
1935 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1936 &$title: Title object representing the current page
1937 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
1939 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
1940 &$user : User performing the action
1941 $action : Action being performed
1942 &$result : Whether or not the action should be prevented
1943 Change $result and return false to give a definitive answer, otherwise
1944 the built-in rate limiting checks are used, if enabled.
1945 $incrBy: Amount to increment counter by
1947 'PlaceNewSection': Override placement of new sections. Return false and put the
1948 merged text into $text to override the default behavior.
1949 $wikipage : WikiPage object
1950 $oldtext : the text of the article before editing
1951 $subject : subject of the new section
1952 &$text : text of the new section
1954 'PreferencesGetLegend': Override the text used for the <legend> of a
1955 preferences section.
1956 $form: the PreferencesForm object. This is a ContextSource as well
1957 $key: the section name
1958 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1960 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1961 AJAX search suggestions. Put results into &$results outparam and return false.
1962 $ns : array of int namespace keys to search in
1963 $search : search term (not guaranteed to be conveniently normalized)
1964 $limit : maximum number of results to return
1965 &$results : out param: array of page names (strings)
1967 'PrefsEmailAudit': Called when user changes their email address.
1968 $user: User (object) changing his email address
1969 $oldaddr: old email address (string)
1970 $newaddr: new email address (string)
1972 'PrefsPasswordAudit': Called when user changes his password.
1973 $user: User (object) changing his password
1974 $newPass: new password
1975 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1977 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
1979 $article: the title being (un)protected
1980 $output: a string of the form HTML so far
1982 'ProtectionForm::save': Called when a protection form is submitted.
1983 $article: the Page being (un)protected
1984 &$errorMsg: an html message string of an error or an array of message name and
1986 $reasonstr: a string describing the reason page protection level is altered
1988 'ProtectionForm::showLogExtract': Called after the protection log extract is
1990 $article: the page the form is shown for
1991 $out: OutputPage object
1993 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
1994 &$obj: RawPage object
1995 &$text: The text that's going to be the output
1997 'RecentChange_save': Called at the end of RecentChange::save().
1998 $recentChange: RecentChange object
2000 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2001 names such as "oldid" that are preserved when using redirecting special pages
2002 such as Special:MyPage and Special:MyTalk.
2003 &$redirectParams: An array of parameters preserved by redirecting special pages.
2005 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2006 instance. Can be used by an extension override what skin is used in certain
2008 IContextSource $context: The RequestContext the skin is being created for.
2009 &$skin: A variable reference you may set a Skin instance or string key on to
2010 override the skin that will be used for the context.
2012 'ResetSessionID': Called from wfResetSessionID
2013 $oldSessionID: old session id
2014 $newSessionID: new session id
2016 'ResourceLoaderGetConfigVars': Called at the end of
2017 ResourceLoaderStartUpModule::getConfig(). Use this to export static
2018 configuration variables to JavaScript. Things that depend on the current page
2019 or request state must be added through MakeGlobalVariablesScript instead.
2020 &$vars: array( variable name => value )
2022 'ResourceLoaderGetStartupModules': Run once the startup module is being
2023 generated. This allows you to add modules to the startup module. This hook
2024 should be used sparingly since any module added here will be loaded on all
2025 pages. This hook is useful if you want to make code available to module loader
2028 'ResourceLoaderRegisterModules': Right before modules information is required,
2029 such as when responding to a resource
2030 loader request or generating HTML output.
2031 &$resourceLoader: ResourceLoader object
2033 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2034 called after the addition of 'qunit' and MediaWiki testing resources.
2035 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2036 included in core, is fed using tests/qunit/QUnitTestResources.php.
2037 &ResourceLoader object
2039 To add a new qunit module named 'myext.tests':
2040 testModules['qunit']['myext.tests'] = array(
2041 'script' => 'extension/myext/tests.js',
2042 'dependencies' => <any module dependency you might have>
2044 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2045 added to any module.
2047 'RevisionInsertComplete': Called after a revision is inserted into the database.
2048 &$revision: the Revision
2049 $data: the data stored in old_text. The meaning depends on $flags: if external
2050 is set, it's the URL of the revision text in external storage; otherwise,
2051 it's the revision text itself. In either case, if gzip is set, the revision
2053 $flags: a comma-delimited list of strings representing the options used. May
2054 include: utf8 (this will always be set for new revisions); gzip; external.
2056 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2057 the normal operations.
2058 $allSearchTerms : Array of the search terms in all content languages
2059 &$titleResult : Outparam; the value to return. A Title object or null.
2061 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2062 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2064 $term : Search term string
2065 &$title : Outparam; set to $title object and return false for a match
2067 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2068 if nothing was found.
2069 $term : Search term string
2070 &$title : Outparam; set to $title object and return false for a match
2072 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2074 $term : Search term string
2075 &$title : Current Title object that is being returned (null if none found).
2077 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
2078 $searchEngine : The SearchEngine object. Users of this hooks will be interested
2079 in the $searchEngine->namespaces array.
2080 $query : Original query.
2081 &$parsed : Resultant query with the prefixes stripped.
2083 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2085 $title : Current Title object being displayed in search results.
2086 &$id: Revision ID (default is false, for latest)
2088 'SearchableNamespaces': An option to modify which namespaces are searchable.
2089 &$arr : Array of namespaces ($nsId => $name) which will be used.
2091 'SetupAfterCache': Called in Setup.php, after cache objects are set
2093 'ShowMissingArticle': Called when generating the output for a non-existent page.
2094 $article: The article object corresponding to the page
2096 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2097 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
2098 $text: Text being shown
2099 $title: Title of the custom script/stylesheet page
2100 $output: Current OutputPage object
2102 'ShowSearchHitTitle': Customise display of search hit title/link.
2103 &$title: Title to link to
2104 &$text: Text to use for the link
2105 $result: The search result
2106 $terms: The search terms entered
2107 $page: The SpecialSearch object.
2109 'ShowSearchHit': Customize display of search hit.
2110 $searchPage: The SpecialSearch instance.
2111 $result: The SearchResult to show
2112 $terms: Search terms, for highlighting
2113 &$link: HTML of link to the matching page. May be modified.
2114 &$redirect: HTML of redirect info. May be modified.
2115 &$section: HTML of matching section. May be modified.
2116 &$extract: HTML of content extract. May be modified.
2117 &$score: HTML of score. May be modified.
2118 &$size: HTML of page size. May be modified.
2119 &$date: HTML of of page modification date. May be modified.
2120 &$related: HTML of additional info for the matching page. May be modified.
2121 &$html: May be set to the full HTML that should be used to represent the search
2122 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2123 function returned false.
2125 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2126 allow the normal method of notice selection/rendering to work, or change the
2127 value of $siteNotice and return false to alter it.
2128 &$siteNotice: HTML returned as the sitenotice
2131 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2132 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2133 the sitenotice/anonnotice.
2136 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2138 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2139 the stock bottom scripts.
2141 'SkinAfterContent': Allows extensions to add text after the page content and
2142 article metadata. This hook should work in all skins. Set the &$data variable to
2143 the text you're going to add.
2144 &$data: (string) Text to be printed out directly (without parsing)
2147 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2149 &$bar: Sidebar contents
2150 Modify $bar to add or modify sidebar portlets.
2152 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2154 $title: displayed page title
2155 $type: 'normal' or 'history' for old/diff views
2156 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2157 message must be in HTML format, not wikitext!
2158 &$link: overridable HTML link to be passed into the message as $1
2159 &$forContent: overridable flag if copyright footer is shown in content language.
2161 'SkinGetPoweredBy': TODO
2162 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2163 the MediaWiki icon but plain text instead.
2166 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2167 &$subpages: Subpage links HTML
2169 $out: OutputPage object
2170 If false is returned $subpages will be used instead of the HTML
2171 subPageSubtitle() generates.
2172 If true is returned, $subpages will be ignored and the rest of
2173 subPageSubtitle() will run.
2175 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2177 $sktemplate: SkinTemplate object
2178 $nav_urls: array of tabs
2180 To alter the structured navigation links in SkinTemplates, there are three
2181 hooks called in different spots:
2183 'SkinTemplateNavigation': Called on content pages after the tabs have been
2184 added, but before variants have been added.
2185 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2186 tab is added but before variants have been added.
2187 'SkinTemplateNavigation::Universal': Called on both content and special pages
2188 after variants have been added.
2189 &$sktemplate: SkinTemplate object
2190 &$links: Structured navigation links. This is used to alter the navigation for
2191 skins which use buildNavigationUrls such as Vector.
2193 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2195 &$sktemplate: SkinTemplate object
2196 &$tpl: Template engine object
2198 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2199 $sktemplate: SkinTemplate object
2200 $res: set to true to prevent active tabs
2202 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2203 You can either create your own array, or alter the parameters for
2205 &$sktemplate: The SkinTemplate instance.
2206 $title: Title instance for the page.
2207 $message: Visible label of tab.
2208 $selected: Whether this is a selected tab.
2209 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2210 &$classes: Array of CSS classes to apply.
2211 &$query: Query string to add to link.
2213 &$result: Complete assoc. array if you want to return true.
2215 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2216 been rendered (useful for adding more).
2217 $sk: The QuickTemplate based skin template running the hook.
2218 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2219 extensions that add support for BaseTemplateToolbox should watch for this
2220 dummy parameter with "$dummy=false" in their code and return without echoing
2221 any HTML to avoid creating duplicate toolbox items.
2223 'SoftwareInfo': Called by Special:Version for returning information about the
2225 $software: The array of software in format 'name' => 'version'. See
2226 SpecialVersion::softwareInformation().
2228 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2229 $sp: SpecialPage object, for context
2230 &$fields: Current HTMLForm fields
2232 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2233 $id: User id number, only provided for backwards-compatability
2234 $user: User object representing user contributions are being fetched for
2235 $sp: SpecialPage instance, providing context
2237 'SpecialListusersDefaultQuery': Called right before the end of
2238 UsersPager::getDefaultQuery().
2239 $pager: The UsersPager instance
2240 $query: The query array to be returned
2242 'SpecialListusersFormatRow': Called right before the end of
2243 UsersPager::formatRow().
2244 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2245 $row: Database row object
2247 'SpecialListusersHeader': Called before closing the <fieldset> in
2248 UsersPager::getPageHeader().
2249 $pager: The UsersPager instance
2250 $out: The header HTML
2252 'SpecialListusersHeaderForm': Called before adding the submit button in
2253 UsersPager::getPageHeader().
2254 $pager: The UsersPager instance
2255 $out: The header HTML
2257 'SpecialListusersQueryInfo': Called right before the end of.
2258 UsersPager::getQueryInfo()
2259 $pager: The UsersPager instance
2260 $query: The query array to be returned
2262 'SpecialMovepageAfterMove': Called after moving a page.
2263 $movePage: MovePageForm object
2264 $oldTitle: old title (object)
2265 $newTitle: new title (object)
2267 'SpecialNewpagesConditions': Called when building sql query for
2269 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2270 $opts: FormOptions object containing special page options
2271 &$conds: array of WHERE conditionals for query
2272 &tables: array of tables to be queried
2273 &$fields: array of columns to select
2274 &$join_conds: join conditions for the tables
2276 'SpecialNewPagesFilters': Called after building form options at NewPages.
2277 $special: the special page object
2278 &$filters: associative array of filter definitions. The keys are the HTML
2279 name/URL parameters. Each key maps to an associative array with a 'msg'
2280 (message key) and a 'default' value.
2282 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2283 hook to remove a core special page.
2284 $list: list (array) of core special pages
2286 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2287 $special: the SpecialPage object
2288 $subPage: the subpage string or null if no subpage was specified
2290 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2291 $special: the SpecialPage object
2292 $subPage: the subpage string or null if no subpage was specified
2294 'SpecialPasswordResetOnSubmit': When executing a form submission on
2295 Special:PasswordReset.
2296 $users: array of User objects.
2297 $data: array of data submitted by the user
2298 &$error: string, error code (message key) used to describe to error (out
2299 parameter). The hook needs to return false when setting this, otherwise it
2300 will have no effect.
2302 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2303 use this to change some selection criteria or substitute a different title.
2304 &$randstr: The random number from wfRandom()
2305 &$isRedir: Boolean, whether to select a redirect or non-redirect
2306 &$namespaces: An array of namespace indexes to get the title from
2307 &$extra: An array of extra SQL statements
2308 &$title: If the hook returns false, a Title object to use instead of the
2309 result from the normal query
2311 'SpecialRecentChangesFilters': Called after building form options at
2313 $special: the special page object
2314 &$filters: associative array of filter definitions. The keys are the HTML
2315 name/URL parameters. Each key maps to an associative array with a 'msg'
2316 (message key) and a 'default' value.
2318 'SpecialRecentChangesPanel': Called when building form options in
2319 SpecialRecentChanges.
2320 &$extraOpts: array of added items, to which can be added
2321 $opts: FormOptions for this request
2323 'SpecialRecentChangesQuery': Called when building SQL query for
2324 SpecialRecentChanges and SpecialRecentChangesLinked.
2325 &$conds: array of WHERE conditionals for query
2326 &$tables: array of tables to be queried
2327 &$join_conds: join conditions for the tables
2328 $opts: FormOptions for this request
2329 &$query_options: array of options for the database request
2330 &$select: Array of columns to select
2332 'SpecialResetTokensTokens': Called when building token list for
2334 &$tokens: array of token information arrays in the format of
2335 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2337 'SpecialSearchCreateLink': Called when making the message to create a page or
2338 go to the existing page.
2339 $t: title object searched for
2340 &$params: an array of the default message name and page title (as parameter)
2342 'SpecialSearchGo': Called when user clicked the "Go".
2343 &$title: title object generated from the text entered by the user
2344 &$term: the search term entered by the user
2346 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2347 target doesn't exist.
2348 &$title: title object generated from the text entered by the user
2350 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2351 the advanced form, a.k.a. power search box.
2352 &$showSections: an array to add values with more options to
2353 $term: the search term (not a title object)
2354 $opts: an array of hidden options (containing 'redirs' and 'profile')
2356 'SpecialSearchProfiles': Allows modification of search profiles.
2357 &$profiles: profiles, which can be modified.
2359 'SpecialSearchProfileForm': Allows modification of search profile forms.
2360 $search: special page object
2361 &$form: String: form html
2362 $profile: String: current search profile
2363 $term: String: search term
2364 $opts: Array: key => value of hidden options for inclusion in custom forms
2366 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2367 $search: SpecialSearch special page object
2368 $profile: String: current search profile
2369 $engine: the search engine
2371 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2372 on the search results page. Useful for including an external search
2373 provider. To disable the output of MediaWiki search output, return
2375 $specialSearch: SpecialSearch object ($this)
2377 $term: Search term specified by the user
2379 'SpecialSearchResultsAppend': Called after all search results HTML has
2380 been output. Note that in some cases, this hook will not be called (no
2381 results, too many results, SpecialSearchResultsPrepend returned false,
2383 $specialSearch: SpecialSearch object ($this)
2385 $term: Search term specified by the user
2387 'SpecialSearchResults': Called before search result display when there are
2389 $term: string of search term
2390 &$titleMatches: empty or SearchResultSet object
2391 &$textMatches: empty or SearchResultSet object
2393 'SpecialSearchNoResults': Called before search result display when there are no
2395 $term: string of search term
2397 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2398 &$extraStats: Array to save the new stats
2399 ( $extraStats['<name of statistic>'] => <value>; )
2401 'SpecialUploadComplete': Called after successfully uploading a file from
2403 $form: The SpecialUpload object
2405 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2406 use this to change the tables headers.
2407 $extTypes: associative array of extensions types
2409 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2410 $wgVersion: Current $wgVersion for you to use
2411 &$versionUrl: Raw url to link to (eg: release notes)
2413 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2414 $special: the special page object
2415 &$filters: associative array of filter definitions. The keys are the HTML
2416 name/URL parameters. Each key maps to an associative array with a 'msg'
2417 (message key) and a 'default' value.
2419 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2420 &$conds: array of WHERE conditionals for query
2421 &$tables: array of tables to be queried
2422 &$join_conds: join conditions for the tables
2423 &$fields: array of query fields
2424 $opts: A FormOptions object with watchlist options for the current request
2426 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2427 SpecialWatchlist. Allows extensions to register custom values they have
2428 inserted to rc_type so they can be returned as part of the watchlist.
2429 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2431 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2432 URL for a title when we have no other parameters on the URL. Gives a chance for
2433 extensions that alter page view behavior radically to abort that redirect or
2435 $request: WebRequest
2436 $title: Title of the currently found title obj
2437 $output: OutputPage object
2439 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2440 rendered (by ThumbnailImage:toHtml method).
2441 $thumbnail: the ThumbnailImage object
2442 &$attribs: image attribute array
2443 &$linkAttribs: image link attribute array
2445 'TitleArrayFromResult': Called when creating an TitleArray object from a
2447 &$titleArray: set this to an object to override the default object returned
2448 $res: database result used to create the object
2450 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2451 or override the quick permissions check.
2452 $title: The Title object being accessed
2453 $user: The User performing the action
2454 $action: Action being performed
2455 &$errors: Array of errors
2456 $doExpensiveQueries: Whether to do expensive DB queries
2457 $short: Whether to return immediately on first error
2459 'TitleGetEditNotices': Allows extensions to add edit notices
2460 $title: The Title object for the page the edit notices are for
2461 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2462 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2464 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2465 that can be applied.
2466 $title: The title in question.
2467 &$types: The types of protection available.
2469 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2470 $title: Title object that is being checked
2471 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2472 Hooks may change this value to override the return value of
2473 Title::isCssOrJsPage().
2475 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2476 overriding default behavior for determining if a page exists. If $isKnown is
2477 kept as null, regular checks happen. If it's a boolean, this value is returned
2478 by the isKnown method.
2479 $title: Title object that is being checked
2480 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2482 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2483 that this hook is not called for interwiki pages or pages in immovable
2484 namespaces: for these, isMovable() always returns false.
2485 $title: Title object that is being checked
2486 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2487 Hooks may change this value to override the return value of
2490 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2491 be handled by separate handler (via ArticleViewCustom).
2492 $title: Title object that is being checked
2493 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2494 Hooks may change this value to override the return value of
2495 Title::isWikitextPage()
2497 'TitleMove': Before moving an article (title).
2500 $user: user who does the move
2502 'TitleMoveComplete': After moving an article (title).
2505 $user: user who did the move
2506 $pageid: database ID of the page that's been moved
2507 $redirid: database ID of the created redirect
2509 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2510 adding the default error message if nothing allows the user to read the page. If
2511 a handler wants a title to *not* be whitelisted, it should also return false.
2512 $title: Title object being checked against
2513 $user: Current user object
2514 &$whitelisted: Boolean value of whether this title is whitelisted
2516 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2517 $this: Title object to purge
2518 &$urls: An array of URLs to purge from the caches, to be manipulated.
2520 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2521 PageArchive object has been created but before any further processing is done.
2522 &$archive: PageArchive object
2523 $title: Title object of the page that we're viewing
2525 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2526 PageArchive object has been created but before any further processing is done.
2527 &$archive: PageArchive object
2528 $title: Title object of the page that we're viewing
2530 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2531 the site is not in read-only mode, that the Title object is not null and after
2532 a PageArchive object has been constructed but before performing any further
2534 &$archive: PageArchive object
2535 $title: Title object of the page that we're about to undelete
2537 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2538 $title: title object related to the revision
2539 $rev: revision (object) that will be viewed
2541 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2543 $action: action name
2544 $article: article "acted on"
2546 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2547 &$files: list of files
2549 'UnwatchArticle': Before a watch is removed from an article.
2550 $user: user watching
2551 $page: WikiPage object to be removed
2552 &$status: Status object to be returned if the hook returns false
2554 'UnwatchArticleComplete': After a watch is removed from an article.
2555 $user: user that watched
2556 $page: WikiPage object that was watched
2558 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2559 $formattedPageStatus: list of valid page states
2561 'UploadForm:initial': Before the upload form is generated. You might set the
2562 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2563 text (HTML) either before or after the editform.
2564 $form: UploadForm object
2566 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2567 poke at member variables like $mUploadDescription before the file is saved. Do
2568 not use this hook to break upload processing. This will return the user to a
2569 blank form with no error message; use UploadVerification and UploadVerifyFile
2571 $form: UploadForm object
2573 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2574 $type: (string) the requested upload type
2575 &$className: the class name of the Upload instance to be created
2577 'UploadComplete': when Upload completes an upload.
2578 &$upload: an UploadBase child instance
2580 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2582 $descriptor: (array) the HTMLForm descriptor
2584 'UploadFormSourceDescriptors': after the standard source inputs have been
2585 added to the descriptor
2586 $descriptor: (array) the HTMLForm descriptor
2588 'UploadVerification': Additional chances to reject an uploaded file. Consider
2589 using UploadVerifyFile instead.
2590 string $saveName: destination file name
2591 string $tempName: filesystem path to the temporary file for checks
2592 string &$error: output: message key for message to show if upload canceled by
2593 returning false. May also be an array, where the first element is the message
2594 key and the remaining elements are used as parameters to the message.
2596 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2597 in most cases over UploadVerification.
2598 object $upload: an instance of UploadBase, with all info about the upload
2599 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2600 will typically only apply for specific mime types.
2601 object &$error: output: true if the file is valid. Otherwise, an indexed array
2602 representing the problem with the file, where the first element is the message
2603 key and the remaining elements are used as parameters to the message.
2605 'UploadComplete': Upon completion of a file upload.
2606 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2607 $uploadBase->getLocalFile().
2609 'User::mailPasswordInternal': before creation and mailing of a user's new
2611 $user: the user who sent the message out
2612 $ip: IP of the user who sent the message out
2613 $u: the account whose new password will be set
2615 'UserAddGroup': Called when adding a group; return false to override
2616 stock group addition.
2617 $user: the user object that is to have a group added
2618 &$group: the group to add, can be modified
2620 'UserArrayFromResult': Called when creating an UserArray object from a database
2622 &$userArray: set this to an object to override the default object returned
2623 $res: database result used to create the object
2625 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2626 want to display an error message, try getUserPermissionsErrors.
2627 $title: Title object being checked against
2628 $user : Current user object
2629 $action: Action being checked
2630 $result: Pointer to result returned if hook returns false. If null is returned,
2631 userCan checks are continued by internal code.
2633 'UserCanSendEmail': To override User::canSendEmail() permission check.
2634 $user: User (object) whose permission is being checked
2635 &$canSend: bool set on input, can override on output
2637 'UserClearNewTalkNotification': Called when clearing the "You have new
2638 messages!" message, return false to not delete it.
2639 $user: User (object) that will clear the message
2640 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2642 'UserComparePasswords': Called when checking passwords, return false to
2643 override the default password checks.
2644 &$hash: String of the password hash (from the database)
2645 &$password: String of the plaintext password the user entered
2646 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2648 &$result: If the hook returns false, this Boolean value will be checked to
2649 determine if the password was valid
2651 'UserCreateForm': change to manipulate the login form
2652 $template: SimpleTemplate instance for the form
2654 'UserCryptPassword': Called when hashing a password, return false to implement
2655 your own hashing method.
2656 &$password: String of the plaintext password to encrypt
2657 &$salt: String of the password salt or Boolean false if no salt is provided
2658 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2660 &$hash: If the hook returns false, this String will be used as the hash
2662 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2663 $user: User to get groups for
2664 &$groups: Current effective groups
2666 'UserGetAllRights': After calculating a list of all available rights.
2667 &$rights: Array of rights, which may be added to.
2669 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2670 before returning the options to the caller. Warning: This hook is called for
2671 every call to User::getDefaultOptions(), which means it's potentially called
2672 dozens or hundreds of times. You may want to cache the results of non-trivial
2673 operations in your hook function for this reason.
2674 &$defaultOptions: Array of preference keys and their default values.
2676 'UserGetEmail': Called when getting an user email address.
2678 &$email: email, change this to override local email
2680 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2681 email authentication.
2683 &$timestamp: timestamp, change this to override local email authentication
2686 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2687 &$groups: List of implicit (automatically-assigned) groups
2689 'UserGetLanguageObject': Called when getting user's interface language object.
2691 &$code: Language code that will be used to create the object
2692 $context: RequestContext object
2694 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2695 &$reservedUsernames: $wgReservedUsernames
2697 'UserGetRights': Called in User::getRights().
2698 $user: User to get rights for
2699 &$rights: Current rights
2701 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2702 specific block exemptions).
2703 $user: User in question
2704 $title: Title of the page in question
2705 &$blocked: Out-param, whether or not the user is blocked from that page.
2706 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2707 to edit their own user talk pages.
2709 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2711 $ip: User's IP address
2712 &$blocked: Whether the user is blocked, to be modified by the hook
2714 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2715 false if a UserGetRights hook might remove the named right.
2716 $right: The user right being checked
2718 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2719 environmental means; occurs after session is loaded.
2720 $user: user object being loaded
2722 'UserLoadDefaults': Called when loading a default user.
2726 'UserLoadFromDatabase': Called when loading a user from the database.
2728 &$s: database query object
2730 'UserLoadFromSession': Called to authenticate users on external/environmental
2731 means; occurs before session is loaded.
2732 $user: user object being loaded
2733 &$result: set this to a boolean value to abort the normal authentication
2736 'UserLoadOptions': When user options/preferences are being loaded from the
2739 &$options: Options, can be modified.
2741 'UserLoginComplete': After a user has logged in.
2742 $user: the user object that was created on login
2743 $inject_html: Any HTML to inject after the "logged in" message.
2745 'UserLoginForm': change to manipulate the login form
2746 $template: SimpleTemplate instance for the form
2748 'UserLogout': Before a user logs out.
2749 $user: the user object that is about to be logged out
2751 'UserLogoutComplete': After a user has logged out.
2752 $user: the user object _after_ logout (won't have name, ID, etc.)
2753 $inject_html: Any HTML to inject after the "logged out" message.
2754 $oldName: name of the user before logout (string)
2756 'UserRemoveGroup': Called when removing a group; return false to override stock
2758 $user: the user object that is to have a group removed
2759 &$group: the group to be removed, can be modified
2761 'UserRights': After a user's group memberships are changed.
2762 $user : User object that was changed
2763 $add : Array of strings corresponding to groups added
2764 $remove: Array of strings corresponding to groups removed
2766 'UserRequiresHTTPS': Called to determine whether a user needs
2767 to be switched to HTTPS.
2768 $user: User in question.
2769 &$https: Boolean whether $user should be switched to HTTPS.
2772 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2774 $user: user retrieving new talks messages
2775 $talks: array of new talks page(s)
2777 'UserSaveSettings': Called when saving user settings.
2780 'UserSaveOptions': Called just before saving user preferences/options.
2782 &$options: Options, modifiable
2784 'UserSetCookies': Called when setting user cookies.
2786 &$session: session array, will be added to $_SESSION
2787 &$cookies: cookies array mapping cookie name to its value
2789 'UserSetEmail': Called when changing user email address.
2791 &$email: new email, change this to override new email address
2793 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2794 email authentication.
2796 &$timestamp: new timestamp, change this to override local email
2797 authentication timestamp
2799 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2800 "Foobar (Talk | Contribs | Block)".
2801 $userId: User id of the current user
2802 $userText: User name of the current user
2803 &$items: Array of user tool links as HTML fragments
2805 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
2806 FormatMetadata::getExtendedMeta (return false means cache will be
2807 invalidated and GetExtendedMetadata hook called again).
2808 $timestamp: The timestamp metadata was generated
2809 $file: The file the metadata is for
2811 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2812 used to alter the SQL query which gets the list of wanted pages.
2813 &$wantedPages: WantedPagesPage object
2814 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2816 'WatchArticle': Before a watch is added to an article.
2817 $user: user that will watch
2818 $page: WikiPage object to be watched
2819 &$status: Status object to be returned if the hook returns false
2821 'WatchArticleComplete': After a watch is added to an article.
2822 $user: user that watched
2823 $page: WikiPage object watched
2825 'WatchlistEditorBuildRemoveLine': when building remove lines in
2826 Special:Watchlist/edit.
2827 &$tools: array of extra links
2828 $title: Title object
2829 $redirect: whether the page is a redirect
2832 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2834 $router: The PathRouter instance
2836 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
2837 Return false to prevent setting of the cookie.
2838 &$name: Cookie name passed to WebResponse::setcookie()
2839 &$value: Cookie value passed to WebResponse::setcookie()
2840 &$expire: Cookie expiration, as for PHP's setcookie()
2841 $options: Options passed to WebResponse::setcookie()
2843 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2844 dumps. One, and only one hook should set this, and return false.
2845 &$tables: Database tables to use in the SELECT query
2846 &$opts: Options to use for the query
2847 &$join: Join conditions
2849 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2850 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2851 specific to a content model should be provided by the respective Content's
2852 getDeletionUpdates() method.
2854 $content: the Content to generate updates for
2855 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2857 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2858 run a MediaWiki cli script.
2859 &$script: MediaWiki cli script path
2860 &$parameters: Array of arguments and options to the script
2861 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2864 'wgQueryPages': Called when initialising $wgQueryPages, use this to add new
2865 query pages to be updated with maintenance/updateSpecialPages.php.
2866 $query: $wgQueryPages itself
2868 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2869 extra metadata to be added.
2870 $obj: The XmlDumpWriter object.
2871 &$out: The output string.
2872 $row: The database row for the page.
2873 $title: The title of the page.
2875 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2877 $obj: The XmlDumpWriter object.
2878 &$out: The text being output.
2879 $row: The database row for the revision.
2880 $text: The revision text.
2882 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2883 to add additional tags to extract.
2884 &$items: Array containing information on which items to extract. See XMPInfo for
2885 details on the format.
2887 'XMPGetResults': Called just before returning the results array of parsing xmp
2888 data. Can be used to post-process the results.
2889 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2890 is an array of metadata tags returned (each tag is either a value, or an array
2893 More hooks might be available but undocumented, you can execute
2894 "php maintenance/findHooks.php" to find hidden ones.