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