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.
251 'AbortMove': allows to abort moving an article (title)
254 $user: user who is doing the move
256 $reason: the reason for the move (added in 1.13)
258 'AbortNewAccount': Return false to cancel account creation.
259 $user: the User object about to be created (read-only, incomplete)
260 $message: out parameter: error message to display on abort
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
266 'AfterImportPage': When a page import is completed
267 $title: Title under which the revisions were imported
268 $origTitle: Title provided by the XML file
269 $revCount: Number of revisions in the XML file
270 $sRevCount: Number of sucessfully imported revisions
271 $pageInfo: associative array of page information
273 'AfterUserMessage': After a user message has been left, this hook is
274 called to take care of any cleanup.
275 $user: The user who we left the message for.
276 $article: The article the message was left on.
277 $subject: The subject of the message
278 $text: The text of the message.
279 $signature: The signature we used.
280 $summary: The edit summary.
281 $editor: The editor that performed the edit.
283 'AjaxAddScript': Called in output page just before the initialisation
284 of the javascript ajax engine. The hook is only called when ajax
285 is enabled ( $wgUseAjax = true; ).
287 'AlternateEdit': before checking if an user can edit a page and
288 before showing the edit form ( EditPage::edit() ). This is triggered
290 $EditPage: the EditPage object
292 'APIAfterExecute': after calling the execute() method of an API module.
293 Use this to extend core API modules.
294 &$module: Module object
296 'APIEditBeforeSave': before saving a page with api.php?action=edit,
297 after processing request parameters. Return false to let the request
298 fail, returning an error message or an <edit result="Failure"> tag
299 if $resultArr was filled.
300 $EditPage : the EditPage object
301 $text : the new text of the article (has yet to be saved)
302 &$resultArr : data in this array will be added to the API result
304 'APIGetAllowedParams': use this hook to modify a module's parameters.
305 &$module: Module object
306 &$params: Array of parameters
308 'APIGetParamDescription': use this hook to modify a module's parameter
310 &$module: Module object
311 &$desc: Array of parameter descriptions
313 'APIQueryAfterExecute': after calling the execute() method of an
314 action=query submodule. Use this to extend core API modules.
315 &$module: Module object
317 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
318 method of an action=query submodule. Use this to extend core API modules.
319 &$module: Module object
320 &$resultPageSet: ApiPageSet object
322 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
323 Every token has an action, which will be used in the intoken parameter
324 and in the output (actiontoken="..."), and a callback function which
325 should return the token, or false if the user isn't allowed to obtain
326 it. The prototype of the callback function is func($pageid, $title)
327 where $pageid is the page ID of the page the token is requested for
328 and $title is the associated Title object. In the hook, just add
329 your callback to the $tokenFunctions array and return true (returning
330 false makes no sense)
331 $tokenFunctions: array(action => callback)
333 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
334 Every token has an action, which will be used in the rvtoken parameter
335 and in the output (actiontoken="..."), and a callback function which
336 should return the token, or false if the user isn't allowed to obtain
337 it. The prototype of the callback function is func($pageid, $title, $rev)
338 where $pageid is the page ID of the page associated to the revision the
339 token is requested for, $title the associated Title object and $rev the
340 associated Revision object. In the hook, just add your callback to the
341 $tokenFunctions array and return true (returning false makes no sense)
342 $tokenFunctions: array(action => callback)
344 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
346 Every token has an action, which will be used in the rctoken parameter
347 and in the output (actiontoken="..."), and a callback function which
348 should return the token, or false if the user isn't allowed to obtain
349 it. The prototype of the callback function is func($pageid, $title, $rc)
350 where $pageid is the page ID of the page associated to the revision the
351 token is requested for, $title the associated Title object and $rc the
352 associated RecentChange object. In the hook, just add your callback to the
353 $tokenFunctions array and return true (returning false makes no sense)
354 $tokenFunctions: array(action => callback)
356 'APIQueryUsersTokens': use this hook to add custom token to list=users.
357 Every token has an action, which will be used in the ustoken parameter
358 and in the output (actiontoken="..."), and a callback function which
359 should return the token, or false if the user isn't allowed to obtain
360 it. The prototype of the callback function is func($user) where $user
361 is the User object. In the hook, just add your callback to the
362 $tokenFunctions array and return true (returning false makes no sense)
363 $tokenFunctions: array(action => callback)
365 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
366 Each service should have its own entry in the $apis array and have a
367 unique name, passed as key for the array that represents the service data.
368 In this data array, the key-value-pair identified by the apiLink key is
370 &$apis: array of services
372 'ArticleAfterFetchContent': after fetching content of an article from
374 $article: the article (object) being loaded from the database
375 $content: the content (string) of the article
377 'ArticleConfirmDelete': before writing the confirmation form for article
379 $article: the article (object) being deleted
380 $output: the OutputPage object ($wgOut)
381 &$reason: the reason (string) the article is being deleted
383 'ArticleContentOnDiff': before showing the article content below a diff.
384 Use this to change the content in this area or how it is loaded.
385 $diffEngine: the DifferenceEngine
386 $output: the OutputPage object ($wgOut)
388 'ArticleDelete': before an article is deleted
389 $article: the article (object) being deleted
390 $user: the user (object) deleting the article
391 $reason: the reason (string) the article is being deleted
392 $error: if the deletion was prohibited, the (raw HTML) error message to display
395 'ArticleDeleteComplete': after an article is deleted
396 $article: the article that was deleted
397 $user: the user that deleted the article
398 $reason: the reason the article was deleted
399 $id: id of the article that was deleted
401 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
403 $article: article (object) of the user talk page
405 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
406 article has been changed
407 $article: the article (object)
408 $editInfo: data holder that includes the parser output ($editInfo->output) for
409 that page after the change
410 $changed: bool for if the page was changed
412 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
413 recentchanges table, return false to not delete old entries
414 $article: article (object) being modified
416 'ArticleFromTitle': when creating an article object from a title object using
417 Wiki::articleFromTitle()
418 $title: title (object) used to create the article object
419 $article: article (object) that will be returned
421 'ArticleInsertComplete': After a new article is created
422 $article: Article created
423 $user: User creating the article
425 $summary: Edit summary/comment
426 $isMinor: Whether or not the edit was marked as minor
427 $isWatch: (No longer used)
428 $section: (No longer used)
429 $flags: Flags passed to Article::doEdit()
430 $revision: New Revision of the article
432 'ArticleMergeComplete': after merging to article using Special:Mergehistory
433 $targetTitle: target title (object)
434 $destTitle: destination title (object)
436 'ArticlePageDataAfter': after loading data of an article from the database
437 $article: article (object) whose data were loaded
438 $row: row (object) returned from the database server
440 'ArticlePageDataBefore': before loading data of an article from the database
441 $article: article (object) that data will be loaded
442 $fields: fileds (array) to load from the database
444 'ArticleProtect': before an article is protected
445 $article: the article being protected
446 $user: the user doing the protection
447 $protect: boolean whether this is a protect or an unprotect
448 $reason: Reason for protect
449 $moveonly: boolean whether this is for move only or not
451 'ArticleProtectComplete': after an article is protected
452 $article: the article that was protected
453 $user: the user who did the protection
454 $protect: boolean whether it was a protect or an unprotect
455 $reason: Reason for protect
456 $moveonly: boolean whether it was for move only or not
458 'ArticlePurge': before executing "&action=purge"
459 $article: article (object) to purge
461 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
462 revision of an article
463 &$title: title object of the article
465 'ArticleRevisionUndeleted': after an article revision is restored
466 $title: the article title
467 $revision: the revision
468 $oldPageID: the page ID of the revision when archived (may be null)
470 'ArticleRollbackComplete': after an article rollback is completed
471 $article: the article that was edited
472 $user: the user who did the rollback
473 $revision: the revision the page was reverted back to
474 $current: the reverted revision
476 'ArticleSave': before an article is saved
477 $article: the article (object) being saved
478 $user: the user (object) saving the article
479 $text: the new article text
480 $summary: the article summary (comment)
485 'ArticleSaveComplete': After an article has been updated
486 $article: Article modified
487 $user: User performing the modification
489 $summary: Edit summary/comment
490 $isMinor: Whether or not the edit was marked as minor
491 $isWatch: (No longer used)
492 $section: (No longer used)
493 $flags: Flags passed to Article::doEdit()
494 $revision: New Revision of the article
495 $baseRevId: the rev ID (or false) this edit was based on
497 'ArticleUndelete': When one or more revisions of an article are restored
498 $title: Title corresponding to the article restored
499 $create: Whether or not the restoration caused the page to be created
500 (i.e. it didn't exist before)
501 $comment: The comment associated with the undeletion.
503 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
504 before the user is redirected back to the page
505 &$article: the article
506 &$sectionanchor: The section anchor link (e.g. "#overview" )
507 &$extraq: Extra query parameters which can be added via hooked functions
509 'ArticleViewHeader': Before the parser cache is about to be tried for article
511 &$article: the article
512 &$pcache: whether to try the parser cache or not
513 &$outputDone: whether the output for this page finished or not
515 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
517 $article: target article (object)
519 'AuthPluginAutoCreate': Called when creating a local account for an user logged
520 in from an external authentication method
521 $user: User object created locally
523 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
524 Gives a chance for an extension to set it programattically to a variable class.
525 &$auth: the $wgAuth object, probably a stub
527 'AutopromoteCondition': check autopromote condition for user.
528 $type: condition type
531 $result: result of checking autopromote condition
533 'BadImage': When checking against the bad image list
534 $name: Image name being checked
535 &$bad: Whether or not the image is "bad"
537 Change $bad and return false to override. If an image is "bad", it is not
538 rendered inline in wiki pages or galleries in category pages.
540 'BeforeGalleryFindFile': before an image is fetched for a gallery
541 &$gallery,: the gallery object
542 &$nt: the image title
543 &$time: image timestamp
545 'BeforeInitialize': before anything is initialized in performRequestForTitle()
546 &$title: Title being used for request
547 &$article: The associated Article object
548 &$output: OutputPage object
550 $request: WebRequest object
551 $mediaWiki: Mediawiki object
553 'BeforePageDisplay': Prior to outputting a page
554 &$out: OutputPage object
557 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
558 &$parser: Parser object
559 &$title: title of the template
560 &$skip: skip this template and link it?
561 &$id: the id of the revision being parsed
563 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
564 &$parser: Parser object
565 &$nt: the image title
566 &$skip: skip this image and link it?
567 &$time: the image timestamp
569 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
570 &$parser: Parser object
571 &$ig: ImageGallery object
573 'BlockIp': before an IP address or user is blocked
574 $block: the Block object about to be saved
575 $user: the user _doing_ the block (not the one being blocked)
577 'BlockIpComplete': after an IP address or user is blocked
578 $block: the Block object that was saved
579 $user: the user who did the block (not the one being blocked)
581 'BookInformation': Before information output on Special:Booksources
582 $isbn: ISBN to show information for
583 $output: OutputPage object in use
585 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
586 &$namespaces: Array of namespace numbers with corresponding canonical names
588 'CategoryPageView': before viewing a categorypage in CategoryPage::view
589 $catpage: CategoryPage instance
591 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
592 &$changesList: ChangesList instance.
593 &$articlelink: HTML of link to article (already filled-in).
594 &$s: HTML of row that is being constructed.
595 &$rc: RecentChange instance.
596 $unpatrolled: Whether or not we are showing unpatrolled changes.
597 $watched: Whether or not the change is watched by the user.
599 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
600 $user: user (object) whose email is being confirmed
602 'ContribsPager::getQueryInfo': Before the contributions query is about to run
603 &$pager: Pager object for contributions
604 &queryInfo: The query for the contribs Pager
606 'ContributionsLineEnding': Called before a contributions HTML line is finished
607 $page: SpecialPage object for contributions
609 $row: the DB row for this line
611 'ContributionsToolLinks': Change tool links above Special:Contributions
613 $title: User page title
614 &$tools: Array of tool links
616 'CustomEditor': When invoking the page editor
617 $article: Article being edited
618 $user: User performing the edit
620 Return true to allow the normal editor to be used, or false
621 if implementing a custom editor, e.g. for a special namespace,
624 'DatabaseOraclePostInit': Called after initialising an Oracle database
625 &$db: the DatabaseOracle object
627 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
628 $title: the diff page title (nullable)
629 &$oldId: the actual old Id to use in the diff
630 &$newId: the actual new Id to use in the diff (0 means current)
631 $old: the ?old= param value from the url
632 $new: the ?new= param value from the url
634 'DiffViewHeader': called before diff display
635 $diff: DifferenceEngine object that's calling
636 $oldRev: Revision object of the "old" revision (may be null/invalid)
637 $newRev: Revision object of the "new" revision
639 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
641 $article: article (object) being viewed
642 $oldid: oldid (int) being viewed
644 'DoEditSectionLink': Override the HTML generated for section edit links
645 $skin: Skin object rendering the UI
646 $title: Title object for the title being linked to (may not be the same as
647 $wgTitle, if the section is included from a template)
648 $section: The designation of the section being pointed to, to be included in
649 the link, like "§ion=$section"
650 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
651 By default, this is wrapped in the 'editsectionhint' message.
652 &$result: The HTML to return, prefilled with the default plus whatever other
653 changes earlier hooks have made
654 $lang: The language code to use for the link in the wfMsg* functions
656 'EditFilter': Perform checks on an edit
657 $editor: Edit form (see includes/EditPage.php)
658 $text: Contents of the edit box
659 $section: Section being edited
660 &$error: Error message to return
661 $summary: Edit summary for page
663 'EditFilterMerged': Post-section-merge edit filter
664 $editor: EditPage instance (object)
665 $text: content of the edit box
666 &$error: error message to return
667 $summary: Edit summary for page
669 'EditFormPreloadText': Allows population of the edit form when creating
671 &$text: Text to preload with
672 &$title: Title object representing the page being created
674 'EditFormInitialText': Allows modifying the edit form when editing existing
676 $editPage: EditPage object
678 'EditPage::attemptSave': called before an article is
679 saved, that is before insertNewArticle() is called
680 $editpage_Obj: the current EditPage object
682 'EditPage::importFormData': allow extensions to read additional data
684 $editpage: EditPage instance
686 return value is ignored (should always return true)
688 'EditPage::showEditForm:fields': allows injection of form field into edit form
689 &$editor: the EditPage instance for reference
690 &$out: an OutputPage instance to write to
691 return value is ignored (should always return true)
693 'EditPage::showEditForm:initial': before showing the edit form
694 $editor: EditPage instance (object)
696 Return false to halt editing; you'll need to handle error messages, etc.
697 yourself. Alternatively, modifying $error and returning true will cause the
698 contents of $error to be echoed at the top of the edit form as wikitext.
699 Return true without altering $error to allow the edit to proceed.
701 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
702 when there's an edit conflict. Return false to halt normal diff output; in
703 this case you're responsible for computing and outputting the entire "conflict"
704 part, i.e., the "difference between revisions" and "your text" headers and
706 &$editor: EditPage instance
707 &$out: OutputPage instance
709 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
710 textarea in the edit form
711 &$editpage: The current EditPage object
712 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
713 &$tabindex: HTML tabindex of the last edit check/button
715 'EditPageBeforeEditChecks': allows modifying the edit checks below the
716 textarea in the edit form
717 &$editpage: The current EditPage object
718 &$checks: Array of edit checks like "watch this page"/"minor edit"
719 &$tabindex: HTML tabindex of the last edit check/button
721 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
722 textarea in the edit form
723 &$toolbar: The toolbar HTMl
725 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
726 $title: title of page being edited
727 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
729 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
731 $editPage: EditPage object
732 &$newtext: wikitext that will be used as "your version"
734 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
735 $editPage: EditPage object
736 &$toparse: wikitext that will be parsed
738 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
739 &$editpage: The current EditPage object
740 &$res: the HTML of the error text
742 'EditPageTosSummary': Give a chance for site and per-namespace customizations
743 of terms of service summary link that might exist separately from the copyright
745 $title: title of page being edited
746 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
748 'EditSectionLink': Do not use, use DoEditSectionLink instead.
749 $skin: Skin rendering the UI
750 $title: Title being linked to
751 $section: Section to link to
753 &$result: Result (alter this to override the generated links)
754 $lang: The language code to use for the link in the wfMsg* functions
756 'EmailConfirmed': When checking that the user's email address is "confirmed"
757 $user: User being checked
758 $confirmed: Whether or not the email address is confirmed
759 This runs before the other checks, such as anonymity and the real check; return
760 true to allow those checks to occur, and false if checking is done.
762 'EmailUser': before sending email from one user to another
763 $to: address of receiving user
764 $from: address of sending user
765 $subject: subject of the mail
766 $text: text of the mail
768 'EmailUserCC': before sending the copy of the email to the author
769 $to: address of receiving user
770 $from: address of sending user
771 $subject: subject of the mail
772 $text: text of the mail
774 'EmailUserComplete': after sending email from one user to another
775 $to: address of receiving user
776 $from: address of sending user
777 $subject: subject of the mail
778 $text: text of the mail
780 'EmailUserForm': after building the email user form object
781 $form: HTMLForm object
783 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
784 $user: The user who is trying to email another user.
785 $editToken: The user's edit token.
786 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
788 'FetchChangesList': When fetching the ChangesList derivative for
790 &$user: User the list is being fetched for
791 &$skin: Skin object to be used with the list
792 &$list: List object (defaults to NULL, change it to an object
793 instance and return false override the list derivative used)
795 'FileDeleteComplete': When a file is deleted
796 $file: reference to the deleted file
797 $oldimage: in case of the deletion of an old image, the name of the old file
798 $article: in case all revisions of the file are deleted a reference to the
799 article associated with the file.
800 $user: user who performed the deletion
803 'FileUpload': When a file upload occurs
804 $file : Image object representing the file that was uploaded
805 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
806 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
808 'FileUndeleteComplete': When a file is undeleted
809 $title: title object to the file
810 $fileVersions: array of undeleted versions. Empty if all versions were restored
811 $user: user who performed the undeletion
814 'FormatUserMessage': Hook to format a message if you want to override
815 the internal formatter.
816 $subject: Title of the message.
817 &$text: Text of the message.
818 $signature: Signature that they would like to leave.
820 'GetAutoPromoteGroups': When determining which autopromote groups a user
821 is entitled to be in.
822 &$user: user to promote.
823 &$promote: groups that will be added.
825 'GetBlockedStatus': after loading blocking status of an user from the database
826 $user: user (object) being checked
828 'GetCacheVaryCookies': get cookies that should vary cache options
829 $out: OutputPage object
830 &$cookies: array of cookies name, add a value to it if you want to add a cookie
831 that have to vary cache options
833 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
834 $title: Title object of page
835 $url: string value as output (out parameter, can modify)
836 $query: query options passed to Title::getFullURL()
838 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
839 $title: Title object of page
840 $url: string value as output (out parameter, can modify)
841 $query: query options passed to Title::getInternalURL()
843 'GetIP': modify the ip of the current user (called only once)
844 &$ip: string holding the ip as determined so far
846 'GetLinkColours': modify the CSS class of an array of page links
847 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
849 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
851 'GetLocalURL': modify local URLs as output into page links
852 $title: Title object of page
853 $url: string value as output (out parameter, can modify)
854 $query: query options passed to Title::getLocalURL()
856 'GetPreferences': modify user preferences
857 $user: User whose preferences are being modified.
858 &$preferences: Preferences description array, to be fed to an HTMLForm object
860 'getUserPermissionsErrors': Add a permissions error when permissions errors are
861 checked for. Use instead of userCan for most cases. Return false if the
862 user can't do it, and populate $result with the reason in the form of
863 array( messagename, param1, param2, ... ). For consistency, error messages
864 should be plain text with no special coloring, bolding, etc. to show that
865 they're errors; presenting them properly to the user as errors is done by
867 $title: Title object being checked against
868 $user : Current user object
869 $action: Action being checked
870 $result: User permissions error to add. If none, return true.
872 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
873 if expensive checks are enabled.
875 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
876 image insertion. You can skip the default logic entirely by returning
877 false, or just modify a few things using call-by-reference.
879 &$title: Title object of the image
880 &$file: File object, or false if it doesn't exist
881 &$frameParams: Various parameters with special meanings; see documentation in
882 includes/Linker.php for Linker::makeImageLink2
883 &$handlerParams: Various parameters with special meanings; see documentation in
884 includes/Linker.php for Linker::makeImageLink2
885 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
886 &$res: Final HTML output, used if you return false
889 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
890 the image on an image page
891 $imagePage: ImagePage object ($this)
894 'ImagePageAfterImageLinks': called after the image links section on an image
896 $imagePage: ImagePage object ($this)
897 &$html: HTML for the hook to add
899 'ImagePageFileHistoryLine': called when a file history line is contructed
901 $line: the HTML of the history line
902 $css: the line CSS class
904 'ImagePageFindFile': called when fetching the file associated with an image page
905 $page: ImagePage object
907 &$displayFile: displayed File object
909 'ImagePageShowTOC': called when the file toc on an image page is generated
910 $page: ImagePage object
911 &$toc: Array of <li> strings
913 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
915 &$title: the Title object of the file as it would appear for the upload page
916 &$path: the original file and path name when img_auth was invoked by the the web
918 &$name: the name only component of the file
919 &$result: The location to pass back results of the hook routine (only used if
921 $result[0]=The index of the header message
922 $result[1]=The index of the body text message
923 $result[2 through n]=Parameters passed to body text message. Please note the
924 header message cannot receive/use parameters.
926 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
927 $reader: XMLReader object
928 $logInfo: Array of information
929 Return false to stop further processing of the tag
931 'ImportHandlePageXMLTag': When parsing a XML tag in a page
932 $reader: XMLReader object
933 $pageInfo: Array of information
934 Return false to stop further processing of the tag
936 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
937 $reader: XMLReader object
938 $revInfo: Array of information
939 Return false to stop further processing of the tag
941 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
942 $reader: XMLReader object
943 Return false to stop further processing of the tag
945 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
946 $reader: XMLReader object
947 $revisionInfo: Array of information
948 Return false to stop further processing of the tag
950 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
951 $title: Title object ($wgTitle)
953 $ignoreRedirect: boolean to skip redirect check
954 $target: Title/string of redirect target
955 $article: Article object
957 'InternalParseBeforeLinks': during Parser's internalParse method before links
958 but after noinclude/includeonly/onlyinclude and other processing.
959 &$parser: Parser object
960 &$text: string containing partially parsed text
961 &$stripState: Parser's internal StripState object
963 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
964 $user: user (object) whose email is being invalidated
966 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
967 $article: article (object) being checked
969 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
971 $result: Change this value to override the result of wfIsTrustedProxy()
973 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
974 tance to return false if the domain name doesn't match your organization
975 $addr: The e-mail address entered by the user
976 &$result: Set this and return false to override the internal checks
978 'isValidPassword': Override the result of User::isValidPassword()
979 $password: The password entered by the user
980 &$result: Set this and return false to override the internal checks
981 $user: User the password is being validated for
983 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
984 $wgExtensionMessagesFiles instead.
985 Use this to define synonyms of magic words depending of the language
986 $magicExtensions: associative array of magic words synonyms
987 $lang: laguage code (string)
989 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
990 listed in $wgExtensionMessagesFiles instead.
991 Use to define aliases of special pages names depending of the language
992 $specialPageAliases: associative array of magic words synonyms
993 $lang: laguage code (string)
995 'LanguageGetTranslatedLanguageNames': Provide translated language names.
996 &$names: array of language code => language name
997 $code language of the preferred translations
999 'LinkBegin': Used when generating internal and interwiki links in
1000 Linker::link(), before processing starts. Return false to skip default proces-
1001 sing and return $ret. See documentation for Linker::link() for details on the
1002 expected meanings of parameters.
1003 $skin: the Skin object
1004 $target: the Title that the link is pointing to
1005 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
1007 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1008 tive array form, with keys and values unescaped. Should be merged with de-
1009 fault values, with a value of false meaning to suppress the attribute.
1010 &$query: the query string to add to the generated URL (the bit after the "?"),
1011 in associative array form, with keys and values unescaped.
1012 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1013 &$ret: the value to return if your hook returns false.
1015 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1016 just before the function returns a value. If you return true, an <a> element
1017 with HTML attributes $attribs and contents $text will be returned. If you re-
1018 turn false, $ret will be returned.
1019 $skin: the Skin object
1020 $target: the Title object that the link is pointing to
1021 $options: the options. Will always include either 'known' or 'broken', and may
1022 include 'noclasses'.
1023 &$text: the final (raw HTML) contents of the <a> tag, after processing.
1024 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1026 &$ret: the value to return if your hook returns false.
1028 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1030 &$url: the image url
1031 &$alt: the image's alt text
1032 &$img: the new image HTML (if returning false)
1034 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1037 &$text: the link text
1038 &$link: the new link HTML (if returning false)
1039 &$attribs: the attributes to be applied.
1040 $linkType: The external link type
1042 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1044 &$linksUpdate: the LinksUpdate object
1046 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1048 &$linksUpdate: the LinksUpdate object
1050 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1051 &$linksUpdate: the LinksUpdate object
1053 'ListDefinedTags': When trying to find all defined tags.
1054 &$tags: The list of tags.
1056 'LoadExtensionSchemaUpdates': called during database installation and updates
1057 &updater: A DatabaseUpdater subclass
1059 'LocalFile::getHistory': called before file history query performed
1062 $fields: select fields
1064 $opts: query options
1065 $join_conds: JOIN conditions
1067 'LocalisationCacheRecache': Called when loading the localisation data into cache
1068 $cache: The LocalisationCache object
1069 $code: language code
1070 &$alldata: The localisation data from core and extensions
1072 'LoginAuthenticateAudit': a login attempt for a valid user account either
1073 succeeded or failed. No return data is accepted; this hook is for auditing only.
1074 $user: the User object being authenticated against
1075 $password: the password being submitted and found wanting
1076 $retval: a LoginForm class constant with authenticateUserData() return
1077 value (SUCCESS, WRONG_PASS, etc)
1079 'LogLine': Processes a single log entry on Special:Log
1080 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1081 logging.log_type database field.
1082 $log_action: string for the type of log action (e.g. 'delete', 'block',
1083 'create2'). Corresponds to logging.log_action database field.
1084 $title: Title object that corresponds to logging.log_namespace and
1085 logging.log_title database fields.
1086 $paramArray: Array of parameters that corresponds to logging.log_params field.
1087 Note that only $paramArray[0] appears to contain anything.
1088 &$comment: string that corresponds to logging.log_comment database field, and
1089 which is displayed in the UI.
1090 &$revert: string that is displayed in the UI, similar to $comment.
1091 $time: timestamp of the log entry (added in 1.12)
1093 'LogPageValidTypes': action being logged.
1094 DEPRECATED: Use $wgLogTypes
1095 &$type: array of strings
1097 'LogPageLogName': name of the logging page(s).
1098 DEPRECATED: Use $wgLogNames
1099 &$typeText: array of strings
1101 'LogPageLogHeader': strings used by wfMsg as a header.
1102 DEPRECATED: Use $wgLogHeaders
1103 &$headerText: array of strings
1105 'LogPageActionText': strings used by wfMsg as a header.
1106 DEPRECATED: Use $wgLogActions
1107 &$actionText: array of strings
1109 'MagicWordMagicWords': When defining new magic word.
1110 DEPRECATED: use $magicWords in a file listed in
1111 $wgExtensionMessagesFiles instead.
1112 $magicWords: array of strings
1114 'MagicWordwgVariableIDs': When definig new magic words IDs.
1115 $variableIDs: array of strings
1117 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1118 is executed. Ideally, this hook should only be used to add variables that
1119 depend on the current page/request; static configuration should be added
1120 through ResourceLoaderConfigVars instead.
1121 &$vars: variable (or multiple variables) to be added into the output
1122 of Skin::makeVariablesScript
1124 'MarkPatrolled': before an edit is marked patrolled
1125 $rcid: ID of the revision to be marked patrolled
1126 $user: the user (object) marking the revision as patrolled
1127 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1128 needs to be a sysop in order to mark an edit patrolled
1130 'MarkPatrolledComplete': after an edit is marked patrolled
1131 $rcid: ID of the revision marked as patrolled
1132 $user: user (object) who marked the edit patrolled
1133 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1134 must be a sysop to patrol the edit
1136 'MathAfterTexvc': after texvc is executed when rendering mathematics
1137 $mathRenderer: instance of MathRenderer
1138 $errmsg: error message, in HTML (string). Nonempty indicates failure
1139 of rendering the formula
1141 'MediaWikiPerformAction': Override MediaWiki::performAction().
1142 Use this to do something completely different, after the basic
1143 globals have been set up, but before ordinary actions take place.
1145 $article: $wgArticle
1148 $request: $wgRequest
1149 $mediaWiki: The $mediawiki object
1151 'MessagesPreLoad': When loading a message from the database
1152 $title: title of the message (string)
1153 $message: value (string), change it to the message you want to define
1155 'MessageCacheReplace': When a message page is changed.
1156 Useful for updating caches.
1157 $title: name of the page changed.
1158 $text: new contents of the page.
1160 'ModifyExportQuery': Modify the query used by the exporter.
1161 $db: The database object to be queried.
1162 &$tables: Tables in the query.
1163 &$conds: Conditions in the query.
1164 &$opts: Options for the query.
1165 &$join_conds: Join conditions for the query.
1167 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1168 been rendered (useful for adding more)
1169 Note: this is only run for the Monobook skin. This hook is deprecated and
1170 may be removed in the future. To add items to the toolbox you should use
1171 the SkinTemplateToolboxEnd hook instead, which works for all
1172 "SkinTemplate"-type skins.
1173 $tools: array of tools
1175 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1176 and returning it for the skin to output. You can add items to the toolbox while
1177 still letting the skin make final decisions on skin-specific markup conventions
1179 &$sk: The BaseTemplate base skin template
1180 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1181 BaseTemplate::makeListItem for details on the format of individual
1182 items inside of this array
1184 'NewRevisionFromEditComplete': called when a revision was inserted
1186 $article: the article edited
1187 $rev: the new revision
1188 $baseID: the revision ID this was based off, if any
1189 $user: the editing user
1191 'NormalizeMessageKey': Called before the software gets the text of a message
1192 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1194 &$key: the message being looked up. Change this to something else to change
1195 what message gets displayed (string)
1196 &$useDB: whether or not to look up the message in the database (bool)
1197 &$langCode: the language code to get the message for (string) - or -
1198 whether to use the content language (true) or site language (false) (bool)
1199 &$transform: whether or not to expand variables and templates
1200 in the message (bool)
1202 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1203 &$changeslist: The OldChangesList instance.
1204 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1205 &$rc: The RecentChange object.
1207 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1208 Hooks can alter or append to the array of URLs for search & suggestion formats.
1209 &$urls: array of associative arrays with Url element attributes
1211 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1212 users and/or IP addresses too
1213 $otherBlockLink: An array with links to other block logs
1214 $ip: The requested IP address or username
1216 'OutputPageBeforeHTML': a page has been processed by the parser and
1217 the resulting HTML is about to be displayed.
1218 $parserOutput: the parserOutput (object) that corresponds to the page
1219 $text: the text that will be displayed, in HTML (string)
1221 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1222 tag to allow for extensions to add attributes to the body of the page they might
1223 need. Or to allow building extensions to add body classes that aren't of high
1224 enough demand to be included in core.
1225 $out: The OutputPage which called the hook, can be used to get the real title
1226 $sk: The Skin that called OutputPage::headElement
1227 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1229 'OutputPageCheckLastModified': when checking if the page has been modified
1230 since the last visit
1231 &$modifiedTimes: array of timestamps.
1232 The following keys are set: page, user, epoch
1234 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1235 $out: OutputPage instance (object)
1236 $parserOutput: parserOutput instance being added in $out
1238 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1239 categories. Implementations should return false if they generate the category
1240 links, so the default link generation is skipped.
1241 $out: OutputPage instance (object)
1242 $categories: associative array, keys are category names, values are category
1243 types ("normal" or "hidden")
1244 $links: array, intended to hold the result. Must be an associative array with
1245 category types as keys and arrays of HTML links as values.
1247 'PageHistoryBeforeList': When a history page list is about to be constructed.
1248 $article: the article that the history is loading for
1250 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1251 $row: the revision row for this line
1252 $s: the string representing this parsed line
1253 $classes: array containing the <li> element classes
1255 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1258 $queryInfo: the query parameters
1260 'PageRenderingHash': alter the parser cache option hash key
1261 A parser extension which depends on user options should install
1262 this hook and append its values to the key.
1263 $hash: reference to a hash key string which can be modified
1265 'ParserAfterStrip': Same as ParserBeforeStrip
1267 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1268 $parser: Parser object being used
1269 $text: text that'll be returned
1271 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1272 $parser: Parser object
1273 $text: text to parse
1274 $stripState: StripState instance being used
1276 'ParserBeforeStrip': Called at start of parsing time
1277 (no more strip, deprecated ?)
1278 $parser: parser object
1279 $text: text being parsed
1280 $stripState: stripState used (object)
1282 'ParserBeforeTidy': called before tidy and custom tags replacements
1283 $parser: Parser object being used
1286 'ParserClearState': called at the end of Parser::clearState()
1287 $parser: Parser object being cleared
1289 'ParserFirstCallInit': called when the parser initialises for the first time
1290 &$parser: Parser object being cleared
1292 'ParserGetVariableValueSwitch': called when the parser need the value of a
1294 $parser: Parser object
1295 $varCache: array to store the value in case of multiples calls of the
1297 $index: index (string) of the magic
1298 $ret: value of the magic word (the hook should set it)
1299 $frame: PPFrame object to use for expanding any template variables
1301 'ParserGetVariableValueTs': use this to change the value of the time for the
1302 {{LOCAL...}} magic word
1303 $parser: Parser object
1304 $time: actual time (timestamp)
1306 'ParserGetVariableValueVarCache': use this to change the value of the
1307 variable cache or return false to not use it
1308 $parser: Parser object
1309 $varCache: varaiable cache (array)
1311 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1312 include comments about size of the text parsed
1313 $parser: Parser object
1314 $limitReport: text that will be included (without comment tags)
1316 'ParserMakeImageParams': Called before the parser make an image link, use this
1317 to modify the parameters of the image.
1318 $title: title object representing the file
1319 $file: file object that will be used to create the image
1320 &$params: 2-D array of parameters
1322 'ParserTestParser': called when creating a new instance of Parser in
1323 maintenance/parserTests.inc
1324 $parser: Parser object created
1326 'ParserTestTables': alter the list of tables to duplicate when parser tests
1327 are run. Use when page save hooks require the presence of custom tables
1328 to ensure that tests continue to run properly.
1329 &$tables: array of table names
1331 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1332 my talk page, my contributions" etc).
1334 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1335 &$title: Title object representing the current page
1337 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1338 &$user : User performing the action
1339 $action : Action being performed
1340 &$result : Whether or not the action should be prevented
1341 Change $result and return false to give a definitive answer, otherwise
1342 the built-in rate limiting checks are used, if enabled.
1344 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1345 AJAX search suggestions. Put results into &$results outparam and return false.
1346 $ns : array of int namespace keys to search in
1347 $search : search term (not guaranteed to be conveniently normalized)
1348 $limit : maximum number of results to return
1349 &$results : out param: array of page names (strings)
1351 'PrefsEmailAudit': called when user changes his email address
1352 $user: User (object) changing his email address
1353 $oldaddr: old email address (string)
1354 $newaddr: new email address (string)
1356 'PrefsPasswordAudit': called when user changes his password
1357 $user: User (object) changing his passoword
1358 $newPass: new password
1359 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1361 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1362 $article: the title being (un)protected
1363 $output: a string of the form HTML so far
1365 'ProtectionForm::save': called when a protection form is submitted
1366 $article: the title being (un)protected
1367 $errorMsg: an html message string of an error
1369 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1370 $article: the page the form is shown for
1371 $out: OutputPage object
1373 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1374 loader request or generating HTML output.
1375 &$resourceLoader: ResourceLoader object
1377 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1378 &$obj: RawPage object
1379 &$text: The text that's going to be the output
1381 'RecentChange_save': called at the end of RecentChange::save()
1382 $recentChange: RecentChange object
1384 'ResourceLoaderConfigVars': called at the end of
1385 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1386 configuration variables to JavaScript. Things that depend on the current
1387 page/request state must be added through MakeGlobalVariablesScript instead.
1388 &$vars: array( variable name => value )
1390 'RevisionInsertComplete': called after a revision is inserted into the DB
1391 &$revision: the Revision
1392 $data: the data stored in old_text. The meaning depends on $flags: if external
1393 is set, it's the URL of the revision text in external storage; otherwise,
1394 it's the revision text itself. In either case, if gzip is set, the revision
1396 $flags: a comma-delimited list of strings representing the options used. May
1397 include: utf8 (this will always be set for new revisions); gzip; external.
1399 'SearchUpdate': Prior to search update completion
1401 $namespace : Page namespace
1403 $text : Current text being indexed
1405 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1406 $allSearchTerms : Array of the search terms in all content languages
1407 &$titleResult : Outparam; the value to return. A Title object or null.
1409 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1410 $term : Search term string
1411 &$title : Outparam; set to $title object and return false for a match
1413 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1414 $term : Search term string
1415 &$title : Current Title object that is being returned (null if none found).
1417 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1418 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1419 in the $searchEngine->namespaces array.
1420 $query : Original query.
1421 &$parsed : Resultant query with the prefixes stripped.
1423 'SearchableNamespaces': An option to modify which namespaces are searchable.
1424 &$arr : Array of namespaces ($nsId => $name) which will be used.
1426 'SetupAfterCache': Called in Setup.php, after cache objects are set
1428 'SetupUserMessageArticle': Called in User::leaveUserMessage() before
1429 anything has been posted to the article.
1430 $user: The user who we left the message for.
1431 &$article: The article that will be posted to.
1432 $subject: The subject of the message
1433 $text: The text of the message.
1434 $signature: The signature we used.
1435 $summary: The edit summary.
1436 $editor: The editor that performed the edit.
1438 'ShowMissingArticle': Called when generating the output for a non-existent page
1439 $article: The article object corresponding to the page
1441 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1442 $text: Text being shown
1443 $title: Title of the custom script/stylesheet page
1444 $output: Current OutputPage object
1446 'ShowSearchHitTitle': Customise display of search hit title/link.
1447 &$title: Title to link to
1448 &$text: Text to use for the link
1449 $result: The search result
1450 $terms: The search terms entered
1451 $page: The SpecialSearch object.
1453 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1454 &$siteNotice: HTML returned as the sitenotice
1455 Return true to allow the normal method of notice selection/rendering to work,
1456 or change the value of $siteNotice and return false to alter it.
1458 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1459 &$siteNotice: HTML sitenotice
1460 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1462 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1464 &$text: bottomScripts Text
1465 Append to $text to add additional text/scripts after the stock bottom scripts.
1467 'SkinAfterContent': Allows extensions to add text after the page content and
1469 &$data: (string) Text to be printed out directly (without parsing)
1471 This hook should work in all skins. Just set the &$data variable to the text
1472 you're going to add.
1474 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1476 &$bar: Sidebar contents
1477 Modify $bar to add or modify sidebar portlets.
1479 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1480 $title: displayed page title
1481 $type: 'normal' or 'history' for old/diff views
1482 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1483 &$link: overridable HTML link to be passed into the message as $1
1484 &$forContent: overridable flag if copyright footer is shown in content language.
1487 &$text: additional 'powered by' icons in HTML.
1488 Note: Modern skin does not use the MediaWiki icon but plain text instead
1491 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1492 &$subpages: Subpage links HTML
1494 If false is returned $subpages will be used instead of the HTML
1495 subPageSubtitle() generates.
1496 If true is returned, $subpages will be ignored and the rest of
1497 subPageSubtitle() will run.
1499 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1500 "permanent link" tab
1501 $sktemplate: SkinTemplate object
1502 $nav_urls: array of tabs
1504 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1505 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1506 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1507 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1508 &$sktemplate: SkinTemplate object
1509 &$links: Structured navigation links
1510 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1512 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1514 &$sktemplate: SkinTemplate object
1515 &$tpl: Template engine object
1517 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1518 $sktemplate: SkinTemplate object
1519 $res: set to true to prevent active tabs
1521 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1524 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1525 You can either create your own array, or alter the parameters for
1527 &$sktemplate: The SkinTemplate instance.
1528 $title: Title instance for the page.
1529 $message: Visible label of tab.
1530 $selected: Whether this is a selected tab.
1531 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1532 &$classes: Array of CSS classes to apply.
1533 &$query: Query string to add to link.
1535 &$result: Complete assoc. array if you want to return true.
1537 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1538 been rendered (useful for adding more)
1539 $tools: array of tools
1541 'SoftwareInfo': Called by Special:Version for returning information about
1543 $software: The array of software in format 'name' => 'version'.
1544 See SpecialVersion::softwareInformation()
1546 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1547 $id: User identifier
1549 'SpecialListusersDefaultQuery': called right before the end of
1550 UsersPager::getDefaultQuery()
1551 $pager: The UsersPager instance
1552 $query: The query array to be returned
1554 'SpecialListusersFormatRow': called right before the end of
1555 UsersPager::formatRow()
1556 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1557 $row: Database row object
1559 'SpecialListusersHeader': called before closing the <fieldset> in
1560 UsersPager::getPageHeader()
1561 $pager: The UsersPager instance
1562 $out: The header HTML
1564 'SpecialListusersHeaderForm': called before adding the submit button in
1565 UsersPager::getPageHeader()
1566 $pager: The UsersPager instance
1567 $out: The header HTML
1569 'SpecialListusersQueryInfo': called right before the end of
1570 UsersPager::getQueryInfo()
1571 $pager: The UsersPager instance
1572 $query: The query array to be returned
1574 'SpecialMovepageAfterMove': called after moving a page
1575 $movePage: MovePageForm object
1576 $oldTitle: old title (object)
1577 $newTitle: new title (object)
1579 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1580 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1581 $opts: FormOptions object containing special page options
1582 &$conds: array of WHERE conditionals for query
1584 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1585 hook to remove a core special page
1586 $list: list (array) of core special pages
1588 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1589 use this to change some selection criteria or substitute a different title
1590 &$randstr: The random number from wfRandom()
1591 &$isRedir: Boolean, whether to select a redirect or non-redirect
1592 &$namespaces: An array of namespace indexes to get the title from
1593 &$extra: An array of extra SQL statements
1594 &$title: If the hook returns false, a Title object to use instead of the
1595 result from the normal query
1597 'SpecialRecentChangesPanel': called when building form options in
1598 SpecialRecentChanges
1599 &$extraOpts: array of added items, to which can be added
1600 $opts: FormOptions for this request
1602 'SpecialRecentChangesQuery': called when building sql query for
1603 SpecialRecentChanges and SpecialRecentChangesLinked
1604 &$conds: array of WHERE conditionals for query
1605 &$tables: array of tables to be queried
1606 &$join_conds: join conditions for the tables
1607 $opts: FormOptions for this request
1608 &$query_options: array of options for the database request
1609 &$select: String '*' or array of columns to select
1611 'SpecialSearchGo': called when user clicked the "Go"
1612 &$title: title object generated from the text entered by the user
1613 &$term: the search term entered by the user
1615 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1616 target doesn't exist
1617 &$title: title object generated from the text entered by the user
1619 'SpecialSearchProfiles': allows modification of search profiles
1620 &$profiles: profiles, which can be modified.
1622 'SpecialSearchResults': called before search result display when there
1624 $term: string of search term
1625 &$titleMatches: empty or SearchResultSet object
1626 &$textMatches: empty or SearchResultSet object
1628 'SpecialSearchNoResults': called before search result display when there are
1630 $term: string of search term
1632 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1633 &$extraStats: Array to save the new stats
1634 ( $extraStats['<name of statistic>'] => <value>; )
1636 'SpecialUploadComplete': Called after successfully uploading a file from
1638 $form: The SpecialUpload object
1640 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1641 use this to change the tables headers
1642 $extTypes: associative array of extensions types
1644 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1645 &$conds: array of WHERE conditionals for query
1646 &$tables: array of tables to be queried
1647 &$join_conds: join conditions for the tables
1648 &$fields: array of query fields
1650 'TitleArrayFromResult': called when creating an TitleArray object from a
1652 &$titleArray: set this to an object to override the default object returned
1653 $res: database result used to create the object
1655 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1656 that can be applied.
1657 $title: The title in question.
1658 &$types: The types of protection available.
1660 'TitleMoveComplete': after moving an article (title)
1663 $user: user who did the move
1664 $pageid: database ID of the page that's been moved
1665 $redirid: database ID of the created redirect
1667 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1668 $title: title object related to the revision
1669 $rev: revision (object) that will be viewed
1671 'UnknownAction': An unknown "action" has occured (useful for defining
1673 $action: action name
1674 $article: article "acted on"
1676 'UnitTestsList': Called when building a list of files with PHPUnit tests
1677 &$files: list of files
1679 'UnwatchArticle': before a watch is removed from an article
1680 $user: user watching
1681 $article: article object to be removed
1683 'UnwatchArticle': after a watch is removed from an article
1684 $user: user that was watching
1685 $article: article object removed
1687 'UnwatchArticleComplete': after a watch is removed from an article
1688 $user: user that watched
1689 $article: article object that was watched
1691 'UploadForm:initial': before the upload form is generated
1692 $form: UploadForm object
1693 You might set the member-variables $uploadFormTextTop and
1694 $uploadFormTextAfterSummary to inject text (HTML) either before
1695 or after the editform.
1697 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1698 $form: UploadForm object
1699 Lets you poke at member variables like $mUploadDescription before the
1701 Do not use this hook to break upload processing. This will return the user to
1702 a blank form with no error message; use UploadVerification and
1703 UploadVerifyFile instead
1705 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1706 $type: (string) the requested upload type
1707 &$className: the class name of the Upload instance to be created
1709 'UploadComplete': when Upload completes an upload
1710 &$upload: an UploadBase child instance
1712 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1714 $descriptor: (array) the HTMLForm descriptor
1716 'UploadFormSourceDescriptors': after the standard source inputs have been
1717 added to the descriptor
1718 $descriptor: (array) the HTMLForm descriptor
1720 'UploadVerification': additional chances to reject an uploaded file. Consider
1721 using UploadVerifyFile instead.
1722 string $saveName: destination file name
1723 string $tempName: filesystem path to the temporary file for checks
1724 string &$error: output: message key for message to show if upload canceled
1725 by returning false. May also be an array, where the first element
1726 is the message key and the remaining elements are used as parameters to
1729 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1730 in most cases over UploadVerification.
1731 object $upload: an instance of UploadBase, with all info about the upload
1732 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1733 will typically only apply for specific mime types.
1734 object &$error: output: true if the file is valid. Otherwise, an indexed array
1735 representing the problem with the file, where the first element
1736 is the message key and the remaining elements are used as parameters to
1739 'UploadComplete': Upon completion of a file upload
1740 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1741 $uploadBase->getLocalFile().
1743 'User::mailPasswordInternal': before creation and mailing of a user's new
1745 $user: the user who sent the message out
1746 $ip: IP of the user who sent the message out
1747 $u: the account whose new password will be set
1749 'UserArrayFromResult': called when creating an UserArray object from a
1751 &$userArray: set this to an object to override the default object returned
1752 $res: database result used to create the object
1754 'userCan': To interrupt/advise the "user can do X to Y article" check.
1755 If you want to display an error message, try getUserPermissionsErrors.
1756 $title: Title object being checked against
1757 $user : Current user object
1758 $action: Action being checked
1759 $result: Pointer to result returned if hook returns false. If null is returned,
1760 userCan checks are continued by internal code.
1762 'UserCanSendEmail': To override User::canSendEmail() permission check
1763 $user: User (object) whose permission is being checked
1764 &$canSend: bool set on input, can override on output
1766 'UserClearNewTalkNotification': called when clearing the
1767 "You have new messages!" message, return false to not delete it
1768 $user: User (object) that'll clear the message
1770 'UserComparePasswords': called when checking passwords, return false to
1771 override the default password checks
1772 &$hash: String of the password hash (from the database)
1773 &$password: String of the plaintext password the user entered
1774 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1776 &$result: If the hook returns false, this Boolean value will be checked to
1777 determine if the password was valid
1779 'UserCreateForm': change to manipulate the login form
1780 $template: SimpleTemplate instance for the form
1782 'UserCryptPassword': called when hashing a password, return false to implement
1783 your own hashing method
1784 &$password: String of the plaintext password to encrypt
1785 &$salt: String of the password salt or Boolean false if no salt is provided
1786 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1788 &$hash: If the hook returns false, this String will be used as the hash
1790 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1791 $user: User to get groups for
1792 &$groups: Current effective groups
1794 'UserGetAllRights': after calculating a list of all available rights
1795 &$rights: Array of rights, which may be added to.
1797 'UserGetEmail': called when getting an user email address
1799 &$email: email, change this to override local email
1801 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1802 email authentification
1804 &$timestamp: timestamp, change this to override local email authentification
1807 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1808 &$groups: List of implicit (automatically-assigned) groups
1810 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1811 &$reservedUsernames: $wgReservedUsernames
1813 'UserGetRights': Called in User::getRights()
1814 $user: User to get rights for
1815 &$rights: Current rights
1817 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1819 $user: User in question
1820 $title: Title of the page in question
1821 &$blocked: Out-param, whether or not the user is blocked from that page.
1822 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1823 own user talk pages.
1825 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1827 $ip: User's IP address
1828 &$blocked: Whether the user is blocked, to be modified by the hook
1830 'UserLoadAfterLoadFromSession': called to authenticate users on
1831 external/environmental means; occurs after session is loaded
1832 $user: user object being loaded
1834 'UserLoadDefaults': called when loading a default user
1838 'UserLoadFromDatabase': called when loading a user from the database
1840 &$s: database query object
1842 'UserLoadFromSession': called to authenticate users on external/environmental
1843 means; occurs before session is loaded
1844 $user: user object being loaded
1845 &$result: set this to a boolean value to abort the normal authentification
1848 'UserLoadOptions': when user options/preferences are being loaded from
1851 &$options: Options, can be modified.
1853 'UserLoginComplete': after a user has logged in
1854 $user: the user object that was created on login
1855 $inject_html: Any HTML to inject after the "logged in" message.
1857 'UserLoginForm': change to manipulate the login form
1858 $template: SimpleTemplate instance for the form
1860 'UserLoginMailPassword': Block users from emailing passwords
1861 $name: the username to email the password of.
1862 &$error: out-param - the error message to return.
1864 'UserLogout': before a user logs out
1865 $user: the user object that is about to be logged out
1867 'UserLogoutComplete': after a user has logged out
1868 $user: the user object _after_ logout (won't have name, ID, etc.)
1869 $inject_html: Any HTML to inject after the "logged out" message.
1870 $oldName: name of the user before logout (string)
1872 'UserRights': After a user's group memberships are changed
1873 $user : User object that was changed
1874 $add : Array of strings corresponding to groups added
1875 $remove: Array of strings corresponding to groups removed
1877 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1879 $user: user retrieving new talks messages
1880 $talks: array of new talks page(s)
1882 'UserSaveSettings': called when saving user settings
1885 'UserSaveOptions': Called just before saving user preferences/options.
1887 &$options: Options, modifiable
1889 'UserSetCookies': called when setting user cookies
1891 &$session: session array, will be added to $_SESSION
1892 &$cookies: cookies array mapping cookie name to its value
1894 'UserSetEmail': called when changing user email address
1896 &$email: new email, change this to override new email address
1898 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1899 of email authentification
1901 &$timestamp: new timestamp, change this to override local email
1902 authentification timestamp
1904 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
1905 used to alter the SQL query which gets the list of wanted pages
1906 &$wantedPages: WantedPagesPage object
1907 &$query: query array, see QueryPage::getQueryInfo() for format documentation
1909 'WatchArticle': before a watch is added to an article
1910 $user: user that will watch
1911 $article: article object to be watched
1913 'WatchArticleComplete': after a watch is added to an article
1914 $user: user that watched
1915 $article: article object watched
1917 'WatchlistEditorBuildRemoveLine': when building remove lines in
1918 Special:Watchlist/edit
1919 &$tools: array of extra links
1920 $title: Title object
1921 $redirect: whether the page is a redirect
1924 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1926 One, and only one hook should set this, and return false.
1927 &$tables: Database tables to use in the SELECT query
1928 &$opts: Options to use for the query
1929 &$join: Join conditions
1931 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1932 query pages to be updated with maintenance/updateSpecialPages.php
1933 $query: $wgQueryPages itself
1935 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1936 metadata to be added.
1937 $obj: The XmlDumpWriter object.
1938 &$out: The output string.
1939 $row: The database row for the page.
1940 $title: The title of the page.
1942 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1944 $obj: The XmlDumpWriter object.
1945 &$out: The text being output.
1946 $row: The database row for the revision.
1947 $text: The revision text.
1949 More hooks might be available but undocumented, you can execute
1950 ./maintenance/findhooks.php to find hidden one.