skins: Update .gitignore
[mediawiki.git] / docs / hooks.txt
blob7ec6ff5c7b50a84d078a6bda5ad444b73d0bb7ac
1 hooks.txt
3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
6 ==Glossary==
8 event
9      Something that happens with the wiki. For example: a user logs in. A wiki
10      page is saved. A wiki page is deleted. Often there are two events
11      associated with a single action: one before the code is run to make the
12      event happen, and one after. Each event has a name, preferably in
13      CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
14      'ArticleDelete'.
16 hook
17      A clump of code and data that should be run when an event happens. This can
18      be either a function and a chunk of data, or an object and a method.
20 hook function
21      The function part of a hook.
23 ==Rationale==
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37         function showAnArticle($article) {
38                 global $wgReverseTitle, $wgCapitalizeTitle;
40                 if ($wgReverseTitle) {
41                         wfReverseTitle($article);
42                 }
44                 if ($wgCapitalizeTitle) {
45                         wfCapitalizeTitle($article);
46                 }
48                 # code to actually show the article goes here
49         }
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55     function showAnArticle($article) {
56         global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58                 if ($wgReverseTitle) {
59                         wfReverseTitle($article);
60                 }
62                 if ($wgCapitalizeTitle) {
63                         wfCapitalizeTitle($article);
64                 }
66                 # code to actually show the article goes here
68                 if ($wgNotifyArticle) {
69                         wfNotifyArticleShow($article));
70                 }
71         }
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76         function showAnArticle($article) {
78                 if (wfRunHooks('ArticleShow', array(&$article))) {
80                         # code to actually show the article goes here
82                         wfRunHooks('ArticleShowComplete', array(&$article));
83                 }
84         }
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
94 file:
96         function reverseArticleTitle($article) {
97                 # ...
98         }
100         function reverseForExport($article) {
101                 # ...
102         }
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
107         setupTitleReversingExtension() {
108                 global $wgHooks;
110                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112                 $wgHooks['ArticleExport'][] = 'reverseForExport';
113         }
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123         require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
126 just leave it out.
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
131 ==Writing hooks==
133 A hook is a chunk of code run at some particular event. It consists of:
135   * a function with some optional accompanying data, or
136   * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141         $wgHooks['EventName'][] = 'someFunction'; # function, no data
142         $wgHooks['EventName'][] = array('someFunction', $someData);
143         $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145         $wgHooks['EventName'][] = $object; # object only
146         $wgHooks['EventName'][] = array($object, 'someMethod');
147         $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148         $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
154         # function, no data
155         someFunction($param1, $param2)
156         # function with data
157         someFunction($someData, $param1, $param2)
159         # object only
160         $object->onEventName($param1, $param2)
161         # object with method
162         $object->someMethod($param1, $param2)
163         # object with method and data
164         $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181   * true: the hook has operated successfully
182   * "some string": an error occurred; processing should stop and the error
183                    should be shown to the user
184   * false: the hook has successfully done the work necessary and the calling
185            function should skip
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191         $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193         function ldapLogin($username, $password) {
194                 # log user into LDAP
195                 return false;
196         }
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
205 ==Using hooks==
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
210         class Article {
211                 # ...
212                 function protect() {
213                         global $wgUser;
214                         if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215                                 # protect the article
216                                 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217                         }
218                 }
219         }
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
230 MediaWiki 1.4rc1.
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation,
238 where normally authentication against an external auth plugin would be creating
239 a local account.
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
253 $rc: The current RecentChange object.
255 'AbortLogin': Return false to cancel account login.
256 $user: the User object being authenticated against
257 $password: the password being submitted, not yet checked for validity
258 &$retval: a LoginForm class constant to return from authenticateUserData();
259           default is LoginForm::ABORTED. Note that the client may be using
260           a machine API rather than the HTML user interface.
261 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: HTML to display on abort
266 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
267           Create the object with Status::newFatal() to ensure proper API error messages
268           are returned when creating account through API clients.
270 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
271 $targetUser: the user whom to send talk page email notification
272 $title: the page title
274 'SendWatchlistEmailNotification': Return true to send watchlist email notification
275 $targetUser: the user whom to send watchlist email notification
276 $title: the page title
277 $enotif: EmailNotification object
279 'AbortChangePassword': Return false to cancel password change.
280 $user: the User object to which the password change is occuring
281 $mOldpass: the old password provided by the user
282 $newpass: the new password provided by the user
283 &$abortMsg: the message identifier for abort reason
285 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
286 $name: name of the action
287 &$form: HTMLForm object
288 $article: Article object
290 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
291 Allows to change the fields on the form that will be generated.
292 $name: name of the action
293 &$fields: HTMLForm descriptor array
294 $article: Article object
296 'AddNewAccount': After a user account is created.
297 $user: the User object that was created. (Parameter added in 1.7)
298 $byEmail: true when account was created "by email" (added in 1.12)
300 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
301 $apiModule: the ApiCreateAccount module calling
302 $loginForm: the LoginForm used
304 'AddNewAccountApiResult': Modify API output when creating a new account via API.
305 $apiModule: the ApiCreateAccount module calling
306 $loginForm: the LoginForm used
307 &$result: associative array for API result data
309 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
310 before OutputPage::sendCacheControl() and final ob_end_flush() which
311 will send the buffered output to the client. This allows for last-minute
312 modification of the output within the buffer by using ob_get_clean().
313 $output: The OutputPage object where output() was called
315 'AfterImportPage': When a page import is completed.
316 $title: Title under which the revisions were imported
317 $origTitle: Title provided by the XML file
318 $revCount: Number of revisions in the XML file
319 $sRevCount: Number of successfully imported revisions
320 $pageInfo: associative array of page information
322 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
323 just before adding its HTML to parser output.
324 $parser: Parser object that called the hook
325 $ig: Gallery, an object of one of the gallery classes (inheriting from
326 ImageGalleryBase)
327 $html: HTML generated by the gallery
329 'AlternateEdit': Before checking if a user can edit a page and before showing
330 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
331 $editPage: the EditPage object
333 'AlternateEditPreview': Before generating the preview of the page when editing
334 ( EditPage::getPreviewText() ).
335 $editPage: the EditPage object
336 &$content: the Content object for the text field from the edit page
337 &$previewHTML: Text to be placed into the page for the preview
338 &$parserOutput: the ParserOutput object for the preview
339 return false and set $previewHTML and $parserOutput to output custom page
340 preview HTML.
342 'AlternateUserMailer': Called before mail is sent so that mail could be logged
343 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
344 the regular method of sending mail.  Return a string to return a php-mail-error
345 message containing the error. Returning true will continue with sending email
346 in the regular way.
347 $headers: Associative array of headers for the email
348 $to: MailAddress object or array
349 $from: From address
350 $subject: Subject of the email
351 $body: Body of the message
353 'APIAfterExecute': After calling the execute() method of an API module. Use
354 this to extend core API modules.
355 &$module: Module object
357 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
358 &$main: ApiMain object
360 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
361 authenticate and authorize API clients before executing the module. Return
362 false and set a message to cancel the request.
363 $module: Module object
364 $user: Current user
365 &$message: API usage message to die with, as a message key or array
366 as accepted by ApiBase::dieUsageMsg.
368 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
369 processing request parameters. Return false to let the request fail, returning
370 an error message or an <edit result="Failure"> tag if $resultArr was filled.
371 $editPage : the EditPage object
372 $text : the new text of the article (has yet to be saved)
373 &$resultArr : data in this array will be added to the API result
375 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
376 highlighting, add output to $context->getOutput() and return false.
377 $context: An IContextSource.
378 $text: Text to be highlighted.
379 $mime: MIME type of $text.
380 $format: API format code for $text.
382 'APIGetAllowedParams': Use this hook to modify a module's parameters.
383 &$module: ApiBase Module object
384 &$params: Array of parameters
385 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
387 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
388 Use this hook to modify a module's description.
389 &$module: ApiBase Module object
390 &$desc: String description, or array of description strings
392 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
393 $module: ApiBase Module object
394 &$msg: Array of Message objects
396 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages instead.
397 Use this hook to modify a module's parameter descriptions.
398 &$module: ApiBase Module object
399 &$desc: Array of parameter descriptions
401 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter descriptions.
402 $module: ApiBase Module object
403 &$msg: Array of arrays of Message objects
405 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
406 $module: ApiBase Module object
407 &$help: Array of HTML strings to be joined for the output.
408 $options: Array Options passed to ApiHelp::getHelp
410 'APIQueryAfterExecute': After calling the execute() method of an
411 action=query submodule. Use this to extend core API modules.
412 &$module: Module object
414 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
415 an action=query submodule. Use this to extend core API modules.
416 &$module: Module object
417 &$resultPageSet: ApiPageSet object
419 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
420 Use this hook to add custom tokens to prop=info. Every token has an action,
421 which will be used in the intoken parameter and in the output
422 (actiontoken="..."), and a callback function which should return the token, or
423 false if the user isn't allowed to obtain it. The prototype of the callback
424 function is func($pageid, $title), where $pageid is the page ID of the page the
425 token is requested for and $title is the associated Title object. In the hook,
426 just add your callback to the $tokenFunctions array and return true (returning
427 false makes no sense).
428 $tokenFunctions: array(action => callback)
430 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
431 Use this hook to add custom tokens to prop=revisions. Every token has an
432 action, which will be used in the rvtoken parameter and in the output
433 (actiontoken="..."), and a callback function which should return the token, or
434 false if the user isn't allowed to obtain it. The prototype of the callback
435 function is func($pageid, $title, $rev), where $pageid is the page ID of the
436 page associated to the revision the token is requested for, $title the
437 associated Title object and $rev the associated Revision object. In the hook,
438 just add your callback to the $tokenFunctions array and return true (returning
439 false makes no sense).
440 $tokenFunctions: array(action => callback)
442 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
443 Use this hook to add custom tokens to list=recentchanges. Every token has an
444 action, which will be used in the rctoken parameter and in the output
445 (actiontoken="..."), and a callback function which should return the token, or
446 false if the user isn't allowed to obtain it. The prototype of the callback
447 function is func($pageid, $title, $rc), where $pageid is the page ID of the
448 page associated to the revision the token is requested for, $title the
449 associated Title object and $rc the associated RecentChange object. In the
450 hook, just add your callback to the $tokenFunctions array and return true
451 (returning false makes no sense).
452 $tokenFunctions: array(action => callback)
454 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
455 sites general information.
456 $module: the current ApiQuerySiteInfo module
457 &$results: array of results, add things here
459 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
460 sites statistics information.
461 &$results: array of results, add things here
463 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
464 action=query&meta=tokens. Note that most modules will probably be able to use
465 the 'csrf' token instead of creating their own token types.
466 &$salts: array( type => salt to pass to User::getEditToken() )
468 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
469 Use this hook to add custom token to list=users. Every token has an action,
470 which will be used in the ustoken parameter and in the output
471 (actiontoken="..."), and a callback function which should return the token, or
472 false if the user isn't allowed to obtain it. The prototype of the callback
473 function is func($user) where $user is the User object. In the hook, just add
474 your callback to the $tokenFunctions array and return true (returning false
475 makes no sense).
476 $tokenFunctions: array(action => callback)
478 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
479 an exception is thrown during API action execution.
480 $apiMain: Calling ApiMain instance.
481 $e: Exception object.
483 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
484 should have its own entry in the $apis array and have a unique name, passed as
485 key for the array that represents the service data. In this data array, the
486 key-value-pair identified by the apiLink key is required.
487 &$apis: array of services
489 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
490 Use this hook to extend action=tokens with new token types.
491 &$tokenTypes: supported token types in format 'type' => callback function
492 used to retrieve this type of tokens.
494 'Article::MissingArticleConditions': Before fetching deletion & move log entries
495 to display a message of a non-existing page being deleted/moved, give extensions
496 a chance to hide their (unrelated) log entries.
497 &$conds: Array of query conditions (all of which have to be met; conditions will
498 AND in the final query)
499 $logTypes: Array of log types being queried
501 'ArticleAfterFetchContent': After fetching content of an article from the
502 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
503 $article: the article (object) being loaded from the database
504 &$content: the content (string) of the article
506 'ArticleAfterFetchContentObject': After fetching content of an article from the
507 database.
508 $article: the article (object) being loaded from the database
509 &$content: the content of the article, as a Content object
511 'ArticleConfirmDelete': Before writing the confirmation form for article
512 deletion.
513 $article: the article (object) being deleted
514 $output: the OutputPage object
515 &$reason: the reason (string) the article is being deleted
517 'ArticleContentOnDiff': Before showing the article content below a diff. Use
518 this to change the content in this area or how it is loaded.
519 $diffEngine: the DifferenceEngine
520 $output: the OutputPage object
522 'ArticleDelete': Before an article is deleted.
523 $wikiPage: the WikiPage (object) being deleted
524 $user: the user (object) deleting the article
525 $reason: the reason (string) the article is being deleted
526 $error: if the deletion was prohibited, the (raw HTML) error message to display
527   (added in 1.13)
528 $status: Status object, modify this to throw an error. Overridden by $error
529   (added in 1.20)
531 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
532 $title: Title of the article that has been deleted.
533 $outputPage: OutputPage that can be used to append the output.
535 'ArticleDeleteComplete': After an article is deleted.
536 $wikiPage: the WikiPage that was deleted
537 $user: the user that deleted the article
538 $reason: the reason the article was deleted
539 $id: id of the article that was deleted
540 $content: the Content of the deleted page
541 $logEntry: the ManualLogEntry used to record the deletion
543 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
544 was changed.
545 &$wikiPage: WikiPage (object) of the user talk page
546 $recipient: User (object) who's talk page was edited
548 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
549 article has been changed.
550 $wikiPage: the WikiPage (object)
551 $editInfo: data holder that includes the parser output ($editInfo->output) for
552 that page after the change
553 $changed: bool for if the page was changed
555 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
556 recentchanges table, return false to not delete old entries.
557 $wikiPage: WikiPage (object) being modified
559 'ArticleFromTitle': when creating an article object from a title object using
560 Wiki::articleFromTitle().
561 $title: Title (object) used to create the article object
562 $article: Article (object) that will be returned
563 $context: IContextSource (object)
565 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
566 PageContentInsertComplete.
567 $wikiPage: WikiPage created
568 $user: User creating the article
569 $text: New content
570 $summary: Edit summary/comment
571 $isMinor: Whether or not the edit was marked as minor
572 $isWatch: (No longer used)
573 $section: (No longer used)
574 $flags: Flags passed to WikiPage::doEditContent()
575 $revision: New Revision of the article
577 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
578 $targetTitle: target title (object)
579 $destTitle: destination title (object)
581 'ArticlePageDataAfter': After loading data of an article from the database.
582 $wikiPage: WikiPage (object) whose data were loaded
583 $row: row (object) returned from the database server
585 'ArticlePageDataBefore': Before loading data of an article from the database.
586 $wikiPage: WikiPage (object) that data will be loaded
587 $fields: fields (array) to load from the database
589 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
590 $wikiPage: the WikiPage being saved
591 $popts: parser options to be used for pre-save transformation
593 'ArticleProtect': Before an article is protected.
594 $wikiPage: the WikiPage being protected
595 $user: the user doing the protection
596 $protect: boolean whether this is a protect or an unprotect
597 $reason: Reason for protect
598 $moveonly: boolean whether this is for move only or not
600 'ArticleProtectComplete': After an article is protected.
601 $wikiPage: the WikiPage that was protected
602 $user: the user who did the protection
603 $protect: boolean whether it was a protect or an unprotect
604 $reason: Reason for protect
605 $moveonly: boolean whether it was for move only or not
607 'ArticlePurge': Before executing "&action=purge".
608 $wikiPage: WikiPage (object) to purge
610 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
611 revisions of an article.
612 &$title: Title object of the article
614 'ArticleRevisionUndeleted': After an article revision is restored.
615 $title: the article title
616 $revision: the revision
617 $oldPageID: the page ID of the revision when archived (may be null)
619 'ArticleRollbackComplete': After an article rollback is completed.
620 $wikiPage: the WikiPage that was edited
621 $user: the user who did the rollback
622 $revision: the revision the page was reverted back to
623 $current: the reverted revision
625 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
626 instead.
627 $wikiPage: the WikiPage (object) being saved
628 $user: the user (object) saving the article
629 $text: the new article text
630 $summary: the article summary (comment)
631 $isminor: minor flag
632 $iswatch: watch flag
633 $section: section #
635 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
636 PageContentSaveComplete instead.
637 $wikiPage: WikiPage modified
638 $user: User performing the modification
639 $text: New content
640 $summary: Edit summary/comment
641 $isMinor: Whether or not the edit was marked as minor
642 $isWatch: (No longer used)
643 $section: (No longer used)
644 $flags: Flags passed to WikiPage::doEditContent()
645 $revision: New Revision of the article
646 $status: Status object about to be returned by doEditContent()
647 $baseRevId: the rev ID (or false) this edit was based on
649 'ArticleUndelete': When one or more revisions of an article are restored.
650 $title: Title corresponding to the article restored
651 $create: Whether or not the restoration caused the page to be created (i.e. it
652   didn't exist before).
653 $comment: The comment associated with the undeletion.
654 $oldPageId: ID of page previously deleted (from archive table)
656 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
657 $pageArchive: the PageArchive object
658 &$logEntry: ManualLogEntry object
659 $user: User who is performing the log action
661 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
662 the user is redirected back to the page.
663 &$article: the article
664 &$sectionanchor: The section anchor link (e.g. "#overview" )
665 &$extraq: Extra query parameters which can be added via hooked functions
667 'ArticleViewFooter': After showing the footer section of an ordinary page view
668 $article: Article object
669 $patrolFooterShown: boolean whether patrol footer is shown
671 'ArticleViewHeader': Before the parser cache is about to be tried for article
672 viewing.
673 &$article: the article
674 &$pcache: whether to try the parser cache or not
675 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
676 object to both indicate that the output is done and what parser output was used.
678 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
679 redirect was followed.
680 $article: target article (object)
682 'ArticleViewCustom': Allows to output the text of the article in a different
683 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
684 that it is preferable to implement proper handing for a custom data type using
685 the ContentHandler facility.
686 $text: text of the page
687 $title: title of the page
688 $output: reference to $wgOut
690 'ArticleContentViewCustom': Allows to output the text of the article in a
691 different format than wikitext. Note that it is preferable to implement proper
692 handing for a custom data type using the ContentHandler facility.
693 $content: content of the page, as a Content object
694 $title: title of the page
695 $output: reference to $wgOut
697 'AuthPluginAutoCreate': Called when creating a local account for an user logged
698 in from an external authentication method.
699 $user: User object created locally
701 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
702 Gives a chance for an extension to set it programmatically to a variable class.
703 &$auth: the $wgAuth object, probably a stub
705 'AutopromoteCondition': Check autopromote condition for user.
706 $type: condition type
707 $args: arguments
708 $user: user
709 $result: result of checking autopromote condition
711 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
712 $table: table name
713 &$prefix: prefix
715 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
716 certain title are fetched.
717 $table: table name
718 $title: title of the page to which backlinks are sought
719 &$conds: query conditions
721 'BadImage': When checking against the bad image list. Change $bad and return
722 false to override. If an image is "bad", it is not rendered inline in wiki
723 pages or galleries in category pages.
724 $name: Image name being checked
725 &$bad: Whether or not the image is "bad"
727 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
728 custom HTML after the section. Any uses of the hook need to handle escaping.
729 $template BaseTemplate
730 $portlet: string portlet name
731 &$html: string
733 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
734 "noarticletext-nopermission" at Article::showMissingArticle().
735 $article: article object
737 'BeforeInitialize': Before anything is initialized in
738 MediaWiki::performRequest().
739 &$title: Title being used for request
740 $unused: null
741 &$output: OutputPage object
742 &$user: User
743 $request: WebRequest object
744 $mediaWiki: Mediawiki object
746 'BeforePageDisplay': Prior to outputting a page.
747 &$out: OutputPage object
748 &$skin: Skin object
750 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
751 override how the redirect is output by modifying, or by returning false, and
752 letting standard HTTP rendering take place.
753 ATTENTION: This hook is likely to be removed soon due to overall design of the system.
754 $context: IContextSource object
755 &$redirect: string URL, modifiable
757 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
758 override how the redirect is output by modifying, or by returning false and
759 taking over the output.
760 $out: OutputPage object
761 &$redirect: URL, modifiable
762 &$code: HTTP code (eg '301' or '302'), modifiable
764 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
765 $parser: Parser object
766 $nt: the image title
767 &$options: array of options to RepoGroup::findFile
768 &$descQuery: query string to add to thumbnail URL
770 FIXME: Where does the below sentence fit in?
771 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
773 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
774 $parser: Parser object
775 $title: title of the template
776 &$skip: skip this template and link it?
777 &$id: the id of the revision being parsed
779 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
780 &$parser: Parser object
781 &$ig: ImageGallery object
783 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
784 newly created user.
785 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
786   to a newly created user account.
787 &$injected_html: Any HTML to inject after the "logged in" message of a newly
788   created user account
790 'BitmapHandlerTransform': before a file is transformed, gives extension the
791 possibility to transform it themselves
792 $handler: BitmapHandler
793 $image: File
794 &$scalerParams: Array with scaler parameters
795 &$mto: null, set to a MediaTransformOutput
797 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
798 normalizations have been performed, except for the $wgMaxImageArea check.
799 $image: File
800 &$params: Array of parameters
801 &$checkImageAreaHookResult: null, set to true or false to override the
802   $wgMaxImageArea check result.
804 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
805 to a user.
806 $block: Block object (which is set to be autoblocking)
807 &$blockIds: Array of block IDs of the autoblock
809 'BlockIp': Before an IP address or user is blocked.
810 $block: the Block object about to be saved
811 $user: the user _doing_ the block (not the one being blocked)
812 &$reason: if the hook is aborted, the error message to be returned in an array
814 'BlockIpComplete': After an IP address or user is blocked.
815 $block: the Block object that was saved
816 $user: the user who did the block (not the one being blocked)
818 'BookInformation': Before information output on Special:Booksources.
819 $isbn: ISBN to show information for
820 $output: OutputPage object in use
822 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
823 to be able to access the wiki via HTTPS.
824 $ip: The IP address in human-readable form
825 &$canDo: This reference should be set to false if the client may not be able
826 to use HTTPS
828 'CanonicalNamespaces': For extensions adding their own namespaces or altering
829 the defaults.
830 Note that if you need to specify namespace protection or content model for
831 a namespace that is added in a CanonicalNamespaces hook handler, you
832 should do so by altering $wgNamespaceProtection and
833 $wgNamespaceContentModels outside the handler, in top-level scope. The
834 point at which the CanonicalNamespaces hook fires is too late for altering
835 these variables. This applies even if the namespace addition is
836 conditional; it is permissible to declare a content model and protection
837 for a namespace and then decline to actually register it.
838 &$namespaces: Array of namespace numbers with corresponding canonical names
840 'CategoryAfterPageAdded': After a page is added to a category.
841 $category: Category that page was added to
842 $wikiPage: WikiPage that was added
844 'CategoryAfterPageRemoved': After a page is removed from a category.
845 $category: Category that page was removed from
846 $wikiPage: WikiPage that was removed
848 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
849 $catpage: CategoryPage instance
851 'ChangePasswordForm': For extensions that need to add a field to the
852 ChangePassword form via the Preferences form.
853 &$extraFields: An array of arrays that hold fields like would be passed to the
854   pretty function.
856 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
857 &$changesList: ChangesList instance.
858 &$articlelink: HTML of link to article (already filled-in).
859 &$s: HTML of row that is being constructed.
860 &$rc: RecentChange instance.
861 $unpatrolled: Whether or not we are showing unpatrolled changes.
862 $watched: Whether or not the change is watched by the user.
864 'ChangesListInitRows': Batch process change list rows prior to rendering.
865 $changesList: ChangesList instance
866 $rows: The data that will be rendered. May be a ResultWrapper instance or
867   an array.
869 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
870 $special: ChangesListSpecialPage instance
871 &$filters: associative array of filter definitions. The keys are the HTML
872   name/URL parameters. Each key maps to an associative array with a 'msg'
873   (message key) and a 'default' value.
875 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
876 $name: name of the special page, e.g. 'Watchlist'
877 &$tables: array of tables to be queried
878 &$fields: array of columns to select
879 &$conds: array of WHERE conditionals for query
880 &$query_options: array of options for the database request
881 &$join_conds: join conditions for the tables
882 $opts: FormOptions for this request
884 'LoginUserMigrated': Called during login to allow extensions the opportunity to
885 inform a user that their username doesn't exist for a specific reason, instead
886 of letting the login form give the generic error message that the account does
887 not exist. For example, when the account has been renamed or deleted.
888 $user: the User object being authenticated against.
889 &$msg: the message identifier for abort reason, or an array to pass a message
890   key and parameters.
892 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
893 $collationName: Name of the collation in question
894 &$collationObject: Null. Replace with a subclass of the Collation class that
895   implements the collation given in $collationName.
897 'ConfirmEmailComplete': Called after a user's email has been confirmed
898 successfully.
899 $user: user (object) whose email is being confirmed
901 'ContentHandlerDefaultModelFor': Called when the default content model is determined
902 for a given title. May be used to assign a different model for that title.
903 $title: the Title in question
904 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
906 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
907 content model name, but no entry for that model exists in $wgContentHandlers.
908 $modeName: the requested content model name
909 &$handler: set this to a ContentHandler object, if desired.
911 'ContentModelCanBeUsedOn': Called to determine whether that content model can
912 be used on a given page. This is especially useful to prevent some content models
913 to be used in some special location.
914 $contentModel: ID of the content model in question
915 $title: the Title in question.
916 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
917 Handler functions that modify $ok should generally return false to prevent further
918 hooks from further modifying $ok.
920 'ContentGetParserOutput': Customize parser output for a given content object,
921 called by AbstractContent::getParserOutput. May be used to override the normal
922 model-specific rendering of page content.
923 $content: The Content to render
924 $title: Title of the page, as context
925 $revId: The revision ID, as context
926 $options: ParserOptions for rendering. To avoid confusing the parser cache,
927 the output can only depend on parameters provided to this hook function, not on global state.
928 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
929 generation of HTML may be skipped, but other information should still be present in the
930 ParserOutput object.
931 &$output: ParserOutput, to manipulate or replace
933 'ContentAlterParserOutput': Modify parser output for a given content object.
934 Called by Content::getParserOutput after parsing has finished. Can be used
935 for changes that depend on the result of the parsing but have to be done
936 before LinksUpdate is called (such as adding tracking categories based on
937 the rendered HTML).
938 $content: The Content to render
939 $title: Title of the page, as context
940 $parserOutput: ParserOutput to manipulate
942 'ConvertContent': Called by AbstractContent::convert when a conversion to another
943 content model is requested.
944 $content: The Content object to be converted.
945 $toModel: The ID of the content model to convert to.
946 $lossy:   boolean indicating whether lossy conversion is allowed.
947 &$result: Output parameter, in case the handler function wants to provide a
948 converted Content object. Note that $result->getContentModel() must return $toModel.
949 Handler functions that modify $result should generally return false to further
950 attempts at conversion.
952 'ContribsPager::getQueryInfo': Before the contributions query is about to run
953 &$pager: Pager object for contributions
954 &$queryInfo: The query for the contribs Pager
956 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
957 &$data: an array of results of all contribs queries
958 $pager: The ContribsPager object hooked into
959 $offset: Index offset, inclusive
960 $limit: Exact query limit
961 $descending: Query direction, false for ascending, true for descending
963 'ContributionsLineEnding': Called before a contributions HTML line is finished
964 $page: SpecialPage object for contributions
965 &$ret: the HTML line
966 $row: the DB row for this line
967 &$classes: the classes to add to the surrounding <li>
969 'ContributionsToolLinks': Change tool links above Special:Contributions
970 $id: User identifier
971 $title: User page title
972 &$tools: Array of tool links
974 'CustomEditor': When invoking the page editor
975 $article: Article being edited
976 $user: User performing the edit
978 Return true to allow the normal editor to be used, or false
979 if implementing a custom editor, e.g. for a special namespace,
980 etc.
982 'DatabaseOraclePostInit': Called after initialising an Oracle database
983 &$db: the DatabaseOracle object
985 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
986 $title: the diff page title (nullable)
987 &$oldId: the actual old Id to use in the diff
988 &$newId: the actual new Id to use in the diff (0 means current)
989 $old: the ?old= param value from the url
990 $new: the ?new= param value from the url
992 'DiffRevisionTools': Override or extend the revision tools available from the
993 diff view, i.e. undo, etc.
994 $newRev: Revision object of the "new" revision
995 &$links: Array of HTML links
996 $oldRev: Revision object of the "old" revision (may be null)
998 'DiffViewHeader': Called before diff display
999 $diff: DifferenceEngine object that's calling
1000 $oldRev: Revision object of the "old" revision (may be null/invalid)
1001 $newRev: Revision object of the "new" revision
1003 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1004 an article
1005 $article: article (object) being viewed
1006 $oldid: oldid (int) being viewed
1008 'DoEditSectionLink': Override the HTML generated for section edit links
1009 $skin: Skin object rendering the UI
1010 $title: Title object for the title being linked to (may not be the same as
1011   the page title, if the section is included from a template)
1012 $section: The designation of the section being pointed to, to be included in
1013   the link, like "&section=$section"
1014 $tooltip: The default tooltip.  Escape before using.
1015   By default, this is wrapped in the 'editsectionhint' message.
1016 &$result: The HTML to return, prefilled with the default plus whatever other
1017   changes earlier hooks have made
1018 $lang: The language code to use for the link in the wfMessage function
1020 'EditFilter': Perform checks on an edit
1021 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1022 $text: Contents of the edit box
1023 $section: Section being edited
1024 &$error: Error message to return
1025 $summary: Edit summary for page
1027 'EditFilterMerged': Post-section-merge edit filter.
1028 DEPRECATED, use EditFilterMergedContent instead.
1029 $editor: EditPage instance (object)
1030 $text: content of the edit box
1031 &$error: error message to return
1032 $summary: Edit summary for page
1034 'EditFilterMergedContent': Post-section-merge edit filter.
1035 This may be triggered by the EditPage or any other facility that modifies page content.
1036 Use the $status object to indicate whether the edit should be allowed, and to provide
1037 a reason for disallowing it. Return false to abort the edit, and true to continue.
1038 Returning true if $status->isOK() returns false means "don't save but continue user
1039 interaction", e.g. show the edit form.
1040 $context: object implementing the IContextSource interface.
1041 $content: content of the edit box, as a Content object.
1042 $status: Status object to represent errors, etc.
1043 $summary: Edit summary for page
1044 $user: the User object representing the user whois performing the edit.
1045 $minoredit: whether the edit was marked as minor by the user.
1047 'EditFormPreloadText': Allows population of the edit form when creating
1048 new pages
1049 &$text: Text to preload with
1050 &$title: Title object representing the page being created
1052 'EditFormInitialText': Allows modifying the edit form when editing existing
1053 pages
1054 $editPage: EditPage     object
1056 'EditPage::attemptSave': Called before an article is
1057 saved, that is before WikiPage::doEditContent() is called
1058 $editpage_Obj: the current EditPage object
1060 'EditPage::importFormData': allow extensions to read additional data
1061 posted in the form
1062 $editpage: EditPage instance
1063 $request: Webrequest
1064 return value is ignored (should always return true)
1066 'EditPage::showEditForm:fields': allows injection of form field into edit form
1067 $editor: the EditPage instance for reference
1068 $out: an OutputPage instance to write to
1069 return value is ignored (should always return true)
1071 'EditPage::showEditForm:initial': before showing the edit form
1072 $editor: EditPage instance (object)
1073 $out: an OutputPage instance to write to
1075 Return false to halt editing; you'll need to handle error messages, etc.
1076 yourself. Alternatively, modifying $error and returning true will cause the
1077 contents of $error to be echoed at the top of the edit form as wikitext.
1078 Return true without altering $error to allow the edit to proceed.
1080 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1081 but for the read-only 'view source' variant of the edit form.
1082 $editor: EditPage instance (object)
1083 &$out: an OutputPage instance to write to
1084 return value is ignored (should always return true)
1086 'EditPage::showStandardInputs:options': allows injection of form fields into
1087 the editOptions area
1088 $editor: EditPage instance (object)
1089 $out: an OutputPage instance to write to
1090 &$tabindex: HTML tabindex of the last edit check/button
1091 return value is ignored (should always be true)
1093 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1094 when there's an edit conflict.  Return false to halt normal diff output; in
1095 this case you're responsible for computing and outputting the entire "conflict"
1096 part, i.e., the "difference between revisions" and "your text" headers and
1097 sections.
1098 &$editor: EditPage instance
1099 &$out: OutputPage instance
1101 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1102 textarea in the edit form.
1103 &$editpage: The current EditPage object
1104 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1105 &$tabindex: HTML tabindex of the last edit check/button
1107 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1108 in the edit form.
1109 &$editpage: The current EditPage object
1110 &$checks: Array of edit checks like "watch this page"/"minor edit"
1111 &$tabindex: HTML tabindex of the last edit check/button
1113 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1114 textarea in the edit form.
1115 &$toolbar: The toolbar HTMl
1117 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1118 contribution/copyright notice.
1119 $title: title of page being edited
1120 &$msg: localization message name, overridable. Default is either
1121   'copyrightwarning' or 'copyrightwarning2'.
1123 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1124 modifying the wikitext that will be used in "Show changes". Note that it is
1125 preferable to implement diff handling for different data types using the
1126 ContentHandler facility.
1127 $editPage: EditPage object
1128 &$newtext: wikitext that will be used as "your version"
1130 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1131 "Show changes". Note that it is preferable to implement diff handling for
1132 different data types using the ContentHandler facility.
1133 $editPage: EditPage object
1134 &$newtext: wikitext that will be used as "your version"
1136 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1137 Allow modifying the wikitext that will be previewed. Note that it is preferable
1138 to implement previews for different data types using the ContentHandler
1139 facility.
1140 $editPage: EditPage object
1141 &$toparse: wikitext that will be parsed
1143 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1144 previewed. Note that it is preferable to implement previews for different data
1145 types using the ContentHandler facility.
1146 $editPage: EditPage object
1147 &$content: Content object to be previewed (may be replaced by hook function)
1149 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1150 &$editpage: The current EditPage object
1151 &$res: the HTML of the error text
1153 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1154 of terms of service summary link that might exist separately from the copyright
1155 notice.
1156 $title: title of page being edited
1157 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1159 'EmailConfirmed': When checking that the user's email address is "confirmed".
1160 $user: User being checked
1161 $confirmed: Whether or not the email address is confirmed
1162 This runs before the other checks, such as anonymity and the real check; return
1163 true to allow those checks to occur, and false if checking is done.
1165 'EmailUser': Before sending email from one user to another.
1166 $to: address of receiving user
1167 $from: address of sending user
1168 $subject: subject of the mail
1169 $text: text of the mail
1171 'EmailUserCC': Before sending the copy of the email to the author.
1172 $to: address of receiving user
1173 $from: address of sending user
1174 $subject: subject of the mail
1175 $text: text of the mail
1177 'EmailUserComplete': After sending email from one user to another.
1178 $to: address of receiving user
1179 $from: address of sending user
1180 $subject: subject of the mail
1181 $text: text of the mail
1183 'EmailUserForm': After building the email user form object.
1184 $form: HTMLForm object
1186 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1187 user.
1188 $user: The user who is trying to email another user.
1189 $editToken: The user's edit token.
1190 &$hookErr: Out-param for the error. Passed as the parameters to
1191   OutputPage::showErrorPage.
1193 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1194 throttle.
1195 $ip: The ip address of the user
1197 'ExtensionTypes': Called when generating the extensions credits, use this to
1198 change the tables headers.
1199 &$extTypes: associative array of extensions types
1201 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1202 thumbnail file name.
1203 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1204 $thumbname: the base name of the thumbnail file
1205 &$params: the currently extracted params (has source name, temp or archived zone)
1207 'FetchChangesList': When fetching the ChangesList derivative for a particular
1208 user.
1209 $user: User the list is being fetched for
1210 &$skin: Skin object to be used with the list
1211 &$list: List object (defaults to NULL, change it to an object instance and
1212   return false override the list derivative used)
1214 'FileDeleteComplete': When a file is deleted.
1215 $file: reference to the deleted file
1216 $oldimage: in case of the deletion of an old image, the name of the old file
1217 $article: in case all revisions of the file are deleted a reference to the
1218   WikiFilePage associated with the file.
1219 $user: user who performed the deletion
1220 $reason: reason
1222 'FileTransformed': When a file is transformed and moved into storage.
1223 $file: reference to the File object
1224 $thumb: the MediaTransformOutput object
1225 $tmpThumbPath: The temporary file system path of the transformed file
1226 $thumbPath: The permanent storage path of the transformed file
1228 'FileUpload': When a file upload occurs.
1229 $file : Image object representing the file that was uploaded
1230 $reupload : Boolean indicating if there was a previously another image there or
1231   not (since 1.17)
1232 $hasDescription : Boolean indicating that there was already a description page
1233   and a new one from the comment wasn't created (since 1.17)
1235 'FileUndeleteComplete': When a file is undeleted
1236 $title: title object to the file
1237 $fileVersions: array of undeleted versions. Empty if all versions were restored
1238 $user: user who performed the undeletion
1239 $reason: reason
1241 'FormatAutocomments': When an autocomment is formatted by the Linker.
1242  &$comment: Reference to the accumulated comment. Initially null, when set the
1243    default code will be skipped.
1244  $pre: Initial part of the parsed comment before the call to the hook.
1245  $auto: The extracted part of the parsed comment before the call to the hook.
1246  $post: The final part of the parsed comment before the call to the hook.
1247  $title: An optional title object used to links to sections. Can be null.
1248  $local: Boolean indicating whether section links should refer to local page.
1250 'GalleryGetModes': Get list of classes that can render different modes of a
1251  gallery
1252 $modeArray: An associative array mapping mode names to classes that implement
1253  that mode. It is expected all registered classes are a subclass of
1254  ImageGalleryBase.
1256 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1257 entitled to be in.
1258 &$user: user to promote.
1259 &$promote: groups that will be added.
1261 'GetBlockedStatus': after loading blocking status of an user from the database
1262 $user: user (object) being checked
1264 'GetCacheVaryCookies': Get cookies that should vary cache options.
1265 $out: OutputPage object
1266 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1267   that have to vary cache options
1269 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1270 notifications.
1271 $title: Title object of page
1272 $url: string value as output (out parameter, can modify)
1273 $query: query options passed to Title::getCanonicalURL()
1275 'GetDefaultSortkey': Override the default sortkey for a page.
1276 $title: Title object that we need to get a sortkey for
1277 &$sortkey: Sortkey to use.
1279 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1280 underscore) magic words. Called by MagicWord.
1281 &$doubleUnderscoreIDs: array of strings
1283 'GetExtendedMetadata': Get extended file metadata for the API
1284 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1285 'value' => prop value, 'source' => 'name of hook' ).
1286 $file: File object of file in question
1287 $context: RequestContext (including language to use)
1288 $single: Only extract the current language; if false, the prop value should
1289 be in the metadata multi-language array format:
1290 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1291 &$maxCacheTime: how long the results can be cached
1293 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1294 $title: Title object of page
1295 $url: string value as output (out parameter, can modify)
1296 $query: query options passed to Title::getFullURL()
1298 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1299 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1300 output.
1301 &$output: string for the output timestamp
1302 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1303 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1304 $user: User whose preferences are being used to make timestamp
1305 $lang: Language that will be used to render the timestamp
1307 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1308 $title: Title object of page
1309 $url: string value as output (out parameter, can modify)
1310 $query: query options passed to Title::getInternalURL()
1312 'GetIP': modify the ip of the current user (called only once).
1313 &$ip: string holding the ip as determined so far
1315 'GetLinkColours': modify the CSS class of an array of page links.
1316 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1317         indexed by page_id.
1318 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1320 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1321 working with internal urls (non-interwiki) then it may be preferable to work
1322 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1323 be buggy for internal urls on render if you do not re-implement the horrible
1324 hack that Title::getLocalURL uses in your own extension.
1325 $title: Title object of page
1326 &$url: string value as output (out parameter, can modify)
1327 $query: query options passed to Title::getLocalURL()
1329 'GetLocalURL::Internal': Modify local URLs to internal pages.
1330 $title: Title object of page
1331 &$url: string value as output (out parameter, can modify)
1332 $query: query options passed to Title::getLocalURL()
1334 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1335 without any fancy queries or variants.
1336 $title: Title object of page
1337 &$url: string value as output (out parameter, can modify)
1339 'GetLogTypesOnUser': Add log types where the target is a userpage
1340 &$types: Array of log types
1342 'GetMetadataVersion': Modify the image metadata version currently in use. This
1343 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1344 that need to have versioned metadata should add an element to the end of the
1345 version array of the form 'handler_name=version'. Most media handlers won't need
1346 to do this unless they broke backwards compatibility with a previous version of
1347 the media handler metadata output.
1348 &$version: Array of version strings
1350 'GetNewMessagesAlert': Disable or modify the new messages alert
1351 &$newMessagesAlert: An empty string by default. If the user has new talk page
1352 messages, this should be populated with an alert message to that effect
1353 $newtalks: An empty array if the user has no new messages or an array containing
1354 links and revisions if there are new messages (See User::getNewMessageLinks)
1355 $user: The user object of the user who is loading the page
1356 $out: OutputPage object (to check what type of page the user is on)
1358 'GetPreferences': Modify user preferences.
1359 $user: User whose preferences are being modified.
1360 &$preferences: Preferences description array, to be fed to an HTMLForm object
1362 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1363 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1364 output.
1365 &$output: string for the output timestamp
1366 &$diff: DateInterval representing the difference between the timestamps
1367 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1368 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1369 $user: User whose preferences are being used to make timestamp
1370 $lang: Language that will be used to render the timestamp
1372 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1373 checked for. Use instead of userCan for most cases. Return false if the user
1374 can't do it, and populate $result with the reason in the form of
1375 array( messagename, param1, param2, ... ). For consistency, error messages
1376 should be plain text with no special coloring, bolding, etc. to show that
1377 they're errors; presenting them properly to the user as errors is done by the
1378 caller.
1379 $title: Title object being checked against
1380 $user : Current user object
1381 $action: Action being checked
1382 $result: User permissions error to add. If none, return true.
1384 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1385 called only if expensive checks are enabled. Add a permissions error when
1386 permissions errors are checked for. Return false if the user can't do it, and
1387 populate $result with the reason in the form of array( messagename, param1,
1388 param2, ... ). For consistency, error messages should be plain text with no
1389 special coloring, bolding, etc. to show that they're errors; presenting them
1390 properly to the user as errors is done by the caller.
1392 $title: Title object being checked against
1393 $user : Current user object
1394 $action: Action being checked
1395 $result: User permissions error to add. If none, return true.
1397 'GitViewers': Called when generating the list of git viewers for
1398 Special:Version, use this to change the list.
1399 &$extTypes: associative array of repo URLS to viewer URLs.
1401 'HistoryRevisionTools': Override or extend the revision tools available from the
1402 page history view, i.e. undo, rollback, etc.
1403 $rev: Revision object
1404 &$links: Array of HTML links
1406 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1407 cache.
1408 $context: An IContextSource object with information about the request being served.
1410 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1411 image insertion. You can skip the default logic entirely by returning false, or
1412 just modify a few things using call-by-reference.
1413 &$skin: Skin object
1414 &$title: Title object of the image
1415 &$file: File object, or false if it doesn't exist
1416 &$frameParams: Various parameters with special meanings; see documentation in
1417   includes/Linker.php for Linker::makeImageLink
1418 &$handlerParams: Various parameters with special meanings; see documentation in
1419   includes/Linker.php for Linker::makeImageLink
1420 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1421 &$res: Final HTML output, used if you return false
1424 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1425 the image on an image page.
1426 $imagePage: ImagePage object ($this)
1427 $output: $wgOut
1429 'ImagePageAfterImageLinks': Called after the image links section on an image
1430 page is built.
1431 $imagePage: ImagePage object ($this)
1432 &$html: HTML for the hook to add
1434 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1435 $file: the file
1436 $line: the HTML of the history line
1437 $css: the line CSS class
1439 'ImagePageFindFile': Called when fetching the file associated with an image
1440 page.
1441 $page: ImagePage object
1442 &$file: File object
1443 &$displayFile: displayed File object
1445 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1446 $page: ImagePage object
1447 &$toc: Array of <li> strings
1449 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1450 using img_auth.php.
1451 &$title: the Title object of the file as it would appear for the upload page
1452 &$path: the original file and path name when img_auth was invoked by the the web
1453   server
1454 &$name: the name only component of the file
1455 &$result: The location to pass back results of the hook routine (only used if
1456   failed)
1457   $result[0]=The index of the header message
1458   $result[1]=The index of the body text message
1459   $result[2 through n]=Parameters passed to body text message. Please note the
1460   header message cannot receive/use parameters.
1462 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1463 $reader: XMLReader object
1464 $logInfo: Array of information
1465 Return false to stop further processing of the tag
1467 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1468 $reader: XMLReader object
1469 $pageInfo: Array of information
1470 Return false to stop further processing of the tag
1472 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1473 $reader: XMLReader object
1474 $pageInfo: Array of page information
1475 $revisionInfo: Array of revision information
1476 Return false to stop further processing of the tag
1478 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1479 $reader: XMLReader object
1480 Return false to stop further processing of the tag
1482 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1483 $reader: XMLReader object
1484 $revisionInfo: Array of information
1485 Return false to stop further processing of the tag
1487 'InfoAction': When building information to display on the action=info page.
1488 $context: IContextSource object
1489 &$pageInfo: Array of information
1491 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1492 $title: Title object for the current page
1493 $request: WebRequest
1494 $ignoreRedirect: boolean to skip redirect check
1495 $target: Title/string of redirect target
1496 $article: Article object
1498 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1499 Return true without providing an interwiki to continue interwiki search.
1500 $prefix: interwiki prefix we are looking for.
1501 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1502   iw_trans and optionally iw_api and iw_wikiid.
1504 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1505 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1506 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1507 template/parser function execution which respect nowiki and HTML-comments.
1508 &$parser: Parser object
1509 &$text: string containing partially parsed text
1510 &$stripState: Parser's internal StripState object
1512 'InternalParseBeforeLinks': during Parser's internalParse method before links
1513 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1514 &$parser: Parser object
1515 &$text: string containing partially parsed text
1516 &$stripState: Parser's internal StripState object
1518 'InvalidateEmailComplete': Called after a user's email has been invalidated
1519 successfully.
1520 $user: user (object) whose email is being invalidated
1522 'IRCLineURL': When constructing the URL to use in an IRC notification.
1523 Callee may modify $url and $query, URL will be constructed as $url . $query
1524 &$url: URL to index.php
1525 &$query: Query string
1526 $rc: RecentChange object that triggered url generation
1528 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1529 $article: article (object) being checked
1531 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1532 $ip: IP being check
1533 $result: Change this value to override the result of wfIsTrustedProxy()
1535 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1536 $url: URL used to upload from
1537 &$allowed: Boolean indicating if uploading is allowed for given URL
1539 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1540 instance to return false if the domain name doesn't match your organization.
1541 $addr: The e-mail address entered by the user
1542 &$result: Set this and return false to override the internal checks
1544 'isValidPassword': Override the result of User::isValidPassword()
1545 $password: The password entered by the user
1546 &$result: Set this and return false to override the internal checks
1547 $user: User the password is being validated for
1549 'Language::getMessagesFileName':
1550 $code: The language code or the language we're looking for a messages file for
1551 &$file: The messages file path, you can override this to change the location.
1553 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1554 remove namespaces. Do not use this hook to add namespaces. Use
1555 CanonicalNamespaces for that.
1556 &$namespaces: Array of namespaces indexed by their numbers
1558 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1559 $wgExtensionMessagesFiles instead.
1560 Use this to define synonyms of magic words depending of the language
1561 $magicExtensions: associative array of magic words synonyms
1562 $lang: language code (string)
1564 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1565 listed in $wgExtensionMessagesFiles instead.
1566 Use to define aliases of special pages names depending of the language
1567 $specialPageAliases: associative array of magic words synonyms
1568 $lang: language code (string)
1570 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1571 &$names: array of language code => language name
1572 $code language of the preferred translations
1574 'LanguageLinks': Manipulate a page's language links. This is called
1575 in various places to allow extensions to define the effective language
1576 links for a page.
1577 $title: The page's Title.
1578 &$links: Associative array mapping language codes to prefixed links of the
1579   form "language:title".
1580 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1581   Currently unused, but planned to provide support for marking individual
1582   language links in the UI, e.g. for featured articles.
1584 'LanguageSelector': Hook to change the language selector available on a page.
1585 $out: The output page.
1586 $cssClassName: CSS class name of the language selector.
1588 'LinkBegin': Used when generating internal and interwiki links in
1589 Linker::link(), before processing starts.  Return false to skip default
1590 processing and return $ret. See documentation for Linker::link() for details on
1591 the expected meanings of parameters.
1592 $skin: the Skin object
1593 $target: the Title that the link is pointing to
1594 &$html: the contents that the <a> tag should have (raw HTML); null means
1595   "default".
1596 &$customAttribs: the HTML attributes that the <a> tag should have, in
1597 associative array form, with keys and values unescaped.  Should be merged with
1598 default values, with a value of false meaning to suppress the attribute.
1599 &$query: the query string to add to the generated URL (the bit after the "?"),
1600   in associative array form, with keys and values unescaped.
1601 &$options: array of options.  Can include 'known', 'broken', 'noclasses'.
1602 &$ret: the value to return if your hook returns false.
1604 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1605 just before the function returns a value.  If you return true, an <a> element
1606 with HTML attributes $attribs and contents $html will be returned.  If you
1607 return false, $ret will be returned.
1608 $skin: the Skin object
1609 $target: the Title object that the link is pointing to
1610 $options: the options.  Will always include either 'known' or 'broken', and may
1611   include 'noclasses'.
1612 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1613 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1614   associative array form.
1615 &$ret: the value to return if your hook returns false.
1617 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1618 before the return.
1619 &$url: the image url
1620 &$alt: the image's alt text
1621 &$img: the new image HTML (if returning false)
1623 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1624 before the return.
1625 &$url: the link url
1626 &$text: the link text
1627 &$link: the new link HTML (if returning false)
1628 &$attribs: the attributes to be applied.
1629 $linkType: The external link type
1631 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1632 before the return.
1633 $title: the Title object that the link is pointing to
1634 $file: the File object or false if broken link
1635 &$html: the link text
1636 &$attribs: the attributes to be applied
1637 &$ret: the value to return if your hook returns false
1639 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1640 actual update.
1641 &$linksUpdate: the LinksUpdate object
1643 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1644 each link table insert.  For example, pagelinks, imagelinks, externallinks.
1645 $linksUpdate: LinksUpdate object
1646 $table: the table to insert links to
1647 $insertions: an array of links to insert
1649 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1650 including delete and insert, has completed for all link tables
1651 &$linksUpdate: the LinksUpdate object
1653 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1654 &$linksUpdate: the LinksUpdate object
1656 'ListDefinedTags': When trying to find all defined tags.
1657 &$tags: The list of tags.
1659 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1660 &updater: A DatabaseUpdater subclass
1662 'LocalFile::getHistory': Called before file history query performed.
1663 $file: the File object
1664 $tables: tables
1665 $fields: select fields
1666 $conds: conditions
1667 $opts: query options
1668 $join_conds: JOIN conditions
1670 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1671 $file: the File object
1672 $archiveName: name of an old file version or false if it's the current one
1674 'LocalisationCacheRecache': Called when loading the localisation data into
1675 cache.
1676 $cache: The LocalisationCache object
1677 $code: language code
1678 &$alldata: The localisation data from core and extensions
1679 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1681 'LocalisationCacheRecacheFallback': Called for each language when merging
1682 fallback data into the cache.
1683 $cache: The LocalisationCache object
1684 $code: language code
1685 &$alldata: The localisation data from core and extensions. Note some keys may
1686   be omitted if they won't be merged into the final result.
1688 'LocalisationChecksBlacklist': When fetching the blacklist of
1689 localisation checks.
1690 &$blacklist: array of checks to blacklist. See the bottom of
1691   maintenance/language/checkLanguage.inc for the format of this variable.
1693 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1694 optional localisation messages
1695 &$ignored Array of ignored message keys
1696 &$optional Array of optional message keys
1698 'LogEventsListGetExtraInputs': When getting extra inputs to display on Special:Log
1699 for a specific log type
1700 $type: String of log type being displayed
1701 $logEventsList: LogEventsList object for context and access to the WebRequest
1702 &$input: string HTML of an input element
1705 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1706 Returning false will prevent the string from being added to the OutputPage.
1707 &$s: html string to show for the log extract
1708 $types: String or Array Log types to show
1709 $page: String or Title The page title to show log entries for
1710 $user: String The user who made the log entries
1711 $param: Associative Array with the following additional options:
1712   - lim Integer Limit of items to show, default is 50
1713   - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1714   - showIfEmpty boolean Set to false if you don't want any output in case the
1715     loglist is empty if set to true (default), "No matching items in log" is
1716     displayed if loglist is empty
1717   - msgKey Array If you want a nice box with a message, set this to the key of
1718     the message. First element is the message key, additional optional elements
1719     are parameters for the key that are processed with
1720     wfMessage()->params()->parseAsBlock()
1721   - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1722     offset
1723   - wrap String Wrap the message in html (usually something like
1724     "&lt;div ...>$1&lt;/div>").
1725   - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1727 'LoginAuthenticateAudit': A login attempt for a valid user account either
1728 succeeded or failed. No return data is accepted; this hook is for auditing only.
1729 $user: the User object being authenticated against
1730 $password: the password being submitted and found wanting
1731 $retval: a LoginForm class constant with authenticateUserData() return
1732   value (SUCCESS, WRONG_PASS, etc.).
1734 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1735 Use this hook to change the Message that will be output on Special:ChangePassword.
1736 &$msg: Message object that will be shown to the user
1737 $username: Username of the user who's password was expired.
1739 'LogLine': Processes a single log entry on Special:Log.
1740 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1741   logging.log_type database field.
1742 $log_action: string for the type of log action (e.g. 'delete', 'block',
1743   'create2'). Corresponds to logging.log_action database field.
1744 $title: Title object that corresponds to logging.log_namespace and
1745   logging.log_title database fields.
1746 $paramArray: Array of parameters that corresponds to logging.log_params field.
1747   Note that only $paramArray[0] appears to contain anything.
1748 &$comment: string that corresponds to logging.log_comment database field, and
1749   which is displayed in the UI.
1750 &$revert: string that is displayed in the UI, similar to $comment.
1751 $time: timestamp of the log entry (added in 1.12)
1753 'LonelyPagesQuery': Allow extensions to modify the query used by
1754 Special:LonelyPages.
1755 &$tables: tables to join in the query
1756 &$conds: conditions for the query
1757 &$joinConds: join conditions for the query
1759 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1760 script.
1761 $refreshLinks: RefreshLinks object
1763 'MagicWordwgVariableIDs': When defining new magic words IDs.
1764 $variableIDs: array of strings
1766 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1767 Ideally, this hook should only be used to add variables that depend on
1768 the current page/request; static configuration should be added through
1769 ResourceLoaderGetConfigVars instead.
1770 &$vars: variable (or multiple variables) to be added into the output of
1771   Skin::makeVariablesScript
1772 $out: The OutputPage which called the hook, can be used to get the real title.
1774 'MarkPatrolled': Before an edit is marked patrolled.
1775 $rcid: ID of the revision to be marked patrolled
1776 $user: the user (object) marking the revision as patrolled
1777 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1778   sysop in order to mark an edit patrolled.
1780 'MarkPatrolledComplete': After an edit is marked patrolled.
1781 $rcid: ID of the revision marked as patrolled
1782 $user: user (object) who marked the edit patrolled
1783 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1784   sysop to patrol the edit.
1786 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1787 something completely different, after the basic globals have been set up, but
1788 before ordinary actions take place.
1789 $output: $wgOut
1790 $article: Article on which the action will be performed
1791 $title: Title on which the action will be performed
1792 $user: $wgUser
1793 $request: $wgRequest
1794 $mediaWiki: The $mediawiki object
1796 'MessagesPreLoad': When loading a message from the database.
1797 $title: title of the message (string)
1798 $message: value (string), change it to the message you want to define
1800 'MessageCache::get': When fetching a message. Can be used to override the key
1801 for customisations. Given and returned message key must be in special format:
1802 1) first letter must be in lower case according to the content language.
1803 2) spaces must be replaced with underscores
1804 &$key: message key (string)
1806 'MessageCacheReplace': When a message page is changed. Useful for updating
1807 caches.
1808 $title: name of the page changed.
1809 $text: new contents of the page.
1811 'MimeMagicInit': Before processing the list mapping MIME types to media types
1812 and the list mapping MIME types to file extensions.
1813 As an extension author, you are encouraged to submit patches to MediaWiki's
1814 core to add new MIME types to mime.types.
1815 $mimeMagic: Instance of MimeMagic.
1816   Use $mimeMagic->addExtraInfo( $stringOfInfo );
1817   for adding new MIME info to the list.
1818   Use $mimeMagic->addExtraTypes( $stringOfTypes );
1819   for adding new MIME types to the list.
1821 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1822 MIME type detected by considering the file extension.
1823 $mimeMagic: Instance of MimeMagic.
1824 $ext: File extension.
1825 &$mime: MIME type (in/out).
1827 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1828 $mimeMagic: Instance of MimeMagic.
1829 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1830 &$tail: More or equal than last 65558 bytes of the file in a string
1831   (in - Do not alter!).
1832 $file: File path.
1833 &$mime: MIME type (out).
1835 'ModifyExportQuery': Modify the query used by the exporter.
1836 $db: The database object to be queried.
1837 &$tables: Tables in the query.
1838 &$conds: Conditions in the query.
1839 &$opts: Options for the query.
1840 &$join_conds: Join conditions for the query.
1842 'MovePageCheckPermissions': Specify whether the user is allowed to move the page.
1843 $oldTitle: Title object of the current (old) location
1844 $newTitle: Title object of the new location
1845 $user: User making the move
1846 $reason: string of the reason provided by the user
1847 $status: Status object to pass error messages to
1849 'MovePageIsValidMove': Specify whether a page can be moved for technical reasons.
1850 $oldTitle: Title object of the current (old) location
1851 $newTitle: Title object of the new location
1852 $status: Status object to pass error messages to
1854 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1855 and returning it for the skin to output. You can add items to the toolbox while
1856 still letting the skin make final decisions on skin-specific markup conventions
1857 using this hook.
1858 &$sk: The BaseTemplate base skin template
1859 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1860   BaseTemplate::makeListItem for details on the format of individual items
1861   inside of this array.
1863 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1864 namespace.
1865 $index: Integer; the index of the namespace being checked.
1866 $result: Boolean; whether MediaWiki currently thinks that pages in this
1867   namespace are movable. Hooks may change this value to override the return
1868   value of MWNamespace::isMovable().
1870 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1871 edit.
1872 $wikiPage: the WikiPage edited
1873 $rev: the new revision
1874 $baseID: the revision ID this was based off, if any
1875 $user: the editing user
1877 'NormalizeMessageKey': Called before the software gets the text of a message
1878 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1879 displayed.
1880 &$key: the message being looked up. Change this to something else to change
1881   what message gets displayed (string)
1882 &$useDB: whether or not to look up the message in the database (bool)
1883 &$langCode: the language code to get the message for (string) - or -
1884   whether to use the content language (true) or site language (false) (bool)
1885 &$transform: whether or not to expand variables and templates
1886   in the message (bool)
1888 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1889 return false to omit the line from RecentChanges and Watchlist special pages.
1890 &$changeslist: The OldChangesList instance.
1891 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1892 &$rc: The RecentChange object.
1893 &$classes: array of css classes for the <li> element
1895 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1896 can alter or append to the array of URLs for search & suggestion formats.
1897 &$urls: array of associative arrays with Url element attributes
1899 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1900 users and/or IP addresses too.
1901 $otherBlockLink: An array with links to other block logs
1902 $ip: The requested IP address or username
1904 'OutputPageBeforeHTML': A page has been processed by the parser and the
1905 resulting HTML is about to be displayed.
1906 $parserOutput: the parserOutput (object) that corresponds to the page
1907 $text: the text that will be displayed, in HTML (string)
1909 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1910 body tag to allow for extensions to add attributes to the body of the page they
1911 might need. Or to allow building extensions to add body classes that aren't of
1912 high enough demand to be included in core.
1913 $out: The OutputPage which called the hook, can be used to get the real title
1914 $sk: The Skin that called OutputPage::headElement
1915 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1917 'OutputPageCheckLastModified': when checking if the page has been modified
1918 since the last visit.
1919 &$modifiedTimes: array of timestamps.
1920         The following keys are set: page, user, epoch
1922 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1923 $out: OutputPage instance (object)
1924 $parserOutput: parserOutput instance being added in $out
1926 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1927 categories. Implementations should return false if they generate the category
1928 links, so the default link generation is skipped.
1929 $out: OutputPage instance (object)
1930 $categories: associative array, keys are category names, values are category
1931   types ("normal" or "hidden")
1932 $links: array, intended to hold the result. Must be an associative array with
1933   category types as keys and arrays of HTML links as values.
1935 'PageContentInsertComplete': After a new article is created.
1936 $wikiPage: WikiPage created
1937 $user: User creating the article
1938 $content: New content as a Content object
1939 $summary: Edit summary/comment
1940 $isMinor: Whether or not the edit was marked as minor
1941 $isWatch: (No longer used)
1942 $section: (No longer used)
1943 $flags: Flags passed to WikiPage::doEditContent()
1944 $revision: New Revision of the article
1946 'PageContentLanguage': Allows changing the language in which the content of a
1947 page is written. Defaults to the wiki content language ($wgContLang).
1948 $title: Title object
1949 &$pageLang: the page content language (either an object or a language code)
1950 $wgLang: the user language
1952 'PageContentSave': Before an article is saved.
1953 $wikiPage: the WikiPage (object) being saved
1954 $user: the user (object) saving the article
1955 $content: the new article content, as a Content object
1956 $summary: the article summary (comment)
1957 $isminor: minor flag
1958 $iswatch: watch flag
1959 $section: section #
1961 'PageContentSaveComplete': After an article has been updated.
1962 $wikiPage: WikiPage modified
1963 $user: User performing the modification
1964 $content: New content, as a Content object
1965 $summary: Edit summary/comment
1966 $isMinor: Whether or not the edit was marked as minor
1967 $isWatch: (No longer used)
1968 $section: (No longer used)
1969 $flags: Flags passed to WikiPage::doEditContent()
1970 $revision: New Revision of the article (can be null for edits that change nothing)
1971 $status: Status object about to be returned by doEditContent()
1972 $baseRevId: the rev ID (or false) this edit was based on
1974 'PageHistoryBeforeList': When a history page list is about to be constructed.
1975 $article: the article that the history is loading for
1976 $context: RequestContext object
1978 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1979 $row: the revision row for this line
1980 $s: the string representing this parsed line
1981 $classes: array containing the <li> element classes
1983 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1984 constructed.
1985 $pager: the pager
1986 $queryInfo: the query parameters
1988 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1989 which depends on user options should install this hook and append its values to
1990 the key.
1991 &$confstr: reference to a hash key string which can be modified
1992 $user: User (object) requesting the page
1994 'ParserAfterParse': Called from Parser::parse() just after the call to
1995 Parser::internalParse() returns.
1996 $parser: parser object
1997 $text: text being parsed
1998 $stripState: stripState used (object)
2000 'ParserAfterStrip': Called at end of parsing time.
2001 TODO: No more strip, deprecated ?
2002 $parser: parser object
2003 $text: text being parsed
2004 $stripState: stripState used (object)
2006 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2007 $parser: Parser object being used
2008 $text: text that will be returned
2010 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2011 $parser: Parser object
2012 $text: text to parse
2013 $stripState: StripState instance being used
2015 'ParserBeforeStrip': Called at start of parsing time.
2016 TODO: No more strip, deprecated ?
2017 $parser: parser object
2018 $text: text being parsed
2019 $stripState: stripState used (object)
2021 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2022 $parser: Parser object being used
2023 $text: actual text
2025 'ParserClearState': Called at the end of Parser::clearState().
2026 $parser: Parser object being cleared
2028 'ParserCloned': Called when the parser is cloned.
2029 $parser: Newly-cloned Parser object
2031 'ParserFirstCallInit': Called when the parser initialises for the first time.
2032 &$parser: Parser object being cleared
2034 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2035 custom magic word
2036 $parser: Parser object
2037 $varCache: array to store the value in case of multiples calls of the
2038         same magic word
2039 $index: index (string) of the magic
2040 $ret: value of the magic word (the hook should set it)
2041 $frame: PPFrame object to use for expanding any template variables
2043 'ParserGetVariableValueTs': Use this to change the value of the time for the
2044 {{LOCAL...}} magic word.
2045 $parser: Parser object
2046 $time: actual time (timestamp)
2048 'ParserGetVariableValueVarCache': use this to change the value of the variable
2049 cache or return false to not use it.
2050 $parser: Parser object
2051 $varCache: variable cache (array)
2053 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
2054 ParserLimitReportFormat instead.
2055 Called at the end of Parser:parse() when the parser will
2056 include comments about size of the text parsed.
2057 $parser: Parser object
2058 &$limitReport: text that will be included (without comment tags)
2060 'ParserLimitReportFormat': Called for each row in the parser limit report that
2061 needs formatting. If nothing handles this hook, the default is to use "$key" to
2062 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2063 format the value.
2064 $key: Key for the limit report item (string)
2065 &$value: Value of the limit report item
2066 &$report: String onto which to append the data
2067 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2068         text intended for display in a monospaced font.
2069 $localize: If false, $report should be output in English.
2071 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2072 include comments about size of the text parsed. Hooks should use
2073 $output->setLimitReportData() to populate data. Functions for this hook should
2074 not use $wgLang; do that in ParserLimitReportFormat instead.
2075 $parser: Parser object
2076 $output: ParserOutput object
2078 'ParserMakeImageParams': Called before the parser make an image link, use this
2079 to modify the parameters of the image.
2080 $title: title object representing the file
2081 $file: file object that will be used to create the image
2082 &$params: 2-D array of parameters
2083 $parser: Parser object that called the hook
2085 'ParserSectionCreate': Called each time the parser creates a document section
2086 from wikitext. Use this to apply per-section modifications to HTML (like
2087 wrapping the section in a DIV).  Caveat: DIVs are valid wikitext, and a DIV
2088 can begin in one section and end in another. Make sure your code can handle
2089 that case gracefully. See the EditSectionClearerLink extension for an example.
2090 $parser: the calling Parser instance
2091 $section: the section number, zero-based, but section 0 is usually empty
2092 &$sectionContent: ref to the content of the section. modify this.
2093 $showEditLinks: boolean describing whether this section has an edit link
2095 'ParserTestParser': Called when creating a new instance of Parser in
2096 tests/parser/parserTest.inc.
2097 $parser: Parser object created
2099 'ParserTestGlobals': Allows to define globals for parser tests.
2100 &$globals: Array with all the globals which should be set for parser tests.
2101   The arrays keys serve as the globals names, its values are the globals values.
2103 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2104 run. Use when page save hooks require the presence of custom tables to ensure
2105 that tests continue to run properly.
2106 &$tables: array of table names
2108 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2109 my talk page, my contributions" etc).
2110 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2111 &$title: Title object representing the current page
2112 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2114 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2115 &$user : User performing the action
2116 $action : Action being performed
2117 &$result : Whether or not the action should be prevented
2118 Change $result and return false to give a definitive answer, otherwise
2119 the built-in rate limiting checks are used, if enabled.
2120 $incrBy: Amount to increment counter by
2122 'PlaceNewSection': Override placement of new sections. Return false and put the
2123 merged text into $text to override the default behavior.
2124 $wikipage : WikiPage object
2125 $oldtext : the text of the article before editing
2126 $subject : subject of the new section
2127 &$text : text of the new section
2129 'PostLoginRedirect': Modify the post login redirect behavior.
2130 Occurs after signing up or logging in, allows for interception of redirect.
2131 &$returnTo: The page name to return to, as a string
2132 &$returnToQuery: array of url parameters, mapping parameter names to values
2133 &$type: type of login redirect as string;
2134   error: display a return to link ignoring $wgRedirectOnLogin
2135   signup: display a return to link using $wgRedirectOnLogin if needed
2136   success: display a return to link using $wgRedirectOnLogin if needed
2137   successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2139 'PreferencesGetLegend': Override the text used for the <legend> of a
2140 preferences section.
2141 $form: the PreferencesForm object. This is a ContextSource as well
2142 $key: the section name
2143 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2145 'PreferencesFormPreSave': Override preferences being saved
2146  $formData: array of user submitted data
2147  $form: PreferencesForm object, also a ContextSource
2148  $user: User object with preferences to be saved set
2149  &$result: boolean indicating success
2151 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2152 AJAX search suggestions. Put results into &$results outparam and return false.
2153 $ns : array of int namespace keys to search in
2154 $search : search term (not guaranteed to be conveniently normalized)
2155 $limit : maximum number of results to return
2156 &$results : out param: array of page names (strings)
2158 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2159 namespace from the search string so that extensions can attempt it.
2160 $namespaces : array of int namespace keys to search in (change this if you can
2161 extract namespaces)
2162 $search : search term (replace this with term without the namespace if you can
2163 extract one)
2165 'PrefsEmailAudit': Called when user changes their email address.
2166 $user: User (object) changing his email address
2167 $oldaddr: old email address (string)
2168 $newaddr: new email address (string)
2170 'PrefsPasswordAudit': Called when user changes his password.
2171 $user: User (object) changing his password
2172 $newPass: new password
2173 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2175 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2176 in the form.
2177 $article: the title being (un)protected
2178 $output: a string of the form HTML so far
2180 'ProtectionForm::save': Called when a protection form is submitted.
2181 $article: the Page being (un)protected
2182 &$errorMsg: an html message string of an error or an array of message name and
2183   its parameters
2184 $reasonstr: a string describing the reason page protection level is altered
2186 'ProtectionForm::showLogExtract': Called after the protection log extract is
2187 shown.
2188 $article: the page the form is shown for
2189 $out: OutputPage object
2191 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2192 &$obj: RawAction object
2193 &$text: The text that's going to be the output
2195 'RecentChange_save': Called at the end of RecentChange::save().
2196 $recentChange: RecentChange object
2198 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2199 names such as "oldid" that are preserved when using redirecting special pages
2200 such as Special:MyPage and Special:MyTalk.
2201 &$redirectParams: An array of parameters preserved by redirecting special pages.
2203 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2204 instance. Can be used by an extension override what skin is used in certain
2205 contexts.
2206 IContextSource $context: The RequestContext the skin is being created for.
2207 &$skin: A variable reference you may set a Skin instance or string key on to
2208   override the skin that will be used for the context.
2210 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2211 $user: The user having their password expiration reset
2212 &$newExpire: The new expiration date
2214 'ResetSessionID': Called from wfResetSessionID
2215 $oldSessionID: old session id
2216 $newSessionID: new session id
2218 'ResourceLoaderGetConfigVars': Called at the end of
2219 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2220 configuration variables to JavaScript. Things that depend on the current page
2221 or request state must be added through MakeGlobalVariablesScript instead.
2222 &$vars: array( variable name => value )
2224 'ResourceLoaderRegisterModules': Right before modules information is required,
2225 such as when responding to a resource
2226 loader request or generating HTML output.
2227 &$resourceLoader: ResourceLoader object
2229 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2230 called after the addition of 'qunit' and MediaWiki testing resources.
2231 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2232   included in core, is fed using tests/qunit/QUnitTestResources.php.
2233 &ResourceLoader object
2235 To add a new qunit module named 'myext.tests':
2236 testModules['qunit']['myext.tests'] = array(
2237         'script' => 'extension/myext/tests.js',
2238         'dependencies' => <any module dependency you might have>
2240 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2241 added to any module.
2243 'RevisionInsertComplete': Called after a revision is inserted into the database.
2244 &$revision: the Revision
2245 $data: the data stored in old_text.  The meaning depends on $flags: if external
2246   is set, it's the URL of the revision text in external storage; otherwise,
2247   it's the revision text itself.  In either case, if gzip is set, the revision
2248   text is gzipped.
2249 $flags: a comma-delimited list of strings representing the options used.  May
2250   include: utf8 (this will always be set for new revisions); gzip; external.
2252 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2253 the normal operations.
2254 $allSearchTerms : Array of the search terms in all content languages
2255 &$titleResult : Outparam; the value to return. A Title object or null.
2257 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2258 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2259 runs after.
2260 $term : Search term string
2261 &$title : Outparam; set to $title object and return false for a match
2263 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2264 if nothing was found.
2265 $term : Search term string
2266 &$title : Outparam; set to $title object and return false for a match
2268 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2269 searches.
2270 $term : Search term string
2271 &$title : Current Title object that is being returned (null if none found).
2273 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2274 search results.
2275 $title : Current Title object being displayed in search results.
2276 &$id: Revision ID (default is false, for latest)
2278 'SearchableNamespaces': An option to modify which namespaces are searchable.
2279 &$arr : Array of namespaces ($nsId => $name) which will be used.
2281 'SelfLinkBegin': Called before a link to the current article is displayed to
2282 allow the display of the link to be customized.
2283 $nt: the Title object
2284 &$html: html to display for the link
2285 &$trail: optional text to display before $html
2286 &$prefix: optional text to display after $html
2287 &$ret: the value to return if your hook returns false
2289 'SetupAfterCache': Called in Setup.php, after cache objects are set
2291 'ShowMissingArticle': Called when generating the output for a non-existent page.
2292 $article: The article object corresponding to the page
2294 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2295 DEPRECATED, use the ContentGetParserOutput hook instead!
2296 $text: Text being shown
2297 $title: Title of the custom script/stylesheet page
2298 $output: Current OutputPage object
2300 'ShowSearchHitTitle': Customise display of search hit title/link.
2301 &$title: Title to link to
2302 &$text: Text to use for the link
2303 $result: The search result
2304 $terms: The search terms entered
2305 $page: The SpecialSearch object.
2307 'ShowSearchHit': Customize display of search hit.
2308 $searchPage: The SpecialSearch instance.
2309 $result: The SearchResult to show
2310 $terms: Search terms, for highlighting
2311 &$link: HTML of link to the matching page. May be modified.
2312 &$redirect: HTML of redirect info. May be modified.
2313 &$section: HTML of matching section. May be modified.
2314 &$extract: HTML of content extract. May be modified.
2315 &$score: HTML of score. May be modified.
2316 &$size: HTML of page size. May be modified.
2317 &$date: HTML of of page modification date. May be modified.
2318 &$related: HTML of additional info for the matching page. May be modified.
2319 &$html: May be set to the full HTML that should be used to represent the search
2320   hit. Must include the <li> ... </li> tags. Will only be used if the hook
2321   function returned false.
2323 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2324 allow the normal method of notice selection/rendering to work, or change the
2325 value of $siteNotice and return false to alter it.
2326 &$siteNotice: HTML returned as the sitenotice
2327 $skin: Skin object
2329 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2330 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2331   the sitenotice/anonnotice.
2332 $skin: Skin object
2334 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2335 $skin: Skin object
2336 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2337   the stock bottom scripts.
2339 'SkinAfterContent': Allows extensions to add text after the page content and
2340 article metadata. This hook should work in all skins. Set the &$data variable to
2341 the text you're going to add.
2342 &$data: (string) Text to be printed out directly (without parsing)
2343 $skin: Skin object
2345 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2346 $skin: Skin object
2347 &$bar: Sidebar contents
2348 Modify $bar to add or modify sidebar portlets.
2350 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2351 $skin Skin object
2352 &$bar: Sidebar content
2353 Modify $bar to add or modify sidebar portlets.
2354 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2356 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2357 copyright notice.
2358 $title: displayed page title
2359 $type: 'normal' or 'history' for old/diff views
2360 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2361   message must be in HTML format, not wikitext!
2362 &$link: overridable HTML link to be passed into the message as $1
2363 &$forContent: overridable flag if copyright footer is shown in content language.
2364   This parameter is deprecated.
2366 'SkinGetPoweredBy': TODO
2367 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2368 the MediaWiki icon but plain text instead.
2369 $skin: Skin object
2371 'SkinPreloadExistence': Supply titles that should be added to link existence
2372 cache before the page is rendered.
2373 &$titles: Array of Title objects
2374 $skin: Skin object
2376 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2377 &$subpages: Subpage links HTML
2378 $skin: Skin object
2379 $out: OutputPage object
2380 If false is returned $subpages will be used instead of the HTML
2381 subPageSubtitle() generates.
2382 If true is returned, $subpages will be ignored and the rest of
2383 subPageSubtitle() will run.
2385 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2386 link" tab.
2387 $sktemplate: SkinTemplate object
2388 $nav_urls: array of tabs
2390 'SkinTemplateGetLanguageLink': After building the data for a language link from
2391 which the actual html is constructed.
2392 &$languageLink: array containing data about the link. The following keys can be
2393   modified: href, text, title, class, lang, hreflang. Each of them is a string.
2394 $languageLinkTitle: Title object belonging to the external language link.
2395 $title: Title object of the page the link belongs to.
2396 $outputPage: The OutputPage object the links are built from.
2398 To alter the structured navigation links in SkinTemplates, there are three
2399 hooks called in different spots:
2401 'SkinTemplateNavigation': Called on content pages after the tabs have been
2402 added, but before variants have been added.
2403 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2404 tab is added but before variants have been added.
2405 'SkinTemplateNavigation::Universal': Called on both content and special pages
2406 after variants have been added.
2407 &$sktemplate: SkinTemplate object
2408 &$links: Structured navigation links. This is used to alter the navigation for
2409   skins which use buildNavigationUrls such as Vector.
2411 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2412 page output.
2413 &$sktemplate: SkinTemplate object
2414 &$tpl: Template engine object
2416 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2417 $sktemplate: SkinTemplate object
2418 $res: set to true to prevent active tabs
2420 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2421 You can either create your own array, or alter the parameters for
2422 the normal one.
2423 &$sktemplate: The SkinTemplate instance.
2424 $title: Title instance for the page.
2425 $message: Visible label of tab.
2426 $selected: Whether this is a selected tab.
2427 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2428 &$classes: Array of CSS classes to apply.
2429 &$query: Query string to add to link.
2430 &$text: Link text.
2431 &$result: Complete assoc. array if you want to return true.
2433 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2434 been rendered (useful for adding more).
2435 $sk: The QuickTemplate based skin template running the hook.
2436 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2437   extensions that add support for BaseTemplateToolbox should watch for this
2438   dummy parameter with "$dummy=false" in their code and return without echoing
2439   any HTML to avoid creating duplicate toolbox items.
2441 'SoftwareInfo': Called by Special:Version for returning information about the
2442 software.
2443 $software: The array of software in format 'name' => 'version'. See
2444   SpecialVersion::softwareInformation().
2446 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2447 $name: name of the special page
2448 &$form: HTMLForm object
2450 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2451 $sp: SpecialPage object, for context
2452 &$fields: Current HTMLForm fields
2454 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2455 $id: User id number, only provided for backwards-compatibility
2456 $user: User object representing user contributions are being fetched for
2457 $sp: SpecialPage instance, providing context
2459 'SpecialListusersDefaultQuery': Called right before the end of
2460 UsersPager::getDefaultQuery().
2461 $pager: The UsersPager instance
2462 $query: The query array to be returned
2464 'SpecialListusersFormatRow': Called right before the end of
2465 UsersPager::formatRow().
2466 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2467 $row: Database row object
2469 'SpecialListusersHeader': Called before closing the <fieldset> in
2470 UsersPager::getPageHeader().
2471 $pager: The UsersPager instance
2472 $out: The header HTML
2474 'SpecialListusersHeaderForm': Called before adding the submit button in
2475 UsersPager::getPageHeader().
2476 $pager: The UsersPager instance
2477 $out: The header HTML
2479 'SpecialListusersQueryInfo': Called right before the end of.
2480 UsersPager::getQueryInfo()
2481 $pager: The UsersPager instance
2482 $query: The query array to be returned
2484 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2485 $type: String of the log type
2486 $request: WebRequest object for getting the value provided by the current user
2487 &$qc: Array for query conditions to add
2489 'SpecialMovepageAfterMove': Called after moving a page.
2490 $movePage: MovePageForm object
2491 $oldTitle: old title (object)
2492 $newTitle: new title (object)
2494 'SpecialNewpagesConditions': Called when building sql query for
2495 Special:NewPages.
2496 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2497 $opts: FormOptions object containing special page options
2498 &$conds: array of WHERE conditionals for query
2499 &tables: array of tables to be queried
2500 &$fields: array of columns to select
2501 &$join_conds: join conditions for the tables
2503 'SpecialNewPagesFilters': Called after building form options at NewPages.
2504 $special: the special page object
2505 &$filters: associative array of filter definitions. The keys are the HTML
2506   name/URL parameters. Each key maps to an associative array with a 'msg'
2507   (message key) and a 'default' value.
2509 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2510 hook to remove a core special page.
2511 $list: list (array) of core special pages
2513 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2514 $special: the SpecialPage object
2515 $subPage: the subpage string or null if no subpage was specified
2517 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2518 $special: the SpecialPage object
2519 $subPage: the subpage string or null if no subpage was specified
2521 'SpecialPasswordResetOnSubmit': When executing a form submission on
2522 Special:PasswordReset.
2523 $users: array of User objects.
2524 $data: array of data submitted by the user
2525 &$error: string, error code (message key) used to describe to error (out
2526   parameter). The hook needs to return false when setting this, otherwise it
2527   will have no effect.
2529 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2530 use this to change some selection criteria or substitute a different title.
2531 &$randstr: The random number from wfRandom()
2532 &$isRedir: Boolean, whether to select a redirect or non-redirect
2533 &$namespaces: An array of namespace indexes to get the title from
2534 &$extra: An array of extra SQL statements
2535 &$title: If the hook returns false, a Title object to use instead of the
2536   result from the normal query
2538 'SpecialRecentChangesFilters': Called after building form options at
2539 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2540 $special: the special page object
2541 &$filters: associative array of filter definitions. The keys are the HTML
2542   name/URL parameters. Each key maps to an associative array with a 'msg'
2543   (message key) and a 'default' value.
2545 'SpecialRecentChangesPanel': Called when building form options in
2546 SpecialRecentChanges.
2547 &$extraOpts: array of added items, to which can be added
2548 $opts: FormOptions for this request
2550 'SpecialRecentChangesQuery': Called when building SQL query for
2551 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2552 ChangesListSpecialPageQuery instead.
2553 &$conds: array of WHERE conditionals for query
2554 &$tables: array of tables to be queried
2555 &$join_conds: join conditions for the tables
2556 $opts: FormOptions for this request
2557 &$query_options: array of options for the database request
2558 &$select: Array of columns to select
2560 'SpecialResetTokensTokens': Called when building token list for
2561 SpecialResetTokens.
2562 &$tokens: array of token information arrays in the format of
2563   array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2565 'SpecialSearchCreateLink': Called when making the message to create a page or
2566 go to the existing page.
2567 $t: title object searched for
2568 &$params: an array of the default message name and page title (as parameter)
2570 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2571 target doesn't exist.
2572 &$title: title object generated from the text entered by the user
2574 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2575 the advanced form, a.k.a. power search box.
2576 &$showSections: an array to add values with more options to
2577 $term: the search term (not a title object)
2578 $opts: an array of hidden options (containing 'redirs' and 'profile')
2580 'SpecialSearchProfiles': Allows modification of search profiles.
2581 &$profiles: profiles, which can be modified.
2583 'SpecialSearchProfileForm': Allows modification of search profile forms.
2584 $search: special page object
2585 &$form: String: form html
2586 $profile: String: current search profile
2587 $term: String: search term
2588 $opts: Array: key => value of hidden options for inclusion in custom forms
2590 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2591 $search: SpecialSearch special page object
2592 $profile: String: current search profile
2593 $engine: the search engine
2595 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2596 on the search results page.  Useful for including an external search
2597 provider.  To disable the output of MediaWiki search output, return
2598 false.
2599 $specialSearch: SpecialSearch object ($this)
2600 $output: $wgOut
2601 $term: Search term specified by the user
2603 'SpecialSearchResults': Called before search result display
2604 $term: string of search term
2605 &$titleMatches: empty or SearchResultSet object
2606 &$textMatches: empty or SearchResultSet object
2608 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2609 &$extraStats: Array to save the new stats
2610   ( $extraStats['<name of statistic>'] => <value>; )
2612 'SpecialUploadComplete': Called after successfully uploading a file from
2613 Special:Upload.
2614 $form: The SpecialUpload object
2616 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2617 $wgVersion: Current $wgVersion for you to use
2618 &$versionUrl: Raw url to link to (eg: release notes)
2620 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2621 Deprecated, use ChangesListSpecialPageFilters instead.
2622 $special: the special page object
2623 &$filters: associative array of filter definitions. The keys are the HTML
2624   name/URL parameters. Each key maps to an associative array with a 'msg'
2625   (message key) and a 'default' value.
2627 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2628 Deprecated, use ChangesListSpecialPageQuery instead.
2629 &$conds: array of WHERE conditionals for query
2630 &$tables: array of tables to be queried
2631 &$join_conds: join conditions for the tables
2632 &$fields: array of query fields
2633 $opts: A FormOptions object with watchlist options for the current request
2635 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2636 SpecialWatchlist. Allows extensions to register custom values they have
2637 inserted to rc_type so they can be returned as part of the watchlist.
2638 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2640 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2641 URL for a title when we have no other parameters on the URL. Gives a chance for
2642 extensions that alter page view behavior radically to abort that redirect or
2643 handle it manually.
2644 $request: WebRequest
2645 $title: Title of the currently found title obj
2646 $output: OutputPage object
2648 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2649 rendered (by ThumbnailImage:toHtml method).
2650 $thumbnail: the ThumbnailImage object
2651 &$attribs: image attribute array
2652 &$linkAttribs: image link attribute array
2654 'TitleArrayFromResult': Called when creating an TitleArray object from a
2655 database result.
2656 &$titleArray: set this to an object to override the default object returned
2657 $res: database result used to create the object
2659 'TitleExists': Called when determining whether a page exists at a given title.
2660 $title: The title being tested.
2661 &$exists: Whether the title exists.
2663 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2664 or override the quick permissions check.
2665 $title: The Title object being accessed
2666 $user: The User performing the action
2667 $action: Action being performed
2668 &$errors: Array of errors
2669 $doExpensiveQueries: Whether to do expensive DB queries
2670 $short: Whether to return immediately on first error
2672 'TitleGetEditNotices': Allows extensions to add edit notices
2673 $title: The Title object for the page the edit notices are for
2674 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2675 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2677 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2678 that can be applied.
2679 $title: The title in question.
2680 &$types: The types of protection available.
2682 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2683 $title: Title object that is being checked
2684 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2685   Hooks may change this value to override the return value of
2686   Title::isCssOrJsPage().
2688 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2689 overriding default behavior for determining if a page exists. If $isKnown is
2690 kept as null, regular checks happen. If it's a boolean, this value is returned
2691 by the isKnown method.
2692 $title: Title object that is being checked
2693 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2695 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2696 that this hook is not called for interwiki pages or pages in immovable
2697 namespaces: for these, isMovable() always returns false.
2698 $title: Title object that is being checked
2699 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2700   Hooks may change this value to override the return value of
2701   Title::isMovable().
2703 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2704 be handled by separate handler (via ArticleViewCustom).
2705 $title: Title object that is being checked
2706 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2707   Hooks may change this value to override the return value of
2708   Title::isWikitextPage()
2710 'TitleMove': Before moving an article (title).
2711 $old: old title
2712 $nt: new title
2713 $user: user who does the move
2715 'TitleMoveComplete': After moving an article (title).
2716 $old: old title
2717 $nt: new title
2718 $user: user who did the move
2719 $pageid: database ID of the page that's been moved
2720 $redirid: database ID of the created redirect
2721 $reason: reason for the move
2723 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2724 adding the default error message if nothing allows the user to read the page. If
2725 a handler wants a title to *not* be whitelisted, it should also return false.
2726 $title: Title object being checked against
2727 $user: Current user object
2728 &$whitelisted: Boolean value of whether this title is whitelisted
2730 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2731 $title: Title object to purge
2732 &$urls: An array of URLs to purge from the caches, to be manipulated.
2734 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2735 PageArchive object has been created but before any further processing is done.
2736 &$archive: PageArchive object
2737 $title: Title object of the page that we're viewing
2739 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2740 PageArchive object has been created but before any further processing is done.
2741 &$archive: PageArchive object
2742 $title: Title object of the page that we're viewing
2744 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2745 the site is not in read-only mode, that the Title object is not null and after
2746 a PageArchive object has been constructed but before performing any further
2747 processing.
2748 &$archive: PageArchive object
2749 $title: Title object of the page that we're about to undelete
2751 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2752 $title: title object related to the revision
2753 $rev: revision (object) that will be viewed
2755 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2756 actions).
2757 $action: action name
2758 $article: article "acted on"
2760 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
2761 Since 1.24: Paths pointing to a directory will be recursively scanned for
2762 test case files matching the suffix "Test.php".
2763 &$paths: list of test cases and directories to search.
2765 'UnwatchArticle': Before a watch is removed from an article.
2766 $user: user watching
2767 $page: WikiPage object to be removed
2768 &$status: Status object to be returned if the hook returns false
2770 'UnwatchArticleComplete': After a watch is removed from an article.
2771 $user: user that watched
2772 $page: WikiPage object that was watched
2774 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2775 $formattedPageStatus: list of valid page states
2777 'UploadForm:initial': Before the upload form is generated. You might set the
2778 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2779 text (HTML) either before or after the editform.
2780 $form: UploadForm object
2782 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2783 poke at member variables like $mUploadDescription before the file is saved. Do
2784 not use this hook to break upload processing. This will return the user to a
2785 blank form with no error message; use UploadVerification and UploadVerifyFile
2786 instead.
2787 $form: UploadForm object
2789 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2790 $type: (string) the requested upload type
2791 &$className: the class name of the Upload instance to be created
2793 'UploadComplete': when Upload completes an upload.
2794 &$upload: an UploadBase child instance
2796 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2797 assembled.
2798 $descriptor: (array) the HTMLForm descriptor
2800 'UploadFormSourceDescriptors': after the standard source inputs have been
2801 added to the descriptor
2802 $descriptor: (array) the HTMLForm descriptor
2804 'UploadVerification': Additional chances to reject an uploaded file. Consider
2805 using UploadVerifyFile instead.
2806 string $saveName: destination file name
2807 string $tempName: filesystem path to the temporary file for checks
2808 string &$error: output: message key for message to show if upload canceled by
2809   returning false. May also be an array, where the first element is the message
2810   key and the remaining elements are used as parameters to the message.
2812 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
2813 in most cases over UploadVerification.
2814 object $upload: an instance of UploadBase, with all info about the upload
2815 string $mime: The uploaded file's MIME type, as detected by MediaWiki. Handlers
2816   will typically only apply for specific MIME types.
2817 object &$error: output: true if the file is valid. Otherwise, an indexed array
2818   representing the problem with the file, where the first element is the message
2819   key and the remaining elements are used as parameters to the message.
2821 'UploadComplete': Upon completion of a file upload.
2822 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2823   $uploadBase->getLocalFile().
2825 'User::mailPasswordInternal': before creation and mailing of a user's new
2826 temporary password
2827 $user: the user who sent the message out
2828 $ip: IP of the user who sent the message out
2829 $u: the account whose new password will be set
2831 'UserAddGroup': Called when adding a group; return false to override
2832 stock group addition.
2833 $user: the user object that is to have a group added
2834 &$group: the group to add, can be modified
2836 'UserArrayFromResult': Called when creating an UserArray object from a database
2837 result.
2838 &$userArray: set this to an object to override the default object returned
2839 $res: database result used to create the object
2841 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2842 want to display an error message, try getUserPermissionsErrors.
2843 $title: Title object being checked against
2844 $user : Current user object
2845 $action: Action being checked
2846 $result: Pointer to result returned if hook returns false. If null is returned,
2847   userCan checks are continued by internal code.
2849 'UserCanSendEmail': To override User::canSendEmail() permission check.
2850 $user: User (object) whose permission is being checked
2851 &$canSend: bool set on input, can override on output
2853 'UserClearNewTalkNotification': Called when clearing the "You have new
2854 messages!" message, return false to not delete it.
2855 $user: User (object) that will clear the message
2856 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2858 'UserCreateForm': change to manipulate the login form
2859 $template: SimpleTemplate instance for the form
2861 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2862 $user: User to get groups for
2863 &$groups: Current effective groups
2865 'UserGetAllRights': After calculating a list of all available rights.
2866 &$rights: Array of rights, which may be added to.
2868 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2869 before returning the options to the caller. Warning: This hook is called for
2870 every call to User::getDefaultOptions(), which means it's potentially called
2871 dozens or hundreds of times. You may want to cache the results of non-trivial
2872 operations in your hook function for this reason.
2873 &$defaultOptions: Array of preference keys and their default values.
2875 'UserGetEmail': Called when getting an user email address.
2876 $user: User object
2877 &$email: email, change this to override local email
2879 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2880 email authentication.
2881 $user: User object
2882 &$timestamp: timestamp, change this to override local email authentication
2883   timestamp
2885 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2886 &$groups: List of implicit (automatically-assigned) groups
2888 'UserGetLanguageObject': Called when getting user's interface language object.
2889 $user: User object
2890 &$code: Language code that will be used to create the object
2891 $context: IContextSource object
2893 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2894 &$reservedUsernames: $wgReservedUsernames
2896 'UserGetRights': Called in User::getRights().
2897 $user: User to get rights for
2898 &$rights: Current rights
2900 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2901 specific block exemptions).
2902 $user: User in question
2903 $title: Title of the page in question
2904 &$blocked: Out-param, whether or not the user is blocked from that page.
2905 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2906   to edit their own user talk pages.
2908 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2909 &$user: User object
2910 $ip: User's IP address
2911 &$blocked: Whether the user is blocked, to be modified by the hook
2913 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2914 false if a UserGetRights hook might remove the named right.
2915 $right: The user right being checked
2917 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2918 environmental means; occurs after session is loaded.
2919 $user: user object being loaded
2921 'UserLoadDefaults': Called when loading a default user.
2922 $user: user object
2923 $name: user name
2925 'UserLoadFromDatabase': Called when loading a user from the database.
2926 $user: user object
2927 &$s: database query object
2929 'UserLoadFromSession': Called to authenticate users on external/environmental
2930 means; occurs before session is loaded.
2931 $user: user object being loaded
2932 &$result: set this to a boolean value to abort the normal authentication
2933   process
2935 'UserLoadOptions': When user options/preferences are being loaded from the
2936 database.
2937 $user: User object
2938 &$options: Options, can be modified.
2940 'UserLoginComplete': After a user has logged in.
2941 $user: the user object that was created on login
2942 $inject_html: Any HTML to inject after the "logged in" message.
2944 'UserLoginForm': change to manipulate the login form
2945 $template: SimpleTemplate instance for the form
2947 'UserLogout': Before a user logs out.
2948 $user: the user object that is about to be logged out
2950 'UserLogoutComplete': After a user has logged out.
2951 $user: the user object _after_ logout (won't have name, ID, etc.)
2952 $inject_html: Any HTML to inject after the "logged out" message.
2953 $oldName: name of the user before logout (string)
2955 'UserRemoveGroup': Called when removing a group; return false to override stock
2956 group removal.
2957 $user: the user object that is to have a group removed
2958 &$group: the group to be removed, can be modified
2960 'UserRights': After a user's group memberships are changed.
2961 $user  : User object that was changed
2962 $add   : Array of strings corresponding to groups added
2963 $remove: Array of strings corresponding to groups removed
2965 'UserRequiresHTTPS': Called to determine whether a user needs
2966 to be switched to HTTPS.
2967 $user: User in question.
2968 &$https: Boolean whether $user should be switched to HTTPS.
2970 'UserResetAllOptions': Called in User::resetOptions() when user preferences
2971 have been requested to be reset. This hook can be used to exclude certain
2972 options from being reset even when the user has requested all prefs to be reset,
2973 because certain options might be stored in the user_properties database table
2974 despite not being visible and editable via Special:Preferences.
2975 $user: the User (object) whose preferences are being reset
2976 &$newOptions: array of new (site default) preferences
2977 $options: array of the user's old preferences
2978 $resetKinds: array containing the kinds of preferences to reset
2980 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2981 message(s).
2982 $user: user retrieving new talks messages
2983 $talks: array of new talks page(s)
2985 'UserSaveSettings': Called when saving user settings.
2986 $user: User object
2988 'UserSaveOptions': Called just before saving user preferences/options.
2989 $user: User object
2990 &$options: Options, modifiable
2992 'UserSetCookies': Called when setting user cookies.
2993 $user: User object
2994 &$session: session array, will be added to $_SESSION
2995 &$cookies: cookies array mapping cookie name to its value
2997 'UserSetEmail': Called when changing user email address.
2998 $user: User object
2999 &$email: new email, change this to override new email address
3001 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3002 email authentication.
3003 $user: User object
3004 &$timestamp: new timestamp, change this to override local email
3005 authentication timestamp
3007 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3008 "Foobar (Talk | Contribs | Block)".
3009 $userId: User id of the current user
3010 $userText: User name of the current user
3011 &$items: Array of user tool links as HTML fragments
3013 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3014 FormatMetadata::getExtendedMeta (return false means cache will be
3015 invalidated and GetExtendedMetadata hook called again).
3016 $timestamp: The timestamp metadata was generated
3017 $file: The file the metadata is for
3019 'UserMailerChangeReturnPath': Called to generate a VERP return address
3020 when UserMailer sends an email, with a bounce handling extension.
3021 $to: Array of MailAddress objects for the recipients
3022 &$returnPath: The return address string
3024 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid error
3025 messages. Allows to add additional error messages (except messages already in
3026 LoginForm::$validErrorMessages).
3027 &$messages Already added messages (inclusive messages from LoginForm::$validErrorMessages)
3029 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3030 used to alter the SQL query which gets the list of wanted pages.
3031 &$wantedPages: WantedPagesPage object
3032 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3034 'WatchArticle': Before a watch is added to an article.
3035 $user: user that will watch
3036 $page: WikiPage object to be watched
3037 &$status: Status object to be returned if the hook returns false
3039 'WatchArticleComplete': After a watch is added to an article.
3040 $user: user that watched
3041 $page: WikiPage object watched
3043 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3044 form, used to manipulate the list of pages or preload data based on that list.
3045 &$watchlistInfo: array of watchlisted pages in
3046   [namespaceId => ['title1' => 1, 'title2' => 1]] format
3048 'WatchlistEditorBuildRemoveLine': when building remove lines in
3049 Special:Watchlist/edit.
3050 &$tools: array of extra links
3051 $title: Title object
3052 $redirect: whether the page is a redirect
3053 $skin: Skin object
3054 &$link: HTML link to title
3056 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3057 REQUEST_URI.
3058 $router: The PathRouter instance
3060 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3061 Return false to prevent setting of the cookie.
3062 &$name: Cookie name passed to WebResponse::setcookie()
3063 &$value: Cookie value passed to WebResponse::setcookie()
3064 &$expire: Cookie expiration, as for PHP's setcookie()
3065 $options: Options passed to WebResponse::setcookie()
3067 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3068 $row: The DB row of the entry.
3069 $title: The Title of the page where the link comes FROM
3070 $target: The Title of the page where the link goes TO
3071 &$props: Array of HTML strings to display after the title.
3073 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3074 dumps. One, and only one hook should set this, and return false.
3075 &$tables: Database tables to use in the SELECT query
3076 &$opts: Options to use for the query
3077 &$join: Join conditions
3079 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3080 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3081 specific to a content model should be provided by the respective Content's
3082 getDeletionUpdates() method.
3083 $page: the WikiPage
3084 $content: the Content to generate updates for
3085 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3087 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3088 run a MediaWiki cli script.
3089 &$script: MediaWiki cli script path
3090 &$parameters: Array of arguments and options to the script
3091 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3092   keys
3094 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3095 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3096 $qp: The list of QueryPages
3098 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3099 extra metadata to be added.
3100 $obj: The XmlDumpWriter object.
3101 &$out: The output string.
3102 $row: The database row for the page.
3103 $title: The title of the page.
3105 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3106 add extra metadata.
3107 $obj: The XmlDumpWriter object.
3108 &$out: The text being output.
3109 $row: The database row for the revision.
3110 $text: The revision text.
3112 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3113 to add additional tags to extract.
3114 &$items: Array containing information on which items to extract. See XMPInfo for
3115   details on the format.
3117 'XMPGetResults': Called just before returning the results array of parsing xmp
3118 data. Can be used to post-process the results.
3119 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3120   is an array of metadata tags returned (each tag is either a value, or an array
3121   of values).
3123 More hooks might be available but undocumented, you can execute
3124 "php maintenance/findHooks.php" to find hidden ones.