[Summary view] [Print] [Text view]

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