Merge "Add ss_active_users in SiteStats::isSane"
[mediawiki.git] / docs / hooks.txt
bloba6fa9fed764f5b6037f5d3ca79a42844fb17217b
1 hooks.txt
3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
6 ==Glossary==
8 event
9      Something that happens with the wiki. For example: a user logs in. A wiki
10      page is saved. A wiki page is deleted. Often there are two events
11      associated with a single action: one before the code is run to make the
12      event happen, and one after. Each event has a name, preferably in
13      CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
14      'ArticleDelete'.
16 hook
17      A clump of code and data that should be run when an event happens. This can
18      be either a function and a chunk of data, or an object and a method.
20 hook function
21      The function part of a hook.
23 ==Rationale==
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37         function showAnArticle($article) {
38                 global $wgReverseTitle, $wgCapitalizeTitle;
40                 if ($wgReverseTitle) {
41                         wfReverseTitle($article);
42                 }
44                 if ($wgCapitalizeTitle) {
45                         wfCapitalizeTitle($article);
46                 }
48                 # code to actually show the article goes here
49         }
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55     function showAnArticle($article) {
56         global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58                 if ($wgReverseTitle) {
59                         wfReverseTitle($article);
60                 }
62                 if ($wgCapitalizeTitle) {
63                         wfCapitalizeTitle($article);
64                 }
66                 # code to actually show the article goes here
68                 if ($wgNotifyArticle) {
69                         wfNotifyArticleShow($article));
70                 }
71         }
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76         function showAnArticle($article) {
78                 if (wfRunHooks('ArticleShow', array(&$article))) {
80                         # code to actually show the article goes here
82                         wfRunHooks('ArticleShowComplete', array(&$article));
83                 }
84         }
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
94 file:
96         function reverseArticleTitle($article) {
97                 # ...
98         }
100         function reverseForExport($article) {
101                 # ...
102         }
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
107         setupTitleReversingExtension() {
108                 global $wgHooks;
110                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112                 $wgHooks['ArticleExport'][] = 'reverseForExport';
113         }
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123         require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
126 just leave it out.
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
131 ==Writing hooks==
133 A hook is a chunk of code run at some particular event. It consists of:
135   * a function with some optional accompanying data, or
136   * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141         $wgHooks['EventName'][] = 'someFunction'; # function, no data
142         $wgHooks['EventName'][] = array('someFunction', $someData);
143         $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145         $wgHooks['EventName'][] = $object; # object only
146         $wgHooks['EventName'][] = array($object, 'someMethod');
147         $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148         $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
154         # function, no data
155         someFunction($param1, $param2)
156         # function with data
157         someFunction($someData, $param1, $param2)
159         # object only
160         $object->onEventName($param1, $param2)
161         # object with method
162         $object->someMethod($param1, $param2)
163         # object with method and data
164         $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181   * true: the hook has operated successfully
182   * "some string": an error occurred; processing should stop and the error
183                    should be shown to the user
184   * false: the hook has successfully done the work necessary and the calling
185            function should skip
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191         $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193         function ldapLogin($username, $password) {
194                 # log user into LDAP
195                 return false;
196         }
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
205 ==Using hooks==
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
210         class Article {
211                 # ...
212                 function protect() {
213                         global $wgUser;
214                         if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215                                 # protect the article
216                                 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217                         }
218                 }
219         }
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
230 MediaWiki 1.4rc1.
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation,
238 where normally authentication against an external auth plugin would be creating
239 a local account.
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
254 'AbortLogin': Return false to cancel account login.
255 $user: the User object being authenticated against
256 $password: the password being submitted, not yet checked for validity
257 &$retval: a LoginForm class constant to return from authenticateUserData();
258           default is LoginForm::ABORTED. Note that the client may be using
259           a machine API rather than the HTML user interface.
260 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
262 'AbortMove': Allows to abort moving an article (title).
263 $old: old title
264 $nt: new title
265 $user: user who is doing the move
266 $err: error message
267 $reason: the reason for the move (added in 1.13)
269 'AbortNewAccount': Return false to cancel explicit account creation.
270 $user: the User object about to be created (read-only, incomplete)
271 &$msg: out parameter: HTML to display on abort
273 'AbortChangePassword': Return false to cancel password change.
274 $user: the User object to which the password change is occuring
275 $mOldpass: the old password provided by the user
276 $newpass: the new password provided by the user
277 &$abortMsg: the message identifier for abort reason
279 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
280 $name: name of the action
281 &$form: HTMLForm object
282 $article: Article object
284 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
285 Allows to change the fields on the form that will be generated.
286 $name: name of the action
287 &$fields: HTMLForm descriptor array
288 $article: Article object
290 'AddNewAccount': After a user account is created.
291 $user: the User object that was created. (Parameter added in 1.7)
292 $byEmail: true when account was created "by email" (added in 1.12)
294 'AfterFinalPageOutput': At the end of OutputPage::output() but before final
295 ob_end_flush() which will send the buffered output to the client. This allows
296 for last-minute modification of the output within the buffer by using
297 ob_get_clean().
298 &$output: OutputPage object
300 'AfterImportPage': When a page import is completed.
301 $title: Title under which the revisions were imported
302 $origTitle: Title provided by the XML file
303 $revCount: Number of revisions in the XML file
304 $sRevCount: Number of successfully imported revisions
305 $pageInfo: associative array of page information
307 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
308 before OutputPage::sendCacheControl() and final ob_end_flush() which
309 will send the buffered output to the client. This allows for last-minute
310 modification of the output within the buffer by using ob_get_clean().
311 $output: The OutputPage object where output() was called
313 'AjaxAddScript': Called in output page just before the initialisation
314 of the javascript ajax engine. The hook is only called when ajax
315 is enabled ( $wgUseAjax = true; ).
316 &$output: OutputPage object
318 'AlternateEdit': Before checking if a user can edit a page and before showing
319 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
320 $editPage: the EditPage object
322 'AlternateEditPreview': Before generating the preview of the page when editing
323 ( EditPage::getPreviewText() ).
324 $editPage: the EditPage object
325 &$content: the Content object for the text field from the edit page
326 &$previewHTML: Text to be placed into the page for the preview
327 &$parserOutput: the ParserOutput object for the preview
328 return false and set $previewHTML and $parserOutput to output custom page
329 preview HTML.
331 'AlternateUserMailer': Called before mail is sent so that mail could be logged
332 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
333 the regular method of sending mail.  Return a string to return a php-mail-error
334 message containing the error. Returning true will continue with sending email
335 in the regular way.
336 $headers: Associative array of headers for the email
337 $to: MailAddress object or array
338 $from: From address
339 $subject: Subject of the email
340 $body: Body of the message
342 'APIAfterExecute': After calling the execute() method of an API module. Use
343 this to extend core API modules.
344 &$module: Module object
346 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
347 authenticate and authorize API clients before executing the module. Return
348 false and set a message to cancel the request.
349 $module: Module object
350 $user: Current user
351 &$message: API usage message to die with, as a message key or array
352 as accepted by ApiBase::dieUsageMsg.
354 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
355 processing request parameters. Return false to let the request fail, returning
356 an error message or an <edit result="Failure"> tag if $resultArr was filled.
357 $editPage : the EditPage object
358 $text : the new text of the article (has yet to be saved)
359 &$resultArr : data in this array will be added to the API result
361 'APIGetAllowedParams': Use this hook to modify a module's parameters.
362 &$module: ApiBase Module object
363 &$params: Array of parameters
364 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
366 'APIGetDescription': Use this hook to modify a module's description.
367 &$module: ApiBase Module object
368 &$desc: Array of descriptions
370 'APIGetParamDescription': Use this hook to modify a module's parameter
371 descriptions.
372 &$module: ApiBase Module object
373 &$desc: Array of parameter descriptions
375 'APIGetResultProperties': Use this hook to modify the properties in a module's
376 result.
377 &$module: ApiBase Module object
378 &$properties: Array of properties
380 'APIGetPossibleErrors': Use this hook to modify the module's list of possible
381 errors.
382 $module: ApiBase Module object
383 &$possibleErrors: Array of possible errors
385 'APIQueryAfterExecute': After calling the execute() method of an
386 action=query submodule. Use this to extend core API modules.
387 &$module: Module object
389 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
390 an action=query submodule. Use this to extend core API modules.
391 &$module: Module object
392 &$resultPageSet: ApiPageSet object
394 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
395 token has an action, which will be used in the intoken parameter and in the
396 output (actiontoken="..."), and a callback function which should return the
397 token, or false if the user isn't allowed to obtain it. The prototype of the
398 callback function is func($pageid, $title), where $pageid is the page ID of the
399 page the token is requested for and $title is the associated Title object. In
400 the hook, just add your callback to the $tokenFunctions array and return true
401 (returning false makes no sense).
402 $tokenFunctions: array(action => callback)
404 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
405 Every token has an action, which will be used in the rvtoken parameter and in
406 the output (actiontoken="..."), and a callback function which should return the
407 token, or false if the user isn't allowed to obtain it. The prototype of the
408 callback function is func($pageid, $title, $rev), where $pageid is the page ID
409 of the page associated to the revision the token is requested for, $title the
410 associated Title object and $rev the associated Revision object. In the hook,
411 just add your callback to the $tokenFunctions array and return true (returning
412 false makes no sense).
413 $tokenFunctions: array(action => callback)
415 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
416 list=recentchanges. Every token has an action, which will be used in the rctoken
417 parameter and in the output (actiontoken="..."), and a callback function which
418 should return the token, or false if the user isn't allowed to obtain it. The
419 prototype of the callback function is func($pageid, $title, $rc), where $pageid
420 is the page ID of the page associated to the revision the token is requested
421 for, $title the associated Title object and $rc the associated RecentChange
422 object. In the hook, just add your callback to the $tokenFunctions array and
423 return true (returning false makes no sense).
424 $tokenFunctions: array(action => callback)
426 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
427 sites general information.
428 $module: the current ApiQuerySiteInfo module
429 &$results: array of results, add things here
431 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
432 token has an action, which will be used in the ustoken parameter and in the
433 output (actiontoken="..."), and a callback function which should return the
434 token, or false if the user isn't allowed to obtain it. The prototype of the
435 callback function is func($user) where $user is the User object. In the hook,
436 just add your callback to the $tokenFunctions array and return true (returning
437 false makes no sense).
438 $tokenFunctions: array(action => callback)
440 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
441 an exception is thrown during API action execution.
442 $apiMain: Calling ApiMain instance.
443 $e: Exception object.
445 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
446 should have its own entry in the $apis array and have a unique name, passed as
447 key for the array that represents the service data. In this data array, the
448 key-value-pair identified by the apiLink key is required.
449 &$apis: array of services
451 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
452 types.
453 &$tokenTypes: supported token types in format 'type' => callback function
454 used to retrieve this type of tokens.
456 'ArticleAfterFetchContent': After fetching content of an article from the
457 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
458 $article: the article (object) being loaded from the database
459 &$content: the content (string) of the article
461 'ArticleAfterFetchContentObject': After fetching content of an article from the
462 database.
463 $article: the article (object) being loaded from the database
464 &$content: the content of the article, as a Content object
466 'ArticleConfirmDelete': Before writing the confirmation form for article
467 deletion.
468 $article: the article (object) being deleted
469 $output: the OutputPage object
470 &$reason: the reason (string) the article is being deleted
472 'ArticleContentOnDiff': Before showing the article content below a diff. Use
473 this to change the content in this area or how it is loaded.
474 $diffEngine: the DifferenceEngine
475 $output: the OutputPage object
477 'ArticleDelete': Before an article is deleted.
478 $wikiPage: the WikiPage (object) being deleted
479 $user: the user (object) deleting the article
480 $reason: the reason (string) the article is being deleted
481 $error: if the deletion was prohibited, the (raw HTML) error message to display
482   (added in 1.13)
483 $status: Status object, modify this to throw an error. Overridden by $error
484   (added in 1.20)
486 'ArticleDeleteComplete': After an article is deleted.
487 $wikiPage: the WikiPage that was deleted
488 $user: the user that deleted the article
489 $reason: the reason the article was deleted
490 $id: id of the article that was deleted
491 $content: the Content of the deleted page
492 $logEntry: the ManualLogEntry used to record the deletion
494 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
495 was changed.
496 &$wikiPage: WikiPage (object) of the user talk page
497 $recipient: User (object) who's talk page was edited
499 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
500 article has been changed.
501 $wikiPage: the WikiPage (object)
502 $editInfo: data holder that includes the parser output ($editInfo->output) for
503 that page after the change
504 $changed: bool for if the page was changed
506 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
507 recentchanges table, return false to not delete old entries.
508 $wikiPage: WikiPage (object) being modified
510 'ArticleFromTitle': when creating an article object from a title object using
511 Wiki::articleFromTitle().
512 $title: Title (object) used to create the article object
513 $article: Article (object) that will be returned
515 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
516 PageContentInsertComplete.
517 $wikiPage: WikiPage created
518 $user: User creating the article
519 $text: New content
520 $summary: Edit summary/comment
521 $isMinor: Whether or not the edit was marked as minor
522 $isWatch: (No longer used)
523 $section: (No longer used)
524 $flags: Flags passed to WikiPage::doEditContent()
525 $revision: New Revision of the article
527 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
528 $targetTitle: target title (object)
529 $destTitle: destination title (object)
531 'ArticlePageDataAfter': After loading data of an article from the database.
532 $wikiPage: WikiPage (object) whose data were loaded
533 $row: row (object) returned from the database server
535 'ArticlePageDataBefore': Before loading data of an article from the database.
536 $wikiPage: WikiPage (object) that data will be loaded
537 $fields: fields (array) to load from the database
539 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
540 $wikiPage: the WikiPage being saved
541 $popts: parser options to be used for pre-save transformation
543 'ArticleProtect': Before an article is protected.
544 $wikiPage: the WikiPage being protected
545 $user: the user doing the protection
546 $protect: boolean whether this is a protect or an unprotect
547 $reason: Reason for protect
548 $moveonly: boolean whether this is for move only or not
550 'ArticleProtectComplete': After an article is protected.
551 $wikiPage: the WikiPage that was protected
552 $user: the user who did the protection
553 $protect: boolean whether it was a protect or an unprotect
554 $reason: Reason for protect
555 $moveonly: boolean whether it was for move only or not
557 'ArticlePurge': Before executing "&action=purge".
558 $wikiPage: WikiPage (object) to purge
560 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
561 revisions of an article.
562 &$title: Title object of the article
564 'ArticleRevisionUndeleted': After an article revision is restored.
565 $title: the article title
566 $revision: the revision
567 $oldPageID: the page ID of the revision when archived (may be null)
569 'ArticleRollbackComplete': After an article rollback is completed.
570 $wikiPage: the WikiPage that was edited
571 $user: the user who did the rollback
572 $revision: the revision the page was reverted back to
573 $current: the reverted revision
575 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
576 instead.
577 $wikiPage: the WikiPage (object) being saved
578 $user: the user (object) saving the article
579 $text: the new article text
580 $summary: the article summary (comment)
581 $isminor: minor flag
582 $iswatch: watch flag
583 $section: section #
585 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
586 PageContentSaveComplete instead.
587 $wikiPage: WikiPage modified
588 $user: User performing the modification
589 $text: New content
590 $summary: Edit summary/comment
591 $isMinor: Whether or not the edit was marked as minor
592 $isWatch: (No longer used)
593 $section: (No longer used)
594 $flags: Flags passed to WikiPage::doEditContent()
595 $revision: New Revision of the article
596 $status: Status object about to be returned by doEditContent()
597 $baseRevId: the rev ID (or false) this edit was based on
599 'ArticleUndelete': When one or more revisions of an article are restored.
600 $title: Title corresponding to the article restored
601 $create: Whether or not the restoration caused the page to be created (i.e. it
602   didn't exist before).
603 $comment: The comment associated with the undeletion.
605 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
606 $pageArchive: the PageArchive object
607 &$logEntry: ManualLogEntry object
608 $user: User who is performing the log action
610 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
611 the user is redirected back to the page.
612 &$article: the article
613 &$sectionanchor: The section anchor link (e.g. "#overview" )
614 &$extraq: Extra query parameters which can be added via hooked functions
616 'ArticleViewFooter': After showing the footer section of an ordinary page view
617 $article: Article object
619 'ArticleViewHeader': Before the parser cache is about to be tried for article
620 viewing.
621 &$article: the article
622 &$pcache: whether to try the parser cache or not
623 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
624 object to both indicate that the output is done and what parser output was used.
626 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
627 redirect was followed.
628 $article: target article (object)
630 'ArticleViewCustom': Allows to output the text of the article in a different
631 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
632 that it is preferable to implement proper handing for a custom data type using
633 the ContentHandler facility.
634 $text: text of the page
635 $title: title of the page
636 $output: reference to $wgOut
638 'ArticleContentViewCustom': Allows to output the text of the article in a
639 different format than wikitext. Note that it is preferable to implement proper
640 handing for a custom data type using the ContentHandler facility.
641 $content: content of the page, as a Content object
642 $title: title of the page
643 $output: reference to $wgOut
645 'AuthPluginAutoCreate': Called when creating a local account for an user logged
646 in from an external authentication method.
647 $user: User object created locally
649 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
650 Gives a chance for an extension to set it programmatically to a variable class.
651 &$auth: the $wgAuth object, probably a stub
653 'AutopromoteCondition': Check autopromote condition for user.
654 $type: condition type
655 $args: arguments
656 $user: user
657 $result: result of checking autopromote condition
659 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
660 $table: table name
661 &$prefix: prefix
663 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
664 certain title are fetched.
665 $table: table name
666 $title: title of the page to which backlinks are sought
667 &$conds: query conditions
669 'BadImage': When checking against the bad image list. Change $bad and return
670 false to override. If an image is "bad", it is not rendered inline in wiki
671 pages or galleries in category pages.
672 $name: Image name being checked
673 &$bad: Whether or not the image is "bad"
675 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
676 "noarticletext-nopermission" at Article::showMissingArticle().
677 $article: article object
679 'BeforeInitialize': Before anything is initialized in
680 MediaWiki::performRequest().
681 &$title: Title being used for request
682 $unused: null
683 &$output: OutputPage object
684 &$user: User
685 $request: WebRequest object
686 $mediaWiki: Mediawiki object
688 'BeforePageDisplay': Prior to outputting a page.
689 &$out: OutputPage object
690 &$skin: Skin object
692 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
693 override how the redirect is output by modifying, or by returning false and
694 taking over the output.
695 $out: OutputPage object
696 &$redirect: URL, modifiable
697 &$code: HTTP code (eg '301' or '302'), modifiable
699 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
700 $parser: Parser object
701 $nt: the image title
702 &$options: array of options to RepoGroup::findFile
703 &$descQuery: query string to add to thumbnail URL
705 FIXME: Where does the below sentence fit in?
706 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
708 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
709 $parser: Parser object
710 $title: title of the template
711 &$skip: skip this template and link it?
712 &$id: the id of the revision being parsed
714 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
715 &$parser: Parser object
716 &$ig: ImageGallery object
718 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
719 newly created user.
720 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
721   to a newly created user account.
722 &$injected_html: Any HTML to inject after the "logged in" message of a newly
723   created user account
725 'BitmapHandlerTransform': before a file is transformed, gives extension the
726 possibility to transform it themselves
727 $handler: BitmapHandler
728 $image: File
729 &$scalerParams: Array with scaler parameters
730 &$mto: null, set to a MediaTransformOutput
732 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
733 normalizations have been performed, except for the $wgMaxImageArea check.
734 $image: File
735 &$params: Array of parameters
736 &$checkImageAreaHookResult: null, set to true or false to override the
737   $wgMaxImageArea check result.
739 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
740 to a user.
741 $block: Block object (which is set to be autoblocking)
742 &$blockIds: Array of block IDs of the autoblock
744 'BlockIp': Before an IP address or user is blocked.
745 $block: the Block object about to be saved
746 $user: the user _doing_ the block (not the one being blocked)
748 'BlockIpComplete': After an IP address or user is blocked.
749 $block: the Block object that was saved
750 $user: the user who did the block (not the one being blocked)
752 'BookInformation': Before information output on Special:Booksources.
753 $isbn: ISBN to show information for
754 $output: OutputPage object in use
756 'CanonicalNamespaces': For extensions adding their own namespaces or altering
757 the defaults.
758 &$namespaces: Array of namespace numbers with corresponding canonical names
760 'CategoryAfterPageAdded': After a page is added to a category.
761 $category: Category that page was added to
762 $wikiPage: WikiPage that was added
764 'CategoryAfterPageRemoved': After a page is removed from a category.
765 $category: Category that page was removed from
766 $wikiPage: WikiPage that was removed
768 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
769 $catpage: CategoryPage instance
771 'ChangePasswordForm': For extensions that need to add a field to the
772 ChangePassword form via the Preferences form.
773 &$extraFields: An array of arrays that hold fields like would be passed to the
774   pretty function.
776 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
777 &$changesList: ChangesList instance.
778 &$articlelink: HTML of link to article (already filled-in).
779 &$s: HTML of row that is being constructed.
780 &$rc: RecentChange instance.
781 $unpatrolled: Whether or not we are showing unpatrolled changes.
782 $watched: Whether or not the change is watched by the user.
784 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
785 $collationName: Name of the collation in question
786 &$collationObject: Null. Replace with a subclass of the Collation class that
787   implements the collation given in $collationName.
789 'ConfirmEmailComplete': Called after a user's email has been confirmed
790 successfully.
791 $user: user (object) whose email is being confirmed
793 'ContentHandlerDefaultModelFor': Called when the default content model is determined
794 for a given title. May be used to assign a different model for that title.
795 $title: the Title in question
796 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
798 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
799 content model name, but no entry for that model exists in $wgContentHandlers.
800 $modeName: the requested content model name
801 &$handler: set this to a ContentHandler object, if desired.
803 'ConvertContent': Called by AbstractContent::convert when a conversion to another
804 content model is requested.
805 $content: The Content object to be converted.
806 $toModel: The ID of the content model to convert to.
807 $lossy:   boolean indicating whether lossy conversion is allowed.
808 &$result: Output parameter, in case the handler function wants to provide a
809 converted Content object. Note that $result->getContentModel() must return $toModel.
810 Handler functions that modify $result should generally return false to further
811 attempts at conversion.
813 'ContribsPager::getQueryInfo': Before the contributions query is about to run
814 &$pager: Pager object for contributions
815 &$queryInfo: The query for the contribs Pager
817 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
818 &$data: an array of results of all contribs queries
819 $pager: The ContribsPager object hooked into
820 $offset: Index offset, inclusive
821 $limit: Exact query limit
822 $descending: Query direction, false for ascending, true for descending
824 'ContributionsLineEnding': Called before a contributions HTML line is finished
825 $page: SpecialPage object for contributions
826 &$ret: the HTML line
827 $row: the DB row for this line
828 &$classes: the classes to add to the surrounding <li>
830 'ContributionsToolLinks': Change tool links above Special:Contributions
831 $id: User identifier
832 $title: User page title
833 &$tools: Array of tool links
835 'CustomEditor': When invoking the page editor
836 $article: Article being edited
837 $user: User performing the edit
839 Return true to allow the normal editor to be used, or false
840 if implementing a custom editor, e.g. for a special namespace,
841 etc.
843 'DatabaseOraclePostInit': Called after initialising an Oracle database
844 &$db: the DatabaseOracle object
846 'Debug': Called when outputting a debug log line via wfDebug() or wfDebugLog()
847 $text: plaintext string to be output
848 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
850 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
851 $title: the diff page title (nullable)
852 &$oldId: the actual old Id to use in the diff
853 &$newId: the actual new Id to use in the diff (0 means current)
854 $old: the ?old= param value from the url
855 $new: the ?new= param value from the url
857 'DiffRevisionTools': Override or extend the revision tools available from the
858 diff view, i.e. undo, etc.
859 $rev: Revision object
860 &$links: Array of HTML links
862 'DiffViewHeader': Called before diff display
863 $diff: DifferenceEngine object that's calling
864 $oldRev: Revision object of the "old" revision (may be null/invalid)
865 $newRev: Revision object of the "new" revision
867 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
868 an article
869 $article: article (object) being viewed
870 $oldid: oldid (int) being viewed
872 'DoEditSectionLink': Override the HTML generated for section edit links
873 $skin: Skin object rendering the UI
874 $title: Title object for the title being linked to (may not be the same as
875   $wgTitle, if the section is included from a template)
876 $section: The designation of the section being pointed to, to be included in
877   the link, like "&section=$section"
878 $tooltip: The default tooltip.  Escape before using.
879   By default, this is wrapped in the 'editsectionhint' message.
880 &$result: The HTML to return, prefilled with the default plus whatever other
881   changes earlier hooks have made
882 $lang: The language code to use for the link in the wfMessage function
884 'EditFilter': Perform checks on an edit
885 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
886 $text: Contents of the edit box
887 $section: Section being edited
888 &$error: Error message to return
889 $summary: Edit summary for page
891 'EditFilterMerged': Post-section-merge edit filter.
892 DEPRECATED, use EditFilterMergedContent instead.
893 $editor: EditPage instance (object)
894 $text: content of the edit box
895 &$error: error message to return
896 $summary: Edit summary for page
898 'EditFilterMergedContent': Post-section-merge edit filter.
899 This may be triggered by the EditPage or any other facility that modifies page content.
900 Use the $status object to indicate whether the edit should be allowed, and to provide
901 a reason for disallowing it. Return false to abort the edit, and true to continue.
902 Returning true if $status->isOK() returns false means "don't save but continue user
903 interaction", e.g. show the edit form.
904 $context: object implementing the IContextSource interface.
905 $content: content of the edit box, as a Content object.
906 $status: Status object to represent errors, etc.
907 $summary: Edit summary for page
908 $user: the User object representing the user whois performing the edit.
909 $minoredit: whether the edit was marked as minor by the user.
911 'EditFormPreloadText': Allows population of the edit form when creating
912 new pages
913 &$text: Text to preload with
914 &$title: Title object representing the page being created
916 'EditFormInitialText': Allows modifying the edit form when editing existing
917 pages
918 $editPage: EditPage     object
920 'EditPage::attemptSave': Called before an article is
921 saved, that is before WikiPage::doEditContent() is called
922 $editpage_Obj: the current EditPage object
924 'EditPage::importFormData': allow extensions to read additional data
925 posted in the form
926 $editpage: EditPage instance
927 $request: Webrequest
928 return value is ignored (should always return true)
930 'EditPage::showEditForm:fields': allows injection of form field into edit form
931 $editor: the EditPage instance for reference
932 $out: an OutputPage instance to write to
933 return value is ignored (should always return true)
935 'EditPage::showEditForm:initial': before showing the edit form
936 $editor: EditPage instance (object)
937 $out: an OutputPage instance to write to
939 Return false to halt editing; you'll need to handle error messages, etc.
940 yourself. Alternatively, modifying $error and returning true will cause the
941 contents of $error to be echoed at the top of the edit form as wikitext.
942 Return true without altering $error to allow the edit to proceed.
944 'EditPage::showStandardInputs:options': allows injection of form fields into
945 the editOptions area
946 $editor: EditPage instance (object)
947 $out: an OutputPage instance to write to
948 &$tabindex: HTML tabindex of the last edit check/button
949 return value is ignored (should always be true)
951 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
952 when there's an edit conflict.  Return false to halt normal diff output; in
953 this case you're responsible for computing and outputting the entire "conflict"
954 part, i.e., the "difference between revisions" and "your text" headers and
955 sections.
956 &$editor: EditPage instance
957 &$out: OutputPage instance
959 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
960 textarea in the edit form.
961 &$editpage: The current EditPage object
962 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
963 &$tabindex: HTML tabindex of the last edit check/button
965 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
966 in the edit form.
967 &$editpage: The current EditPage object
968 &$checks: Array of edit checks like "watch this page"/"minor edit"
969 &$tabindex: HTML tabindex of the last edit check/button
971 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
972 textarea in the edit form.
973 &$toolbar: The toolbar HTMl
975 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
976 contribution/copyright notice.
977 $title: title of page being edited
978 &$msg: localization message name, overridable. Default is either
979   'copyrightwarning' or 'copyrightwarning2'.
981 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
982 modifying the wikitext that will be used in "Show changes". Note that it is
983 preferable to implement diff handling for different data types using the
984 ContentHandler facility.
985 $editPage: EditPage object
986 &$newtext: wikitext that will be used as "your version"
988 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
989 "Show changes". Note that it is preferable to implement diff handling for
990 different data types using the ContentHandler facility.
991 $editPage: EditPage object
992 &$newtext: wikitext that will be used as "your version"
994 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
995 Allow modifying the wikitext that will be previewed. Note that it is preferable
996 to implement previews for different data types using the ContentHandler
997 facility.
998 $editPage: EditPage object
999 &$toparse: wikitext that will be parsed
1001 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1002 previewed. Note that it is preferable to implement previews for different data
1003 types using the ContentHandler facility.
1004 $editPage: EditPage object
1005 &$content: Content object to be previewed (may be replaced by hook function)
1007 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1008 &$editpage: The current EditPage object
1009 &$res: the HTML of the error text
1011 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1012 of terms of service summary link that might exist separately from the copyright
1013 notice.
1014 $title: title of page being edited
1015 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1017 'EditSectionLink': Do not use, use DoEditSectionLink instead.
1018 $skin: Skin rendering the UI
1019 $title: Title being linked to
1020 $section: Section to link to
1021 $link: Default link
1022 &$result: Result (alter this to override the generated links)
1023 $lang: The language code to use for the link in the wfMessage function
1025 'EmailConfirmed': When checking that the user's email address is "confirmed".
1026 $user: User being checked
1027 $confirmed: Whether or not the email address is confirmed
1028 This runs before the other checks, such as anonymity and the real check; return
1029 true to allow those checks to occur, and false if checking is done.
1031 'EmailUser': Before sending email from one user to another.
1032 $to: address of receiving user
1033 $from: address of sending user
1034 $subject: subject of the mail
1035 $text: text of the mail
1037 'EmailUserCC': Before sending the copy of the email to the author.
1038 $to: address of receiving user
1039 $from: address of sending user
1040 $subject: subject of the mail
1041 $text: text of the mail
1043 'EmailUserComplete': After sending email from one user to another.
1044 $to: address of receiving user
1045 $from: address of sending user
1046 $subject: subject of the mail
1047 $text: text of the mail
1049 'EmailUserForm': After building the email user form object.
1050 $form: HTMLForm object
1052 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1053 user.
1054 $user: The user who is trying to email another user.
1055 $editToken: The user's edit token.
1056 &$hookErr: Out-param for the error. Passed as the parameters to
1057   OutputPage::showErrorPage.
1059 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1060 throttle.
1061 $ip: The ip address of the user
1063 'ExtensionTypes': Called when generating the extensions credits, use this to
1064 change the tables headers.
1065 &$extTypes: associative array of extensions types
1067 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1068 thumbnail file name.
1069 $thumbname: the base name of the thumbnail file
1070 &$params: the currently extracted params (has source name, temp or archived zone)
1072 'FetchChangesList': When fetching the ChangesList derivative for a particular
1073 user.
1074 $user: User the list is being fetched for
1075 &$skin: Skin object to be used with the list
1076 &$list: List object (defaults to NULL, change it to an object instance and
1077   return false override the list derivative used)
1079 'FileDeleteComplete': When a file is deleted.
1080 $file: reference to the deleted file
1081 $oldimage: in case of the deletion of an old image, the name of the old file
1082 $article: in case all revisions of the file are deleted a reference to the
1083   WikiFilePage associated with the file.
1084 $user: user who performed the deletion
1085 $reason: reason
1087 'FileTransformed': When a file is transformed and moved into storage.
1088 $file: reference to the File object
1089 $thumb: the MediaTransformOutput object
1090 $tmpThumbPath: The temporary file system path of the transformed file
1091 $thumbPath: The permanent storage path of the transformed file
1093 'FileUpload': When a file upload occurs.
1094 $file : Image object representing the file that was uploaded
1095 $reupload : Boolean indicating if there was a previously another image there or
1096   not (since 1.17)
1097 $hasDescription : Boolean indicating that there was already a description page
1098   and a new one from the comment wasn't created (since 1.17)
1100 'FileUndeleteComplete': When a file is undeleted
1101 $title: title object to the file
1102 $fileVersions: array of undeleted versions. Empty if all versions were restored
1103 $user: user who performed the undeletion
1104 $reason: reason
1106 'FormatAutocomments': When an autocomment is formatted by the Linker.
1107  &$comment: Reference to the accumulated comment. Initially null, when set the
1108    default code will be skipped.
1109  $pre: Initial part of the parsed comment before the call to the hook.
1110  $auto: The extracted part of the parsed comment before the call to the hook.
1111  $post: The final part of the parsed comment before the call to the hook.
1112  $title: An optional title object used to links to sections. Can be null.
1113  $local: Boolean indicating whether section links should refer to local page.
1115 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1116 entitled to be in.
1117 &$user: user to promote.
1118 &$promote: groups that will be added.
1120 'GetBlockedStatus': after loading blocking status of an user from the database
1121 $user: user (object) being checked
1123 'GetCacheVaryCookies': Get cookies that should vary cache options.
1124 $out: OutputPage object
1125 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1126   that have to vary cache options
1128 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1129 notifications.
1130 $title: Title object of page
1131 $url: string value as output (out parameter, can modify)
1132 $query: query options passed to Title::getCanonicalURL()
1134 'GetDefaultSortkey': Override the default sortkey for a page.
1135 $title: Title object that we need to get a sortkey for
1136 &$sortkey: Sortkey to use.
1138 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1139 underscore) magic words. Called by MagicWord.
1140 &$doubleUnderscoreIDs: array of strings
1142 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1143 $title: Title object of page
1144 $url: string value as output (out parameter, can modify)
1145 $query: query options passed to Title::getFullURL()
1147 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1148 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1149 output.
1150 &$output: string for the output timestamp
1151 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1152 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1153 $user: User whose preferences are being used to make timestamp
1154 $lang: Language that will be used to render the timestamp
1156 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1157 $title: Title object of page
1158 $url: string value as output (out parameter, can modify)
1159 $query: query options passed to Title::getInternalURL()
1161 'GetIP': modify the ip of the current user (called only once).
1162 &$ip: string holding the ip as determined so far
1164 'GetLinkColours': modify the CSS class of an array of page links.
1165 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1166         indexed by page_id.
1167 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1169 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1170 working with internal urls (non-interwiki) then it may be preferable to work
1171 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1172 be buggy for internal urls on render if you do not re-implement the horrible
1173 hack that Title::getLocalURL uses in your own extension.
1174 $title: Title object of page
1175 &$url: string value as output (out parameter, can modify)
1176 $query: query options passed to Title::getLocalURL()
1178 'GetLocalURL::Internal': Modify local URLs to internal pages.
1179 $title: Title object of page
1180 &$url: string value as output (out parameter, can modify)
1181 $query: query options passed to Title::getLocalURL()
1183 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1184 without any fancy queries or variants.
1185 $title: Title object of page
1186 &$url: string value as output (out parameter, can modify)
1188 'GetMetadataVersion': Modify the image metadata version currently in use. This
1189 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1190 that need to have versioned metadata should add an element to the end of the
1191 version array of the form 'handler_name=version'. Most media handlers won't need
1192 to do this unless they broke backwards compatibility with a previous version of
1193 the media handler metadata output.
1194 &$version: Array of version strings
1196 'GetNewMessagesAlert': Disable or modify the new messages alert
1197 &$newMessagesAlert: An empty string by default. If the user has new talk page
1198 messages, this should be populated with an alert message to that effect
1199 $newtalks: An empty array if the user has no new messages or an array containing
1200 links and revisions if there are new messages (See User::getNewMessageLinks)
1201 $user: The user object of the user who is loading the page
1202 $out: OutputPage object (to check what type of page the user is on)
1204 'GetPreferences': Modify user preferences.
1205 $user: User whose preferences are being modified.
1206 &$preferences: Preferences description array, to be fed to an HTMLForm object
1208 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1209 checked for. Use instead of userCan for most cases. Return false if the user
1210 can't do it, and populate $result with the reason in the form of
1211 array( messagename, param1, param2, ... ). For consistency, error messages
1212 should be plain text with no special coloring, bolding, etc. to show that
1213 they're errors; presenting them properly to the user as errors is done by the
1214 caller.
1215 $title: Title object being checked against
1216 $user : Current user object
1217 $action: Action being checked
1218 $result: User permissions error to add. If none, return true.
1220 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1221 called only if expensive checks are enabled. Add a permissions error when
1222 permissions errors are checked for. Return false if the user can't do it, and
1223 populate $result with the reason in the form of array( messagename, param1,
1224 param2, ... ). For consistency, error messages should be plain text with no
1225 special coloring, bolding, etc. to show that they're errors; presenting them
1226 properly to the user as errors is done by the caller.
1228 $title: Title object being checked against
1229 $user : Current user object
1230 $action: Action being checked
1231 $result: User permissions error to add. If none, return true.
1233 'GitViewers': Called when generating the list of git viewers for
1234 Special:Version, use this to change the list.
1235 &$extTypes: associative array of repo URLS to viewer URLs.
1237 'HistoryRevisionTools': Override or extend the revision tools available from the
1238 page history view, i.e. undo, rollback, etc.
1239 $rev: Revision object
1240 &$links: Array of HTML links
1242 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1243 image insertion. You can skip the default logic entirely by returning false, or
1244 just modify a few things using call-by-reference.
1245 &$skin: Skin object
1246 &$title: Title object of the image
1247 &$file: File object, or false if it doesn't exist
1248 &$frameParams: Various parameters with special meanings; see documentation in
1249   includes/Linker.php for Linker::makeImageLink
1250 &$handlerParams: Various parameters with special meanings; see documentation in
1251   includes/Linker.php for Linker::makeImageLink
1252 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1253 &$res: Final HTML output, used if you return false
1256 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1257 the image on an image page.
1258 $imagePage: ImagePage object ($this)
1259 $output: $wgOut
1261 'ImagePageAfterImageLinks': Called after the image links section on an image
1262 page is built.
1263 $imagePage: ImagePage object ($this)
1264 &$html: HTML for the hook to add
1266 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1267 $file: the file
1268 $line: the HTML of the history line
1269 $css: the line CSS class
1271 'ImagePageFindFile': Called when fetching the file associated with an image
1272 page.
1273 $page: ImagePage object
1274 &$file: File object
1275 &$displayFile: displayed File object
1277 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1278 $page: ImagePage object
1279 &$toc: Array of <li> strings
1281 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1282 using img_auth.php.
1283 &$title: the Title object of the file as it would appear for the upload page
1284 &$path: the original file and path name when img_auth was invoked by the the web
1285   server
1286 &$name: the name only component of the file
1287 &$result: The location to pass back results of the hook routine (only used if
1288   failed)
1289   $result[0]=The index of the header message
1290   $result[1]=The index of the body text message
1291   $result[2 through n]=Parameters passed to body text message. Please note the
1292   header message cannot receive/use parameters.
1294 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1295 $reader: XMLReader object
1296 $logInfo: Array of information
1297 Return false to stop further processing of the tag
1299 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1300 $reader: XMLReader object
1301 $pageInfo: Array of information
1302 Return false to stop further processing of the tag
1304 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1305 $reader: XMLReader object
1306 $pageInfo: Array of page information
1307 $revisionInfo: Array of revision information
1308 Return false to stop further processing of the tag
1310 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1311 $reader: XMLReader object
1312 Return false to stop further processing of the tag
1314 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1315 $reader: XMLReader object
1316 $revisionInfo: Array of information
1317 Return false to stop further processing of the tag
1319 'InfoAction': When building information to display on the action=info page.
1320 $context: IContextSource object
1321 &$pageInfo: Array of information
1323 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1324 $title: Title object ($wgTitle)
1325 $request: WebRequest
1326 $ignoreRedirect: boolean to skip redirect check
1327 $target: Title/string of redirect target
1328 $article: Article object
1330 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1331 Return true without providing an interwiki to continue interwiki search.
1332 $prefix: interwiki prefix we are looking for.
1333 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1334   iw_trans and optionally iw_api and iw_wikiid.
1336 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1337 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1338 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1339 template/parser function execution which respect nowiki and HTML-comments.
1340 &$parser: Parser object
1341 &$text: string containing partially parsed text
1342 &$stripState: Parser's internal StripState object
1344 'InternalParseBeforeLinks': during Parser's internalParse method before links
1345 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1346 &$parser: Parser object
1347 &$text: string containing partially parsed text
1348 &$stripState: Parser's internal StripState object
1350 'InvalidateEmailComplete': Called after a user's email has been invalidated
1351 successfully.
1352 $user: user (object) whose email is being invalidated
1354 'IRCLineURL': When constructing the URL to use in an IRC notification.
1355 Callee may modify $url and $query, URL will be constructed as $url . $query
1356 &$url: URL to index.php
1357 &$query: Query string
1359 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1360 $article: article (object) being checked
1362 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1363 $ip: IP being check
1364 $result: Change this value to override the result of wfIsTrustedProxy()
1366 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1367 instance to return false if the domain name doesn't match your organization.
1368 $addr: The e-mail address entered by the user
1369 &$result: Set this and return false to override the internal checks
1371 'isValidPassword': Override the result of User::isValidPassword()
1372 $password: The password entered by the user
1373 &$result: Set this and return false to override the internal checks
1374 $user: User the password is being validated for
1376 'Language::getMessagesFileName':
1377 $code: The language code or the language we're looking for a messages file for
1378 &$file: The messages file path, you can override this to change the location.
1380 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1381 remove namespaces. Do not use this hook to add namespaces. Use
1382 CanonicalNamespaces for that.
1383 &$namespaces: Array of namespaces indexed by their numbers
1385 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1386 $wgExtensionMessagesFiles instead.
1387 Use this to define synonyms of magic words depending of the language
1388 $magicExtensions: associative array of magic words synonyms
1389 $lang: language code (string)
1391 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1392 listed in $wgExtensionMessagesFiles instead.
1393 Use to define aliases of special pages names depending of the language
1394 $specialPageAliases: associative array of magic words synonyms
1395 $lang: language code (string)
1397 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1398 &$names: array of language code => language name
1399 $code language of the preferred translations
1401 'LanguageLinks': Manipulate a page's language links. This is called
1402 in various places to allow extensions to define the effective language
1403 links for a page.
1404 $title: The page's Title.
1405 &$links: Associative array mapping language codes to prefixed links of the
1406   form "language:title".
1407 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1408   Currently unused, but planned to provide support for marking individual
1409   language links in the UI, e.g. for featured articles.
1411 'LinkBegin': Used when generating internal and interwiki links in
1412 Linker::link(), before processing starts.  Return false to skip default
1413 processing and return $ret. See documentation for Linker::link() for details on
1414 the expected meanings of parameters.
1415 $skin: the Skin object
1416 $target: the Title that the link is pointing to
1417 &$html: the contents that the <a> tag should have (raw HTML); null means
1418   "default".
1419 &$customAttribs: the HTML attributes that the <a> tag should have, in
1420 associative array form, with keys and values unescaped.  Should be merged with
1421 default values, with a value of false meaning to suppress the attribute.
1422 &$query: the query string to add to the generated URL (the bit after the "?"),
1423   in associative array form, with keys and values unescaped.
1424 &$options: array of options.  Can include 'known', 'broken', 'noclasses'.
1425 &$ret: the value to return if your hook returns false.
1427 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1428 just before the function returns a value.  If you return true, an <a> element
1429 with HTML attributes $attribs and contents $html will be returned.  If you
1430 return false, $ret will be returned.
1431 $skin: the Skin object
1432 $target: the Title object that the link is pointing to
1433 $options: the options.  Will always include either 'known' or 'broken', and may
1434   include 'noclasses'.
1435 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1436 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1437   associative array form.
1438 &$ret: the value to return if your hook returns false.
1440 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1441 before the return.
1442 &$url: the image url
1443 &$alt: the image's alt text
1444 &$img: the new image HTML (if returning false)
1446 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1447 before the return.
1448 &$url: the link url
1449 &$text: the link text
1450 &$link: the new link HTML (if returning false)
1451 &$attribs: the attributes to be applied.
1452 $linkType: The external link type
1454 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1455 actual update.
1456 &$linksUpdate: the LinksUpdate object
1458 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1459 each link table insert.  For example, pagelinks, imagelinks, externallinks.
1460 $linksUpdate: LinksUpdate object
1461 $table: the table to insert links to
1462 $insertions: an array of links to insert
1464 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1465 including delete and insert, has completed for all link tables
1466 &$linksUpdate: the LinksUpdate object
1468 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1469 &$linksUpdate: the LinksUpdate object
1471 'ListDefinedTags': When trying to find all defined tags.
1472 &$tags: The list of tags.
1474 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1475 &updater: A DatabaseUpdater subclass
1477 'LocalFile::getHistory': Called before file history query performed.
1478 $file: the File object
1479 $tables: tables
1480 $fields: select fields
1481 $conds: conditions
1482 $opts: query options
1483 $join_conds: JOIN conditions
1485 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1486 $file: the File object
1487 $archiveName: name of an old file version or false if it's the current one
1489 'LocalisationCacheRecache': Called when loading the localisation data into
1490 cache.
1491 $cache: The LocalisationCache object
1492 $code: language code
1493 &$alldata: The localisation data from core and extensions
1495 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1496 Returning false will prevent the string from being added to the OutputPage.
1497 &$s: html string to show for the log extract
1498 $types: String or Array Log types to show
1499 $page: String or Title The page title to show log entries for
1500 $user: String The user who made the log entries
1501 $param: Associative Array with the following additional options:
1502   - lim Integer Limit of items to show, default is 50
1503   - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1504   - showIfEmpty boolean Set to false if you don't want any output in case the
1505     loglist is empty if set to true (default), "No matching items in log" is
1506     displayed if loglist is empty
1507   - msgKey Array If you want a nice box with a message, set this to the key of
1508     the message. First element is the message key, additional optional elements
1509     are parameters for the key that are processed with
1510     wfMessage()->params()->parseAsBlock()
1511   - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1512     offset
1513   - wrap String Wrap the message in html (usually something like
1514     "&lt;div ...>$1&lt;/div>").
1515   - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1517 'LoginAuthenticateAudit': A login attempt for a valid user account either
1518 succeeded or failed. No return data is accepted; this hook is for auditing only.
1519 $user: the User object being authenticated against
1520 $password: the password being submitted and found wanting
1521 $retval: a LoginForm class constant with authenticateUserData() return
1522   value (SUCCESS, WRONG_PASS, etc.).
1524 'LogLine': Processes a single log entry on Special:Log.
1525 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1526   logging.log_type database field.
1527 $log_action: string for the type of log action (e.g. 'delete', 'block',
1528   'create2'). Corresponds to logging.log_action database field.
1529 $title: Title object that corresponds to logging.log_namespace and
1530   logging.log_title database fields.
1531 $paramArray: Array of parameters that corresponds to logging.log_params field.
1532   Note that only $paramArray[0] appears to contain anything.
1533 &$comment: string that corresponds to logging.log_comment database field, and
1534   which is displayed in the UI.
1535 &$revert: string that is displayed in the UI, similar to $comment.
1536 $time: timestamp of the log entry (added in 1.12)
1538 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1539 script.
1540 $refreshLinks: RefreshLinks object
1542 'MagicWordwgVariableIDs': When defining new magic words IDs.
1543 $variableIDs: array of strings
1545 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1546 executed. Ideally, this hook should only be used to add variables that depend on
1547 the current page/request; static configuration should be added through
1548 ResourceLoaderGetConfigVars instead.
1549 &$vars: variable (or multiple variables) to be added into the output of
1550   Skin::makeVariablesScript
1551 $out: The OutputPage which called the hook, can be used to get the real title.
1553 'MarkPatrolled': Before an edit is marked patrolled.
1554 $rcid: ID of the revision to be marked patrolled
1555 $user: the user (object) marking the revision as patrolled
1556 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1557   sysop in order to mark an edit patrolled.
1559 'MarkPatrolledComplete': After an edit is marked patrolled.
1560 $rcid: ID of the revision marked as patrolled
1561 $user: user (object) who marked the edit patrolled
1562 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1563   sysop to patrol the edit.
1565 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1566 something completely different, after the basic globals have been set up, but
1567 before ordinary actions take place.
1568 $output: $wgOut
1569 $article: $wgArticle
1570 $title: $wgTitle
1571 $user: $wgUser
1572 $request: $wgRequest
1573 $mediaWiki: The $mediawiki object
1575 'MessagesPreLoad': When loading a message from the database.
1576 $title: title of the message (string)
1577 $message: value (string), change it to the message you want to define
1579 'MessageCacheReplace': When a message page is changed. Useful for updating
1580 caches.
1581 $title: name of the page changed.
1582 $text: new contents of the page.
1584 'ModifyExportQuery': Modify the query used by the exporter.
1585 $db: The database object to be queried.
1586 &$tables: Tables in the query.
1587 &$conds: Conditions in the query.
1588 &$opts: Options for the query.
1589 &$join_conds: Join conditions for the query.
1591 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1592 links have been rendered (useful for adding more). Note: this is only run for
1593 the Monobook skin. To add items to the toolbox you should use the
1594 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1595 skins.
1596 $tools: array of tools
1598 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1599 and returning it for the skin to output. You can add items to the toolbox while
1600 still letting the skin make final decisions on skin-specific markup conventions
1601 using this hook.
1602 &$sk: The BaseTemplate base skin template
1603 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1604   BaseTemplate::makeListItem for details on the format of individual items
1605   inside of this array.
1607 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1608 namespace.
1609 $index: Integer; the index of the namespace being checked.
1610 $result: Boolean; whether MediaWiki currently thinks that pages in this
1611   namespace are movable. Hooks may change this value to override the return
1612   value of MWNamespace::isMovable().
1614 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1615 edit.
1616 $wikiPage: the WikiPage edited
1617 $rev: the new revision
1618 $baseID: the revision ID this was based off, if any
1619 $user: the editing user
1621 'NormalizeMessageKey': Called before the software gets the text of a message
1622 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1623 displayed.
1624 &$key: the message being looked up. Change this to something else to change
1625   what message gets displayed (string)
1626 &$useDB: whether or not to look up the message in the database (bool)
1627 &$langCode: the language code to get the message for (string) - or -
1628   whether to use the content language (true) or site language (false) (bool)
1629 &$transform: whether or not to expand variables and templates
1630   in the message (bool)
1632 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1633 return false to omit the line from RecentChanges and Watchlist special pages.
1634 &$changeslist: The OldChangesList instance.
1635 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1636 &$rc: The RecentChange object.
1637 &$classes: array of css classes for the <li> element
1639 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1640 can alter or append to the array of URLs for search & suggestion formats.
1641 &$urls: array of associative arrays with Url element attributes
1643 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1644 users and/or IP addresses too.
1645 $otherBlockLink: An array with links to other block logs
1646 $ip: The requested IP address or username
1648 'OutputPageBeforeHTML': A page has been processed by the parser and the
1649 resulting HTML is about to be displayed.
1650 $parserOutput: the parserOutput (object) that corresponds to the page
1651 $text: the text that will be displayed, in HTML (string)
1653 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1654 body tag to allow for extensions to add attributes to the body of the page they
1655 might need. Or to allow building extensions to add body classes that aren't of
1656 high enough demand to be included in core.
1657 $out: The OutputPage which called the hook, can be used to get the real title
1658 $sk: The Skin that called OutputPage::headElement
1659 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1661 'OutputPageCheckLastModified': when checking if the page has been modified
1662 since the last visit.
1663 &$modifiedTimes: array of timestamps.
1664         The following keys are set: page, user, epoch
1666 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1667 $out: OutputPage instance (object)
1668 $parserOutput: parserOutput instance being added in $out
1670 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1671 categories. Implementations should return false if they generate the category
1672 links, so the default link generation is skipped.
1673 $out: OutputPage instance (object)
1674 $categories: associative array, keys are category names, values are category
1675   types ("normal" or "hidden")
1676 $links: array, intended to hold the result. Must be an associative array with
1677   category types as keys and arrays of HTML links as values.
1679 'PageContentInsertComplete': After a new article is created.
1680 $wikiPage: WikiPage created
1681 $user: User creating the article
1682 $content: New content as a Content object
1683 $summary: Edit summary/comment
1684 $isMinor: Whether or not the edit was marked as minor
1685 $isWatch: (No longer used)
1686 $section: (No longer used)
1687 $flags: Flags passed to WikiPage::doEditContent()
1688 $revision: New Revision of the article
1690 'PageContentLanguage': Allows changing the language in which the content of a
1691 page is written. Defaults to the wiki content language ($wgContLang).
1692 $title: Title object
1693 &$pageLang: the page content language (either an object or a language code)
1694 $wgLang: the user language
1696 'PageContentSave': Before an article is saved.
1697 $wikiPage: the WikiPage (object) being saved
1698 $user: the user (object) saving the article
1699 $content: the new article content, as a Content object
1700 $summary: the article summary (comment)
1701 $isminor: minor flag
1702 $iswatch: watch flag
1703 $section: section #
1705 'PageContentSaveComplete': After an article has been updated.
1706 $wikiPage: WikiPage modified
1707 $user: User performing the modification
1708 $content: New content, as a Content object
1709 $summary: Edit summary/comment
1710 $isMinor: Whether or not the edit was marked as minor
1711 $isWatch: (No longer used)
1712 $section: (No longer used)
1713 $flags: Flags passed to WikiPage::doEditContent()
1714 $revision: New Revision of the article
1715 $status: Status object about to be returned by doEditContent()
1716 $baseRevId: the rev ID (or false) this edit was based on
1718 'PageHistoryBeforeList': When a history page list is about to be constructed.
1719 $article: the article that the history is loading for
1720 $context: RequestContext object
1722 'PageHistoryLineEnding' : Right before the end <li> is added to a history line.
1723 $row: the revision row for this line
1724 $s: the string representing this parsed line
1725 $classes: array containing the <li> element classes
1727 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1728 constructed.
1729 $pager: the pager
1730 $queryInfo: the query parameters
1732 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1733 which depends on user options should install this hook and append its values to
1734 the key.
1735 $hash: reference to a hash key string which can be modified
1737 'ParserAfterParse': Called from Parser::parse() just after the call to
1738 Parser::internalParse() returns.
1739 $parser: parser object
1740 $text: text being parsed
1741 $stripState: stripState used (object)
1743 'ParserAfterStrip': Called at end of parsing time.
1744 TODO: No more strip, deprecated ?
1745 $parser: parser object
1746 $text: text being parsed
1747 $stripState: stripState used (object)
1749 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1750 $parser: Parser object being used
1751 $text: text that will be returned
1753 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1754 $parser: Parser object
1755 $text: text to parse
1756 $stripState: StripState instance being used
1758 'ParserBeforeStrip': Called at start of parsing time.
1759 TODO: No more strip, deprecated ?
1760 $parser: parser object
1761 $text: text being parsed
1762 $stripState: stripState used (object)
1764 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1765 $parser: Parser object being used
1766 $text: actual text
1768 'ParserClearState': Called at the end of Parser::clearState().
1769 $parser: Parser object being cleared
1771 'ParserCloned': Called when the parser is cloned.
1772 $parser: Newly-cloned Parser object
1774 'ParserFirstCallInit': Called when the parser initialises for the first time.
1775 &$parser: Parser object being cleared
1777 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1778 custom magic word
1779 $parser: Parser object
1780 $varCache: array to store the value in case of multiples calls of the
1781         same magic word
1782 $index: index (string) of the magic
1783 $ret: value of the magic word (the hook should set it)
1784 $frame: PPFrame object to use for expanding any template variables
1786 'ParserGetVariableValueTs': Use this to change the value of the time for the
1787 {{LOCAL...}} magic word.
1788 $parser: Parser object
1789 $time: actual time (timestamp)
1791 'ParserGetVariableValueVarCache': use this to change the value of the variable
1792 cache or return false to not use it.
1793 $parser: Parser object
1794 $varCache: variable cache (array)
1796 'ParserLimitReport': Called at the end of Parser:parse() when the parser will
1797 include comments about size of the text parsed.
1798 $parser: Parser object
1799 $limitReport: text that will be included (without comment tags)
1801 'ParserMakeImageParams': Called before the parser make an image link, use this
1802 to modify the parameters of the image.
1803 $title: title object representing the file
1804 $file: file object that will be used to create the image
1805 &$params: 2-D array of parameters
1806 $parser: Parser object that called the hook
1808 'ParserSectionCreate': Called each time the parser creates a document section
1809 from wikitext. Use this to apply per-section modifications to HTML (like
1810 wrapping the section in a DIV).  Caveat: DIVs are valid wikitext, and a DIV
1811 can begin in one section and end in another. Make sure your code can handle
1812 that case gracefully. See the EditSectionClearerLink extension for an example.
1813 $parser: the calling Parser instance
1814 $section: the section number, zero-based, but section 0 is usually empty
1815 &$sectionContent: ref to the content of the section. modify this.
1816 $showEditLinks: boolean describing whether this section has an edit link
1818 'ParserTestParser': Called when creating a new instance of Parser in
1819 maintenance/parserTests.inc.
1820 $parser: Parser object created
1822 'ParserTestGlobals': Allows to define globals for parser tests.
1823 &$globals: Array with all the globals which should be set for parser tests.
1824   The arrays keys serve as the globals names, its values are the globals values.
1826 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
1827 run. Use when page save hooks require the presence of custom tables to ensure
1828 that tests continue to run properly.
1829 &$tables: array of table names
1831 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1832 my talk page, my contributions" etc).
1833 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1834 &$title: Title object representing the current page
1836 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
1837 &$user : User performing the action
1838 $action : Action being performed
1839 &$result : Whether or not the action should be prevented
1840 Change $result and return false to give a definitive answer, otherwise
1841 the built-in rate limiting checks are used, if enabled.
1843 'PlaceNewSection': Override placement of new sections. Return false and put the
1844 merged text into $text to override the default behavior.
1845 $wikipage : WikiPage object
1846 $oldtext : the text of the article before editing
1847 $subject : subject of the new section
1848 &$text : text of the new section
1850 'PreferencesGetLegend': Override the text used for the <legend> of a
1851 preferences section.
1852 $form: the PreferencesForm object. This is a ContextSource as well
1853 $key: the section name
1854 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1856 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1857 AJAX search suggestions. Put results into &$results outparam and return false.
1858 $ns : array of int namespace keys to search in
1859 $search : search term (not guaranteed to be conveniently normalized)
1860 $limit : maximum number of results to return
1861 &$results : out param: array of page names (strings)
1863 'PrefsEmailAudit': Called when user changes their email address.
1864 $user: User (object) changing his email address
1865 $oldaddr: old email address (string)
1866 $newaddr: new email address (string)
1868 'PrefsPasswordAudit': Called when user changes his password.
1869 $user: User (object) changing his password
1870 $newPass: new password
1871 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1873 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
1874 in the form.
1875 $article: the title being (un)protected
1876 $output: a string of the form HTML so far
1878 'ProtectionForm::save': Called when a protection form is submitted.
1879 $article: the title being (un)protected
1880 $errorMsg: an html message string of an error or an array of message name and
1881   its parameters
1883 'ProtectionForm::showLogExtract': Called after the protection log extract is
1884 shown.
1885 $article: the page the form is shown for
1886 $out: OutputPage object
1888 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
1889 &$obj: RawPage object
1890 &$text: The text that's going to be the output
1892 'RecentChange_save': Called at the end of RecentChange::save().
1893 $recentChange: RecentChange object
1895 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
1896 names such as "oldid" that are preserved when using redirecting special pages
1897 such as Special:MyPage and Special:MyTalk.
1898 &$redirectParams: An array of parameters preserved by redirecting special pages.
1900 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
1901 instance. Can be used by an extension override what skin is used in certain
1902 contexts.
1903 IContextSource $context: The RequestContext the skin is being created for.
1904 &$skin: A variable reference you may set a Skin instance or string key on to
1905   override the skin that will be used for the context.
1907 'ResourceLoaderGetConfigVars': Called at the end of
1908 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1909 configuration variables to JavaScript. Things that depend on the current page
1910 or request state must be added through MakeGlobalVariablesScript instead.
1911 &$vars: array( variable name => value )
1913 'ResourceLoaderGetStartupModules': Run once the startup module is being
1914 generated. This allows you to add modules to the startup module. This hook
1915 should be used sparingly since any module added here will be loaded on all
1916 pages. This hook is useful if you want to make code available to module loader
1917 scripts.
1919 'ResourceLoaderRegisterModules': Right before modules information is required,
1920 such as when responding to a resource
1921 loader request or generating HTML output.
1922 &$resourceLoader: ResourceLoader object
1924 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
1925 called after the addition of 'qunit' and MediaWiki testing resources.
1926 &testModules: array of JavaScript testing modules. The 'qunit' framework,
1927   included in core, is fed using tests/qunit/QUnitTestResources.php.
1928 &ResourceLoader object
1930 To add a new qunit module named 'myext.tests':
1931 testModules['qunit']['myext.tests'] = array(
1932         'script' => 'extension/myext/tests.js',
1933         'dependencies' => <any module dependency you might have>
1935 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
1936 added to any module.
1938 'RevisionInsertComplete': Called after a revision is inserted into the database.
1939 &$revision: the Revision
1940 $data: the data stored in old_text.  The meaning depends on $flags: if external
1941   is set, it's the URL of the revision text in external storage; otherwise,
1942   it's the revision text itself.  In either case, if gzip is set, the revision
1943   text is gzipped.
1944 $flags: a comma-delimited list of strings representing the options used.  May
1945   include: utf8 (this will always be set for new revisions); gzip; external.
1947 'SearchUpdate': Prior to search update completion.
1948 $id : Page id
1949 $namespace : Page namespace
1950 $title : Page title
1951 $text : Current text being indexed
1953 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
1954 the normal operations.
1955 $allSearchTerms : Array of the search terms in all content languages
1956 &$titleResult : Outparam; the value to return. A Title object or null.
1958 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
1959 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
1960 runs after.
1961 $term : Search term string
1962 &$title : Outparam; set to $title object and return false for a match
1964 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1965 if nothing was found.
1966 $term : Search term string
1967 &$title : Outparam; set to $title object and return false for a match
1969 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
1970 searches.
1971 $term : Search term string
1972 &$title : Current Title object that is being returned (null if none found).
1974 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1975 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1976 in the $searchEngine->namespaces array.
1977 $query : Original query.
1978 &$parsed : Resultant query with the prefixes stripped.
1980 'SearchResultInitFromTitle': Set the revision used when displaying a page in
1981 search results.
1982 $title : Current Title object being displayed in search results.
1983 &$id: Revision ID (default is false, for latest)
1985 'SearchableNamespaces': An option to modify which namespaces are searchable.
1986 &$arr : Array of namespaces ($nsId => $name) which will be used.
1988 'SeleniumSettings': TODO
1990 'SetupAfterCache': Called in Setup.php, after cache objects are set
1992 'ShowMissingArticle': Called when generating the output for a non-existent page.
1993 $article: The article object corresponding to the page
1995 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
1996 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
1997 $text: Text being shown
1998 $title: Title of the custom script/stylesheet page
1999 $output: Current OutputPage object
2001 'ShowSearchHitTitle': Customise display of search hit title/link.
2002 &$title: Title to link to
2003 &$text: Text to use for the link
2004 $result: The search result
2005 $terms: The search terms entered
2006 $page: The SpecialSearch object.
2008 'ShowSearchHit': Customize display of search hit.
2009 $searchPage: The SpecialSearch instance.
2010 $result: The SearchResult to show
2011 $terms: Search terms, for highlighting
2012 &$link: HTML of link to the matching page. May be modified.
2013 &$redirect: HTML of redirect info. May be modified.
2014 &$section: HTML of matching section. May be modified.
2015 &$extract: HTML of content extract. May be modified.
2016 &$score: HTML of score. May be modified.
2017 &$size: HTML of page size. May be modified.
2018 &$date: HTML of of page modification date. May be modified.
2019 &$related: HTML of additional info for the matching page. May be modified.
2020 &$html: May be set to the full HTML that should be used to represent the search
2021   hit. Must include the <li> ... </li> tags. Will only be used if the hook
2022   function returned false.
2024 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2025 allow the normal method of notice selection/rendering to work, or change the
2026 value of $siteNotice and return false to alter it.
2027 &$siteNotice: HTML returned as the sitenotice
2028 $skin: Skin object
2030 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2031 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2032   the sitenotice/anonnotice.
2033 $skin: Skin object
2035 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2036 $skin: Skin object
2037 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2038   the stock bottom scripts.
2040 'SkinAfterContent': Allows extensions to add text after the page content and
2041 article metadata. This hook should work in all skins. Set the &$data variable to
2042 the text you're going to add.
2043 &$data: (string) Text to be printed out directly (without parsing)
2044 $skin: Skin object
2046 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2047 $skin: Skin object
2048 &$bar: Sidebar contents
2049 Modify $bar to add or modify sidebar portlets.
2051 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2052 copyright notice.
2053 $title: displayed page title
2054 $type: 'normal' or 'history' for old/diff views
2055 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2056   message must be in HTML format, not wikitext!
2057 &$link: overridable HTML link to be passed into the message as $1
2058 &$forContent: overridable flag if copyright footer is shown in content language.
2060 'SkinGetPoweredBy': TODO
2061 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2062 the MediaWiki icon but plain text instead.
2063 $skin: Skin object
2065 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2066 &$subpages: Subpage links HTML
2067 $skin: Skin object
2068 $out: OutputPage object
2069 If false is returned $subpages will be used instead of the HTML
2070 subPageSubtitle() generates.
2071 If true is returned, $subpages will be ignored and the rest of
2072 subPageSubtitle() will run.
2074 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2075 link" tab.
2076 $sktemplate: SkinTemplate object
2077 $nav_urls: array of tabs
2079 To alter the structured navigation links in SkinTemplates, there are three
2080 hooks called in different spots:
2082 'SkinTemplateNavigation': Called on content pages after the tabs have been
2083 added, but before variants have been added.
2084 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2085 tab is added but before variants have been added.
2086 'SkinTemplateNavigation::Universal': Called on both content and special pages
2087 after variants have been added.
2088 &$sktemplate: SkinTemplate object
2089 &$links: Structured navigation links. This is used to alter the navigation for
2090   skins which use buildNavigationUrls such as Vector.
2092 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2093 page output.
2094 &$sktemplate: SkinTemplate object
2095 &$tpl: Template engine object
2097 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2098 $sktemplate: SkinTemplate object
2099 $res: set to true to prevent active tabs
2101 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2102 You can either create your own array, or alter the parameters for
2103 the normal one.
2104 &$sktemplate: The SkinTemplate instance.
2105 $title: Title instance for the page.
2106 $message: Visible label of tab.
2107 $selected: Whether this is a selected tab.
2108 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2109 &$classes: Array of CSS classes to apply.
2110 &$query: Query string to add to link.
2111 &$text: Link text.
2112 &$result: Complete assoc. array if you want to return true.
2114 'SkinTemplateTabs': TODO
2116 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2117 been rendered (useful for adding more).
2118 $sk: The QuickTemplate based skin template running the hook.
2119 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2120   extensions that add support for BaseTemplateToolbox should watch for this
2121   dummy parameter with "$dummy=false" in their code and return without echoing
2122   any HTML to avoid creating duplicate toolbox items.
2124 'SoftwareInfo': Called by Special:Version for returning information about the
2125 software.
2126 $software: The array of software in format 'name' => 'version'. See
2127   SpecialVersion::softwareInformation().
2129 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2130 $id: User identifier
2132 'SpecialListusersDefaultQuery': Called right before the end of
2133 UsersPager::getDefaultQuery().
2134 $pager: The UsersPager instance
2135 $query: The query array to be returned
2137 'SpecialListusersFormatRow': Called right before the end of
2138 UsersPager::formatRow().
2139 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2140 $row: Database row object
2142 'SpecialListusersHeader': Called before closing the <fieldset> in
2143 UsersPager::getPageHeader().
2144 $pager: The UsersPager instance
2145 $out: The header HTML
2147 'SpecialListusersHeaderForm': Called before adding the submit button in
2148 UsersPager::getPageHeader().
2149 $pager: The UsersPager instance
2150 $out: The header HTML
2152 'SpecialListusersQueryInfo': Called right before the end of.
2153 UsersPager::getQueryInfo()
2154 $pager: The UsersPager instance
2155 $query: The query array to be returned
2157 'SpecialMovepageAfterMove': Called after moving a page.
2158 $movePage: MovePageForm object
2159 $oldTitle: old title (object)
2160 $newTitle: new title (object)
2162 'SpecialNewpagesConditions': Called when building sql query for
2163 Special:NewPages.
2164 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2165 $opts: FormOptions object containing special page options
2166 &$conds: array of WHERE conditionals for query
2167 &tables: array of tables to be queried
2168 &$fields: array of columns to select
2169 &$join_conds: join conditions for the tables
2171 'SpecialNewPagesFilters': Called after building form options at NewPages.
2172 $special: the special page object
2173 &$filters: associative array of filter definitions. The keys are the HTML
2174   name/URL parameters. Each key maps to an associative array with a 'msg'
2175   (message key) and a 'default' value.
2177 'SpecialPage_initList': Called when setting up SpecialPage::$mList, use this
2178 hook to remove a core special page.
2179 $list: list (array) of core special pages
2181 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2182 $special: the SpecialPage object
2183 $subPage: the subpage string or null if no subpage was specified
2185 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2186 $special: the SpecialPage object
2187 $subPage: the subpage string or null if no subpage was specified
2189 'SpecialPasswordResetOnSubmit': When executing a form submission on
2190 Special:PasswordReset.
2191 $users: array of User objects.
2192 $data: array of data submitted by the user
2193 &$error: string, error code (message key) used to describe to error (out
2194   parameter). The hook needs to return false when setting this, otherwise it
2195   will have no effect.
2197 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2198 use this to change some selection criteria or substitute a different title.
2199 &$randstr: The random number from wfRandom()
2200 &$isRedir: Boolean, whether to select a redirect or non-redirect
2201 &$namespaces: An array of namespace indexes to get the title from
2202 &$extra: An array of extra SQL statements
2203 &$title: If the hook returns false, a Title object to use instead of the
2204   result from the normal query
2206 'SpecialRecentChangesFilters': Called after building form options at
2207 RecentChanges.
2208 $special: the special page object
2209 &$filters: associative array of filter definitions. The keys are the HTML
2210   name/URL parameters. Each key maps to an associative array with a 'msg'
2211   (message key) and a 'default' value.
2213 'SpecialRecentChangesPanel': Called when building form options in
2214 SpecialRecentChanges.
2215 &$extraOpts: array of added items, to which can be added
2216 $opts: FormOptions for this request
2218 'SpecialRecentChangesQuery': Called when building SQL query for
2219 SpecialRecentChanges and SpecialRecentChangesLinked.
2220 &$conds: array of WHERE conditionals for query
2221 &$tables: array of tables to be queried
2222 &$join_conds: join conditions for the tables
2223 $opts: FormOptions for this request
2224 &$query_options: array of options for the database request
2225 &$select: Array of columns to select
2227 'SpecialSearchCreateLink': Called when making the message to create a page or
2228 go to the existing page.
2229 $t: title object searched for
2230 &$params: an array of the default message name and page title (as parameter)
2232 'SpecialSearchGo': Called when user clicked the "Go".
2233 &$title: title object generated from the text entered by the user
2234 &$term: the search term entered by the user
2236 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2237 target doesn't exist.
2238 &$title: title object generated from the text entered by the user
2240 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2241 the advanced form, a.k.a. power search box.
2242 &$showSections: an array to add values with more options to
2243 $term: the search term (not a title object)
2244 $opts: an array of hidden options (containing 'redirs' and 'profile')
2246 'SpecialSearchProfiles': Allows modification of search profiles.
2247 &$profiles: profiles, which can be modified.
2249 'SpecialSearchProfileForm': Allows modification of search profile forms.
2250 $search: special page object
2251 &$form: String: form html
2252 $profile: String: current search profile
2253 $term: String: search term
2254 $opts: Array: key => value of hidden options for inclusion in custom forms
2256 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2257 $search: SpecialSearch special page object
2258 $profile: String: current search profile
2259 $engine: the search engine
2261 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2262 on the search results page.  Useful for including an external search
2263 provider.  To disable the output of MediaWiki search output, return
2264 false.
2265 $specialSearch: SpecialSearch object ($this)
2266 $output: $wgOut
2267 $term: Search term specified by the user
2269 'SpecialSearchResultsAppend': Called after all search results HTML has
2270 been output.  Note that in some cases, this hook will not be called (no
2271 results, too many results, SpecialSearchResultsPrepend returned false,
2272 etc).
2273 $specialSearch: SpecialSearch object ($this)
2274 $output: $wgOut
2275 $term: Search term specified by the user
2277 'SpecialSearchResults': Called before search result display when there are
2278 matches.
2279 $term: string of search term
2280 &$titleMatches: empty or SearchResultSet object
2281 &$textMatches: empty or SearchResultSet object
2283 'SpecialSearchNoResults': Called before search result display when there are no
2284 matches.
2285 $term: string of search term
2287 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2288 &$extraStats: Array to save the new stats
2289   ( $extraStats['<name of statistic>'] => <value>; )
2291 'SpecialUploadComplete': Called after successfully uploading a file from
2292 Special:Upload.
2293 $form: The SpecialUpload object
2295 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2296 use this to change the tables headers.
2297 $extTypes: associative array of extensions types
2299 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2300 $wgVersion: Current $wgVersion for you to use
2301 &$versionUrl: Raw url to link to (eg: release notes)
2303 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2304 $special: the special page object
2305 &$filters: associative array of filter definitions. The keys are the HTML
2306   name/URL parameters. Each key maps to an associative array with a 'msg'
2307   (message key) and a 'default' value.
2309 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2310 &$conds: array of WHERE conditionals for query
2311 &$tables: array of tables to be queried
2312 &$join_conds: join conditions for the tables
2313 &$fields: array of query fields
2314 $values: array of variables with watchlist options
2316 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2317 URL for a title when we have no other parameters on the URL. Gives a chance for
2318 extensions that alter page view behavior radically to abort that redirect or
2319 handle it manually.
2320 $request: WebRequest
2321 $title: Title of the currently found title obj
2322 $output: OutputPage object
2324 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2325 rendered (by ThumbnailImage:toHtml method).
2326 $thumbnail: the ThumbnailImage object
2327 &$attribs: image attribute array
2328 &$linkAttribs: image link attribute array
2330 'TitleArrayFromResult': Called when creating an TitleArray object from a
2331 database result.
2332 &$titleArray: set this to an object to override the default object returned
2333 $res: database result used to create the object
2335 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2336 that can be applied.
2337 $title: The title in question.
2338 &$types: The types of protection available.
2340 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2341 $title: Title object that is being checked
2342 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2343   Hooks may change this value to override the return value of
2344   Title::isCssOrJsPage().
2346 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2347 overriding default behavior for determining if a page exists. If $isKnown is
2348 kept as null, regular checks happen. If it's a boolean, this value is returned
2349 by the isKnown method.
2350 $title: Title object that is being checked
2351 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2353 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2354 that this hook is not called for interwiki pages or pages in immovable
2355 namespaces: for these, isMovable() always returns false.
2356 $title: Title object that is being checked
2357 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2358   Hooks may change this value to override the return value of
2359   Title::isMovable().
2361 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2362 be handled by separate handler (via ArticleViewCustom).
2363 $title: Title object that is being checked
2364 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2365   Hooks may change this value to override the return value of
2366   Title::isWikitextPage()
2368 'TitleMoveComplete': After moving an article (title).
2369 $old: old title
2370 $nt: new title
2371 $user: user who did the move
2372 $pageid: database ID of the page that's been moved
2373 $redirid: database ID of the created redirect
2375 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2376 adding the default error message if nothing allows the user to read the page. If
2377 a handler wants a title to *not* be whitelisted, it should also return false.
2378 $title: Title object being checked against
2379 $user: Current user object
2380 &$whitelisted: Boolean value of whether this title is whitelisted
2382 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2383 $this: Title object to purge
2384 &$urls: An array of URLs to purge from the caches, to be manipulated.
2386 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2387 PageArchive object has been created but before any further processing is done.
2388 &$archive: PageArchive object
2389 $title: Title object of the page that we're viewing
2391 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2392 PageArchive object has been created but before any further processing is done.
2393 &$archive: PageArchive object
2394 $title: Title object of the page that we're viewing
2396 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2397 the site is not in read-only mode, that the Title object is not null and after
2398 a PageArchive object has been constructed but before performing any further
2399 processing.
2400 &$archive: PageArchive object
2401 $title: Title object of the page that we're about to undelete
2403 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2404 $title: title object related to the revision
2405 $rev: revision (object) that will be viewed
2407 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2408 actions).
2409 $action: action name
2410 $article: article "acted on"
2412 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2413 &$files: list of files
2415 'UnwatchArticle': Before a watch is removed from an article.
2416 $user: user watching
2417 $page: WikiPage object to be removed
2419 'UnwatchArticleComplete': After a watch is removed from an article.
2420 $user: user that watched
2421 $page: WikiPage object that was watched
2423 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2424 $formattedPageStatus: list of valid page states
2426 'UploadForm:initial': Before the upload form is generated. You might set the
2427 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2428 text (HTML) either before or after the editform.
2429 $form: UploadForm object
2431 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2432 poke at member variables like $mUploadDescription before the file is saved. Do
2433 not use this hook to break upload processing. This will return the user to a
2434 blank form with no error message; use UploadVerification and UploadVerifyFile
2435 instead.
2436 $form: UploadForm object
2438 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2439 $type: (string) the requested upload type
2440 &$className: the class name of the Upload instance to be created
2442 'UploadComplete': when Upload completes an upload.
2443 &$upload: an UploadBase child instance
2445 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2446 assembled.
2447 $descriptor: (array) the HTMLForm descriptor
2449 'UploadFormSourceDescriptors': after the standard source inputs have been
2450 added to the descriptor
2451 $descriptor: (array) the HTMLForm descriptor
2453 'UploadVerification': Additional chances to reject an uploaded file. Consider
2454 using UploadVerifyFile instead.
2455 string $saveName: destination file name
2456 string $tempName: filesystem path to the temporary file for checks
2457 string &$error: output: message key for message to show if upload canceled by
2458   returning false. May also be an array, where the first element is the message
2459   key and the remaining elements are used as parameters to the message.
2461 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2462 in most cases over UploadVerification.
2463 object $upload: an instance of UploadBase, with all info about the upload
2464 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2465   will typically only apply for specific mime types.
2466 object &$error: output: true if the file is valid. Otherwise, an indexed array
2467   representing the problem with the file, where the first element is the message
2468   key and the remaining elements are used as parameters to the message.
2470 'UploadComplete': Upon completion of a file upload.
2471 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2472   $uploadBase->getLocalFile().
2474 'User::mailPasswordInternal': before creation and mailing of a user's new
2475 temporary password
2476 $user: the user who sent the message out
2477 $ip: IP of the user who sent the message out
2478 $u: the account whose new password will be set
2480 'UserAddGroup': Called when adding a group; return false to override
2481 stock group addition.
2482 $user: the user object that is to have a group added
2483 &$group: the group to add, can be modified
2485 'UserArrayFromResult': Called when creating an UserArray object from a database
2486 result.
2487 &$userArray: set this to an object to override the default object returned
2488 $res: database result used to create the object
2490 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2491 want to display an error message, try getUserPermissionsErrors.
2492 $title: Title object being checked against
2493 $user : Current user object
2494 $action: Action being checked
2495 $result: Pointer to result returned if hook returns false. If null is returned,
2496   userCan checks are continued by internal code.
2498 'UserCanSendEmail': To override User::canSendEmail() permission check.
2499 $user: User (object) whose permission is being checked
2500 &$canSend: bool set on input, can override on output
2502 'UserClearNewTalkNotification': Called when clearing the "You have new
2503 messages!" message, return false to not delete it.
2504 $user: User (object) that will clear the message
2506 'UserComparePasswords': Called when checking passwords, return false to
2507 override the default password checks.
2508 &$hash: String of the password hash (from the database)
2509 &$password: String of the plaintext password the user entered
2510 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2511   supplied
2512 &$result: If the hook returns false, this Boolean value will be checked to
2513   determine if the password was valid
2515 'UserCreateForm': change to manipulate the login form
2516 $template: SimpleTemplate instance for the form
2518 'UserCryptPassword': Called when hashing a password, return false to implement
2519 your own hashing method.
2520 &$password: String of the plaintext password to encrypt
2521 &$salt: String of the password salt or Boolean false if no salt is provided
2522 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2523   method
2524 &$hash: If the hook returns false, this String will be used as the hash
2526 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2527 $user: User to get groups for
2528 &$groups: Current effective groups
2530 'UserGetAllRights': After calculating a list of all available rights.
2531 &$rights: Array of rights, which may be added to.
2533 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2534 before returning the options to the caller. Warning: This hook is called for
2535 every call to User::getDefaultOptions(), which means it's potentially called
2536 dozens or hundreds of times. You may want to cache the results of non-trivial
2537 operations in your hook function for this reason.
2538 &$defaultOptions: Array of preference keys and their default values.
2540 'UserGetEmail': Called when getting an user email address.
2541 $user: User object
2542 &$email: email, change this to override local email
2544 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2545 email authentication.
2546 $user: User object
2547 &$timestamp: timestamp, change this to override local email authentication
2548   timestamp
2550 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2551 &$groups: List of implicit (automatically-assigned) groups
2553 'UserGetLanguageObject': Called when getting user's interface language object.
2554 $user: User object
2555 &$code: Language code that will be used to create the object
2556 $context: RequestContext object
2558 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2559 &$reservedUsernames: $wgReservedUsernames
2561 'UserGetRights': Called in User::getRights().
2562 $user: User to get rights for
2563 &$rights: Current rights
2565 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2566 specific block exemptions).
2567 $user: User in question
2568 $title: Title of the page in question
2569 &$blocked: Out-param, whether or not the user is blocked from that page.
2570 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2571   to edit their own user talk pages.
2573 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2574 &$user: User object
2575 $ip: User's IP address
2576 &$blocked: Whether the user is blocked, to be modified by the hook
2578 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2579 environmental means; occurs after session is loaded.
2580 $user: user object being loaded
2582 'UserLoadDefaults': Called when loading a default user.
2583 $user: user object
2584 $name: user name
2586 'UserLoadFromDatabase': Called when loading a user from the database.
2587 $user: user object
2588 &$s: database query object
2590 'UserLoadFromSession': Called to authenticate users on external/environmental
2591 means; occurs before session is loaded.
2592 $user: user object being loaded
2593 &$result: set this to a boolean value to abort the normal authentication
2594   process
2596 'UserLoadOptions': When user options/preferences are being loaded from the
2597 database.
2598 $user: User object
2599 &$options: Options, can be modified.
2601 'UserLoginComplete': After a user has logged in.
2602 $user: the user object that was created on login
2603 $inject_html: Any HTML to inject after the "logged in" message.
2605 'UserLoginForm': change to manipulate the login form
2606 $template: SimpleTemplate instance for the form
2608 'UserLogout': Before a user logs out.
2609 $user: the user object that is about to be logged out
2611 'UserLogoutComplete': After a user has logged out.
2612 $user: the user object _after_ logout (won't have name, ID, etc.)
2613 $inject_html: Any HTML to inject after the "logged out" message.
2614 $oldName: name of the user before logout (string)
2616 'UserRemoveGroup': Called when removing a group; return false to override stock
2617 group removal.
2618 $user: the user object that is to have a group removed
2619 &$group: the group to be removed, can be modified
2621 'UserRights': After a user's group memberships are changed.
2622 $user  : User object that was changed
2623 $add   : Array of strings corresponding to groups added
2624 $remove: Array of strings corresponding to groups removed
2626 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2627 message(s).
2628 $user: user retrieving new talks messages
2629 $talks: array of new talks page(s)
2631 'UserSaveSettings': Called when saving user settings.
2632 $user: User object
2634 'UserSaveOptions': Called just before saving user preferences/options.
2635 $user: User object
2636 &$options: Options, modifiable
2638 'UserSetCookies': Called when setting user cookies.
2639 $user: User object
2640 &$session: session array, will be added to $_SESSION
2641 &$cookies: cookies array mapping cookie name to its value
2643 'UserSetEmail': Called when changing user email address.
2644 $user: User object
2645 &$email: new email, change this to override new email address
2647 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2648 email authentication.
2649 $user: User object
2650 &$timestamp: new timestamp, change this to override local email
2651 authentication timestamp
2653 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2654 "Foobar (Talk | Contribs | Block)".
2655 $userId: User id of the current user
2656 $userText: User name of the current user
2657 &$items: Array of user tool links as HTML fragments
2659 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2660 used to alter the SQL query which gets the list of wanted pages.
2661 &$wantedPages: WantedPagesPage object
2662 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2664 'WatchArticle': Before a watch is added to an article.
2665 $user: user that will watch
2666 $page: WikiPage object to be watched
2668 'WatchArticleComplete': After a watch is added to an article.
2669 $user: user that watched
2670 $page: WikiPage object watched
2672 'WatchlistEditorBuildRemoveLine': when building remove lines in
2673 Special:Watchlist/edit.
2674 &$tools: array of extra links
2675 $title: Title object
2676 $redirect: whether the page is a redirect
2677 $skin: Skin object
2679 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2680 REQUEST_URI.
2681 $router: The PathRouter instance
2683 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2684 dumps. One, and only one hook should set this, and return false.
2685 &$tables: Database tables to use in the SELECT query
2686 &$opts: Options to use for the query
2687 &$join: Join conditions
2689 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2690 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2691 specific to a content model should be provided by the respective Content's
2692 getDeletionUpdates() method.
2693 $page: the WikiPage
2694 $content: the Content to generate updates for
2695 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2697 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2698 run a MediaWiki cli script.
2699 &$script: MediaWiki cli script path
2700 &$parameters: Array of arguments and options to the script
2701 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2702   keys
2704 'wgQueryPages': Called when initialising $wgQueryPages, use this to add new
2705 query pages to be updated with maintenance/updateSpecialPages.php.
2706 $query: $wgQueryPages itself
2708 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2709 extra metadata to be added.
2710 $obj: The XmlDumpWriter object.
2711 &$out: The output string.
2712 $row: The database row for the page.
2713 $title: The title of the page.
2715 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2716 add extra metadata.
2717 $obj: The XmlDumpWriter object.
2718 &$out: The text being output.
2719 $row: The database row for the revision.
2720 $text: The revision text.
2722 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2723 to add additional tags to extract.
2724 &$items: Array containing information on which items to extract. See XMPInfo for
2725   details on the format.
2727 'XMPGetResults': Called just before returning the results array of parsing xmp
2728 data. Can be used to post-process the results.
2729 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2730   is an array of metadata tags returned (each tag is either a value, or an array
2731   of values).
2733 More hooks might be available but undocumented, you can execute
2734 'php maintenance/findHooks.php' to find hidden ones.