3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252 default is LoginForm::ABORTED. Note that the client may be using
253 a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
256 'AbortMove': allows to abort moving an article (title)
259 $user: user who is doing the move
261 $reason: the reason for the move (added in 1.13)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: name of error message to display on abort
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273 allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
293 'AlternateEdit': before checking if an user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
296 $EditPage: the EditPage object
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or PHP's mail().
300 Return false to skip the regular method of sending mail. Return a
301 string to return a php-mail-error message containing the error.
302 Returning true will continue with sending email in the regular way.
303 $headers: Associative array of headers for the email
304 $to: MailAddress object or array
306 $subject: Subject of the email
307 $body: Body of the message
309 'APIAfterExecute': after calling the execute() method of an API module.
310 Use this to extend core API modules.
311 &$module: Module object
313 'APIEditBeforeSave': before saving a page with api.php?action=edit,
314 after processing request parameters. Return false to let the request
315 fail, returning an error message or an <edit result="Failure"> tag
316 if $resultArr was filled.
317 $EditPage : the EditPage object
318 $text : the new text of the article (has yet to be saved)
319 &$resultArr : data in this array will be added to the API result
321 'APIGetAllowedParams': use this hook to modify a module's parameters.
322 &$module: Module object
323 &$params: Array of parameters
325 'APIGetParamDescription': use this hook to modify a module's parameter
327 &$module: Module object
328 &$desc: Array of parameter descriptions
330 'APIQueryAfterExecute': after calling the execute() method of an
331 action=query submodule. Use this to extend core API modules.
332 &$module: Module object
334 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
335 method of an action=query submodule. Use this to extend core API modules.
336 &$module: Module object
337 &$resultPageSet: ApiPageSet object
339 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
340 Every token has an action, which will be used in the intoken parameter
341 and in the output (actiontoken="..."), and a callback function which
342 should return the token, or false if the user isn't allowed to obtain
343 it. The prototype of the callback function is func($pageid, $title)
344 where $pageid is the page ID of the page the token is requested for
345 and $title is the associated Title object. In the hook, just add
346 your callback to the $tokenFunctions array and return true (returning
347 false makes no sense)
348 $tokenFunctions: array(action => callback)
350 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
351 Every token has an action, which will be used in the rvtoken parameter
352 and in the output (actiontoken="..."), and a callback function which
353 should return the token, or false if the user isn't allowed to obtain
354 it. The prototype of the callback function is func($pageid, $title, $rev)
355 where $pageid is the page ID of the page associated to the revision the
356 token is requested for, $title the associated Title object and $rev the
357 associated Revision object. In the hook, just add your callback to the
358 $tokenFunctions array and return true (returning false makes no sense)
359 $tokenFunctions: array(action => callback)
361 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
363 Every token has an action, which will be used in the rctoken parameter
364 and in the output (actiontoken="..."), and a callback function which
365 should return the token, or false if the user isn't allowed to obtain
366 it. The prototype of the callback function is func($pageid, $title, $rc)
367 where $pageid is the page ID of the page associated to the revision the
368 token is requested for, $title the associated Title object and $rc the
369 associated RecentChange object. In the hook, just add your callback to the
370 $tokenFunctions array and return true (returning false makes no sense)
371 $tokenFunctions: array(action => callback)
373 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
374 the sites general information.
375 $module: the current ApiQuerySiteInfo module
376 &$results: array of results, add things here
378 'APIQueryUsersTokens': use this hook to add custom token to list=users.
379 Every token has an action, which will be used in the ustoken parameter
380 and in the output (actiontoken="..."), and a callback function which
381 should return the token, or false if the user isn't allowed to obtain
382 it. The prototype of the callback function is func($user) where $user
383 is the User object. In the hook, just add your callback to the
384 $tokenFunctions array and return true (returning false makes no sense)
385 $tokenFunctions: array(action => callback)
387 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
388 Each service should have its own entry in the $apis array and have a
389 unique name, passed as key for the array that represents the service data.
390 In this data array, the key-value-pair identified by the apiLink key is
392 &$apis: array of services
394 'ArticleAfterFetchContent': after fetching content of an article from
396 $article: the article (object) being loaded from the database
397 $content: the content (string) of the article
399 'ArticleConfirmDelete': before writing the confirmation form for article
401 $article: the article (object) being deleted
402 $output: the OutputPage object ($wgOut)
403 &$reason: the reason (string) the article is being deleted
405 'ArticleContentOnDiff': before showing the article content below a diff.
406 Use this to change the content in this area or how it is loaded.
407 $diffEngine: the DifferenceEngine
408 $output: the OutputPage object ($wgOut)
410 'ArticleDelete': before an article is deleted
411 $article: the WikiPage (object) being deleted
412 $user: the user (object) deleting the article
413 $reason: the reason (string) the article is being deleted
414 $error: if the deletion was prohibited, the (raw HTML) error message to display
417 'ArticleDeleteComplete': after an article is deleted
418 $article: the WikiPage that was deleted
419 $user: the user that deleted the article
420 $reason: the reason the article was deleted
421 $id: id of the article that was deleted
423 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
425 $article: WikiPage (object) of the user talk page
427 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
428 article has been changed
429 $article: the WikiPage (object)
430 $editInfo: data holder that includes the parser output ($editInfo->output) for
431 that page after the change
432 $changed: bool for if the page was changed
434 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
435 recentchanges table, return false to not delete old entries
436 $article: WikiPage (object) being modified
438 'ArticleFromTitle': when creating an article object from a title object using
439 Wiki::articleFromTitle()
440 $title: title (object) used to create the article object
441 $article: article (object) that will be returned
443 'ArticleInsertComplete': After a new article is created
444 $article: WikiPage created
445 $user: User creating the article
447 $summary: Edit summary/comment
448 $isMinor: Whether or not the edit was marked as minor
449 $isWatch: (No longer used)
450 $section: (No longer used)
451 $flags: Flags passed to Article::doEdit()
452 $revision: New Revision of the article
454 'ArticleMergeComplete': after merging to article using Special:Mergehistory
455 $targetTitle: target title (object)
456 $destTitle: destination title (object)
458 'ArticlePageDataAfter': after loading data of an article from the database
459 $article: WikiPage (object) whose data were loaded
460 $row: row (object) returned from the database server
462 'ArticlePageDataBefore': before loading data of an article from the database
463 $article: WikiPage (object) that data will be loaded
464 $fields: fileds (array) to load from the database
466 'ArticlePrepareTextForEdit': called when preparing text to be saved
467 $article: the WikiPage being saved
468 $popts: parser options to be used for pre-save transformation
470 'ArticleProtect': before an article is protected
471 $article: the WikiPage being protected
472 $user: the user doing the protection
473 $protect: boolean whether this is a protect or an unprotect
474 $reason: Reason for protect
475 $moveonly: boolean whether this is for move only or not
477 'ArticleProtectComplete': after an article is protected
478 $article: the WikiPage that was protected
479 $user: the user who did the protection
480 $protect: boolean whether it was a protect or an unprotect
481 $reason: Reason for protect
482 $moveonly: boolean whether it was for move only or not
484 'ArticlePurge': before executing "&action=purge"
485 $article: WikiPage (object) to purge
487 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
488 revision of an article
489 &$title: title object of the article
491 'ArticleRevisionUndeleted': after an article revision is restored
492 $title: the article title
493 $revision: the revision
494 $oldPageID: the page ID of the revision when archived (may be null)
496 'ArticleRollbackComplete': after an article rollback is completed
497 $article: the WikiPage that was edited
498 $user: the user who did the rollback
499 $revision: the revision the page was reverted back to
500 $current: the reverted revision
502 'ArticleSave': before an article is saved
503 $article: the WikiPage (object) being saved
504 $user: the user (object) saving the article
505 $text: the new article text
506 $summary: the article summary (comment)
511 'ArticleSaveComplete': After an article has been updated
512 $article: WikiPage modified
513 $user: User performing the modification
515 $summary: Edit summary/comment
516 $isMinor: Whether or not the edit was marked as minor
517 $isWatch: (No longer used)
518 $section: (No longer used)
519 $flags: Flags passed to Article::doEdit()
520 $revision: New Revision of the article
521 $baseRevId: the rev ID (or false) this edit was based on
523 'ArticleUndelete': When one or more revisions of an article are restored
524 $title: Title corresponding to the article restored
525 $create: Whether or not the restoration caused the page to be created
526 (i.e. it didn't exist before)
527 $comment: The comment associated with the undeletion.
529 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
530 before the user is redirected back to the page
531 &$article: the article
532 &$sectionanchor: The section anchor link (e.g. "#overview" )
533 &$extraq: Extra query parameters which can be added via hooked functions
535 'ArticleViewFooter': After showing the footer section of an ordinary page view
536 $article: Article object
538 'ArticleViewHeader': Before the parser cache is about to be tried for article
540 &$article: the article
541 &$pcache: whether to try the parser cache or not
542 &$outputDone: whether the output for this page finished or not
544 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
546 $article: target article (object)
548 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext
549 $text: text of the page
550 $title: title of the page
551 $output: reference to $wgOut
553 'AuthPluginAutoCreate': Called when creating a local account for an user logged
554 in from an external authentication method
555 $user: User object created locally
557 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
558 Gives a chance for an extension to set it programattically to a variable class.
559 &$auth: the $wgAuth object, probably a stub
561 'AutopromoteCondition': check autopromote condition for user.
562 $type: condition type
565 $result: result of checking autopromote condition
567 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
571 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
574 $title: title of the page to which backlinks are sought
575 &$conds: query conditions
577 'BadImage': When checking against the bad image list
578 $name: Image name being checked
579 &$bad: Whether or not the image is "bad"
581 Change $bad and return false to override. If an image is "bad", it is not
582 rendered inline in wiki pages or galleries in category pages.
584 'BeforeInitialize': before anything is initialized in performRequestForTitle()
585 &$title: Title being used for request
586 &$article: The associated Article object
587 &$output: OutputPage object
589 $request: WebRequest object
590 $mediaWiki: Mediawiki object
592 'BeforePageDisplay': Prior to outputting a page
593 &$out: OutputPage object
596 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
597 $parser: Parser object
599 &$time: the image timestamp (use '0' to force a broken thumbnail)
600 &$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set)
601 &$descQuery: query string to add to thumbnail URL
603 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
604 $parser: Parser object
605 $title: title of the template
606 &$skip: skip this template and link it?
607 &$id: the id of the revision being parsed
609 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
610 &$parser: Parser object
611 &$ig: ImageGallery object
613 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
614 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
615 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
617 'BitmapHandlerTransform': before a file is transformed, gives extension the
618 possibility to transform it themselves
619 $handler: BitmapHandler
621 &$scalerParams: Array with scaler parameters
622 &$mto: null, set to a MediaTransformOutput
624 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
625 $block: Block object (which is set to be autoblocking)
626 &$blockIds: Array of block IDs of the autoblock
628 'BlockIp': before an IP address or user is blocked
629 $block: the Block object about to be saved
630 $user: the user _doing_ the block (not the one being blocked)
632 'BlockIpComplete': after an IP address or user is blocked
633 $block: the Block object that was saved
634 $user: the user who did the block (not the one being blocked)
636 'BookInformation': Before information output on Special:Booksources
637 $isbn: ISBN to show information for
638 $output: OutputPage object in use
640 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
641 &$namespaces: Array of namespace numbers with corresponding canonical names
643 'CategoryPageView': before viewing a categorypage in CategoryPage::view
644 $catpage: CategoryPage instance
646 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
647 &$changesList: ChangesList instance.
648 &$articlelink: HTML of link to article (already filled-in).
649 &$s: HTML of row that is being constructed.
650 &$rc: RecentChange instance.
651 $unpatrolled: Whether or not we are showing unpatrolled changes.
652 $watched: Whether or not the change is watched by the user.
654 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
655 $collationName: Name of the collation in question
656 &$collationObject: Null. Replace with a subclass of the Collation class that implements
657 the collation given in $collationName.
659 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
660 $user: user (object) whose email is being confirmed
662 'ContribsPager::getQueryInfo': Before the contributions query is about to run
663 &$pager: Pager object for contributions
664 &queryInfo: The query for the contribs Pager
666 'ContributionsLineEnding': Called before a contributions HTML line is finished
667 $page: SpecialPage object for contributions
669 $row: the DB row for this line
671 'ContributionsToolLinks': Change tool links above Special:Contributions
673 $title: User page title
674 &$tools: Array of tool links
676 'CustomEditor': When invoking the page editor
677 $article: Article being edited
678 $user: User performing the edit
680 Return true to allow the normal editor to be used, or false
681 if implementing a custom editor, e.g. for a special namespace,
684 'DatabaseOraclePostInit': Called after initialising an Oracle database
685 &$db: the DatabaseOracle object
687 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
688 $text: plaintext string to be output
689 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
691 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
692 $title: the diff page title (nullable)
693 &$oldId: the actual old Id to use in the diff
694 &$newId: the actual new Id to use in the diff (0 means current)
695 $old: the ?old= param value from the url
696 $new: the ?new= param value from the url
698 'DiffViewHeader': called before diff display
699 $diff: DifferenceEngine object that's calling
700 $oldRev: Revision object of the "old" revision (may be null/invalid)
701 $newRev: Revision object of the "new" revision
703 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
705 $article: article (object) being viewed
706 $oldid: oldid (int) being viewed
708 'DoEditSectionLink': Override the HTML generated for section edit links
709 $skin: Skin object rendering the UI
710 $title: Title object for the title being linked to (may not be the same as
711 $wgTitle, if the section is included from a template)
712 $section: The designation of the section being pointed to, to be included in
713 the link, like "§ion=$section"
714 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
715 By default, this is wrapped in the 'editsectionhint' message.
716 &$result: The HTML to return, prefilled with the default plus whatever other
717 changes earlier hooks have made
718 $lang: The language code to use for the link in the wfMsg* functions
720 'EditFilter': Perform checks on an edit
721 $editor: Edit form (see includes/EditPage.php)
722 $text: Contents of the edit box
723 $section: Section being edited
724 &$error: Error message to return
725 $summary: Edit summary for page
727 'EditFilterMerged': Post-section-merge edit filter
728 $editor: EditPage instance (object)
729 $text: content of the edit box
730 &$error: error message to return
731 $summary: Edit summary for page
733 'EditFormPreloadText': Allows population of the edit form when creating
735 &$text: Text to preload with
736 &$title: Title object representing the page being created
738 'EditFormInitialText': Allows modifying the edit form when editing existing
740 $editPage: EditPage object
742 'EditPage::attemptSave': called before an article is
743 saved, that is before Article::doEdit() is called
744 $editpage_Obj: the current EditPage object
746 'EditPage::importFormData': allow extensions to read additional data
748 $editpage: EditPage instance
750 return value is ignored (should always return true)
752 'EditPage::showEditForm:fields': allows injection of form field into edit form
753 &$editor: the EditPage instance for reference
754 &$out: an OutputPage instance to write to
755 return value is ignored (should always return true)
757 'EditPage::showEditForm:initial': before showing the edit form
758 $editor: EditPage instance (object)
760 Return false to halt editing; you'll need to handle error messages, etc.
761 yourself. Alternatively, modifying $error and returning true will cause the
762 contents of $error to be echoed at the top of the edit form as wikitext.
763 Return true without altering $error to allow the edit to proceed.
765 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
766 when there's an edit conflict. Return false to halt normal diff output; in
767 this case you're responsible for computing and outputting the entire "conflict"
768 part, i.e., the "difference between revisions" and "your text" headers and
770 &$editor: EditPage instance
771 &$out: OutputPage instance
773 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
774 textarea in the edit form
775 &$editpage: The current EditPage object
776 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
777 &$tabindex: HTML tabindex of the last edit check/button
779 'EditPageBeforeEditChecks': allows modifying the edit checks below the
780 textarea in the edit form
781 &$editpage: The current EditPage object
782 &$checks: Array of edit checks like "watch this page"/"minor edit"
783 &$tabindex: HTML tabindex of the last edit check/button
785 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
786 textarea in the edit form
787 &$toolbar: The toolbar HTMl
789 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
790 $title: title of page being edited
791 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
793 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
795 $editPage: EditPage object
796 &$newtext: wikitext that will be used as "your version"
798 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
799 $editPage: EditPage object
800 &$toparse: wikitext that will be parsed
802 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
803 &$editpage: The current EditPage object
804 &$res: the HTML of the error text
806 'EditPageTosSummary': Give a chance for site and per-namespace customizations
807 of terms of service summary link that might exist separately from the copyright
809 $title: title of page being edited
810 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
812 'EditSectionLink': Do not use, use DoEditSectionLink instead.
813 $skin: Skin rendering the UI
814 $title: Title being linked to
815 $section: Section to link to
817 &$result: Result (alter this to override the generated links)
818 $lang: The language code to use for the link in the wfMsg* functions
820 'EmailConfirmed': When checking that the user's email address is "confirmed"
821 $user: User being checked
822 $confirmed: Whether or not the email address is confirmed
823 This runs before the other checks, such as anonymity and the real check; return
824 true to allow those checks to occur, and false if checking is done.
826 'EmailUser': before sending email from one user to another
827 $to: address of receiving user
828 $from: address of sending user
829 $subject: subject of the mail
830 $text: text of the mail
832 'EmailUserCC': before sending the copy of the email to the author
833 $to: address of receiving user
834 $from: address of sending user
835 $subject: subject of the mail
836 $text: text of the mail
838 'EmailUserComplete': after sending email from one user to another
839 $to: address of receiving user
840 $from: address of sending user
841 $subject: subject of the mail
842 $text: text of the mail
844 'EmailUserForm': after building the email user form object
845 $form: HTMLForm object
847 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
848 $user: The user who is trying to email another user.
849 $editToken: The user's edit token.
850 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
852 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
853 &$extTypes: associative array of extensions types
855 'FetchChangesList': When fetching the ChangesList derivative for
857 $user: User the list is being fetched for
858 &$skin: Skin object to be used with the list
859 &$list: List object (defaults to NULL, change it to an object
860 instance and return false override the list derivative used)
862 'FileDeleteComplete': When a file is deleted
863 $file: reference to the deleted file
864 $oldimage: in case of the deletion of an old image, the name of the old file
865 $article: in case all revisions of the file are deleted a reference to the
866 article associated with the file.
867 $user: user who performed the deletion
870 'FileUpload': When a file upload occurs
871 $file : Image object representing the file that was uploaded
872 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
873 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
875 'FileUndeleteComplete': When a file is undeleted
876 $title: title object to the file
877 $fileVersions: array of undeleted versions. Empty if all versions were restored
878 $user: user who performed the undeletion
881 'GetAutoPromoteGroups': When determining which autopromote groups a user
882 is entitled to be in.
883 &$user: user to promote.
884 &$promote: groups that will be added.
886 'GetBlockedStatus': after loading blocking status of an user from the database
887 $user: user (object) being checked
889 'GetCacheVaryCookies': get cookies that should vary cache options
890 $out: OutputPage object
891 &$cookies: array of cookies name, add a value to it if you want to add a cookie
892 that have to vary cache options
894 'GetDefaultSortkey': Override the default sortkey for a page.
895 $title: Title object that we need to get a sortkey for
896 &$sortkey: Sortkey to use.
898 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
899 $title: Title object of page
900 $url: string value as output (out parameter, can modify)
901 $query: query options passed to Title::getFullURL()
903 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
904 $title: Title object of page
905 $url: string value as output (out parameter, can modify)
906 $query: query options passed to Title::getInternalURL()
908 'GetIP': modify the ip of the current user (called only once)
909 &$ip: string holding the ip as determined so far
911 'GetLinkColours': modify the CSS class of an array of page links
912 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
914 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
916 'GetLocalURL': modify local URLs as output into page links. Note that if you
917 are working with internal urls (non-interwiki) then it may be preferable
918 to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
919 GetLocalURL can be buggy for internal urls on render if you do not
920 re-implement the horrible hack that Title::getLocalURL uses
921 in your own extension.
922 $title: Title object of page
923 &$url: string value as output (out parameter, can modify)
924 $query: query options passed to Title::getLocalURL()
925 $variant: variant options passed to Title::getLocalURL()
927 'GetLocalURL::Internal': modify local URLs to internal pages.
928 $title: Title object of page
929 &$url: string value as output (out parameter, can modify)
930 $query: query options passed to Title::getLocalURL()
931 $variant: variant options passed to Title::getLocalURL()
933 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
934 without any fancy queries or variants.
935 $title: Title object of page
936 &$url: string value as output (out parameter, can modify)
938 'GetMetadataVersion': modify the image metadata version currently in use. This is
939 used when requesting image metadata from a ForiegnApiRepo. Media handlers
940 that need to have versioned metadata should add an element to the end of
941 the version array of the form 'handler_name=version'. Most media handlers
942 won't need to do this unless they broke backwards compatibility with a
943 previous version of the media handler metadata output.
944 &$version: Array of version strings
946 'GetPreferences': modify user preferences
947 $user: User whose preferences are being modified.
948 &$preferences: Preferences description array, to be fed to an HTMLForm object
950 'getUserPermissionsErrors': Add a permissions error when permissions errors are
951 checked for. Use instead of userCan for most cases. Return false if the
952 user can't do it, and populate $result with the reason in the form of
953 array( messagename, param1, param2, ... ). For consistency, error messages
954 should be plain text with no special coloring, bolding, etc. to show that
955 they're errors; presenting them properly to the user as errors is done by
957 $title: Title object being checked against
958 $user : Current user object
959 $action: Action being checked
960 $result: User permissions error to add. If none, return true.
962 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
963 if expensive checks are enabled.
965 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
966 image insertion. You can skip the default logic entirely by returning
967 false, or just modify a few things using call-by-reference.
969 &$title: Title object of the image
970 &$file: File object, or false if it doesn't exist
971 &$frameParams: Various parameters with special meanings; see documentation in
972 includes/Linker.php for Linker::makeImageLink2
973 &$handlerParams: Various parameters with special meanings; see documentation in
974 includes/Linker.php for Linker::makeImageLink2
975 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
976 &$res: Final HTML output, used if you return false
979 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
980 the image on an image page
981 $imagePage: ImagePage object ($this)
984 'ImagePageAfterImageLinks': called after the image links section on an image
986 $imagePage: ImagePage object ($this)
987 &$html: HTML for the hook to add
989 'ImagePageFileHistoryLine': called when a file history line is contructed
991 $line: the HTML of the history line
992 $css: the line CSS class
994 'ImagePageFindFile': called when fetching the file associated with an image page
995 $page: ImagePage object
997 &$displayFile: displayed File object
999 'ImagePageShowTOC': called when the file toc on an image page is generated
1000 $page: ImagePage object
1001 &$toc: Array of <li> strings
1003 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1005 &$title: the Title object of the file as it would appear for the upload page
1006 &$path: the original file and path name when img_auth was invoked by the the web
1008 &$name: the name only component of the file
1009 &$result: The location to pass back results of the hook routine (only used if
1011 $result[0]=The index of the header message
1012 $result[1]=The index of the body text message
1013 $result[2 through n]=Parameters passed to body text message. Please note the
1014 header message cannot receive/use parameters.
1016 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1017 $reader: XMLReader object
1018 $logInfo: Array of information
1019 Return false to stop further processing of the tag
1021 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1022 $reader: XMLReader object
1023 $pageInfo: Array of information
1024 Return false to stop further processing of the tag
1026 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1027 $reader: XMLReader object
1028 $revInfo: Array of information
1029 Return false to stop further processing of the tag
1031 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1032 $reader: XMLReader object
1033 Return false to stop further processing of the tag
1035 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1036 $reader: XMLReader object
1037 $revisionInfo: Array of information
1038 Return false to stop further processing of the tag
1040 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1041 $title: Title object ($wgTitle)
1042 $request: WebRequest
1043 $ignoreRedirect: boolean to skip redirect check
1044 $target: Title/string of redirect target
1045 $article: Article object
1047 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1048 Return true without providing an interwiki to continue interwiki search.
1049 $prefix: interwiki prefix we are looking for.
1050 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1051 iw_trans and optionally iw_api and iw_wikiid.
1053 'InternalParseBeforeLinks': during Parser's internalParse method before links
1054 but after noinclude/includeonly/onlyinclude and other processing.
1055 &$parser: Parser object
1056 &$text: string containing partially parsed text
1057 &$stripState: Parser's internal StripState object
1059 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1060 $user: user (object) whose email is being invalidated
1062 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1063 $article: article (object) being checked
1065 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1067 $result: Change this value to override the result of wfIsTrustedProxy()
1069 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1070 tance to return false if the domain name doesn't match your organization
1071 $addr: The e-mail address entered by the user
1072 &$result: Set this and return false to override the internal checks
1074 'isValidPassword': Override the result of User::isValidPassword()
1075 $password: The password entered by the user
1076 &$result: Set this and return false to override the internal checks
1077 $user: User the password is being validated for
1079 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1080 $wgExtensionMessagesFiles instead.
1081 Use this to define synonyms of magic words depending of the language
1082 $magicExtensions: associative array of magic words synonyms
1083 $lang: laguage code (string)
1085 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1086 listed in $wgExtensionMessagesFiles instead.
1087 Use to define aliases of special pages names depending of the language
1088 $specialPageAliases: associative array of magic words synonyms
1089 $lang: laguage code (string)
1091 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1092 &$names: array of language code => language name
1093 $code language of the preferred translations
1095 'LinkBegin': Used when generating internal and interwiki links in
1096 Linker::link(), before processing starts. Return false to skip default proces-
1097 sing and return $ret. See documentation for Linker::link() for details on the
1098 expected meanings of parameters.
1099 $skin: the Skin object
1100 $target: the Title that the link is pointing to
1101 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1103 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1104 tive array form, with keys and values unescaped. Should be merged with de-
1105 fault values, with a value of false meaning to suppress the attribute.
1106 &$query: the query string to add to the generated URL (the bit after the "?"),
1107 in associative array form, with keys and values unescaped.
1108 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1109 &$ret: the value to return if your hook returns false.
1111 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1112 just before the function returns a value. If you return true, an <a> element
1113 with HTML attributes $attribs and contents $html will be returned. If you re-
1114 turn false, $ret will be returned.
1115 $skin: the Skin object
1116 $target: the Title object that the link is pointing to
1117 $options: the options. Will always include either 'known' or 'broken', and may
1118 include 'noclasses'.
1119 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1120 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1122 &$ret: the value to return if your hook returns false.
1124 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1126 &$url: the image url
1127 &$alt: the image's alt text
1128 &$img: the new image HTML (if returning false)
1130 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1133 &$text: the link text
1134 &$link: the new link HTML (if returning false)
1135 &$attribs: the attributes to be applied.
1136 $linkType: The external link type
1138 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1140 &$linksUpdate: the LinksUpdate object
1142 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1144 &$linksUpdate: the LinksUpdate object
1146 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1147 &$linksUpdate: the LinksUpdate object
1149 'ListDefinedTags': When trying to find all defined tags.
1150 &$tags: The list of tags.
1152 'LoadExtensionSchemaUpdates': called during database installation and updates
1153 &updater: A DatabaseUpdater subclass
1155 'LocalFile::getHistory': called before file history query performed
1158 $fields: select fields
1160 $opts: query options
1161 $join_conds: JOIN conditions
1163 'LocalisationCacheRecache': Called when loading the localisation data into cache
1164 $cache: The LocalisationCache object
1165 $code: language code
1166 &$alldata: The localisation data from core and extensions
1168 'LoginAuthenticateAudit': a login attempt for a valid user account either
1169 succeeded or failed. No return data is accepted; this hook is for auditing only.
1170 $user: the User object being authenticated against
1171 $password: the password being submitted and found wanting
1172 $retval: a LoginForm class constant with authenticateUserData() return
1173 value (SUCCESS, WRONG_PASS, etc)
1175 'LogLine': Processes a single log entry on Special:Log
1176 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1177 logging.log_type database field.
1178 $log_action: string for the type of log action (e.g. 'delete', 'block',
1179 'create2'). Corresponds to logging.log_action database field.
1180 $title: Title object that corresponds to logging.log_namespace and
1181 logging.log_title database fields.
1182 $paramArray: Array of parameters that corresponds to logging.log_params field.
1183 Note that only $paramArray[0] appears to contain anything.
1184 &$comment: string that corresponds to logging.log_comment database field, and
1185 which is displayed in the UI.
1186 &$revert: string that is displayed in the UI, similar to $comment.
1187 $time: timestamp of the log entry (added in 1.12)
1189 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1190 $refreshLinks: RefreshLinks object
1192 'MagicWordMagicWords': When defining new magic word.
1193 DEPRECATED: use $magicWords in a file listed in
1194 $wgExtensionMessagesFiles instead.
1195 $magicWords: array of strings
1197 'MagicWordwgVariableIDs': When definig new magic words IDs.
1198 $variableIDs: array of strings
1200 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1201 is executed. Ideally, this hook should only be used to add variables that
1202 depend on the current page/request; static configuration should be added
1203 through ResourceLoaderGetConfigVars instead.
1204 &$vars: variable (or multiple variables) to be added into the output
1205 of Skin::makeVariablesScript
1207 'MarkPatrolled': before an edit is marked patrolled
1208 $rcid: ID of the revision to be marked patrolled
1209 $user: the user (object) marking the revision as patrolled
1210 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1211 needs to be a sysop in order to mark an edit patrolled
1213 'MarkPatrolledComplete': after an edit is marked patrolled
1214 $rcid: ID of the revision marked as patrolled
1215 $user: user (object) who marked the edit patrolled
1216 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1217 must be a sysop to patrol the edit
1219 'MediaWikiPerformAction': Override MediaWiki::performAction().
1220 Use this to do something completely different, after the basic
1221 globals have been set up, but before ordinary actions take place.
1223 $article: $wgArticle
1226 $request: $wgRequest
1227 $mediaWiki: The $mediawiki object
1229 'MessagesPreLoad': When loading a message from the database
1230 $title: title of the message (string)
1231 $message: value (string), change it to the message you want to define
1233 'MessageCacheReplace': When a message page is changed.
1234 Useful for updating caches.
1235 $title: name of the page changed.
1236 $text: new contents of the page.
1238 'ModifyExportQuery': Modify the query used by the exporter.
1239 $db: The database object to be queried.
1240 &$tables: Tables in the query.
1241 &$conds: Conditions in the query.
1242 &$opts: Options for the query.
1243 &$join_conds: Join conditions for the query.
1245 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1246 been rendered (useful for adding more)
1247 Note: this is only run for the Monobook skin. This hook is deprecated and
1248 may be removed in the future. To add items to the toolbox you should use
1249 the SkinTemplateToolboxEnd hook instead, which works for all
1250 "SkinTemplate"-type skins.
1251 $tools: array of tools
1253 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1254 and returning it for the skin to output. You can add items to the toolbox while
1255 still letting the skin make final decisions on skin-specific markup conventions
1257 &$sk: The BaseTemplate base skin template
1258 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1259 BaseTemplate::makeListItem for details on the format of individual
1260 items inside of this array
1262 'NewRevisionFromEditComplete': called when a revision was inserted
1264 $article: the WikiPage edited
1265 $rev: the new revision
1266 $baseID: the revision ID this was based off, if any
1267 $user: the editing user
1269 'NormalizeMessageKey': Called before the software gets the text of a message
1270 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1272 &$key: the message being looked up. Change this to something else to change
1273 what message gets displayed (string)
1274 &$useDB: whether or not to look up the message in the database (bool)
1275 &$langCode: the language code to get the message for (string) - or -
1276 whether to use the content language (true) or site language (false) (bool)
1277 &$transform: whether or not to expand variables and templates
1278 in the message (bool)
1280 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1281 &$changeslist: The OldChangesList instance.
1282 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1283 &$rc: The RecentChange object.
1285 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1286 Hooks can alter or append to the array of URLs for search & suggestion formats.
1287 &$urls: array of associative arrays with Url element attributes
1289 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1290 users and/or IP addresses too
1291 $otherBlockLink: An array with links to other block logs
1292 $ip: The requested IP address or username
1294 'OutputPageBeforeHTML': a page has been processed by the parser and
1295 the resulting HTML is about to be displayed.
1296 $parserOutput: the parserOutput (object) that corresponds to the page
1297 $text: the text that will be displayed, in HTML (string)
1299 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1300 tag to allow for extensions to add attributes to the body of the page they might
1301 need. Or to allow building extensions to add body classes that aren't of high
1302 enough demand to be included in core.
1303 $out: The OutputPage which called the hook, can be used to get the real title
1304 $sk: The Skin that called OutputPage::headElement
1305 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1307 'OutputPageCheckLastModified': when checking if the page has been modified
1308 since the last visit
1309 &$modifiedTimes: array of timestamps.
1310 The following keys are set: page, user, epoch
1312 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1313 $out: OutputPage instance (object)
1314 $parserOutput: parserOutput instance being added in $out
1316 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1317 categories. Implementations should return false if they generate the category
1318 links, so the default link generation is skipped.
1319 $out: OutputPage instance (object)
1320 $categories: associative array, keys are category names, values are category
1321 types ("normal" or "hidden")
1322 $links: array, intended to hold the result. Must be an associative array with
1323 category types as keys and arrays of HTML links as values.
1325 'PageContentLanguage': allows changing the language in which the content of
1326 a page is written. Defaults to the wiki content language ($wgContLang).
1327 $title: Title object
1328 &$pageLang: the page content language (either an object or a language code)
1329 $wgLang: the user language
1331 'PageHistoryBeforeList': When a history page list is about to be constructed.
1332 $article: the article that the history is loading for
1334 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1335 $row: the revision row for this line
1336 $s: the string representing this parsed line
1337 $classes: array containing the <li> element classes
1339 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1342 $queryInfo: the query parameters
1344 'PageRenderingHash': alter the parser cache option hash key
1345 A parser extension which depends on user options should install
1346 this hook and append its values to the key.
1347 $hash: reference to a hash key string which can be modified
1349 'ParserAfterStrip': Same as ParserBeforeStrip
1351 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1352 $parser: Parser object being used
1353 $text: text that'll be returned
1355 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1356 $parser: Parser object
1357 $text: text to parse
1358 $stripState: StripState instance being used
1360 'ParserBeforeStrip': Called at start of parsing time
1361 (no more strip, deprecated ?)
1362 $parser: parser object
1363 $text: text being parsed
1364 $stripState: stripState used (object)
1366 'ParserBeforeTidy': called before tidy and custom tags replacements
1367 $parser: Parser object being used
1370 'ParserClearState': called at the end of Parser::clearState()
1371 $parser: Parser object being cleared
1373 'ParserFirstCallInit': called when the parser initialises for the first time
1374 &$parser: Parser object being cleared
1376 'ParserGetVariableValueSwitch': called when the parser need the value of a
1378 $parser: Parser object
1379 $varCache: array to store the value in case of multiples calls of the
1381 $index: index (string) of the magic
1382 $ret: value of the magic word (the hook should set it)
1383 $frame: PPFrame object to use for expanding any template variables
1385 'ParserGetVariableValueTs': use this to change the value of the time for the
1386 {{LOCAL...}} magic word
1387 $parser: Parser object
1388 $time: actual time (timestamp)
1390 'ParserGetVariableValueVarCache': use this to change the value of the
1391 variable cache or return false to not use it
1392 $parser: Parser object
1393 $varCache: varaiable cache (array)
1395 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1396 include comments about size of the text parsed
1397 $parser: Parser object
1398 $limitReport: text that will be included (without comment tags)
1400 'ParserMakeImageParams': Called before the parser make an image link, use this
1401 to modify the parameters of the image.
1402 $title: title object representing the file
1403 $file: file object that will be used to create the image
1404 &$params: 2-D array of parameters
1406 'ParserSectionCreate': Called each time the parser creates a document section
1407 from wikitext. Use this to apply per-section modifications to HTML (like
1408 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1409 can begin in one section and end in another. Make sure your code can handle
1410 that case gracefully. See the EditSectionClearerLink extension for an
1412 $parser: the calling Parser instance
1413 $section: the section number, zero-based, but section 0 is usually empty
1414 &$sectionContent: ref to the content of the section. modify this.
1415 $showEditLinks: boolean describing whether this section has an edit link
1417 'ParserTestParser': called when creating a new instance of Parser in
1418 maintenance/parserTests.inc
1419 $parser: Parser object created
1421 'ParserTestTables': alter the list of tables to duplicate when parser tests
1422 are run. Use when page save hooks require the presence of custom tables
1423 to ensure that tests continue to run properly.
1424 &$tables: array of table names
1426 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1427 my talk page, my contributions" etc).
1429 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1430 &$title: Title object representing the current page
1432 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1433 &$user : User performing the action
1434 $action : Action being performed
1435 &$result : Whether or not the action should be prevented
1436 Change $result and return false to give a definitive answer, otherwise
1437 the built-in rate limiting checks are used, if enabled.
1439 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1440 AJAX search suggestions. Put results into &$results outparam and return false.
1441 $ns : array of int namespace keys to search in
1442 $search : search term (not guaranteed to be conveniently normalized)
1443 $limit : maximum number of results to return
1444 &$results : out param: array of page names (strings)
1446 'PrefsEmailAudit': called when user changes his email address
1447 $user: User (object) changing his email address
1448 $oldaddr: old email address (string)
1449 $newaddr: new email address (string)
1451 'PrefsPasswordAudit': called when user changes his password
1452 $user: User (object) changing his passoword
1453 $newPass: new password
1454 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1456 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1457 $article: the title being (un)protected
1458 $output: a string of the form HTML so far
1460 'ProtectionForm::save': called when a protection form is submitted
1461 $article: the title being (un)protected
1462 $errorMsg: an html message string of an error
1464 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1465 $article: the page the form is shown for
1466 $out: OutputPage object
1468 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1469 loader request or generating HTML output.
1470 &$resourceLoader: ResourceLoader object
1472 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1473 to add modules to the startup module. This hook should be used sparingly since any module added here
1474 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1477 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1478 &$obj: RawPage object
1479 &$text: The text that's going to be the output
1481 'RecentChange_save': called at the end of RecentChange::save()
1482 $recentChange: RecentChange object
1484 'ResourceLoaderGetConfigVars': called at the end of
1485 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1486 configuration variables to JavaScript. Things that depend on the current
1487 page/request state must be added through MakeGlobalVariablesScript instead.
1488 &$vars: array( variable name => value )
1490 'RevisionInsertComplete': called after a revision is inserted into the DB
1491 &$revision: the Revision
1492 $data: the data stored in old_text. The meaning depends on $flags: if external
1493 is set, it's the URL of the revision text in external storage; otherwise,
1494 it's the revision text itself. In either case, if gzip is set, the revision
1496 $flags: a comma-delimited list of strings representing the options used. May
1497 include: utf8 (this will always be set for new revisions); gzip; external.
1499 'SearchUpdate': Prior to search update completion
1501 $namespace : Page namespace
1503 $text : Current text being indexed
1505 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1506 $allSearchTerms : Array of the search terms in all content languages
1507 &$titleResult : Outparam; the value to return. A Title object or null.
1509 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1510 $term : Search term string
1511 &$title : Outparam; set to $title object and return false for a match
1513 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1514 $term : Search term string
1515 &$title : Current Title object that is being returned (null if none found).
1517 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1518 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1519 in the $searchEngine->namespaces array.
1520 $query : Original query.
1521 &$parsed : Resultant query with the prefixes stripped.
1523 'SearchableNamespaces': An option to modify which namespaces are searchable.
1524 &$arr : Array of namespaces ($nsId => $name) which will be used.
1526 'SetupAfterCache': Called in Setup.php, after cache objects are set
1528 'ShowMissingArticle': Called when generating the output for a non-existent page
1529 $article: The article object corresponding to the page
1531 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1532 $text: Text being shown
1533 $title: Title of the custom script/stylesheet page
1534 $output: Current OutputPage object
1536 'ShowSearchHitTitle': Customise display of search hit title/link.
1537 &$title: Title to link to
1538 &$text: Text to use for the link
1539 $result: The search result
1540 $terms: The search terms entered
1541 $page: The SpecialSearch object.
1543 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1544 &$siteNotice: HTML returned as the sitenotice
1546 Return true to allow the normal method of notice selection/rendering to work,
1547 or change the value of $siteNotice and return false to alter it.
1549 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1550 &$siteNotice: HTML sitenotice
1552 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1554 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1556 &$text: bottomScripts Text
1557 Append to $text to add additional text/scripts after the stock bottom scripts.
1559 'SkinAfterContent': Allows extensions to add text after the page content and
1561 &$data: (string) Text to be printed out directly (without parsing)
1563 This hook should work in all skins. Just set the &$data variable to the text
1564 you're going to add.
1566 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1568 &$bar: Sidebar contents
1569 Modify $bar to add or modify sidebar portlets.
1571 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1572 $title: displayed page title
1573 $type: 'normal' or 'history' for old/diff views
1574 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1575 &$link: overridable HTML link to be passed into the message as $1
1576 &$forContent: overridable flag if copyright footer is shown in content language.
1579 &$text: additional 'powered by' icons in HTML.
1580 Note: Modern skin does not use the MediaWiki icon but plain text instead
1583 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1584 &$subpages: Subpage links HTML
1586 $out: OutputPage object
1587 If false is returned $subpages will be used instead of the HTML
1588 subPageSubtitle() generates.
1589 If true is returned, $subpages will be ignored and the rest of
1590 subPageSubtitle() will run.
1592 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1593 "permanent link" tab
1594 $sktemplate: SkinTemplate object
1595 $nav_urls: array of tabs
1597 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1598 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1599 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1600 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1601 &$sktemplate: SkinTemplate object
1602 &$links: Structured navigation links
1603 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1605 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1607 &$sktemplate: SkinTemplate object
1608 &$tpl: Template engine object
1610 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1611 $sktemplate: SkinTemplate object
1612 $res: set to true to prevent active tabs
1614 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1615 You can either create your own array, or alter the parameters for
1617 &$sktemplate: The SkinTemplate instance.
1618 $title: Title instance for the page.
1619 $message: Visible label of tab.
1620 $selected: Whether this is a selected tab.
1621 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1622 &$classes: Array of CSS classes to apply.
1623 &$query: Query string to add to link.
1625 &$result: Complete assoc. array if you want to return true.
1627 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1628 been rendered (useful for adding more)
1629 $sk: The QuickTemplate based skin template running the hook.
1631 'SoftwareInfo': Called by Special:Version for returning information about
1633 $software: The array of software in format 'name' => 'version'.
1634 See SpecialVersion::softwareInformation()
1636 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1637 $id: User identifier
1639 'SpecialListusersDefaultQuery': called right before the end of
1640 UsersPager::getDefaultQuery()
1641 $pager: The UsersPager instance
1642 $query: The query array to be returned
1644 'SpecialListusersFormatRow': called right before the end of
1645 UsersPager::formatRow()
1646 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1647 $row: Database row object
1649 'SpecialListusersHeader': called before closing the <fieldset> in
1650 UsersPager::getPageHeader()
1651 $pager: The UsersPager instance
1652 $out: The header HTML
1654 'SpecialListusersHeaderForm': called before adding the submit button in
1655 UsersPager::getPageHeader()
1656 $pager: The UsersPager instance
1657 $out: The header HTML
1659 'SpecialListusersQueryInfo': called right before the end of
1660 UsersPager::getQueryInfo()
1661 $pager: The UsersPager instance
1662 $query: The query array to be returned
1664 'SpecialMovepageAfterMove': called after moving a page
1665 $movePage: MovePageForm object
1666 $oldTitle: old title (object)
1667 $newTitle: new title (object)
1669 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1670 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1671 $opts: FormOptions object containing special page options
1672 &$conds: array of WHERE conditionals for query
1673 &tables: array of tables to be queried
1674 &$fields: array of columns to select
1675 &$join_conds: join conditions for the tables
1677 'SpecialNewPagesFilters': called after building form options at NewPages
1678 $special: the special page object
1679 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1680 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1682 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1683 hook to remove a core special page
1684 $list: list (array) of core special pages
1686 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1687 $users: array of User objects
1688 $data: array of data submitted by the user
1689 &$error: string, error code (message name) used to describe to error (out paramater).
1690 The hook needs to return false when setting this, otherwise it will have no effect.
1692 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1693 use this to change some selection criteria or substitute a different title
1694 &$randstr: The random number from wfRandom()
1695 &$isRedir: Boolean, whether to select a redirect or non-redirect
1696 &$namespaces: An array of namespace indexes to get the title from
1697 &$extra: An array of extra SQL statements
1698 &$title: If the hook returns false, a Title object to use instead of the
1699 result from the normal query
1701 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1702 $special: the special page object
1703 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1704 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1706 'SpecialRecentChangesPanel': called when building form options in
1707 SpecialRecentChanges
1708 &$extraOpts: array of added items, to which can be added
1709 $opts: FormOptions for this request
1711 'SpecialRecentChangesQuery': called when building sql query for
1712 SpecialRecentChanges and SpecialRecentChangesLinked
1713 &$conds: array of WHERE conditionals for query
1714 &$tables: array of tables to be queried
1715 &$join_conds: join conditions for the tables
1716 $opts: FormOptions for this request
1717 &$query_options: array of options for the database request
1718 &$select: Array of columns to select
1720 'SpecialSearchGo': called when user clicked the "Go"
1721 &$title: title object generated from the text entered by the user
1722 &$term: the search term entered by the user
1724 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1725 target doesn't exist
1726 &$title: title object generated from the text entered by the user
1728 'SpecialSearchProfiles': allows modification of search profiles
1729 &$profiles: profiles, which can be modified.
1731 'SpecialSearchProfileForm': allows modification of search profile forms
1732 $search: special page object
1733 &$form: String: form html
1734 $profile: String: current search profile
1735 $term: String: search term
1736 $opts: Array: key => value of hidden options for inclusion in custom forms
1738 'SpecialSearchSetupEngine': allows passing custom data to search engine
1739 $search: special page object
1740 $profile: String: current search profile
1741 $engine: the search engine
1743 'SpecialSearchResults': called before search result display when there
1745 $term: string of search term
1746 &$titleMatches: empty or SearchResultSet object
1747 &$textMatches: empty or SearchResultSet object
1749 'SpecialSearchNoResults': called before search result display when there are
1751 $term: string of search term
1753 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1754 &$extraStats: Array to save the new stats
1755 ( $extraStats['<name of statistic>'] => <value>; )
1757 'SpecialUploadComplete': Called after successfully uploading a file from
1759 $form: The SpecialUpload object
1761 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1762 use this to change the tables headers
1763 $extTypes: associative array of extensions types
1765 'SpecialWatchlistFilters': called after building form options at Watchlist
1766 $special: the special page object
1767 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1768 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1770 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1771 &$conds: array of WHERE conditionals for query
1772 &$tables: array of tables to be queried
1773 &$join_conds: join conditions for the tables
1774 &$fields: array of query fields
1776 'TitleArrayFromResult': called when creating an TitleArray object from a
1778 &$titleArray: set this to an object to override the default object returned
1779 $res: database result used to create the object
1781 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1782 that can be applied.
1783 $title: The title in question.
1784 &$types: The types of protection available.
1786 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1787 $title: Title object that is being checked
1788 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
1790 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
1791 be handled by seperate handler (via ArticleViewCustom)
1792 $title: Title object that is being checked
1793 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
1795 'TitleMoveComplete': after moving an article (title)
1798 $user: user who did the move
1799 $pageid: database ID of the page that's been moved
1800 $redirid: database ID of the created redirect
1802 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1803 PageArchive object has been created but before any further processing is done.
1804 &$archive: PageArchive object
1805 $title: Title object of the page that we're viewing
1807 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1808 PageArchive object has been created but before any further processing is done.
1809 &$archive: PageArchive object
1810 $title: Title object of the page that we're viewing
1812 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1813 the site is not in read-only mode, that the Title object is not null and after
1814 a PageArchive object has been constructed but before performing any further
1816 &$archive: PageArchive object
1817 $title: Title object of the page that we're about to undelete
1819 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1820 $title: title object related to the revision
1821 $rev: revision (object) that will be viewed
1823 'UnknownAction': An unknown "action" has occured (useful for defining
1825 $action: action name
1826 $article: article "acted on"
1828 'UnitTestsList': Called when building a list of files with PHPUnit tests
1829 &$files: list of files
1831 'UnwatchArticle': before a watch is removed from an article
1832 $user: user watching
1833 $article: article object to be removed
1835 'UnwatchArticle': after a watch is removed from an article
1836 $user: user that was watching
1837 $article: article object removed
1839 'UnwatchArticleComplete': after a watch is removed from an article
1840 $user: user that watched
1841 $article: article object that was watched
1843 'UploadForm:initial': before the upload form is generated
1844 $form: UploadForm object
1845 You might set the member-variables $uploadFormTextTop and
1846 $uploadFormTextAfterSummary to inject text (HTML) either before
1847 or after the editform.
1849 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1850 $form: UploadForm object
1851 Lets you poke at member variables like $mUploadDescription before the
1853 Do not use this hook to break upload processing. This will return the user to
1854 a blank form with no error message; use UploadVerification and
1855 UploadVerifyFile instead
1857 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1858 $type: (string) the requested upload type
1859 &$className: the class name of the Upload instance to be created
1861 'UploadComplete': when Upload completes an upload
1862 &$upload: an UploadBase child instance
1864 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1866 $descriptor: (array) the HTMLForm descriptor
1868 'UploadFormSourceDescriptors': after the standard source inputs have been
1869 added to the descriptor
1870 $descriptor: (array) the HTMLForm descriptor
1872 'UploadVerification': additional chances to reject an uploaded file. Consider
1873 using UploadVerifyFile instead.
1874 string $saveName: destination file name
1875 string $tempName: filesystem path to the temporary file for checks
1876 string &$error: output: message key for message to show if upload canceled
1877 by returning false. May also be an array, where the first element
1878 is the message key and the remaining elements are used as parameters to
1881 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1882 in most cases over UploadVerification.
1883 object $upload: an instance of UploadBase, with all info about the upload
1884 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1885 will typically only apply for specific mime types.
1886 object &$error: output: true if the file is valid. Otherwise, an indexed array
1887 representing the problem with the file, where the first element
1888 is the message key and the remaining elements are used as parameters to
1891 'UploadComplete': Upon completion of a file upload
1892 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1893 $uploadBase->getLocalFile().
1895 'User::mailPasswordInternal': before creation and mailing of a user's new
1897 $user: the user who sent the message out
1898 $ip: IP of the user who sent the message out
1899 $u: the account whose new password will be set
1901 'UserAddGroup': called when adding a group; return false to override
1902 stock group addition.
1903 $user: the user object that is to have a group added
1904 &$group: the group to add, can be modified
1906 'UserArrayFromResult': called when creating an UserArray object from a
1908 &$userArray: set this to an object to override the default object returned
1909 $res: database result used to create the object
1911 'userCan': To interrupt/advise the "user can do X to Y article" check.
1912 If you want to display an error message, try getUserPermissionsErrors.
1913 $title: Title object being checked against
1914 $user : Current user object
1915 $action: Action being checked
1916 $result: Pointer to result returned if hook returns false. If null is returned,
1917 userCan checks are continued by internal code.
1919 'UserCanSendEmail': To override User::canSendEmail() permission check
1920 $user: User (object) whose permission is being checked
1921 &$canSend: bool set on input, can override on output
1923 'UserClearNewTalkNotification': called when clearing the
1924 "You have new messages!" message, return false to not delete it
1925 $user: User (object) that'll clear the message
1927 'UserComparePasswords': called when checking passwords, return false to
1928 override the default password checks
1929 &$hash: String of the password hash (from the database)
1930 &$password: String of the plaintext password the user entered
1931 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1933 &$result: If the hook returns false, this Boolean value will be checked to
1934 determine if the password was valid
1936 'UserCreateForm': change to manipulate the login form
1937 $template: SimpleTemplate instance for the form
1939 'UserCryptPassword': called when hashing a password, return false to implement
1940 your own hashing method
1941 &$password: String of the plaintext password to encrypt
1942 &$salt: String of the password salt or Boolean false if no salt is provided
1943 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1945 &$hash: If the hook returns false, this String will be used as the hash
1947 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1948 $user: User to get groups for
1949 &$groups: Current effective groups
1951 'UserGetAllRights': after calculating a list of all available rights
1952 &$rights: Array of rights, which may be added to.
1954 'UserGetEmail': called when getting an user email address
1956 &$email: email, change this to override local email
1958 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1959 email authentification
1961 &$timestamp: timestamp, change this to override local email authentification
1964 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1965 &$groups: List of implicit (automatically-assigned) groups
1967 'UserGetLanguageObject': Called when getting user's interface language object
1969 &$code: Langauge code that will be used to create the object
1971 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1972 &$reservedUsernames: $wgReservedUsernames
1974 'UserGetRights': Called in User::getRights()
1975 $user: User to get rights for
1976 &$rights: Current rights
1978 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1980 $user: User in question
1981 $title: Title of the page in question
1982 &$blocked: Out-param, whether or not the user is blocked from that page.
1983 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1984 own user talk pages.
1986 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1988 $ip: User's IP address
1989 &$blocked: Whether the user is blocked, to be modified by the hook
1991 'UserLoadAfterLoadFromSession': called to authenticate users on
1992 external/environmental means; occurs after session is loaded
1993 $user: user object being loaded
1995 'UserLoadDefaults': called when loading a default user
1999 'UserLoadFromDatabase': called when loading a user from the database
2001 &$s: database query object
2003 'UserLoadFromSession': called to authenticate users on external/environmental
2004 means; occurs before session is loaded
2005 $user: user object being loaded
2006 &$result: set this to a boolean value to abort the normal authentification
2009 'UserLoadOptions': when user options/preferences are being loaded from
2012 &$options: Options, can be modified.
2014 'UserLoginComplete': after a user has logged in
2015 $user: the user object that was created on login
2016 $inject_html: Any HTML to inject after the "logged in" message.
2018 'UserLoginForm': change to manipulate the login form
2019 $template: SimpleTemplate instance for the form
2021 'UserLogout': before a user logs out
2022 $user: the user object that is about to be logged out
2024 'UserLogoutComplete': after a user has logged out
2025 $user: the user object _after_ logout (won't have name, ID, etc.)
2026 $inject_html: Any HTML to inject after the "logged out" message.
2027 $oldName: name of the user before logout (string)
2029 'UserRemoveGroup': called when removing a group; return false to override
2030 stock group removal.
2031 $user: the user object that is to have a group removed
2032 &$group: the group to be removed, can be modified
2034 'UserRights': After a user's group memberships are changed
2035 $user : User object that was changed
2036 $add : Array of strings corresponding to groups added
2037 $remove: Array of strings corresponding to groups removed
2039 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2041 $user: user retrieving new talks messages
2042 $talks: array of new talks page(s)
2044 'UserSaveSettings': called when saving user settings
2047 'UserSaveOptions': Called just before saving user preferences/options.
2049 &$options: Options, modifiable
2051 'UserSetCookies': called when setting user cookies
2053 &$session: session array, will be added to $_SESSION
2054 &$cookies: cookies array mapping cookie name to its value
2056 'UserSetEmail': called when changing user email address
2058 &$email: new email, change this to override new email address
2060 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2061 of email authentification
2063 &$timestamp: new timestamp, change this to override local email
2064 authentification timestamp
2066 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2067 used to alter the SQL query which gets the list of wanted pages
2068 &$wantedPages: WantedPagesPage object
2069 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2071 'WatchArticle': before a watch is added to an article
2072 $user: user that will watch
2073 $article: article object to be watched
2075 'WatchArticleComplete': after a watch is added to an article
2076 $user: user that watched
2077 $article: article object watched
2079 'WatchlistEditorBuildRemoveLine': when building remove lines in
2080 Special:Watchlist/edit
2081 &$tools: array of extra links
2082 $title: Title object
2083 $redirect: whether the page is a redirect
2086 'WebRequestGetPathInfoRequestURI': while extracting path info from REQUEST_URI.
2087 Allows an extension to extend the extraction of titles from paths.
2088 Implementing hooks should follow the pattern used in core:
2089 * Use the `$matches = WebRequest::extractTitle` pattern
2090 * Ensure that you test `if ( !$matches ) {` before you try extracting a title
2091 from the path so that you don't override an already found match.
2092 $path: The request path to extract a title from.
2093 &$matches: The array to apply matches to.
2095 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2097 One, and only one hook should set this, and return false.
2098 &$tables: Database tables to use in the SELECT query
2099 &$opts: Options to use for the query
2100 &$join: Join conditions
2102 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2103 query pages to be updated with maintenance/updateSpecialPages.php
2104 $query: $wgQueryPages itself
2106 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2107 metadata to be added.
2108 $obj: The XmlDumpWriter object.
2109 &$out: The output string.
2110 $row: The database row for the page.
2111 $title: The title of the page.
2113 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2115 $obj: The XmlDumpWriter object.
2116 &$out: The text being output.
2117 $row: The database row for the revision.
2118 $text: The revision text.
2120 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2121 additional tags to extract.
2122 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2124 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2125 used to post-process the results.
2126 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2127 metadata tags returned (each tag is either a value, or an array of values).
2129 More hooks might be available but undocumented, you can execute
2130 ./maintenance/findhooks.php to find hidden one.