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 'AbortAutoblock': Return false to cancel an autoblock.
238 $autoblockip: The IP going to be autoblocked.
239 $block: The block from which the autoblock is coming.
241 'AbortDiffCache': Can be used to cancel the caching of a diff
242 &$diffEngine: DifferenceEngine object
244 'AbortLogin': Return false to cancel account login.
245 $user: the User object being authenticated against
246 $password: the password being submitted, not yet checked for validity
247 &$retval: a LoginForm class constant to return from authenticateUserData();
248 default is LoginForm::ABORTED. Note that the client may be using
249 a machine API rather than the HTML user interface.
250 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
252 'AbortMove': allows to abort moving an article (title)
255 $user: user who is doing the move
257 $reason: the reason for the move (added in 1.13)
259 'AbortNewAccount': Return false to cancel account creation.
260 $user: the User object about to be created (read-only, incomplete)
261 $message: out parameter: error message to display on abort
263 'AddNewAccount': after a user account is created
264 $user: the User object that was created. (Parameter added in 1.7)
265 $byEmail: true when account was created "by email" (added in 1.12)
267 'AfterImportPage': When a page import is completed
268 $title: Title under which the revisions were imported
269 $origTitle: Title provided by the XML file
270 $revCount: Number of revisions in the XML file
271 $sRevCount: Number of sucessfully imported revisions
272 $pageInfo: associative array of page information
274 'AfterUserMessage': After a user message has been left, this hook is
275 called to take care of any cleanup.
276 $user: The user who we left the message for.
277 $article: The article the message was left on.
278 $subject: The subject of the message
279 $text: The text of the message.
280 $signature: The signature we used.
281 $summary: The edit summary.
282 $editor: The editor that performed the edit.
284 'AjaxAddScript': Called in output page just before the initialisation
285 of the javascript ajax engine. The hook is only called when ajax
286 is enabled ( $wgUseAjax = true; ).
288 'AlternateEdit': before checking if an user can edit a page and
289 before showing the edit form ( EditPage::edit() ). This is triggered
291 $EditPage: the EditPage object
293 'APIAfterExecute': after calling the execute() method of an API module.
294 Use this to extend core API modules.
295 &$module: Module object
297 'APIEditBeforeSave': before saving a page with api.php?action=edit,
298 after processing request parameters. Return false to let the request
299 fail, returning an error message or an <edit result="Failure"> tag
300 if $resultArr was filled.
301 $EditPage : the EditPage object
302 $text : the new text of the article (has yet to be saved)
303 &$resultArr : data in this array will be added to the API result
305 'APIGetAllowedParams': use this hook to modify a module's parameters.
306 &$module: Module object
307 &$params: Array of parameters
309 'APIGetParamDescription': use this hook to modify a module's parameter
311 &$module: Module object
312 &$desc: Array of parameter descriptions
314 'APIQueryAfterExecute': after calling the execute() method of an
315 action=query submodule. Use this to extend core API modules.
316 &$module: Module object
318 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
319 method of an action=query submodule. Use this to extend core API modules.
320 &$module: Module object
321 &$resultPageSet: ApiPageSet object
323 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
324 Every token has an action, which will be used in the intoken parameter
325 and in the output (actiontoken="..."), and a callback function which
326 should return the token, or false if the user isn't allowed to obtain
327 it. The prototype of the callback function is func($pageid, $title)
328 where $pageid is the page ID of the page the token is requested for
329 and $title is the associated Title object. In the hook, just add
330 your callback to the $tokenFunctions array and return true (returning
331 false makes no sense)
332 $tokenFunctions: array(action => callback)
334 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
335 Every token has an action, which will be used in the rvtoken parameter
336 and in the output (actiontoken="..."), and a callback function which
337 should return the token, or false if the user isn't allowed to obtain
338 it. The prototype of the callback function is func($pageid, $title, $rev)
339 where $pageid is the page ID of the page associated to the revision the
340 token is requested for, $title the associated Title object and $rev the
341 associated Revision object. In the hook, just add your callback to the
342 $tokenFunctions array and return true (returning false makes no sense)
343 $tokenFunctions: array(action => callback)
345 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
347 Every token has an action, which will be used in the rctoken parameter
348 and in the output (actiontoken="..."), and a callback function which
349 should return the token, or false if the user isn't allowed to obtain
350 it. The prototype of the callback function is func($pageid, $title, $rc)
351 where $pageid is the page ID of the page associated to the revision the
352 token is requested for, $title the associated Title object and $rc the
353 associated RecentChange object. In the hook, just add your callback to the
354 $tokenFunctions array and return true (returning false makes no sense)
355 $tokenFunctions: array(action => callback)
357 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
358 the sites general information.
359 $module: the current ApiQuerySiteInfo module
360 &$results: array of results, add things here
362 'APIQueryUsersTokens': use this hook to add custom token to list=users.
363 Every token has an action, which will be used in the ustoken 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($user) where $user
367 is the User object. In the hook, just add your callback to the
368 $tokenFunctions array and return true (returning false makes no sense)
369 $tokenFunctions: array(action => callback)
371 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
372 Each service should have its own entry in the $apis array and have a
373 unique name, passed as key for the array that represents the service data.
374 In this data array, the key-value-pair identified by the apiLink key is
376 &$apis: array of services
378 'ArticleAfterFetchContent': after fetching content of an article from
380 $article: the article (object) being loaded from the database
381 $content: the content (string) of the article
383 'ArticleConfirmDelete': before writing the confirmation form for article
385 $article: the article (object) being deleted
386 $output: the OutputPage object ($wgOut)
387 &$reason: the reason (string) the article is being deleted
389 'ArticleContentOnDiff': before showing the article content below a diff.
390 Use this to change the content in this area or how it is loaded.
391 $diffEngine: the DifferenceEngine
392 $output: the OutputPage object ($wgOut)
394 'ArticleDelete': before an article is deleted
395 $article: the article (object) being deleted
396 $user: the user (object) deleting the article
397 $reason: the reason (string) the article is being deleted
398 $error: if the deletion was prohibited, the (raw HTML) error message to display
401 'ArticleDeleteComplete': after an article is deleted
402 $article: the article that was deleted
403 $user: the user that deleted the article
404 $reason: the reason the article was deleted
405 $id: id of the article that was deleted
407 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
409 $article: article (object) of the user talk page
411 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
412 article has been changed
413 $article: the article (object)
414 $editInfo: data holder that includes the parser output ($editInfo->output) for
415 that page after the change
416 $changed: bool for if the page was changed
418 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
419 recentchanges table, return false to not delete old entries
420 $article: article (object) being modified
422 'ArticleFromTitle': when creating an article object from a title object using
423 Wiki::articleFromTitle()
424 $title: title (object) used to create the article object
425 $article: article (object) that will be returned
427 'ArticleInsertComplete': After a new article is created
428 $article: Article created
429 $user: User creating the article
431 $summary: Edit summary/comment
432 $isMinor: Whether or not the edit was marked as minor
433 $isWatch: (No longer used)
434 $section: (No longer used)
435 $flags: Flags passed to Article::doEdit()
436 $revision: New Revision of the article
438 'ArticleMergeComplete': after merging to article using Special:Mergehistory
439 $targetTitle: target title (object)
440 $destTitle: destination title (object)
442 'ArticlePageDataAfter': after loading data of an article from the database
443 $article: article (object) whose data were loaded
444 $row: row (object) returned from the database server
446 'ArticlePageDataBefore': before loading data of an article from the database
447 $article: article (object) that data will be loaded
448 $fields: fileds (array) to load from the database
450 'ArticlePrepareTextForEdit': called when preparing text to be saved
451 $article: the article being saved
452 $popts: parser options to be used for pre-save transformation
454 'ArticleProtect': before an article is protected
455 $article: the article being protected
456 $user: the user doing the protection
457 $protect: boolean whether this is a protect or an unprotect
458 $reason: Reason for protect
459 $moveonly: boolean whether this is for move only or not
461 'ArticleProtectComplete': after an article is protected
462 $article: the article that was protected
463 $user: the user who did the protection
464 $protect: boolean whether it was a protect or an unprotect
465 $reason: Reason for protect
466 $moveonly: boolean whether it was for move only or not
468 'ArticlePurge': before executing "&action=purge"
469 $article: article (object) to purge
471 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
472 revision of an article
473 &$title: title object of the article
475 'ArticleRevisionUndeleted': after an article revision is restored
476 $title: the article title
477 $revision: the revision
478 $oldPageID: the page ID of the revision when archived (may be null)
480 'ArticleRollbackComplete': after an article rollback is completed
481 $article: the article that was edited
482 $user: the user who did the rollback
483 $revision: the revision the page was reverted back to
484 $current: the reverted revision
486 'ArticleSave': before an article is saved
487 $article: the article (object) being saved
488 $user: the user (object) saving the article
489 $text: the new article text
490 $summary: the article summary (comment)
495 'ArticleSaveComplete': After an article has been updated
496 $article: Article modified
497 $user: User performing the modification
499 $summary: Edit summary/comment
500 $isMinor: Whether or not the edit was marked as minor
501 $isWatch: (No longer used)
502 $section: (No longer used)
503 $flags: Flags passed to Article::doEdit()
504 $revision: New Revision of the article
505 $baseRevId: the rev ID (or false) this edit was based on
507 'ArticleUndelete': When one or more revisions of an article are restored
508 $title: Title corresponding to the article restored
509 $create: Whether or not the restoration caused the page to be created
510 (i.e. it didn't exist before)
511 $comment: The comment associated with the undeletion.
513 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
514 before the user is redirected back to the page
515 &$article: the article
516 &$sectionanchor: The section anchor link (e.g. "#overview" )
517 &$extraq: Extra query parameters which can be added via hooked functions
519 'ArticleViewFooter': After showing the footer section of an ordinary page view
520 $article: Article object
522 'ArticleViewHeader': Before the parser cache is about to be tried for article
524 &$article: the article
525 &$pcache: whether to try the parser cache or not
526 &$outputDone: whether the output for this page finished or not
528 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
530 $article: target article (object)
532 'AuthPluginAutoCreate': Called when creating a local account for an user logged
533 in from an external authentication method
534 $user: User object created locally
536 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
537 Gives a chance for an extension to set it programattically to a variable class.
538 &$auth: the $wgAuth object, probably a stub
540 'AutopromoteCondition': check autopromote condition for user.
541 $type: condition type
544 $result: result of checking autopromote condition
546 'BadImage': When checking against the bad image list
547 $name: Image name being checked
548 &$bad: Whether or not the image is "bad"
550 Change $bad and return false to override. If an image is "bad", it is not
551 rendered inline in wiki pages or galleries in category pages.
553 'BeforeInitialize': before anything is initialized in performRequestForTitle()
554 &$title: Title being used for request
555 &$article: The associated Article object
556 &$output: OutputPage object
558 $request: WebRequest object
559 $mediaWiki: Mediawiki object
561 'BeforePageDisplay': Prior to outputting a page
562 &$out: OutputPage object
565 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
566 &$parser: Parser object
567 &$nt: the image title
568 &$time: the image timestamp (use '0' to force a broken thumbnail)
569 &$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set)
570 &$descQuery: query string to add to thumbnail URL
572 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
573 &$parser: Parser object
574 &$title: title of the template
575 &$skip: skip this template and link it?
576 &$id: the id of the revision being parsed
578 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
579 &$parser: Parser object
580 &$ig: ImageGallery object
582 'BitmapHandlerTransform': before a file is transformed, gives extension the
583 possibility to transform it themselves
584 $handler: BitmapHandler
586 &$scalerParams: Array with scaler parameters
587 &$mto: null, set to a MediaTransformOutput
589 'BlockIp': before an IP address or user is blocked
590 $block: the Block object about to be saved
591 $user: the user _doing_ the block (not the one being blocked)
593 'BlockIpComplete': after an IP address or user is blocked
594 $block: the Block object that was saved
595 $user: the user who did the block (not the one being blocked)
597 'BookInformation': Before information output on Special:Booksources
598 $isbn: ISBN to show information for
599 $output: OutputPage object in use
601 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
602 &$namespaces: Array of namespace numbers with corresponding canonical names
604 'CategoryPageView': before viewing a categorypage in CategoryPage::view
605 $catpage: CategoryPage instance
607 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
608 &$changesList: ChangesList instance.
609 &$articlelink: HTML of link to article (already filled-in).
610 &$s: HTML of row that is being constructed.
611 &$rc: RecentChange instance.
612 $unpatrolled: Whether or not we are showing unpatrolled changes.
613 $watched: Whether or not the change is watched by the user.
615 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
616 $user: user (object) whose email is being confirmed
618 'ContribsPager::getQueryInfo': Before the contributions query is about to run
619 &$pager: Pager object for contributions
620 &queryInfo: The query for the contribs Pager
622 'ContributionsLineEnding': Called before a contributions HTML line is finished
623 $page: SpecialPage object for contributions
625 $row: the DB row for this line
627 'ContributionsToolLinks': Change tool links above Special:Contributions
629 $title: User page title
630 &$tools: Array of tool links
632 'CustomEditor': When invoking the page editor
633 $article: Article being edited
634 $user: User performing the edit
636 Return true to allow the normal editor to be used, or false
637 if implementing a custom editor, e.g. for a special namespace,
640 'DatabaseOraclePostInit': Called after initialising an Oracle database
641 &$db: the DatabaseOracle object
643 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
644 $title: the diff page title (nullable)
645 &$oldId: the actual old Id to use in the diff
646 &$newId: the actual new Id to use in the diff (0 means current)
647 $old: the ?old= param value from the url
648 $new: the ?new= param value from the url
650 'DiffViewHeader': called before diff display
651 $diff: DifferenceEngine object that's calling
652 $oldRev: Revision object of the "old" revision (may be null/invalid)
653 $newRev: Revision object of the "new" revision
655 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
657 $article: article (object) being viewed
658 $oldid: oldid (int) being viewed
660 'DoEditSectionLink': Override the HTML generated for section edit links
661 $skin: Skin object rendering the UI
662 $title: Title object for the title being linked to (may not be the same as
663 $wgTitle, if the section is included from a template)
664 $section: The designation of the section being pointed to, to be included in
665 the link, like "§ion=$section"
666 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
667 By default, this is wrapped in the 'editsectionhint' message.
668 &$result: The HTML to return, prefilled with the default plus whatever other
669 changes earlier hooks have made
670 $lang: The language code to use for the link in the wfMsg* functions
672 'EditFilter': Perform checks on an edit
673 $editor: Edit form (see includes/EditPage.php)
674 $text: Contents of the edit box
675 $section: Section being edited
676 &$error: Error message to return
677 $summary: Edit summary for page
679 'EditFilterMerged': Post-section-merge edit filter
680 $editor: EditPage instance (object)
681 $text: content of the edit box
682 &$error: error message to return
683 $summary: Edit summary for page
685 'EditFormPreloadText': Allows population of the edit form when creating
687 &$text: Text to preload with
688 &$title: Title object representing the page being created
690 'EditFormInitialText': Allows modifying the edit form when editing existing
692 $editPage: EditPage object
694 'EditPage::attemptSave': called before an article is
695 saved, that is before insertNewArticle() is called
696 $editpage_Obj: the current EditPage object
698 'EditPage::importFormData': allow extensions to read additional data
700 $editpage: EditPage instance
702 return value is ignored (should always return true)
704 'EditPage::showEditForm:fields': allows injection of form field into edit form
705 &$editor: the EditPage instance for reference
706 &$out: an OutputPage instance to write to
707 return value is ignored (should always return true)
709 'EditPage::showEditForm:initial': before showing the edit form
710 $editor: EditPage instance (object)
712 Return false to halt editing; you'll need to handle error messages, etc.
713 yourself. Alternatively, modifying $error and returning true will cause the
714 contents of $error to be echoed at the top of the edit form as wikitext.
715 Return true without altering $error to allow the edit to proceed.
717 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
718 when there's an edit conflict. Return false to halt normal diff output; in
719 this case you're responsible for computing and outputting the entire "conflict"
720 part, i.e., the "difference between revisions" and "your text" headers and
722 &$editor: EditPage instance
723 &$out: OutputPage instance
725 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
726 textarea in the edit form
727 &$editpage: The current EditPage object
728 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
729 &$tabindex: HTML tabindex of the last edit check/button
731 'EditPageBeforeEditChecks': allows modifying the edit checks below the
732 textarea in the edit form
733 &$editpage: The current EditPage object
734 &$checks: Array of edit checks like "watch this page"/"minor edit"
735 &$tabindex: HTML tabindex of the last edit check/button
737 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
738 textarea in the edit form
739 &$toolbar: The toolbar HTMl
741 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
742 $title: title of page being edited
743 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
745 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
747 $editPage: EditPage object
748 &$newtext: wikitext that will be used as "your version"
750 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
751 $editPage: EditPage object
752 &$toparse: wikitext that will be parsed
754 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
755 &$editpage: The current EditPage object
756 &$res: the HTML of the error text
758 'EditPageTosSummary': Give a chance for site and per-namespace customizations
759 of terms of service summary link that might exist separately from the copyright
761 $title: title of page being edited
762 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
764 'EditSectionLink': Do not use, use DoEditSectionLink instead.
765 $skin: Skin rendering the UI
766 $title: Title being linked to
767 $section: Section to link to
769 &$result: Result (alter this to override the generated links)
770 $lang: The language code to use for the link in the wfMsg* functions
772 'EmailConfirmed': When checking that the user's email address is "confirmed"
773 $user: User being checked
774 $confirmed: Whether or not the email address is confirmed
775 This runs before the other checks, such as anonymity and the real check; return
776 true to allow those checks to occur, and false if checking is done.
778 'EmailUser': before sending email from one user to another
779 $to: address of receiving user
780 $from: address of sending user
781 $subject: subject of the mail
782 $text: text of the mail
784 'EmailUserCC': before sending the copy of the email to the author
785 $to: address of receiving user
786 $from: address of sending user
787 $subject: subject of the mail
788 $text: text of the mail
790 'EmailUserComplete': after sending email from one user to another
791 $to: address of receiving user
792 $from: address of sending user
793 $subject: subject of the mail
794 $text: text of the mail
796 'EmailUserForm': after building the email user form object
797 $form: HTMLForm object
799 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
800 $user: The user who is trying to email another user.
801 $editToken: The user's edit token.
802 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
804 'FetchChangesList': When fetching the ChangesList derivative for
806 &$user: User the list is being fetched for
807 &$skin: Skin object to be used with the list
808 &$list: List object (defaults to NULL, change it to an object
809 instance and return false override the list derivative used)
811 'FileDeleteComplete': When a file is deleted
812 $file: reference to the deleted file
813 $oldimage: in case of the deletion of an old image, the name of the old file
814 $article: in case all revisions of the file are deleted a reference to the
815 article associated with the file.
816 $user: user who performed the deletion
819 'FileUpload': When a file upload occurs
820 $file : Image object representing the file that was uploaded
821 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
822 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
824 'FileUndeleteComplete': When a file is undeleted
825 $title: title object to the file
826 $fileVersions: array of undeleted versions. Empty if all versions were restored
827 $user: user who performed the undeletion
830 'FormatUserMessage': Hook to format a message if you want to override
831 the internal formatter.
832 $subject: Title of the message.
833 &$text: Text of the message.
834 $signature: Signature that they would like to leave.
836 'GetAutoPromoteGroups': When determining which autopromote groups a user
837 is entitled to be in.
838 &$user: user to promote.
839 &$promote: groups that will be added.
841 'GetBlockedStatus': after loading blocking status of an user from the database
842 $user: user (object) being checked
844 'GetCacheVaryCookies': get cookies that should vary cache options
845 $out: OutputPage object
846 &$cookies: array of cookies name, add a value to it if you want to add a cookie
847 that have to vary cache options
849 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
850 $title: Title object of page
851 $url: string value as output (out parameter, can modify)
852 $query: query options passed to Title::getFullURL()
854 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
855 $title: Title object of page
856 $url: string value as output (out parameter, can modify)
857 $query: query options passed to Title::getInternalURL()
859 'GetIP': modify the ip of the current user (called only once)
860 &$ip: string holding the ip as determined so far
862 'GetLinkColours': modify the CSS class of an array of page links
863 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
865 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
867 'GetLocalURL': modify local URLs as output into page links
868 $title: Title object of page
869 $url: string value as output (out parameter, can modify)
870 $query: query options passed to Title::getLocalURL()
872 'GetPreferences': modify user preferences
873 $user: User whose preferences are being modified.
874 &$preferences: Preferences description array, to be fed to an HTMLForm object
876 'getUserPermissionsErrors': Add a permissions error when permissions errors are
877 checked for. Use instead of userCan for most cases. Return false if the
878 user can't do it, and populate $result with the reason in the form of
879 array( messagename, param1, param2, ... ). For consistency, error messages
880 should be plain text with no special coloring, bolding, etc. to show that
881 they're errors; presenting them properly to the user as errors is done by
883 $title: Title object being checked against
884 $user : Current user object
885 $action: Action being checked
886 $result: User permissions error to add. If none, return true.
888 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
889 if expensive checks are enabled.
891 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
892 image insertion. You can skip the default logic entirely by returning
893 false, or just modify a few things using call-by-reference.
895 &$title: Title object of the image
896 &$file: File object, or false if it doesn't exist
897 &$frameParams: Various parameters with special meanings; see documentation in
898 includes/Linker.php for Linker::makeImageLink2
899 &$handlerParams: Various parameters with special meanings; see documentation in
900 includes/Linker.php for Linker::makeImageLink2
901 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
902 &$res: Final HTML output, used if you return false
905 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
906 the image on an image page
907 $imagePage: ImagePage object ($this)
910 'ImagePageAfterImageLinks': called after the image links section on an image
912 $imagePage: ImagePage object ($this)
913 &$html: HTML for the hook to add
915 'ImagePageFileHistoryLine': called when a file history line is contructed
917 $line: the HTML of the history line
918 $css: the line CSS class
920 'ImagePageFindFile': called when fetching the file associated with an image page
921 $page: ImagePage object
923 &$displayFile: displayed File object
925 'ImagePageShowTOC': called when the file toc on an image page is generated
926 $page: ImagePage object
927 &$toc: Array of <li> strings
929 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
931 &$title: the Title object of the file as it would appear for the upload page
932 &$path: the original file and path name when img_auth was invoked by the the web
934 &$name: the name only component of the file
935 &$result: The location to pass back results of the hook routine (only used if
937 $result[0]=The index of the header message
938 $result[1]=The index of the body text message
939 $result[2 through n]=Parameters passed to body text message. Please note the
940 header message cannot receive/use parameters.
942 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
943 $reader: XMLReader object
944 $logInfo: Array of information
945 Return false to stop further processing of the tag
947 'ImportHandlePageXMLTag': When parsing a XML tag in a page
948 $reader: XMLReader object
949 $pageInfo: Array of information
950 Return false to stop further processing of the tag
952 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
953 $reader: XMLReader object
954 $revInfo: Array of information
955 Return false to stop further processing of the tag
957 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
958 $reader: XMLReader object
959 Return false to stop further processing of the tag
961 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
962 $reader: XMLReader object
963 $revisionInfo: Array of information
964 Return false to stop further processing of the tag
966 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
967 $title: Title object ($wgTitle)
969 $ignoreRedirect: boolean to skip redirect check
970 $target: Title/string of redirect target
971 $article: Article object
973 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
974 Return true without providing an interwiki to continue interwiki search.
975 $prefix: interwiki prefix we are looking for.
976 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
977 iw_trans and optionally iw_api and iw_wikiid.
979 'InternalParseBeforeLinks': during Parser's internalParse method before links
980 but after noinclude/includeonly/onlyinclude and other processing.
981 &$parser: Parser object
982 &$text: string containing partially parsed text
983 &$stripState: Parser's internal StripState object
985 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
986 $user: user (object) whose email is being invalidated
988 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
989 $article: article (object) being checked
991 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
993 $result: Change this value to override the result of wfIsTrustedProxy()
995 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
996 tance to return false if the domain name doesn't match your organization
997 $addr: The e-mail address entered by the user
998 &$result: Set this and return false to override the internal checks
1000 'isValidPassword': Override the result of User::isValidPassword()
1001 $password: The password entered by the user
1002 &$result: Set this and return false to override the internal checks
1003 $user: User the password is being validated for
1005 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1006 $wgExtensionMessagesFiles instead.
1007 Use this to define synonyms of magic words depending of the language
1008 $magicExtensions: associative array of magic words synonyms
1009 $lang: laguage code (string)
1011 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1012 listed in $wgExtensionMessagesFiles instead.
1013 Use to define aliases of special pages names depending of the language
1014 $specialPageAliases: associative array of magic words synonyms
1015 $lang: laguage code (string)
1017 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1018 &$names: array of language code => language name
1019 $code language of the preferred translations
1021 'LinkBegin': Used when generating internal and interwiki links in
1022 Linker::link(), before processing starts. Return false to skip default proces-
1023 sing and return $ret. See documentation for Linker::link() for details on the
1024 expected meanings of parameters.
1025 $skin: the Skin object
1026 $target: the Title that the link is pointing to
1027 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
1029 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1030 tive array form, with keys and values unescaped. Should be merged with de-
1031 fault values, with a value of false meaning to suppress the attribute.
1032 &$query: the query string to add to the generated URL (the bit after the "?"),
1033 in associative array form, with keys and values unescaped.
1034 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1035 &$ret: the value to return if your hook returns false.
1037 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1038 just before the function returns a value. If you return true, an <a> element
1039 with HTML attributes $attribs and contents $text will be returned. If you re-
1040 turn false, $ret will be returned.
1041 $skin: the Skin object
1042 $target: the Title object that the link is pointing to
1043 $options: the options. Will always include either 'known' or 'broken', and may
1044 include 'noclasses'.
1045 &$text: the final (raw HTML) contents of the <a> tag, after processing.
1046 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1048 &$ret: the value to return if your hook returns false.
1050 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1052 &$url: the image url
1053 &$alt: the image's alt text
1054 &$img: the new image HTML (if returning false)
1056 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1059 &$text: the link text
1060 &$link: the new link HTML (if returning false)
1061 &$attribs: the attributes to be applied.
1062 $linkType: The external link type
1064 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1066 &$linksUpdate: the LinksUpdate object
1068 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1070 &$linksUpdate: the LinksUpdate object
1072 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1073 &$linksUpdate: the LinksUpdate object
1075 'ListDefinedTags': When trying to find all defined tags.
1076 &$tags: The list of tags.
1078 'LoadExtensionSchemaUpdates': called during database installation and updates
1079 &updater: A DatabaseUpdater subclass
1081 'LocalFile::getHistory': called before file history query performed
1084 $fields: select fields
1086 $opts: query options
1087 $join_conds: JOIN conditions
1089 'LocalisationCacheRecache': Called when loading the localisation data into cache
1090 $cache: The LocalisationCache object
1091 $code: language code
1092 &$alldata: The localisation data from core and extensions
1094 'LoginAuthenticateAudit': a login attempt for a valid user account either
1095 succeeded or failed. No return data is accepted; this hook is for auditing only.
1096 $user: the User object being authenticated against
1097 $password: the password being submitted and found wanting
1098 $retval: a LoginForm class constant with authenticateUserData() return
1099 value (SUCCESS, WRONG_PASS, etc)
1101 'LogLine': Processes a single log entry on Special:Log
1102 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1103 logging.log_type database field.
1104 $log_action: string for the type of log action (e.g. 'delete', 'block',
1105 'create2'). Corresponds to logging.log_action database field.
1106 $title: Title object that corresponds to logging.log_namespace and
1107 logging.log_title database fields.
1108 $paramArray: Array of parameters that corresponds to logging.log_params field.
1109 Note that only $paramArray[0] appears to contain anything.
1110 &$comment: string that corresponds to logging.log_comment database field, and
1111 which is displayed in the UI.
1112 &$revert: string that is displayed in the UI, similar to $comment.
1113 $time: timestamp of the log entry (added in 1.12)
1115 'LogPageValidTypes': action being logged.
1116 DEPRECATED: Use $wgLogTypes
1117 &$type: array of strings
1119 'LogPageLogName': name of the logging page(s).
1120 DEPRECATED: Use $wgLogNames
1121 &$typeText: array of strings
1123 'LogPageLogHeader': strings used by wfMsg as a header.
1124 DEPRECATED: Use $wgLogHeaders
1125 &$headerText: array of strings
1127 'LogPageActionText': strings used by wfMsg as a header.
1128 DEPRECATED: Use $wgLogActions
1129 &$actionText: array of strings
1131 'MagicWordMagicWords': When defining new magic word.
1132 DEPRECATED: use $magicWords in a file listed in
1133 $wgExtensionMessagesFiles instead.
1134 $magicWords: array of strings
1136 'MagicWordwgVariableIDs': When definig new magic words IDs.
1137 $variableIDs: array of strings
1139 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1140 is executed. Ideally, this hook should only be used to add variables that
1141 depend on the current page/request; static configuration should be added
1142 through ResourceLoaderGetConfigVars instead.
1143 &$vars: variable (or multiple variables) to be added into the output
1144 of Skin::makeVariablesScript
1146 'MarkPatrolled': before an edit is marked patrolled
1147 $rcid: ID of the revision to be marked patrolled
1148 $user: the user (object) marking the revision as patrolled
1149 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1150 needs to be a sysop in order to mark an edit patrolled
1152 'MarkPatrolledComplete': after an edit is marked patrolled
1153 $rcid: ID of the revision marked as patrolled
1154 $user: user (object) who marked the edit patrolled
1155 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1156 must be a sysop to patrol the edit
1158 'MathAfterTexvc': after texvc is executed when rendering mathematics
1159 $mathRenderer: instance of MathRenderer
1160 $errmsg: error message, in HTML (string). Nonempty indicates failure
1161 of rendering the formula
1163 'MediaWikiPerformAction': Override MediaWiki::performAction().
1164 Use this to do something completely different, after the basic
1165 globals have been set up, but before ordinary actions take place.
1167 $article: $wgArticle
1170 $request: $wgRequest
1171 $mediaWiki: The $mediawiki object
1173 'MessagesPreLoad': When loading a message from the database
1174 $title: title of the message (string)
1175 $message: value (string), change it to the message you want to define
1177 'MessageCacheReplace': When a message page is changed.
1178 Useful for updating caches.
1179 $title: name of the page changed.
1180 $text: new contents of the page.
1182 'ModifyExportQuery': Modify the query used by the exporter.
1183 $db: The database object to be queried.
1184 &$tables: Tables in the query.
1185 &$conds: Conditions in the query.
1186 &$opts: Options for the query.
1187 &$join_conds: Join conditions for the query.
1189 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1190 been rendered (useful for adding more)
1191 Note: this is only run for the Monobook skin. This hook is deprecated and
1192 may be removed in the future. To add items to the toolbox you should use
1193 the SkinTemplateToolboxEnd hook instead, which works for all
1194 "SkinTemplate"-type skins.
1195 $tools: array of tools
1197 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1198 and returning it for the skin to output. You can add items to the toolbox while
1199 still letting the skin make final decisions on skin-specific markup conventions
1201 &$sk: The BaseTemplate base skin template
1202 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1203 BaseTemplate::makeListItem for details on the format of individual
1204 items inside of this array
1206 'NewRevisionFromEditComplete': called when a revision was inserted
1208 $article: the article edited
1209 $rev: the new revision
1210 $baseID: the revision ID this was based off, if any
1211 $user: the editing user
1213 'NormalizeMessageKey': Called before the software gets the text of a message
1214 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1216 &$key: the message being looked up. Change this to something else to change
1217 what message gets displayed (string)
1218 &$useDB: whether or not to look up the message in the database (bool)
1219 &$langCode: the language code to get the message for (string) - or -
1220 whether to use the content language (true) or site language (false) (bool)
1221 &$transform: whether or not to expand variables and templates
1222 in the message (bool)
1224 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1225 &$changeslist: The OldChangesList instance.
1226 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1227 &$rc: The RecentChange object.
1229 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1230 Hooks can alter or append to the array of URLs for search & suggestion formats.
1231 &$urls: array of associative arrays with Url element attributes
1233 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1234 users and/or IP addresses too
1235 $otherBlockLink: An array with links to other block logs
1236 $ip: The requested IP address or username
1238 'OutputPageBeforeHTML': a page has been processed by the parser and
1239 the resulting HTML is about to be displayed.
1240 $parserOutput: the parserOutput (object) that corresponds to the page
1241 $text: the text that will be displayed, in HTML (string)
1243 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1244 tag to allow for extensions to add attributes to the body of the page they might
1245 need. Or to allow building extensions to add body classes that aren't of high
1246 enough demand to be included in core.
1247 $out: The OutputPage which called the hook, can be used to get the real title
1248 $sk: The Skin that called OutputPage::headElement
1249 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1251 'OutputPageCheckLastModified': when checking if the page has been modified
1252 since the last visit
1253 &$modifiedTimes: array of timestamps.
1254 The following keys are set: page, user, epoch
1256 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1257 $out: OutputPage instance (object)
1258 $parserOutput: parserOutput instance being added in $out
1260 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1261 categories. Implementations should return false if they generate the category
1262 links, so the default link generation is skipped.
1263 $out: OutputPage instance (object)
1264 $categories: associative array, keys are category names, values are category
1265 types ("normal" or "hidden")
1266 $links: array, intended to hold the result. Must be an associative array with
1267 category types as keys and arrays of HTML links as values.
1269 'PageHistoryBeforeList': When a history page list is about to be constructed.
1270 $article: the article that the history is loading for
1272 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1273 $row: the revision row for this line
1274 $s: the string representing this parsed line
1275 $classes: array containing the <li> element classes
1277 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1280 $queryInfo: the query parameters
1282 'PageRenderingHash': alter the parser cache option hash key
1283 A parser extension which depends on user options should install
1284 this hook and append its values to the key.
1285 $hash: reference to a hash key string which can be modified
1287 'ParserAfterStrip': Same as ParserBeforeStrip
1289 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1290 $parser: Parser object being used
1291 $text: text that'll be returned
1293 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1294 $parser: Parser object
1295 $text: text to parse
1296 $stripState: StripState instance being used
1298 'ParserBeforeStrip': Called at start of parsing time
1299 (no more strip, deprecated ?)
1300 $parser: parser object
1301 $text: text being parsed
1302 $stripState: stripState used (object)
1304 'ParserBeforeTidy': called before tidy and custom tags replacements
1305 $parser: Parser object being used
1308 'ParserClearState': called at the end of Parser::clearState()
1309 $parser: Parser object being cleared
1311 'ParserFirstCallInit': called when the parser initialises for the first time
1312 &$parser: Parser object being cleared
1314 'ParserGetVariableValueSwitch': called when the parser need the value of a
1316 $parser: Parser object
1317 $varCache: array to store the value in case of multiples calls of the
1319 $index: index (string) of the magic
1320 $ret: value of the magic word (the hook should set it)
1321 $frame: PPFrame object to use for expanding any template variables
1323 'ParserGetVariableValueTs': use this to change the value of the time for the
1324 {{LOCAL...}} magic word
1325 $parser: Parser object
1326 $time: actual time (timestamp)
1328 'ParserGetVariableValueVarCache': use this to change the value of the
1329 variable cache or return false to not use it
1330 $parser: Parser object
1331 $varCache: varaiable cache (array)
1333 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1334 include comments about size of the text parsed
1335 $parser: Parser object
1336 $limitReport: text that will be included (without comment tags)
1338 'ParserMakeImageParams': Called before the parser make an image link, use this
1339 to modify the parameters of the image.
1340 $title: title object representing the file
1341 $file: file object that will be used to create the image
1342 &$params: 2-D array of parameters
1344 'ParserTestParser': called when creating a new instance of Parser in
1345 maintenance/parserTests.inc
1346 $parser: Parser object created
1348 'ParserTestTables': alter the list of tables to duplicate when parser tests
1349 are run. Use when page save hooks require the presence of custom tables
1350 to ensure that tests continue to run properly.
1351 &$tables: array of table names
1353 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1354 my talk page, my contributions" etc).
1356 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1357 &$title: Title object representing the current page
1359 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1360 &$user : User performing the action
1361 $action : Action being performed
1362 &$result : Whether or not the action should be prevented
1363 Change $result and return false to give a definitive answer, otherwise
1364 the built-in rate limiting checks are used, if enabled.
1366 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1367 AJAX search suggestions. Put results into &$results outparam and return false.
1368 $ns : array of int namespace keys to search in
1369 $search : search term (not guaranteed to be conveniently normalized)
1370 $limit : maximum number of results to return
1371 &$results : out param: array of page names (strings)
1373 'PrefsEmailAudit': called when user changes his email address
1374 $user: User (object) changing his email address
1375 $oldaddr: old email address (string)
1376 $newaddr: new email address (string)
1378 'PrefsPasswordAudit': called when user changes his password
1379 $user: User (object) changing his passoword
1380 $newPass: new password
1381 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1383 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1384 $article: the title being (un)protected
1385 $output: a string of the form HTML so far
1387 'ProtectionForm::save': called when a protection form is submitted
1388 $article: the title being (un)protected
1389 $errorMsg: an html message string of an error
1391 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1392 $article: the page the form is shown for
1393 $out: OutputPage object
1395 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1396 loader request or generating HTML output.
1397 &$resourceLoader: ResourceLoader object
1399 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1400 to add modules to the startup module. This hook should be used sparingly since any module added here
1401 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1404 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1405 &$obj: RawPage object
1406 &$text: The text that's going to be the output
1408 'RecentChange_save': called at the end of RecentChange::save()
1409 $recentChange: RecentChange object
1411 'ResourceLoaderGetConfigVars': called at the end of
1412 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1413 configuration variables to JavaScript. Things that depend on the current
1414 page/request state must be added through MakeGlobalVariablesScript instead.
1415 &$vars: array( variable name => value )
1417 'RevisionInsertComplete': called after a revision is inserted into the DB
1418 &$revision: the Revision
1419 $data: the data stored in old_text. The meaning depends on $flags: if external
1420 is set, it's the URL of the revision text in external storage; otherwise,
1421 it's the revision text itself. In either case, if gzip is set, the revision
1423 $flags: a comma-delimited list of strings representing the options used. May
1424 include: utf8 (this will always be set for new revisions); gzip; external.
1426 'SearchUpdate': Prior to search update completion
1428 $namespace : Page namespace
1430 $text : Current text being indexed
1432 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1433 $allSearchTerms : Array of the search terms in all content languages
1434 &$titleResult : Outparam; the value to return. A Title object or null.
1436 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1437 $term : Search term string
1438 &$title : Outparam; set to $title object and return false for a match
1440 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1441 $term : Search term string
1442 &$title : Current Title object that is being returned (null if none found).
1444 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1445 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1446 in the $searchEngine->namespaces array.
1447 $query : Original query.
1448 &$parsed : Resultant query with the prefixes stripped.
1450 'SearchableNamespaces': An option to modify which namespaces are searchable.
1451 &$arr : Array of namespaces ($nsId => $name) which will be used.
1453 'SetupAfterCache': Called in Setup.php, after cache objects are set
1455 'SetupUserMessageArticle': Called in User::leaveUserMessage() before
1456 anything has been posted to the article.
1457 $user: The user who we left the message for.
1458 &$article: The article that will be posted to.
1459 $subject: The subject of the message
1460 $text: The text of the message.
1461 $signature: The signature we used.
1462 $summary: The edit summary.
1463 $editor: The editor that performed the edit.
1465 'ShowMissingArticle': Called when generating the output for a non-existent page
1466 $article: The article object corresponding to the page
1468 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1469 $text: Text being shown
1470 $title: Title of the custom script/stylesheet page
1471 $output: Current OutputPage object
1473 'ShowSearchHitTitle': Customise display of search hit title/link.
1474 &$title: Title to link to
1475 &$text: Text to use for the link
1476 $result: The search result
1477 $terms: The search terms entered
1478 $page: The SpecialSearch object.
1480 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1481 &$siteNotice: HTML returned as the sitenotice
1483 Return true to allow the normal method of notice selection/rendering to work,
1484 or change the value of $siteNotice and return false to alter it.
1486 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1487 &$siteNotice: HTML sitenotice
1489 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1491 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1493 &$text: bottomScripts Text
1494 Append to $text to add additional text/scripts after the stock bottom scripts.
1496 'SkinAfterContent': Allows extensions to add text after the page content and
1498 &$data: (string) Text to be printed out directly (without parsing)
1500 This hook should work in all skins. Just set the &$data variable to the text
1501 you're going to add.
1503 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1505 &$bar: Sidebar contents
1506 Modify $bar to add or modify sidebar portlets.
1508 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1509 $title: displayed page title
1510 $type: 'normal' or 'history' for old/diff views
1511 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1512 &$link: overridable HTML link to be passed into the message as $1
1513 &$forContent: overridable flag if copyright footer is shown in content language.
1516 &$text: additional 'powered by' icons in HTML.
1517 Note: Modern skin does not use the MediaWiki icon but plain text instead
1520 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1521 &$subpages: Subpage links HTML
1523 $out: OutputPage object
1524 If false is returned $subpages will be used instead of the HTML
1525 subPageSubtitle() generates.
1526 If true is returned, $subpages will be ignored and the rest of
1527 subPageSubtitle() will run.
1529 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1530 "permanent link" tab
1531 $sktemplate: SkinTemplate object
1532 $nav_urls: array of tabs
1534 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1535 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1536 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1537 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1538 &$sktemplate: SkinTemplate object
1539 &$links: Structured navigation links
1540 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1542 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1544 &$sktemplate: SkinTemplate object
1545 &$tpl: Template engine object
1547 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1548 $sktemplate: SkinTemplate object
1549 $res: set to true to prevent active tabs
1551 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1554 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1555 You can either create your own array, or alter the parameters for
1557 &$sktemplate: The SkinTemplate instance.
1558 $title: Title instance for the page.
1559 $message: Visible label of tab.
1560 $selected: Whether this is a selected tab.
1561 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1562 &$classes: Array of CSS classes to apply.
1563 &$query: Query string to add to link.
1565 &$result: Complete assoc. array if you want to return true.
1567 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1568 been rendered (useful for adding more)
1569 $sk: The QuickTemplate based skin template running the hook.
1571 'SoftwareInfo': Called by Special:Version for returning information about
1573 $software: The array of software in format 'name' => 'version'.
1574 See SpecialVersion::softwareInformation()
1576 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1577 $id: User identifier
1579 'SpecialListusersDefaultQuery': called right before the end of
1580 UsersPager::getDefaultQuery()
1581 $pager: The UsersPager instance
1582 $query: The query array to be returned
1584 'SpecialListusersFormatRow': called right before the end of
1585 UsersPager::formatRow()
1586 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1587 $row: Database row object
1589 'SpecialListusersHeader': called before closing the <fieldset> in
1590 UsersPager::getPageHeader()
1591 $pager: The UsersPager instance
1592 $out: The header HTML
1594 'SpecialListusersHeaderForm': called before adding the submit button in
1595 UsersPager::getPageHeader()
1596 $pager: The UsersPager instance
1597 $out: The header HTML
1599 'SpecialListusersQueryInfo': called right before the end of
1600 UsersPager::getQueryInfo()
1601 $pager: The UsersPager instance
1602 $query: The query array to be returned
1604 'SpecialMovepageAfterMove': called after moving a page
1605 $movePage: MovePageForm object
1606 $oldTitle: old title (object)
1607 $newTitle: new title (object)
1609 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1610 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1611 $opts: FormOptions object containing special page options
1612 &$conds: array of WHERE conditionals for query
1614 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1615 hook to remove a core special page
1616 $list: list (array) of core special pages
1618 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1619 use this to change some selection criteria or substitute a different title
1620 &$randstr: The random number from wfRandom()
1621 &$isRedir: Boolean, whether to select a redirect or non-redirect
1622 &$namespaces: An array of namespace indexes to get the title from
1623 &$extra: An array of extra SQL statements
1624 &$title: If the hook returns false, a Title object to use instead of the
1625 result from the normal query
1627 'SpecialRecentChangesPanel': called when building form options in
1628 SpecialRecentChanges
1629 &$extraOpts: array of added items, to which can be added
1630 $opts: FormOptions for this request
1632 'SpecialRecentChangesQuery': called when building sql query for
1633 SpecialRecentChanges and SpecialRecentChangesLinked
1634 &$conds: array of WHERE conditionals for query
1635 &$tables: array of tables to be queried
1636 &$join_conds: join conditions for the tables
1637 $opts: FormOptions for this request
1638 &$query_options: array of options for the database request
1639 &$select: String '*' or array of columns to select
1641 'SpecialSearchGo': called when user clicked the "Go"
1642 &$title: title object generated from the text entered by the user
1643 &$term: the search term entered by the user
1645 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1646 target doesn't exist
1647 &$title: title object generated from the text entered by the user
1649 'SpecialSearchProfiles': allows modification of search profiles
1650 &$profiles: profiles, which can be modified.
1652 'SpecialSearchResults': called before search result display when there
1654 $term: string of search term
1655 &$titleMatches: empty or SearchResultSet object
1656 &$textMatches: empty or SearchResultSet object
1658 'SpecialSearchNoResults': called before search result display when there are
1660 $term: string of search term
1662 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1663 &$extraStats: Array to save the new stats
1664 ( $extraStats['<name of statistic>'] => <value>; )
1666 'SpecialUploadComplete': Called after successfully uploading a file from
1668 $form: The SpecialUpload object
1670 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1671 use this to change the tables headers
1672 $extTypes: associative array of extensions types
1674 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1675 &$conds: array of WHERE conditionals for query
1676 &$tables: array of tables to be queried
1677 &$join_conds: join conditions for the tables
1678 &$fields: array of query fields
1680 'TitleArrayFromResult': called when creating an TitleArray object from a
1682 &$titleArray: set this to an object to override the default object returned
1683 $res: database result used to create the object
1685 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1686 that can be applied.
1687 $title: The title in question.
1688 &$types: The types of protection available.
1690 'TitleMoveComplete': after moving an article (title)
1693 $user: user who did the move
1694 $pageid: database ID of the page that's been moved
1695 $redirid: database ID of the created redirect
1697 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1698 $title: title object related to the revision
1699 $rev: revision (object) that will be viewed
1701 'UnknownAction': An unknown "action" has occured (useful for defining
1703 $action: action name
1704 $article: article "acted on"
1706 'UnitTestsList': Called when building a list of files with PHPUnit tests
1707 &$files: list of files
1709 'UnwatchArticle': before a watch is removed from an article
1710 $user: user watching
1711 $article: article object to be removed
1713 'UnwatchArticle': after a watch is removed from an article
1714 $user: user that was watching
1715 $article: article object removed
1717 'UnwatchArticleComplete': after a watch is removed from an article
1718 $user: user that watched
1719 $article: article object that was watched
1721 'UploadForm:initial': before the upload form is generated
1722 $form: UploadForm object
1723 You might set the member-variables $uploadFormTextTop and
1724 $uploadFormTextAfterSummary to inject text (HTML) either before
1725 or after the editform.
1727 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1728 $form: UploadForm object
1729 Lets you poke at member variables like $mUploadDescription before the
1731 Do not use this hook to break upload processing. This will return the user to
1732 a blank form with no error message; use UploadVerification and
1733 UploadVerifyFile instead
1735 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1736 $type: (string) the requested upload type
1737 &$className: the class name of the Upload instance to be created
1739 'UploadComplete': when Upload completes an upload
1740 &$upload: an UploadBase child instance
1742 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1744 $descriptor: (array) the HTMLForm descriptor
1746 'UploadFormSourceDescriptors': after the standard source inputs have been
1747 added to the descriptor
1748 $descriptor: (array) the HTMLForm descriptor
1750 'UploadVerification': additional chances to reject an uploaded file. Consider
1751 using UploadVerifyFile instead.
1752 string $saveName: destination file name
1753 string $tempName: filesystem path to the temporary file for checks
1754 string &$error: output: message key for message to show if upload canceled
1755 by returning false. May also be an array, where the first element
1756 is the message key and the remaining elements are used as parameters to
1759 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1760 in most cases over UploadVerification.
1761 object $upload: an instance of UploadBase, with all info about the upload
1762 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1763 will typically only apply for specific mime types.
1764 object &$error: output: true if the file is valid. Otherwise, an indexed array
1765 representing the problem with the file, where the first element
1766 is the message key and the remaining elements are used as parameters to
1769 'UploadComplete': Upon completion of a file upload
1770 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1771 $uploadBase->getLocalFile().
1773 'User::mailPasswordInternal': before creation and mailing of a user's new
1775 $user: the user who sent the message out
1776 $ip: IP of the user who sent the message out
1777 $u: the account whose new password will be set
1779 'UserAddGroup': called when adding a group; return false to override
1780 stock group addition.
1781 $user: the user object that is to have a group added
1782 &$group: the group to add, can be modified
1784 'UserArrayFromResult': called when creating an UserArray object from a
1786 &$userArray: set this to an object to override the default object returned
1787 $res: database result used to create the object
1789 'userCan': To interrupt/advise the "user can do X to Y article" check.
1790 If you want to display an error message, try getUserPermissionsErrors.
1791 $title: Title object being checked against
1792 $user : Current user object
1793 $action: Action being checked
1794 $result: Pointer to result returned if hook returns false. If null is returned,
1795 userCan checks are continued by internal code.
1797 'UserCanSendEmail': To override User::canSendEmail() permission check
1798 $user: User (object) whose permission is being checked
1799 &$canSend: bool set on input, can override on output
1801 'UserClearNewTalkNotification': called when clearing the
1802 "You have new messages!" message, return false to not delete it
1803 $user: User (object) that'll clear the message
1805 'UserComparePasswords': called when checking passwords, return false to
1806 override the default password checks
1807 &$hash: String of the password hash (from the database)
1808 &$password: String of the plaintext password the user entered
1809 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1811 &$result: If the hook returns false, this Boolean value will be checked to
1812 determine if the password was valid
1814 'UserCreateForm': change to manipulate the login form
1815 $template: SimpleTemplate instance for the form
1817 'UserCryptPassword': called when hashing a password, return false to implement
1818 your own hashing method
1819 &$password: String of the plaintext password to encrypt
1820 &$salt: String of the password salt or Boolean false if no salt is provided
1821 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1823 &$hash: If the hook returns false, this String will be used as the hash
1825 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1826 $user: User to get groups for
1827 &$groups: Current effective groups
1829 'UserGetAllRights': after calculating a list of all available rights
1830 &$rights: Array of rights, which may be added to.
1832 'UserGetEmail': called when getting an user email address
1834 &$email: email, change this to override local email
1836 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1837 email authentification
1839 &$timestamp: timestamp, change this to override local email authentification
1842 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1843 &$groups: List of implicit (automatically-assigned) groups
1845 'UserGetLanguageObject': Called when getting user's interface language object
1847 &$code: Langauge code that will be used to create the object
1849 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1850 &$reservedUsernames: $wgReservedUsernames
1852 'UserGetRights': Called in User::getRights()
1853 $user: User to get rights for
1854 &$rights: Current rights
1856 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1858 $user: User in question
1859 $title: Title of the page in question
1860 &$blocked: Out-param, whether or not the user is blocked from that page.
1861 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1862 own user talk pages.
1864 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1866 $ip: User's IP address
1867 &$blocked: Whether the user is blocked, to be modified by the hook
1869 'UserLoadAfterLoadFromSession': called to authenticate users on
1870 external/environmental means; occurs after session is loaded
1871 $user: user object being loaded
1873 'UserLoadDefaults': called when loading a default user
1877 'UserLoadFromDatabase': called when loading a user from the database
1879 &$s: database query object
1881 'UserLoadFromSession': called to authenticate users on external/environmental
1882 means; occurs before session is loaded
1883 $user: user object being loaded
1884 &$result: set this to a boolean value to abort the normal authentification
1887 'UserLoadOptions': when user options/preferences are being loaded from
1890 &$options: Options, can be modified.
1892 'UserLoginComplete': after a user has logged in
1893 $user: the user object that was created on login
1894 $inject_html: Any HTML to inject after the "logged in" message.
1896 'UserLoginForm': change to manipulate the login form
1897 $template: SimpleTemplate instance for the form
1899 'UserLoginMailPassword': Block users from emailing passwords
1900 $name: the username to email the password of.
1901 &$error: out-param - the error message to return.
1903 'UserLogout': before a user logs out
1904 $user: the user object that is about to be logged out
1906 'UserLogoutComplete': after a user has logged out
1907 $user: the user object _after_ logout (won't have name, ID, etc.)
1908 $inject_html: Any HTML to inject after the "logged out" message.
1909 $oldName: name of the user before logout (string)
1911 'UserRemoveGroup': called when removing a group; return false to override
1912 stock group removal.
1913 $user: the user object that is to have a group removed
1914 &$group: the group to be removed, can be modified
1916 'UserRights': After a user's group memberships are changed
1917 $user : User object that was changed
1918 $add : Array of strings corresponding to groups added
1919 $remove: Array of strings corresponding to groups removed
1921 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1923 $user: user retrieving new talks messages
1924 $talks: array of new talks page(s)
1926 'UserSaveSettings': called when saving user settings
1929 'UserSaveOptions': Called just before saving user preferences/options.
1931 &$options: Options, modifiable
1933 'UserSetCookies': called when setting user cookies
1935 &$session: session array, will be added to $_SESSION
1936 &$cookies: cookies array mapping cookie name to its value
1938 'UserSetEmail': called when changing user email address
1940 &$email: new email, change this to override new email address
1942 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1943 of email authentification
1945 &$timestamp: new timestamp, change this to override local email
1946 authentification timestamp
1948 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
1949 used to alter the SQL query which gets the list of wanted pages
1950 &$wantedPages: WantedPagesPage object
1951 &$query: query array, see QueryPage::getQueryInfo() for format documentation
1953 'WatchArticle': before a watch is added to an article
1954 $user: user that will watch
1955 $article: article object to be watched
1957 'WatchArticleComplete': after a watch is added to an article
1958 $user: user that watched
1959 $article: article object watched
1961 'WatchlistEditorBuildRemoveLine': when building remove lines in
1962 Special:Watchlist/edit
1963 &$tools: array of extra links
1964 $title: Title object
1965 $redirect: whether the page is a redirect
1968 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1970 One, and only one hook should set this, and return false.
1971 &$tables: Database tables to use in the SELECT query
1972 &$opts: Options to use for the query
1973 &$join: Join conditions
1975 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1976 query pages to be updated with maintenance/updateSpecialPages.php
1977 $query: $wgQueryPages itself
1979 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1980 metadata to be added.
1981 $obj: The XmlDumpWriter object.
1982 &$out: The output string.
1983 $row: The database row for the page.
1984 $title: The title of the page.
1986 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1988 $obj: The XmlDumpWriter object.
1989 &$out: The text being output.
1990 $row: The database row for the revision.
1991 $text: The revision text.
1993 More hooks might be available but undocumented, you can execute
1994 ./maintenance/findhooks.php to find hidden one.