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 ‘AfterUserMessage': After a user message has been left, this hook is
267 called to take care of any cleanup.
268 $user: The user who we left the message for.
269 $article: The article the message was left on.
270 $subject: The subject of the message
271 $text: The text of the message.
272 $signature: The signature we used.
273 $summary: The edit summary.
274 $editor: The editor that performed the edit.
276 'AjaxAddScript': Called in output page just before the initialisation
277 of the javascript ajax engine. The hook is only called when ajax
278 is enabled ( $wgUseAjax = true; ).
280 'AlternateEdit': before checking if an user can edit a page and
281 before showing the edit form ( EditPage::edit() ). This is triggered
283 $EditPage: the EditPage object
285 'APIAfterExecute': after calling the execute() method of an API module.
286 Use this to extend core API modules.
287 &$module: Module object
289 'APIEditBeforeSave': before saving a page with api.php?action=edit,
290 after processing request parameters. Return false to let the request
291 fail, returning an error message or an <edit result="Failure"> tag
292 if $resultArr was filled.
293 $EditPage : the EditPage object
294 $text : the new text of the article (has yet to be saved)
295 &$resultArr : data in this array will be added to the API result
297 'APIGetAllowedParams': use this hook to modify a module's parameters.
298 &$module: Module object
299 &$params: Array of parameters
301 'APIGetParamDescription': use this hook to modify a module's parameter
303 &$module: Module object
304 &$desc: Array of parameter descriptions
306 'APIQueryAfterExecute': after calling the execute() method of an
307 action=query submodule. Use this to extend core API modules.
308 &$module: Module object
310 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
311 method of an action=query submodule. Use this to extend core API modules.
312 &$module: Module object
313 &$resultPageSet: ApiPageSet object
315 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
316 Every token has an action, which will be used in the intoken parameter
317 and in the output (actiontoken="..."), and a callback function which
318 should return the token, or false if the user isn't allowed to obtain
319 it. The prototype of the callback function is func($pageid, $title)
320 where $pageid is the page ID of the page the token is requested for
321 and $title is the associated Title object. In the hook, just add
322 your callback to the $tokenFunctions array and return true (returning
323 false makes no sense)
324 $tokenFunctions: array(action => callback)
326 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
327 Every token has an action, which will be used in the rvtoken parameter
328 and in the output (actiontoken="..."), and a callback function which
329 should return the token, or false if the user isn't allowed to obtain
330 it. The prototype of the callback function is func($pageid, $title, $rev)
331 where $pageid is the page ID of the page associated to the revision the
332 token is requested for, $title the associated Title object and $rev the
333 associated Revision object. In the hook, just add your callback to the
334 $tokenFunctions array and return true (returning false makes no sense)
335 $tokenFunctions: array(action => callback)
337 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
339 Every token has an action, which will be used in the rctoken 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, $rc)
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 $rc the
345 associated RecentChange 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 'APIQueryUsersTokens': use this hook to add custom token to list=users.
350 Every token has an action, which will be used in the ustoken parameter
351 and in the output (actiontoken="..."), and a callback function which
352 should return the token, or false if the user isn't allowed to obtain
353 it. The prototype of the callback function is func($user) where $user
354 is the User object. In the hook, just add your callback to the
355 $tokenFunctions array and return true (returning false makes no sense)
356 $tokenFunctions: array(action => callback)
358 'ArticleAfterFetchContent': after fetching content of an article from
360 $article: the article (object) being loaded from the database
361 $content: the content (string) of the article
363 'ArticleConfirmDelete': before writing the confirmation form for article
365 $article: the article (object) being deleted
366 $output: the OutputPage object ($wgOut)
367 &$reason: the reason (string) the article is being deleted
369 'ArticleDelete': before an article is deleted
370 $article: the article (object) being deleted
371 $user: the user (object) deleting the article
372 $reason: the reason (string) the article is being deleted
373 $error: if the deletion was prohibited, the (raw HTML) error message to display
376 'ArticleDeleteComplete': after an article is deleted
377 $article: the article that was deleted
378 $user: the user that deleted the article
379 $reason: the reason the article was deleted
380 $id: id of the article that was deleted
382 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
384 $article: article (object) of the user talk page
386 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
387 article has been changed
388 $article: the article (object)
389 $editInfo: data holder that includes the parser output ($editInfo->output) for
390 that page after the change
391 $changed: bool for if the page was changed
393 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
394 recentchanges table, return false to not delete old entries
395 $article: article (object) being modified
397 'ArticleFromTitle': when creating an article object from a title object using
398 Wiki::articleFromTitle()
399 $title: title (object) used to create the article object
400 $article: article (object) that will be returned
402 'ArticleInsertComplete': After a new article is created
403 $article: Article created
404 $user: User creating the article
406 $summary: Edit summary/comment
407 $isMinor: Whether or not the edit was marked as minor
408 $isWatch: (No longer used)
409 $section: (No longer used)
410 $flags: Flags passed to Article::doEdit()
411 $revision: New Revision of the article
413 'ArticleMergeComplete': after merging to article using Special:Mergehistory
414 $targetTitle: target title (object)
415 $destTitle: destination title (object)
417 'ArticlePageDataAfter': after loading data of an article from the database
418 $article: article (object) whose data were loaded
419 $row: row (object) returned from the database server
421 'ArticlePageDataBefore': before loading data of an article from the database
422 $article: article (object) that data will be loaded
423 $fields: fileds (array) to load from the database
425 'ArticleProtect': before an article is protected
426 $article: the article being protected
427 $user: the user doing the protection
428 $protect: boolean whether this is a protect or an unprotect
429 $reason: Reason for protect
430 $moveonly: boolean whether this is for move only or not
432 'ArticleProtectComplete': after an article is protected
433 $article: the article that was protected
434 $user: the user who did the protection
435 $protect: boolean whether it was a protect or an unprotect
436 $reason: Reason for protect
437 $moveonly: boolean whether it was for move only or not
439 'ArticlePurge': before executing "&action=purge"
440 $article: article (object) to purge
442 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
443 revision of an article
444 &$title: title object of the article
446 'ArticleRevisionUndeleted': after an article revision is restored
447 $title: the article title
448 $revision: the revision
449 $oldPageID: the page ID of the revision when archived (may be null)
451 'ArticleRollbackComplete': after an article rollback is completed
452 $article: the article that was edited
453 $user: the user who did the rollback
454 $revision: the revision the page was reverted back to
455 $current: the reverted revision
457 'ArticleSave': before an article is saved
458 $article: the article (object) being saved
459 $user: the user (object) saving the article
460 $text: the new article text
461 $summary: the article summary (comment)
466 'ArticleSaveComplete': After an article has been updated
467 $article: Article modified
468 $user: User performing the modification
470 $summary: Edit summary/comment
471 $isMinor: Whether or not the edit was marked as minor
472 $isWatch: (No longer used)
473 $section: (No longer used)
474 $flags: Flags passed to Article::doEdit()
475 $revision: New Revision of the article
476 $baseRevId: the rev ID (or false) this edit was based on
478 'ArticleUndelete': When one or more revisions of an article are restored
479 $title: Title corresponding to the article restored
480 $create: Whether or not the restoration caused the page to be created
481 (i.e. it didn't exist before)
482 $comment: The comment associated with the undeletion.
484 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
485 before the user is redirected back to the page
486 &$article: the article
487 &$sectionanchor: The section anchor link (e.g. "#overview" )
488 &$extraq: Extra query parameters which can be added via hooked functions
490 'ArticleViewHeader': Before the parser cache is about to be tried for article
492 &$article: the article
493 &$pcache: whether to try the parser cache or not
494 &$outputDone: whether the output for this page finished or not
496 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
498 $article: target article (object)
500 'AuthPluginAutoCreate': Called when creating a local account for an user logged
501 in from an external authentication method
502 $user: User object created locally
504 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
505 Gives a chance for an extension to set it programattically to a variable class.
506 &$auth: the $wgAuth object, probably a stub
508 'AutopromoteCondition': check autopromote condition for user.
509 $type: condition type
512 $result: result of checking autopromote condition
514 'BadImage': When checking against the bad image list
515 $name: Image name being checked
516 &$bad: Whether or not the image is "bad"
518 Change $bad and return false to override. If an image is "bad", it is not
519 rendered inline in wiki pages or galleries in category pages.
521 'BeforeGalleryFindFile': before an image is fetched for a gallery
522 &$gallery,: the gallery object
523 &$nt: the image title
524 &$time: image timestamp
526 'BeforeInitialize': before anything is initialized in performRequestForTitle()
527 &$title: Title being used for request
528 &$article: The associated Article object
529 &$output: OutputPage object
531 $request: WebRequest object
532 $mediaWiki: Mediawiki object
534 'BeforePageDisplay': Prior to outputting a page
535 &$out: OutputPage object
538 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
539 &$parser: Parser object
540 &$title: title of the template
541 &$skip: skip this template and link it?
542 &$id: the id of the revision being parsed
544 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
545 &$parser: Parser object
546 &$nt: the image title
547 &$skip: skip this image and link it?
548 &$time: the image timestamp
550 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
551 &$parser: Parser object
552 &$ig: ImageGallery object
554 'BlockIp': before an IP address or user is blocked
555 $block: the Block object about to be saved
556 $user: the user _doing_ the block (not the one being blocked)
558 'BlockIpComplete': after an IP address or user is blocked
559 $block: the Block object that was saved
560 $user: the user who did the block (not the one being blocked)
562 'BookInformation': Before information output on Special:Booksources
563 $isbn: ISBN to show information for
564 $output: OutputPage object in use
566 'CategoryPageView': before viewing a categorypage in CategoryPage::view
567 $catpage: CategoryPage instance
569 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
570 &$changesList: ChangesList instance.
571 &$articlelink: HTML of link to article (already filled-in).
572 &$s: HTML of row that is being constructed.
573 &$rc: RecentChange instance.
574 $unpatrolled: Whether or not we are showing unpatrolled changes.
575 $watched: Whether or not the change is watched by the user.
577 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
578 $user: user (object) whose email is being confirmed
580 'ContribsPager::getQueryInfo': Before the contributions query is about to run
581 &$pager: Pager object for contributions
582 &queryInfo: The query for the contribs Pager
584 'ContributionsLineEnding': Called before a contributions HTML line is finished
585 $page: SpecialPage object for contributions
587 $row: the DB row for this line
589 'ContributionsToolLinks': Change tool links above Special:Contributions
591 $title: User page title
592 &$tools: Array of tool links
594 'CustomEditor': When invoking the page editor
595 $article: Article being edited
596 $user: User performing the edit
598 Return true to allow the normal editor to be used, or false
599 if implementing a custom editor, e.g. for a special namespace,
602 'DatabaseOraclePostInit': Called after initialising an Oracle database
603 &$db: the DatabaseOracle object
605 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
606 $title: the diff page title (nullable)
607 &$oldId: the actual old Id to use in the diff
608 &$newId: the actual new Id to use in the diff (0 means current)
609 $old: the ?old= param value from the url
610 $new: the ?new= param value from the url
612 'DiffViewHeader': called before diff display
613 $diff: DifferenceEngine object that's calling
614 $oldRev: Revision object of the "old" revision (may be null/invalid)
615 $newRev: Revision object of the "new" revision
617 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
619 $article: article (object) being viewed
620 $oldid: oldid (int) being viewed
622 'DoEditSectionLink': Override the HTML generated for section edit links
623 $skin: Skin object rendering the UI
624 $title: Title object for the title being linked to (may not be the same as
625 $wgTitle, if the section is included from a template)
626 $section: The designation of the section being pointed to, to be included in
627 the link, like "§ion=$section"
628 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
629 By default, this is wrapped in the 'editsectionhint' message.
630 $result: The HTML to return, prefilled with the default plus whatever other
631 changes earlier hooks have made
633 'EditFilter': Perform checks on an edit
634 $editor: Edit form (see includes/EditPage.php)
635 $text: Contents of the edit box
636 $section: Section being edited
637 &$error: Error message to return
638 $summary: Edit summary for page
640 'EditFilterMerged': Post-section-merge edit filter
641 $editor: EditPage instance (object)
642 $text: content of the edit box
643 &$error: error message to return
644 $summary: Edit summary for page
646 'EditFormPreloadText': Allows population of the edit form when creating
648 &$text: Text to preload with
649 &$title: Title object representing the page being created
651 'EditFormInitialText': Allows modifying the edit form when editing existing
653 $editPage: EditPage object
655 'EditPage::attemptSave': called before an article is
656 saved, that is before insertNewArticle() is called
657 $editpage_Obj: the current EditPage object
659 'EditPage::importFormData': allow extensions to read additional data
661 $editpage: EditPage instance
663 return value is ignored (should always return true)
665 'EditPage::showEditForm:fields': allows injection of form field into edit form
666 &$editor: the EditPage instance for reference
667 &$out: an OutputPage instance to write to
668 return value is ignored (should always return true)
670 'EditPage::showEditForm:initial': before showing the edit form
671 $editor: EditPage instance (object)
673 Return false to halt editing; you'll need to handle error messages, etc.
674 yourself. Alternatively, modifying $error and returning true will cause the
675 contents of $error to be echoed at the top of the edit form as wikitext.
676 Return true without altering $error to allow the edit to proceed.
678 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
679 when there's an edit conflict. Return false to halt normal diff output; in
680 this case you're responsible for computing and outputting the entire "conflict"
681 part, i.e., the "difference between revisions" and "your text" headers and
683 &$editor: EditPage instance
684 &$out: OutputPage instance
686 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
687 textarea in the edit form
688 &$editpage: The current EditPage object
689 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
690 &$tabindex: HTML tabindex of the last edit check/button
692 'EditPageBeforeEditChecks': allows modifying the edit checks below the
693 textarea in the edit form
694 &$editpage: The current EditPage object
695 &$checks: Array of edit checks like "watch this page"/"minor edit"
696 &$tabindex: HTML tabindex of the last edit check/button
698 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
699 textarea in the edit form
700 &$toolbar: The toolbar HTMl
702 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
703 $title: title of page being edited
704 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
706 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
708 $editPage: EditPage object
709 &$newtext: wikitext that will be used as "your version"
711 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
712 $editPage: EditPage object
713 &$toparse: wikitext that will be parsed
715 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
716 &$editpage: The current EditPage object
717 &$res: the HTML of the error text
719 'EditPageTosSummary': Give a chance for site and per-namespace customizations
720 of terms of service summary link that might exist separately from the copyright
722 $title: title of page being edited
723 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
725 'EditSectionLink': Do not use, use DoEditSectionLink instead.
726 $skin: Skin rendering the UI
727 $title: Title being linked to
728 $section: Section to link to
730 $result: Result (alter this to override the generated links)
732 'EmailConfirmed': When checking that the user's email address is "confirmed"
733 $user: User being checked
734 $confirmed: Whether or not the email address is confirmed
735 This runs before the other checks, such as anonymity and the real check; return
736 true to allow those checks to occur, and false if checking is done.
738 'EmailUser': before sending email from one user to another
739 $to: address of receiving user
740 $from: address of sending user
741 $subject: subject of the mail
742 $text: text of the mail
744 'EmailUserCC': before sending the copy of the email to the author
745 $to: address of receiving user
746 $from: address of sending user
747 $subject: subject of the mail
748 $text: text of the mail
750 'EmailUserComplete': after sending email from one user to another
751 $to: address of receiving user
752 $from: address of sending user
753 $subject: subject of the mail
754 $text: text of the mail
756 'EmailUserForm': after building the email user form object
757 $form: HTMLForm object
759 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
760 $user: The user who is trying to email another user.
761 $editToken: The user's edit token.
762 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
764 'FetchChangesList': When fetching the ChangesList derivative for
766 &$user: User the list is being fetched for
767 &$skin: Skin object to be used with the list
768 &$list: List object (defaults to NULL, change it to an object
769 instance and return false override the list derivative used)
771 'FileDeleteComplete': When a file is deleted
772 $file: reference to the deleted file
773 $oldimage: in case of the deletion of an old image, the name of the old file
774 $article: in case all revisions of the file are deleted a reference to the
775 article associated with the file.
776 $user: user who performed the deletion
779 'FileUpload': When a file upload occurs
780 $file : Image object representing the file that was uploaded
782 'FileUndeleteComplete': When a file is undeleted
783 $title: title object to the file
784 $fileVersions: array of undeleted versions. Empty if all versions were restored
785 $user: user who performed the undeletion
788 'FormatUserMessage': Hook to format a message if you want to override
789 the internal formatter.
790 $subject: Title of the message.
791 &$text: Text of the message.
792 $signature: Signature that they would like to leave.
794 'GetAutoPromoteGroups': When determining which autopromote groups a user
795 is entitled to be in.
796 &$user: user to promote.
797 &$promote: groups that will be added.
799 'GetBlockedStatus': after loading blocking status of an user from the database
800 $user: user (object) being checked
802 'GetCacheVaryCookies': get cookies that should vary cache options
803 $out: OutputPage object
804 &$cookies: array of cookies name, add a value to it if you want to add a cookie
805 that have to vary cache options
807 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
808 $title: Title object of page
809 $url: string value as output (out parameter, can modify)
810 $query: query options passed to Title::getFullURL()
812 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
813 $title: Title object of page
814 $url: string value as output (out parameter, can modify)
815 $query: query options passed to Title::getInternalURL()
817 'GetLinkColours': modify the CSS class of an array of page links
818 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
820 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
822 'GetLocalURL': modify local URLs as output into page links
823 $title: Title object of page
824 $url: string value as output (out parameter, can modify)
825 $query: query options passed to Title::getLocalURL()
827 'GetPreferences': modify user preferences
828 $user: User whose preferences are being modified.
829 &$preferences: Preferences description array, to be fed to an HTMLForm object
831 'getUserPermissionsErrors': Add a permissions error when permissions errors are
832 checked for. Use instead of userCan for most cases. Return false if the
833 user can't do it, and populate $result with the reason in the form of
834 array( messagename, param1, param2, ... ). For consistency, error messages
835 should be plain text with no special coloring, bolding, etc. to show that
836 they're errors; presenting them properly to the user as errors is done by
838 $title: Title object being checked against
839 $user : Current user object
840 $action: Action being checked
841 $result: User permissions error to add. If none, return true.
843 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
844 if expensive checks are enabled.
846 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
848 $title: Title object, pages linked to this title are purged.
850 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
851 image insertion. You can skip the default logic entirely by returning
852 false, or just modify a few things using call-by-reference.
854 &$title: Title object of the image
855 &$file: File object, or false if it doesn't exist
856 &$frameParams: Various parameters with special meanings; see documentation in
857 includes/Linker.php for Linker::makeImageLink2
858 &$handlerParams: Various parameters with special meanings; see documentation in
859 includes/Linker.php for Linker::makeImageLink2
860 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
861 &$res: Final HTML output, used if you return false
864 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
865 the image on an image page
866 $imagePage: ImagePage object ($this)
869 'ImagePageAfterImageLinks': called after the image links section on an image
871 $imagePage: ImagePage object ($this)
872 &$html: HTML for the hook to add
874 'ImagePageFileHistoryLine': called when a file history line is contructed
876 $line: the HTML of the history line
877 $css: the line CSS class
879 'ImagePageFindFile': called when fetching the file associated with an image page
880 $page: ImagePage object
882 &$displayFile: displayed File object
884 'ImagePageShowTOC': called when the file toc on an image page is generated
885 $page: ImagePage object
886 &$toc: Array of <li> strings
888 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
890 &$title: the Title object of the file as it would appear for the upload page
891 &$path: the original file and path name when img_auth was invoked by the the web
893 &$name: the name only component of the file
894 &$result: The location to pass back results of the hook routine (only used if
896 $result[0]=The index of the header message
897 $result[1]=The index of the body text message
898 $result[2 through n]=Parameters passed to body text message. Please note the
899 header message cannot receive/use parameters.
902 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
903 $title: Title object ($wgTitle)
905 $ignoreRedirect: boolean to skip redirect check
906 $target: Title/string of redirect target
907 $article: Article object
909 'InternalParseBeforeLinks': during Parser's internalParse method before links
910 but after noinclude/includeonly/onlyinclude and other processing.
911 &$parser: Parser object
912 &$text: string containing partially parsed text
913 &$stripState: Parser's internal StripState object
915 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
916 $user: user (object) whose email is being invalidated
918 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
919 $article: article (object) being checked
921 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
923 $result: Change this value to override the result of wfIsTrustedProxy()
925 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
926 tance to return false if the domain name doesn't match your organization
927 $addr: The e-mail address entered by the user
928 &$result: Set this and return false to override the internal checks
930 'isValidPassword': Override the result of User::isValidPassword()
931 $password: The password entered by the user
932 &$result: Set this and return false to override the internal checks
933 $user: User the password is being validated for
935 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
936 $wgExtensionMessagesFiles instead.
937 Use this to define synonyms of magic words depending of the language
938 $magicExtensions: associative array of magic words synonyms
939 $lang: laguage code (string)
941 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
942 listed in $wgExtensionMessagesFiles instead.
943 Use to define aliases of special pages names depending of the language
944 $specialPageAliases: associative array of magic words synonyms
945 $lang: laguage code (string)
947 'LinkBegin': Used when generating internal and interwiki links in
948 Linker::link(), before processing starts. Return false to skip default proces-
949 sing and return $ret. See documentation for Linker::link() for details on the
950 expected meanings of parameters.
951 $skin: the Skin object
952 $target: the Title that the link is pointing to
953 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
955 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
956 tive array form, with keys and values unescaped. Should be merged with de-
957 fault values, with a value of false meaning to suppress the attribute.
958 &$query: the query string to add to the generated URL (the bit after the "?"),
959 in associative array form, with keys and values unescaped.
960 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
961 &$ret: the value to return if your hook returns false.
963 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
964 just before the function returns a value. If you return true, an <a> element
965 with HTML attributes $attribs and contents $text will be returned. If you re-
966 turn false, $ret will be returned.
967 $skin: the Skin object
968 $target: the Title object that the link is pointing to
969 $options: the options. Will always include either 'known' or 'broken', and may
971 &$text: the final (raw HTML) contents of the <a> tag, after processing.
972 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
974 &$ret: the value to return if your hook returns false.
976 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
979 &$alt: the image's alt text
980 &$img: the new image HTML (if returning false)
982 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
985 &$text: the link text
986 &$link: the new link HTML (if returning false)
987 &$attribs: the attributes to be applied.
988 $linkType: The external link type
990 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
992 &$linksUpdate: the LinksUpdate object
994 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
996 &$linksUpdate: the LinksUpdate object
998 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
999 &$linksUpdate: the LinksUpdate object
1001 'ListDefinedTags': When trying to find all defined tags.
1002 &$tags: The list of tags.
1004 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
1007 'LocalFile::getHistory': called before file history query performed
1010 $fields: select fields
1012 $opts: query options
1013 $join_conds: JOIN conditions
1015 'LocalisationCacheRecache': Called when loading the localisation data into cache
1016 $cache: The LocalisationCache object
1017 $code: language code
1018 &$alldata: The localisation data from core and extensions
1020 'LoginAuthenticateAudit': a login attempt for a valid user account either
1021 succeeded or failed. No return data is accepted; this hook is for auditing only.
1022 $user: the User object being authenticated against
1023 $password: the password being submitted and found wanting
1024 $retval: a LoginForm class constant with authenticateUserData() return
1025 value (SUCCESS, WRONG_PASS, etc)
1027 'LogLine': Processes a single log entry on Special:Log
1028 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1029 logging.log_type database field.
1030 $log_action: string for the type of log action (e.g. 'delete', 'block',
1031 'create2'). Corresponds to logging.log_action database field.
1032 $title: Title object that corresponds to logging.log_namespace and
1033 logging.log_title database fields.
1034 $paramArray: Array of parameters that corresponds to logging.log_params field.
1035 Note that only $paramArray[0] appears to contain anything.
1036 &$comment: string that corresponds to logging.log_comment database field, and
1037 which is displayed in the UI.
1038 &$revert: string that is displayed in the UI, similar to $comment.
1039 $time: timestamp of the log entry (added in 1.12)
1041 'LogPageValidTypes': action being logged.
1042 DEPRECATED: Use $wgLogTypes
1043 &$type: array of strings
1045 'LogPageLogName': name of the logging page(s).
1046 DEPRECATED: Use $wgLogNames
1047 &$typeText: array of strings
1049 'LogPageLogHeader': strings used by wfMsg as a header.
1050 DEPRECATED: Use $wgLogHeaders
1051 &$headerText: array of strings
1053 'LogPageActionText': strings used by wfMsg as a header.
1054 DEPRECATED: Use $wgLogActions
1055 &$actionText: array of strings
1057 'MagicWordMagicWords': When defining new magic word.
1058 DEPRECATED: use $magicWords in a file listed in
1059 $wgExtensionMessagesFiles instead.
1060 $magicWords: array of strings
1062 'MagicWordwgVariableIDs': When definig new magic words IDs.
1063 $variableIDs: array of strings
1065 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1067 &$vars: variable (or multiple variables) to be added into the output
1068 of Skin::makeVariablesScript
1070 'MarkPatrolled': before an edit is marked patrolled
1071 $rcid: ID of the revision to be marked patrolled
1072 $user: the user (object) marking the revision as patrolled
1073 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1074 needs to be a sysop in order to mark an edit patrolled
1076 'MarkPatrolledComplete': after an edit is marked patrolled
1077 $rcid: ID of the revision marked as patrolled
1078 $user: user (object) who marked the edit patrolled
1079 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1080 must be a sysop to patrol the edit
1082 'MathAfterTexvc': after texvc is executed when rendering mathematics
1083 $mathRenderer: instance of MathRenderer
1084 $errmsg: error message, in HTML (string). Nonempty indicates failure
1085 of rendering the formula
1087 'MediaWikiPerformAction': Override MediaWiki::performAction().
1088 Use this to do something completely different, after the basic
1089 globals have been set up, but before ordinary actions take place.
1091 $article: $wgArticle
1094 $request: $wgRequest
1095 $mediaWiki: The $mediawiki object
1097 'MessagesPreLoad': When loading a message from the database
1098 $title: title of the message (string)
1099 $message: value (string), change it to the message you want to define
1101 'MessageCacheReplace': When a message page is changed.
1102 Useful for updating caches.
1103 $title: name of the page changed.
1104 $text: new contents of the page.
1106 'ModifyExportQuery': Modify the query used by the exporter.
1107 $db: The database object to be queried.
1108 &$tables: Tables in the query.
1109 &$conds: Conditions in the query.
1110 &$opts: Options for the query.
1111 &$join_conds: Join conditions for the query.
1113 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1114 been rendered (useful for adding more)
1115 Note: this is only run for the Monobook skin. This hook is deprecated and
1116 may be removed in the future. To add items to the toolbox you should use
1117 the SkinTemplateToolboxEnd hook instead, which works for all
1118 'SkinTemplate'-type skins.
1119 $tools: array of tools
1121 'NewRevisionFromEditComplete': called when a revision was inserted
1123 $article: the article edited
1124 $rev: the new revision
1125 $baseID: the revision ID this was based off, if any
1126 $user: the editing user
1128 'NormalizeMessageKey': Called before the software gets the text of a message
1129 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1131 &$key: the message being looked up. Change this to something else to change
1132 what message gets displayed (string)
1133 &$useDB: whether or not to look up the message in the database (bool)
1134 &$langCode: the language code to get the message for (string) - or -
1135 whether to use the content language (true) or site language (false) (bool)
1136 &$transform: whether or not to expand variables and templates
1137 in the message (bool)
1139 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1140 &$changeslist: The OldChangesList instance.
1141 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1142 &$rc: The RecentChange object.
1144 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1145 Hooks can alter or append to the array of URLs for search & suggestion formats.
1146 &$urls: array of associative arrays with Url element attributes
1148 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1149 users and/or IP addresses too
1150 $otherBlockLink: An array with links to other block logs
1151 $ip: The requested IP address or username
1153 'OutputPageBeforeHTML': a page has been processed by the parser and
1154 the resulting HTML is about to be displayed.
1155 $parserOutput: the parserOutput (object) that corresponds to the page
1156 $text: the text that will be displayed, in HTML (string)
1158 'OutputPageCheckLastModified': when checking if the page has been modified
1159 since the last visit
1160 &$modifiedTimes: array of timestamps.
1161 The following keys are set: page, user, epoch
1163 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1164 $out: OutputPage instance (object)
1165 $parserOutput: parserOutput instance being added in $out
1167 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1168 categories. Implementations should return false if they generate the category
1169 links, so the default link generation is skipped.
1170 $out: OutputPage instance (object)
1171 $categories: associative array, keys are category names, values are category
1172 types ("normal" or "hidden")
1173 $links: array, intended to hold the result. Must be an associative array with
1174 category types as keys and arrays of HTML links as values.
1176 'PageHistoryBeforeList': When a history page list is about to be constructed.
1177 $article: the article that the history is loading for
1179 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1180 $row: the revision row for this line
1181 $s: the string representing this parsed line
1182 $classes: array containing the <li> element classes
1184 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1187 $queryInfo: the query parameters
1189 'PageRenderingHash': alter the parser cache option hash key
1190 A parser extension which depends on user options should install
1191 this hook and append its values to the key.
1192 $hash: reference to a hash key string which can be modified
1194 'ParserAfterStrip': Same as ParserBeforeStrip
1196 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1197 $parser: Parser object being used
1198 $text: text that'll be returned
1200 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1201 $parser: Parser object
1202 $text: text to parse
1203 $stripState: StripState instance being used
1205 'ParserBeforeStrip': Called at start of parsing time
1206 (no more strip, deprecated ?)
1207 $parser: parser object
1208 $text: text being parsed
1209 $stripState: stripState used (object)
1211 'ParserBeforeTidy': called before tidy and custom tags replacements
1212 $parser: Parser object being used
1215 'ParserClearState': called at the end of Parser::clearState()
1216 $parser: Parser object being cleared
1218 'ParserFirstCallInit': called when the parser initialises for the first time
1219 &$parser: Parser object being cleared
1221 'ParserGetVariableValueSwitch': called when the parser need the value of a
1223 $parser: Parser object
1224 $varCache: array to store the value in case of multiples calls of the
1226 $index: index (string) of the magic
1227 $ret: value of the magic word (the hook should set it)
1228 $frame: PPFrame object to use for expanding any template variables
1230 'ParserGetVariableValueTs': use this to change the value of the time for the
1231 {{LOCAL...}} magic word
1232 $parser: Parser object
1233 $time: actual time (timestamp)
1235 'ParserGetVariableValueVarCache': use this to change the value of the
1236 variable cache or return false to not use it
1237 $parser: Parser object
1238 $varCache: varaiable cache (array)
1240 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1241 include comments about size of the text parsed
1242 $parser: Parser object
1243 $limitReport: text that will be included (without comment tags)
1245 'ParserMakeImageParams': Called before the parser make an image link, use this
1246 to modify the parameters of the image.
1247 $title: title object representing the file
1248 $file: file object that will be used to create the image
1249 &$params: 2-D array of parameters
1251 'ParserTestParser': called when creating a new instance of Parser in
1252 maintenance/parserTests.inc
1253 $parser: Parser object created
1255 'ParserTestTables': alter the list of tables to duplicate when parser tests
1256 are run. Use when page save hooks require the presence of custom tables
1257 to ensure that tests continue to run properly.
1258 &$tables: array of table names
1260 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1261 my talk page, my contributions" etc).
1263 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1264 &$title: Title object representing the current page
1266 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1267 &$user : User performing the action
1268 $action : Action being performed
1269 &$result : Whether or not the action should be prevented
1270 Change $result and return false to give a definitive answer, otherwise
1271 the built-in rate limiting checks are used, if enabled.
1273 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1274 AJAX search suggestions. Put results into &$results outparam and return false.
1275 $ns : array of int namespace keys to search in
1276 $search : search term (not guaranteed to be conveniently normalized)
1277 $limit : maximum number of results to return
1278 &$results : out param: array of page names (strings)
1280 'PrefsEmailAudit': called when user changes his email address
1281 $user: User (object) changing his email address
1282 $oldaddr: old email address (string)
1283 $newaddr: new email address (string)
1285 'PrefsPasswordAudit': called when user changes his password
1286 $user: User (object) changing his passoword
1287 $newPass: new password
1288 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1290 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1291 $article: the title being (un)protected
1292 $output: a string of the form HTML so far
1294 'ProtectionForm::save': called when a protection form is submitted
1295 $article: the title being (un)protected
1296 $errorMsg: an html message string of an error
1298 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1299 $article: the page the form is shown for
1300 $out: OutputPage object
1302 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1303 &$obj: RawPage object
1304 &$text: The text that's going to be the output
1306 'RecentChange_save': called at the end of RecenChange::save()
1307 $recentChange: RecentChange object
1309 'RevisionInsertComplete': called after a revision is inserted into the DB
1310 &$revision: the Revision
1311 $data: the data stored in old_text. The meaning depends on $flags: if external
1312 is set, it's the URL of the revision text in external storage; otherwise,
1313 it's the revision text itself. In either case, if gzip is set, the revision
1315 $flags: a comma-delimited list of strings representing the options used. May
1316 include: utf8 (this will always be set for new revisions); gzip; external.
1318 'SearchUpdate': Prior to search update completion
1320 $namespace : Page namespace
1322 $text : Current text being indexed
1324 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1325 $allSearchTerms : Array of the search terms in all content languages
1326 &$titleResult : Outparam; the value to return. A Title object or null.
1328 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1329 $term : Search term string
1330 &$title : Outparam; set to $title object and return false for a match
1332 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1333 $term : Search term string
1334 &$title : Current Title object that is being returned (null if none found).
1336 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1337 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1338 in the $searchEngine->namespaces array.
1339 $query : Original query.
1340 &$parsed : Resultant query with the prefixes stripped.
1342 'SearchableNamespaces': An option to modify which namespaces are searchable.
1343 &$arr : Array of namespaces ($nsId => $name) which will be used.
1345 'SetupAfterCache': Called in Setup.php, after cache objects are set
1347 ‘SetupUserMessageArticle': Called in User::leaveUserMessage() before
1348 anything has been posted to the article.
1349 $user: The user who we left the message for.
1350 &$article: The article that will be posted to.
1351 $subject: The subject of the message
1352 $text: The text of the message.
1353 $signature: The signature we used.
1354 $summary: The edit summary.
1355 $editor: The editor that performed the edit.
1357 'ShowMissingArticle': Called when generating the output for a non-existent page
1358 $article: The article object corresponding to the page
1360 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1361 $text: Text being shown
1362 $title: Title of the custom script/stylesheet page
1363 $output: Current OutputPage object
1365 'ShowSearchHitTitle': Customise display of search hit title/link.
1366 &$title: Title to link to
1367 &$text: Text to use for the link
1368 $result: The search result
1369 $terms: The search terms entered
1370 $page: The SpecialSearch object.
1372 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1373 &$siteNotice: HTML returned as the sitenotice
1374 Return true to allow the normal method of notice selection/rendering to work,
1375 or change the value of $siteNotice and return false to alter it.
1377 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1378 &$siteNotice: HTML sitenotice
1379 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1381 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1383 &$text: bottomScripts Text
1384 Append to $text to add additional text/scripts after the stock bottom scripts.
1386 'SkinAfterContent': Allows extensions to add text after the page content and
1388 &$data: (string) Text to be printed out directly (without parsing)
1389 This hook should work in all skins. Just set the &$data variable to the text
1390 you're going to add.
1392 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1394 &$bar: Sidebar contents
1395 Modify $bar to add or modify sidebar portlets.
1397 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1398 $title: displayed page title
1399 $type: 'normal' or 'history' for old/diff views
1400 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1401 &$link: overridable HTML link to be passed into the message as $1
1403 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1405 &$subpages: Subpage links HTML
1406 If false is returned $subpages will be used instead of the HTML
1407 subPageSubtitle() generates.
1408 If true is returned, $subpages will be ignored and the rest of
1409 subPageSubtitle() will run.
1411 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1412 when showing a special page
1413 $sktemplate: SkinTemplate object
1414 $content_actions: array of tabs
1416 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1417 "permanent link" tab
1418 $sktemplate: SkinTemplate object
1419 $nav_urls: array of tabs
1421 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1422 &$content_actions: Content actions
1423 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1426 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1427 &$sktemplate: SkinTemplate object
1428 &$links: Structured navigation links
1429 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1431 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1433 &$sktemplate: SkinTemplate object
1434 &$tpl: Template engine object
1436 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1437 $sktemplate: SkinTemplate object
1438 $res: set to true to prevent active tabs
1440 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1443 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1444 You can either create your own array, or alter the parameters for
1446 &$sktemplate: The SkinTemplate instance.
1447 $title: Title instance for the page.
1448 $message: Visible label of tab.
1449 $selected: Whether this is a selected tab.
1450 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1451 &$classes: Array of CSS classes to apply.
1452 &$query: Query string to add to link.
1454 &$result: Complete assoc. array if you want to return true.
1456 'SkinTemplateTabs': called when finished to build the actions tabs
1457 $sktemplate: SkinTemplate object
1458 $content_actions: array of tabs
1460 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1461 been rendered (useful for adding more)
1462 $tools: array of tools
1464 'SoftwareInfo': Called by Special:Version for returning information about
1466 $software: The array of software in format 'name' => 'version'.
1467 See SpecialVersion::softwareInformation()
1469 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1470 $id: User identifier
1472 'SpecialListusersDefaultQuery': called right before the end of
1473 UsersPager::getDefaultQuery()
1474 $pager: The UsersPager instance
1475 $query: The query array to be returned
1477 'SpecialListusersFormatRow': called right before the end of
1478 UsersPager::formatRow()
1479 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1480 $row: Database row object
1482 'SpecialListusersHeader': called before closing the <fieldset> in
1483 UsersPager::getPageHeader()
1484 $pager: The UsersPager instance
1485 $out: The header HTML
1487 'SpecialListusersHeaderForm': called before adding the submit button in
1488 UsersPager::getPageHeader()
1489 $pager: The UsersPager instance
1490 $out: The header HTML
1492 'SpecialListusersQueryInfo': called right before the end of
1493 UsersPager::getQueryInfo()
1494 $pager: The UsersPager instance
1495 $query: The query array to be returned
1497 'SpecialMovepageAfterMove': called after moving a page
1498 $movePage: MovePageForm object
1499 $oldTitle: old title (object)
1500 $newTitle: new title (object)
1502 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1503 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1504 $opts: FormOptions object containing special page options
1505 &$conds: array of WHERE conditionals for query
1507 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1508 hook to remove a core special page
1509 $list: list (array) of core special pages
1511 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1512 use this to change some selection criteria or substitute a different title
1513 &$randstr: The random number from wfRandom()
1514 &$isRedir: Boolean, whether to select a redirect or non-redirect
1515 &$namespaces: An array of namespace indexes to get the title from
1516 &$extra: An array of extra SQL statements
1517 &$title: If the hook returns false, a Title object to use instead of the
1518 result from the normal query
1520 'SpecialRecentChangesPanel': called when building form options in
1521 SpecialRecentChanges
1522 &$extraOpts: array of added items, to which can be added
1523 $opts: FormOptions for this request
1525 'SpecialRecentChangesQuery': called when building sql query for
1526 SpecialRecentChanges
1527 &$conds: array of WHERE conditionals for query
1528 &$tables: array of tables to be queried
1529 &$join_conds: join conditions for the tables
1530 $opts: FormOptions for this request
1531 &$query_options: array of options for the database request
1533 'SpecialSearchGomatch': called when user clicked the "Go" button and the target
1535 &$title: title object generated from the text entred by the user
1537 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1538 target doesn't exist
1539 &$title: title object generated from the text entred by the user
1541 'SpecialSearchProfiles': allows modification of search profiles
1542 &$profiles: profiles, which can be modified.
1544 'SpecialSearchResults': called before search result display when there
1546 $term: string of search term
1547 &$titleMatches: empty or SearchResultSet object
1548 &$textMatches: empty or SearchResultSet object
1550 'SpecialSearchNoResults': called before search result display when there are
1552 $term: string of search term
1554 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1555 &$extraStats: Array to save the new stats
1556 ( $extraStats['<name of statistic>'] => <value>; )
1558 'SpecialUploadComplete': Called after successfully uploading a file from
1560 $form: The SpecialUpload object
1562 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1563 use this to change the tables headers
1564 $extTypes: associative array of extensions types
1566 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1567 &$conds: array of WHERE conditionals for query
1568 &$tables: array of tables to be queried
1569 &$join_conds: join conditions for the tables
1570 &$fields: array of query fields
1572 'TitleArrayFromResult': called when creating an TitleArray object from a
1574 &$titleArray: set this to an object to override the default object returned
1575 $res: database result used to create the object
1577 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1578 that can be applied.
1579 $title: The title in question.
1580 &$types: The types of protection available.
1582 'TitleMoveComplete': after moving an article (title)
1585 $user: user who did the move
1586 $pageid: database ID of the page that's been moved
1587 $redirid: database ID of the created redirect
1589 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1590 $title: title object related to the revision
1591 $rev: revision (object) that will be viewed
1593 'UnknownAction': An unknown "action" has occured (useful for defining
1595 $action: action name
1596 $article: article "acted on"
1598 'UnwatchArticle': before a watch is removed from an article
1599 $user: user watching
1600 $article: article object to be removed
1602 'UnwatchArticle': after a watch is removed from an article
1603 $user: user that was watching
1604 $article: article object removed
1606 'UnwatchArticleComplete': after a watch is removed from an article
1607 $user: user that watched
1608 $article: article object that was watched
1610 'UploadForm:initial': before the upload form is generated
1611 $form: UploadForm object
1612 You might set the member-variables $uploadFormTextTop and
1613 $uploadFormTextAfterSummary to inject text (HTML) either before
1614 or after the editform.
1616 'UploadForm:BeforeProcessing': DEPRECATED! at the beginning of processUpload()
1617 $form: UploadForm object
1618 Lets you poke at member variables like $mUploadDescription before the
1621 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1622 $type: (string) the requested upload type
1623 &$className: the class name of the Upload instance to be created
1625 'UploadComplete': when Upload completes an upload
1626 &$upload: an UploadBase child instance
1628 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1630 $descriptor: (array) the HTMLForm descriptor
1632 'UploadFormSourceDescriptors': after the standard source inputs have been
1633 added to the descriptor
1634 $descriptor: (array) the HTMLForm descriptor
1636 'UploadVerification': additional chances to reject an uploaded file
1637 string $saveName: destination file name
1638 string $tempName: filesystem path to the temporary file for checks
1639 string &$error: output: message key for message to show if upload canceled
1640 by returning false. May also be an array, where the first element
1641 is the message key and the remaining elements are used as parameters to
1644 'UploadComplete': Upon completion of a file upload
1645 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1646 $uploadBase->getLocalFile().
1648 'User::mailPasswordInternal': before creation and mailing of a user's new
1650 $user: the user who sent the message out
1651 $ip: IP of the user who sent the message out
1652 $u: the account whose new password will be set
1654 'UserArrayFromResult': called when creating an UserArray object from a
1656 &$userArray: set this to an object to override the default object returned
1657 $res: database result used to create the object
1659 'userCan': To interrupt/advise the "user can do X to Y article" check.
1660 If you want to display an error message, try getUserPermissionsErrors.
1661 $title: Title object being checked against
1662 $user : Current user object
1663 $action: Action being checked
1664 $result: Pointer to result returned if hook returns false. If null is returned,
1665 userCan checks are continued by internal code.
1667 'UserCanSendEmail': To override User::canSendEmail() permission check
1668 $user: User (object) whose permission is being checked
1669 &$canSend: bool set on input, can override on output
1671 'UserClearNewTalkNotification': called when clearing the
1672 "You have new messages!" message, return false to not delete it
1673 $user: User (object) that'll clear the message
1675 'UserComparePasswords': called when checking passwords, return false to
1676 override the default password checks
1677 &$hash: String of the password hash (from the database)
1678 &$password: String of the plaintext password the user entered
1679 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1681 &$result: If the hook returns false, this Boolean value will be checked to
1682 determine if the password was valid
1684 'UserCreateForm': change to manipulate the login form
1685 $template: SimpleTemplate instance for the form
1687 'UserCryptPassword': called when hashing a password, return false to implement
1688 your own hashing method
1689 &$password: String of the plaintext password to encrypt
1690 &$salt: String of the password salt or Boolean false if no salt is provided
1691 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1693 &$hash: If the hook returns false, this String will be used as the hash
1695 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1696 $user: User to get groups for
1697 &$groups: Current effective groups
1699 'UserGetAllRights': after calculating a list of all available rights
1700 &$rights: Array of rights, which may be added to.
1702 'UserGetEmail': called when getting an user email address
1704 &$email: email, change this to override local email
1706 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1707 email authentification
1709 &$timestamp: timestamp, change this to override local email authentification
1712 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1713 &$groups: List of implicit (automatically-assigned) groups
1715 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1716 &$reservedUsernames: $wgReservedUsernames
1718 'UserGetRights': Called in User::getRights()
1719 $user: User to get rights for
1720 &$rights: Current rights
1722 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1724 $user: User in question
1725 $title: Title of the page in question
1726 &$blocked: Out-param, whether or not the user is blocked from that page.
1727 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1728 own user talk pages.
1730 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1732 $ip: User's IP address
1733 &$blocked: Whether the user is blocked, to be modified by the hook
1735 'UserLoadAfterLoadFromSession': called to authenticate users on
1736 external/environmental means; occurs after session is loaded
1737 $user: user object being loaded
1739 'UserLoadDefaults': called when loading a default user
1743 'UserLoadFromDatabase': called when loading a user from the database
1745 &$s: database query object
1747 'UserLoadFromSession': called to authenticate users on external/environmental
1748 means; occurs before session is loaded
1749 $user: user object being loaded
1750 &$result: set this to a boolean value to abort the normal authentification
1753 'UserLoadOptions': when user options/preferences are being loaded from
1756 &$options: Options, can be modified.
1758 'UserLoginComplete': after a user has logged in
1759 $user: the user object that was created on login
1760 $inject_html: Any HTML to inject after the "logged in" message.
1762 'UserLoginForm': change to manipulate the login form
1763 $template: SimpleTemplate instance for the form
1765 'UserLoginMailPassword': Block users from emailing passwords
1766 $name: the username to email the password of.
1767 &$error: out-param - the error message to return.
1769 'UserLogout': before a user logs out
1770 $user: the user object that is about to be logged out
1772 'UserLogoutComplete': after a user has logged out
1773 $user: the user object _after_ logout (won't have name, ID, etc.)
1774 $inject_html: Any HTML to inject after the "logged out" message.
1775 $oldName: name of the user before logout (string)
1777 'UserRights': After a user's group memberships are changed
1778 $user : User object that was changed
1779 $add : Array of strings corresponding to groups added
1780 $remove: Array of strings corresponding to groups removed
1782 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1784 $user: user retrieving new talks messages
1785 $talks: array of new talks page(s)
1787 'UserSaveSettings': called when saving user settings
1790 'UserSaveOptions': Called just before saving user preferences/options.
1792 &$options: Options, modifiable
1794 'UserSetCookies': called when setting user cookies
1796 &$session: session array, will be added to $_SESSION
1797 &$cookies: cookies array mapping cookie name to its value
1799 'UserSetEmail': called when changing user email address
1801 &$email: new email, change this to override new email address
1803 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1804 of email authentification
1806 &$timestamp: new timestamp, change this to override local email
1807 authentification timestamp
1809 'UserToggles': called when initialising User::$mToggles, use this to add
1811 $toggles: array of toggles to add
1813 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1814 alter the SQL query which gets the list of wanted pages
1815 &$wantedPages: WantedPagesPage object
1816 &$sql: raw SQL query used to get the list of wanted pages
1818 'WatchArticle': before a watch is added to an article
1819 $user: user that will watch
1820 $article: article object to be watched
1822 'WatchArticleComplete': after a watch is added to an article
1823 $user: user that watched
1824 $article: article object watched
1826 'WatchlistEditorBuildRemoveLine': when building remove lines in
1827 Special:Watchlist/edit
1828 &$tools: array of extra links
1829 $title: Title object
1830 $redirect: whether the page is a redirect
1833 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1835 One, and only one hook should set this, and return false.
1836 &$tables: Database tables to use in the SELECT query
1837 &$opts: Options to use for the query
1838 &$join: Join conditions
1840 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1841 query pages to be updated with maintenance/updateSpecialPages.php
1842 $query: $wgQueryPages itself
1844 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1845 metadata to be added.
1846 $obj: The XmlDumpWriter object.
1847 &$out: The output string.
1848 $row: The database row for the page.
1849 $title: The title of the page.
1851 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1853 $obj: The XmlDumpWriter object.
1854 &$out: The text being output.
1855 $row: The database row for the revision.
1856 $text: The revision text.
1858 More hooks might be available but undocumented, you can execute
1859 ./maintenance/findhooks.php to find hidden one.