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 'ArticleAfterFetchContent': after fetching content of an article from
367 $article: the article (object) being loaded from the database
368 $content: the content (string) of the article
370 'ArticleConfirmDelete': before writing the confirmation form for article
372 $article: the article (object) being deleted
373 $output: the OutputPage object ($wgOut)
374 &$reason: the reason (string) the article is being deleted
376 'ArticleDelete': before an article is deleted
377 $article: the article (object) being deleted
378 $user: the user (object) deleting the article
379 $reason: the reason (string) the article is being deleted
380 $error: if the deletion was prohibited, the (raw HTML) error message to display
383 'ArticleDeleteComplete': after an article is deleted
384 $article: the article that was deleted
385 $user: the user that deleted the article
386 $reason: the reason the article was deleted
387 $id: id of the article that was deleted
389 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
391 $article: article (object) of the user talk page
393 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
394 article has been changed
395 $article: the article (object)
396 $editInfo: data holder that includes the parser output ($editInfo->output) for
397 that page after the change
398 $changed: bool for if the page was changed
400 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
401 recentchanges table, return false to not delete old entries
402 $article: article (object) being modified
404 'ArticleFromTitle': when creating an article object from a title object using
405 Wiki::articleFromTitle()
406 $title: title (object) used to create the article object
407 $article: article (object) that will be returned
409 'ArticleInsertComplete': After a new article is created
410 $article: Article created
411 $user: User creating the article
413 $summary: Edit summary/comment
414 $isMinor: Whether or not the edit was marked as minor
415 $isWatch: (No longer used)
416 $section: (No longer used)
417 $flags: Flags passed to Article::doEdit()
418 $revision: New Revision of the article
420 'ArticleMergeComplete': after merging to article using Special:Mergehistory
421 $targetTitle: target title (object)
422 $destTitle: destination title (object)
424 'ArticlePageDataAfter': after loading data of an article from the database
425 $article: article (object) whose data were loaded
426 $row: row (object) returned from the database server
428 'ArticlePageDataBefore': before loading data of an article from the database
429 $article: article (object) that data will be loaded
430 $fields: fileds (array) to load from the database
432 'ArticleProtect': before an article is protected
433 $article: the article being protected
434 $user: the user doing the protection
435 $protect: boolean whether this is a protect or an unprotect
436 $reason: Reason for protect
437 $moveonly: boolean whether this is for move only or not
439 'ArticleProtectComplete': after an article is protected
440 $article: the article that was protected
441 $user: the user who did the protection
442 $protect: boolean whether it was a protect or an unprotect
443 $reason: Reason for protect
444 $moveonly: boolean whether it was for move only or not
446 'ArticlePurge': before executing "&action=purge"
447 $article: article (object) to purge
449 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
450 revision of an article
451 &$title: title object of the article
453 'ArticleRevisionUndeleted': after an article revision is restored
454 $title: the article title
455 $revision: the revision
456 $oldPageID: the page ID of the revision when archived (may be null)
458 'ArticleRollbackComplete': after an article rollback is completed
459 $article: the article that was edited
460 $user: the user who did the rollback
461 $revision: the revision the page was reverted back to
462 $current: the reverted revision
464 'ArticleSave': before an article is saved
465 $article: the article (object) being saved
466 $user: the user (object) saving the article
467 $text: the new article text
468 $summary: the article summary (comment)
473 'ArticleSaveComplete': After an article has been updated
474 $article: Article modified
475 $user: User performing the modification
477 $summary: Edit summary/comment
478 $isMinor: Whether or not the edit was marked as minor
479 $isWatch: (No longer used)
480 $section: (No longer used)
481 $flags: Flags passed to Article::doEdit()
482 $revision: New Revision of the article
483 $baseRevId: the rev ID (or false) this edit was based on
485 'ArticleUndelete': When one or more revisions of an article are restored
486 $title: Title corresponding to the article restored
487 $create: Whether or not the restoration caused the page to be created
488 (i.e. it didn't exist before)
489 $comment: The comment associated with the undeletion.
491 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
492 before the user is redirected back to the page
493 &$article: the article
494 &$sectionanchor: The section anchor link (e.g. "#overview" )
495 &$extraq: Extra query parameters which can be added via hooked functions
497 'ArticleViewHeader': Before the parser cache is about to be tried for article
499 &$article: the article
500 &$pcache: whether to try the parser cache or not
501 &$outputDone: whether the output for this page finished or not
503 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
505 $article: target article (object)
507 'AuthPluginAutoCreate': Called when creating a local account for an user logged
508 in from an external authentication method
509 $user: User object created locally
511 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
512 Gives a chance for an extension to set it programattically to a variable class.
513 &$auth: the $wgAuth object, probably a stub
515 'AutopromoteCondition': check autopromote condition for user.
516 $type: condition type
519 $result: result of checking autopromote condition
521 'BadImage': When checking against the bad image list
522 $name: Image name being checked
523 &$bad: Whether or not the image is "bad"
525 Change $bad and return false to override. If an image is "bad", it is not
526 rendered inline in wiki pages or galleries in category pages.
528 'BeforeGalleryFindFile': before an image is fetched for a gallery
529 &$gallery,: the gallery object
530 &$nt: the image title
531 &$time: image timestamp
533 'BeforeInitialize': before anything is initialized in performRequestForTitle()
534 &$title: Title being used for request
535 &$article: The associated Article object
536 &$output: OutputPage object
538 $request: WebRequest object
539 $mediaWiki: Mediawiki object
541 'BeforePageDisplay': Prior to outputting a page
542 &$out: OutputPage object
545 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
546 &$parser: Parser object
547 &$title: title of the template
548 &$skip: skip this template and link it?
549 &$id: the id of the revision being parsed
551 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
552 &$parser: Parser object
553 &$nt: the image title
554 &$skip: skip this image and link it?
555 &$time: the image timestamp
557 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
558 &$parser: Parser object
559 &$ig: ImageGallery object
561 'BlockIp': before an IP address or user is blocked
562 $block: the Block object about to be saved
563 $user: the user _doing_ the block (not the one being blocked)
565 'BlockIpComplete': after an IP address or user is blocked
566 $block: the Block object that was saved
567 $user: the user who did the block (not the one being blocked)
569 'BookInformation': Before information output on Special:Booksources
570 $isbn: ISBN to show information for
571 $output: OutputPage object in use
573 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
574 &$namespaces: Array of namespace numbers with corresponding canonical names
576 'CategoryPageView': before viewing a categorypage in CategoryPage::view
577 $catpage: CategoryPage instance
579 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
580 &$changesList: ChangesList instance.
581 &$articlelink: HTML of link to article (already filled-in).
582 &$s: HTML of row that is being constructed.
583 &$rc: RecentChange instance.
584 $unpatrolled: Whether or not we are showing unpatrolled changes.
585 $watched: Whether or not the change is watched by the user.
587 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
588 $user: user (object) whose email is being confirmed
590 'ContribsPager::getQueryInfo': Before the contributions query is about to run
591 &$pager: Pager object for contributions
592 &queryInfo: The query for the contribs Pager
594 'ContributionsLineEnding': Called before a contributions HTML line is finished
595 $page: SpecialPage object for contributions
597 $row: the DB row for this line
599 'ContributionsToolLinks': Change tool links above Special:Contributions
601 $title: User page title
602 &$tools: Array of tool links
604 'CustomEditor': When invoking the page editor
605 $article: Article being edited
606 $user: User performing the edit
608 Return true to allow the normal editor to be used, or false
609 if implementing a custom editor, e.g. for a special namespace,
612 'DatabaseOraclePostInit': Called after initialising an Oracle database
613 &$db: the DatabaseOracle object
615 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
616 $title: the diff page title (nullable)
617 &$oldId: the actual old Id to use in the diff
618 &$newId: the actual new Id to use in the diff (0 means current)
619 $old: the ?old= param value from the url
620 $new: the ?new= param value from the url
622 'DiffViewHeader': called before diff display
623 $diff: DifferenceEngine object that's calling
624 $oldRev: Revision object of the "old" revision (may be null/invalid)
625 $newRev: Revision object of the "new" revision
627 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
629 $article: article (object) being viewed
630 $oldid: oldid (int) being viewed
632 'DoEditSectionLink': Override the HTML generated for section edit links
633 $skin: Skin object rendering the UI
634 $title: Title object for the title being linked to (may not be the same as
635 $wgTitle, if the section is included from a template)
636 $section: The designation of the section being pointed to, to be included in
637 the link, like "§ion=$section"
638 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
639 By default, this is wrapped in the 'editsectionhint' message.
640 $result: The HTML to return, prefilled with the default plus whatever other
641 changes earlier hooks have made
643 'EditFilter': Perform checks on an edit
644 $editor: Edit form (see includes/EditPage.php)
645 $text: Contents of the edit box
646 $section: Section being edited
647 &$error: Error message to return
648 $summary: Edit summary for page
650 'EditFilterMerged': Post-section-merge edit filter
651 $editor: EditPage instance (object)
652 $text: content of the edit box
653 &$error: error message to return
654 $summary: Edit summary for page
656 'EditFormPreloadText': Allows population of the edit form when creating
658 &$text: Text to preload with
659 &$title: Title object representing the page being created
661 'EditFormInitialText': Allows modifying the edit form when editing existing
663 $editPage: EditPage object
665 'EditPage::attemptSave': called before an article is
666 saved, that is before insertNewArticle() is called
667 $editpage_Obj: the current EditPage object
669 'EditPage::importFormData': allow extensions to read additional data
671 $editpage: EditPage instance
673 return value is ignored (should always return true)
675 'EditPage::showEditForm:fields': allows injection of form field into edit form
676 &$editor: the EditPage instance for reference
677 &$out: an OutputPage instance to write to
678 return value is ignored (should always return true)
680 'EditPage::showEditForm:initial': before showing the edit form
681 $editor: EditPage instance (object)
683 Return false to halt editing; you'll need to handle error messages, etc.
684 yourself. Alternatively, modifying $error and returning true will cause the
685 contents of $error to be echoed at the top of the edit form as wikitext.
686 Return true without altering $error to allow the edit to proceed.
688 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
689 when there's an edit conflict. Return false to halt normal diff output; in
690 this case you're responsible for computing and outputting the entire "conflict"
691 part, i.e., the "difference between revisions" and "your text" headers and
693 &$editor: EditPage instance
694 &$out: OutputPage instance
696 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
697 textarea in the edit form
698 &$editpage: The current EditPage object
699 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
700 &$tabindex: HTML tabindex of the last edit check/button
702 'EditPageBeforeEditChecks': allows modifying the edit checks below the
703 textarea in the edit form
704 &$editpage: The current EditPage object
705 &$checks: Array of edit checks like "watch this page"/"minor edit"
706 &$tabindex: HTML tabindex of the last edit check/button
708 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
709 textarea in the edit form
710 &$toolbar: The toolbar HTMl
712 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
713 $title: title of page being edited
714 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
716 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
718 $editPage: EditPage object
719 &$newtext: wikitext that will be used as "your version"
721 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
722 $editPage: EditPage object
723 &$toparse: wikitext that will be parsed
725 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
726 &$editpage: The current EditPage object
727 &$res: the HTML of the error text
729 'EditPageTosSummary': Give a chance for site and per-namespace customizations
730 of terms of service summary link that might exist separately from the copyright
732 $title: title of page being edited
733 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
735 'EditSectionLink': Do not use, use DoEditSectionLink instead.
736 $skin: Skin rendering the UI
737 $title: Title being linked to
738 $section: Section to link to
740 $result: Result (alter this to override the generated links)
742 'EmailConfirmed': When checking that the user's email address is "confirmed"
743 $user: User being checked
744 $confirmed: Whether or not the email address is confirmed
745 This runs before the other checks, such as anonymity and the real check; return
746 true to allow those checks to occur, and false if checking is done.
748 'EmailUser': before sending email from one user to another
749 $to: address of receiving user
750 $from: address of sending user
751 $subject: subject of the mail
752 $text: text of the mail
754 'EmailUserCC': before sending the copy of the email to the author
755 $to: address of receiving user
756 $from: address of sending user
757 $subject: subject of the mail
758 $text: text of the mail
760 'EmailUserComplete': after sending email from one user to another
761 $to: address of receiving user
762 $from: address of sending user
763 $subject: subject of the mail
764 $text: text of the mail
766 'EmailUserForm': after building the email user form object
767 $form: HTMLForm object
769 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
770 $user: The user who is trying to email another user.
771 $editToken: The user's edit token.
772 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
774 'FetchChangesList': When fetching the ChangesList derivative for
776 &$user: User the list is being fetched for
777 &$skin: Skin object to be used with the list
778 &$list: List object (defaults to NULL, change it to an object
779 instance and return false override the list derivative used)
781 'FileDeleteComplete': When a file is deleted
782 $file: reference to the deleted file
783 $oldimage: in case of the deletion of an old image, the name of the old file
784 $article: in case all revisions of the file are deleted a reference to the
785 article associated with the file.
786 $user: user who performed the deletion
789 'FileUpload': When a file upload occurs
790 $file : Image object representing the file that was uploaded
792 'FileUndeleteComplete': When a file is undeleted
793 $title: title object to the file
794 $fileVersions: array of undeleted versions. Empty if all versions were restored
795 $user: user who performed the undeletion
798 'FormatUserMessage': Hook to format a message if you want to override
799 the internal formatter.
800 $subject: Title of the message.
801 &$text: Text of the message.
802 $signature: Signature that they would like to leave.
804 'GetAutoPromoteGroups': When determining which autopromote groups a user
805 is entitled to be in.
806 &$user: user to promote.
807 &$promote: groups that will be added.
809 'GetBlockedStatus': after loading blocking status of an user from the database
810 $user: user (object) being checked
812 'GetCacheVaryCookies': get cookies that should vary cache options
813 $out: OutputPage object
814 &$cookies: array of cookies name, add a value to it if you want to add a cookie
815 that have to vary cache options
817 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
818 $title: Title object of page
819 $url: string value as output (out parameter, can modify)
820 $query: query options passed to Title::getFullURL()
822 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
823 $title: Title object of page
824 $url: string value as output (out parameter, can modify)
825 $query: query options passed to Title::getInternalURL()
827 'GetLinkColours': modify the CSS class of an array of page links
828 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
830 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
832 'GetLocalURL': modify local URLs as output into page links
833 $title: Title object of page
834 $url: string value as output (out parameter, can modify)
835 $query: query options passed to Title::getLocalURL()
837 'GetPreferences': modify user preferences
838 $user: User whose preferences are being modified.
839 &$preferences: Preferences description array, to be fed to an HTMLForm object
841 'getUserPermissionsErrors': Add a permissions error when permissions errors are
842 checked for. Use instead of userCan for most cases. Return false if the
843 user can't do it, and populate $result with the reason in the form of
844 array( messagename, param1, param2, ... ). For consistency, error messages
845 should be plain text with no special coloring, bolding, etc. to show that
846 they're errors; presenting them properly to the user as errors is done by
848 $title: Title object being checked against
849 $user : Current user object
850 $action: Action being checked
851 $result: User permissions error to add. If none, return true.
853 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
854 if expensive checks are enabled.
856 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
858 $title: Title object, pages linked to this title are purged.
860 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
861 image insertion. You can skip the default logic entirely by returning
862 false, or just modify a few things using call-by-reference.
864 &$title: Title object of the image
865 &$file: File object, or false if it doesn't exist
866 &$frameParams: Various parameters with special meanings; see documentation in
867 includes/Linker.php for Linker::makeImageLink2
868 &$handlerParams: Various parameters with special meanings; see documentation in
869 includes/Linker.php for Linker::makeImageLink2
870 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
871 &$res: Final HTML output, used if you return false
874 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
875 the image on an image page
876 $imagePage: ImagePage object ($this)
879 'ImagePageAfterImageLinks': called after the image links section on an image
881 $imagePage: ImagePage object ($this)
882 &$html: HTML for the hook to add
884 'ImagePageFileHistoryLine': called when a file history line is contructed
886 $line: the HTML of the history line
887 $css: the line CSS class
889 'ImagePageFindFile': called when fetching the file associated with an image page
890 $page: ImagePage object
892 &$displayFile: displayed File object
894 'ImagePageShowTOC': called when the file toc on an image page is generated
895 $page: ImagePage object
896 &$toc: Array of <li> strings
898 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
900 &$title: the Title object of the file as it would appear for the upload page
901 &$path: the original file and path name when img_auth was invoked by the the web
903 &$name: the name only component of the file
904 &$result: The location to pass back results of the hook routine (only used if
906 $result[0]=The index of the header message
907 $result[1]=The index of the body text message
908 $result[2 through n]=Parameters passed to body text message. Please note the
909 header message cannot receive/use parameters.
911 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
912 $reader: XMLReader object
913 $logInfo: Array of information
914 Return false to stop further processing of the tag
916 'ImportHandlePageXMLTag': When parsing a XML tag in a page
917 $reader: XMLReader object
918 $pageInfo: Array of information
919 Return false to stop further processing of the tag
921 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
922 $reader: XMLReader object
923 $revInfo: Array of information
924 Return false to stop further processing of the tag
926 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
927 $reader: XMLReader object
928 Return false to stop further processing of the tag
930 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
931 $reader: XMLReader object
932 $revisionInfo: Array of information
933 Return false to stop further processing of the tag
935 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
936 $title: Title object ($wgTitle)
938 $ignoreRedirect: boolean to skip redirect check
939 $target: Title/string of redirect target
940 $article: Article object
942 'InternalParseBeforeLinks': during Parser's internalParse method before links
943 but after noinclude/includeonly/onlyinclude and other processing.
944 &$parser: Parser object
945 &$text: string containing partially parsed text
946 &$stripState: Parser's internal StripState object
948 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
949 $user: user (object) whose email is being invalidated
951 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
952 $article: article (object) being checked
954 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
956 $result: Change this value to override the result of wfIsTrustedProxy()
958 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
959 tance to return false if the domain name doesn't match your organization
960 $addr: The e-mail address entered by the user
961 &$result: Set this and return false to override the internal checks
963 'isValidPassword': Override the result of User::isValidPassword()
964 $password: The password entered by the user
965 &$result: Set this and return false to override the internal checks
966 $user: User the password is being validated for
968 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
969 $wgExtensionMessagesFiles instead.
970 Use this to define synonyms of magic words depending of the language
971 $magicExtensions: associative array of magic words synonyms
972 $lang: laguage code (string)
974 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
975 listed in $wgExtensionMessagesFiles instead.
976 Use to define aliases of special pages names depending of the language
977 $specialPageAliases: associative array of magic words synonyms
978 $lang: laguage code (string)
980 'LinkBegin': Used when generating internal and interwiki links in
981 Linker::link(), before processing starts. Return false to skip default proces-
982 sing and return $ret. See documentation for Linker::link() for details on the
983 expected meanings of parameters.
984 $skin: the Skin object
985 $target: the Title that the link is pointing to
986 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
988 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
989 tive array form, with keys and values unescaped. Should be merged with de-
990 fault values, with a value of false meaning to suppress the attribute.
991 &$query: the query string to add to the generated URL (the bit after the "?"),
992 in associative array form, with keys and values unescaped.
993 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
994 &$ret: the value to return if your hook returns false.
996 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
997 just before the function returns a value. If you return true, an <a> element
998 with HTML attributes $attribs and contents $text will be returned. If you re-
999 turn false, $ret will be returned.
1000 $skin: the Skin object
1001 $target: the Title object that the link is pointing to
1002 $options: the options. Will always include either 'known' or 'broken', and may
1003 include 'noclasses'.
1004 &$text: the final (raw HTML) contents of the <a> tag, after processing.
1005 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1007 &$ret: the value to return if your hook returns false.
1009 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1011 &$url: the image url
1012 &$alt: the image's alt text
1013 &$img: the new image HTML (if returning false)
1015 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1018 &$text: the link text
1019 &$link: the new link HTML (if returning false)
1020 &$attribs: the attributes to be applied.
1021 $linkType: The external link type
1023 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1025 &$linksUpdate: the LinksUpdate object
1027 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1029 &$linksUpdate: the LinksUpdate object
1031 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1032 &$linksUpdate: the LinksUpdate object
1034 'ListDefinedTags': When trying to find all defined tags.
1035 &$tags: The list of tags.
1037 'LoadExtensionSchemaUpdates': called during database installation and updates
1038 &updater: A DatabaseUpdater subclass
1040 'LocalFile::getHistory': called before file history query performed
1043 $fields: select fields
1045 $opts: query options
1046 $join_conds: JOIN conditions
1048 'LocalisationCacheRecache': Called when loading the localisation data into cache
1049 $cache: The LocalisationCache object
1050 $code: language code
1051 &$alldata: The localisation data from core and extensions
1053 'LoginAuthenticateAudit': a login attempt for a valid user account either
1054 succeeded or failed. No return data is accepted; this hook is for auditing only.
1055 $user: the User object being authenticated against
1056 $password: the password being submitted and found wanting
1057 $retval: a LoginForm class constant with authenticateUserData() return
1058 value (SUCCESS, WRONG_PASS, etc)
1060 'LogLine': Processes a single log entry on Special:Log
1061 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1062 logging.log_type database field.
1063 $log_action: string for the type of log action (e.g. 'delete', 'block',
1064 'create2'). Corresponds to logging.log_action database field.
1065 $title: Title object that corresponds to logging.log_namespace and
1066 logging.log_title database fields.
1067 $paramArray: Array of parameters that corresponds to logging.log_params field.
1068 Note that only $paramArray[0] appears to contain anything.
1069 &$comment: string that corresponds to logging.log_comment database field, and
1070 which is displayed in the UI.
1071 &$revert: string that is displayed in the UI, similar to $comment.
1072 $time: timestamp of the log entry (added in 1.12)
1074 'LogPageValidTypes': action being logged.
1075 DEPRECATED: Use $wgLogTypes
1076 &$type: array of strings
1078 'LogPageLogName': name of the logging page(s).
1079 DEPRECATED: Use $wgLogNames
1080 &$typeText: array of strings
1082 'LogPageLogHeader': strings used by wfMsg as a header.
1083 DEPRECATED: Use $wgLogHeaders
1084 &$headerText: array of strings
1086 'LogPageActionText': strings used by wfMsg as a header.
1087 DEPRECATED: Use $wgLogActions
1088 &$actionText: array of strings
1090 'MagicWordMagicWords': When defining new magic word.
1091 DEPRECATED: use $magicWords in a file listed in
1092 $wgExtensionMessagesFiles instead.
1093 $magicWords: array of strings
1095 'MagicWordwgVariableIDs': When definig new magic words IDs.
1096 $variableIDs: array of strings
1098 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1100 &$vars: variable (or multiple variables) to be added into the output
1101 of Skin::makeVariablesScript
1103 'MarkPatrolled': before an edit is marked patrolled
1104 $rcid: ID of the revision to be marked patrolled
1105 $user: the user (object) marking the revision as patrolled
1106 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1107 needs to be a sysop in order to mark an edit patrolled
1109 'MarkPatrolledComplete': after an edit is marked patrolled
1110 $rcid: ID of the revision marked as patrolled
1111 $user: user (object) who marked the edit patrolled
1112 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1113 must be a sysop to patrol the edit
1115 'MathAfterTexvc': after texvc is executed when rendering mathematics
1116 $mathRenderer: instance of MathRenderer
1117 $errmsg: error message, in HTML (string). Nonempty indicates failure
1118 of rendering the formula
1120 'MediaWikiPerformAction': Override MediaWiki::performAction().
1121 Use this to do something completely different, after the basic
1122 globals have been set up, but before ordinary actions take place.
1124 $article: $wgArticle
1127 $request: $wgRequest
1128 $mediaWiki: The $mediawiki object
1130 'MessagesPreLoad': When loading a message from the database
1131 $title: title of the message (string)
1132 $message: value (string), change it to the message you want to define
1134 'MessageCacheReplace': When a message page is changed.
1135 Useful for updating caches.
1136 $title: name of the page changed.
1137 $text: new contents of the page.
1139 'ModifyExportQuery': Modify the query used by the exporter.
1140 $db: The database object to be queried.
1141 &$tables: Tables in the query.
1142 &$conds: Conditions in the query.
1143 &$opts: Options for the query.
1144 &$join_conds: Join conditions for the query.
1146 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1147 been rendered (useful for adding more)
1148 Note: this is only run for the Monobook skin. This hook is deprecated and
1149 may be removed in the future. To add items to the toolbox you should use
1150 the SkinTemplateToolboxEnd hook instead, which works for all
1151 "SkinTemplate"-type skins.
1152 $tools: array of tools
1154 'NewRevisionFromEditComplete': called when a revision was inserted
1156 $article: the article edited
1157 $rev: the new revision
1158 $baseID: the revision ID this was based off, if any
1159 $user: the editing user
1161 'NormalizeMessageKey': Called before the software gets the text of a message
1162 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1164 &$key: the message being looked up. Change this to something else to change
1165 what message gets displayed (string)
1166 &$useDB: whether or not to look up the message in the database (bool)
1167 &$langCode: the language code to get the message for (string) - or -
1168 whether to use the content language (true) or site language (false) (bool)
1169 &$transform: whether or not to expand variables and templates
1170 in the message (bool)
1172 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1173 &$changeslist: The OldChangesList instance.
1174 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1175 &$rc: The RecentChange object.
1177 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1178 Hooks can alter or append to the array of URLs for search & suggestion formats.
1179 &$urls: array of associative arrays with Url element attributes
1181 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1182 users and/or IP addresses too
1183 $otherBlockLink: An array with links to other block logs
1184 $ip: The requested IP address or username
1186 'OutputPageBeforeHTML': a page has been processed by the parser and
1187 the resulting HTML is about to be displayed.
1188 $parserOutput: the parserOutput (object) that corresponds to the page
1189 $text: the text that will be displayed, in HTML (string)
1191 'OutputPageCheckLastModified': when checking if the page has been modified
1192 since the last visit
1193 &$modifiedTimes: array of timestamps.
1194 The following keys are set: page, user, epoch
1196 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1197 $out: OutputPage instance (object)
1198 $parserOutput: parserOutput instance being added in $out
1200 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1201 categories. Implementations should return false if they generate the category
1202 links, so the default link generation is skipped.
1203 $out: OutputPage instance (object)
1204 $categories: associative array, keys are category names, values are category
1205 types ("normal" or "hidden")
1206 $links: array, intended to hold the result. Must be an associative array with
1207 category types as keys and arrays of HTML links as values.
1209 'PageHistoryBeforeList': When a history page list is about to be constructed.
1210 $article: the article that the history is loading for
1212 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1213 $row: the revision row for this line
1214 $s: the string representing this parsed line
1215 $classes: array containing the <li> element classes
1217 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1220 $queryInfo: the query parameters
1222 'PageRenderingHash': alter the parser cache option hash key
1223 A parser extension which depends on user options should install
1224 this hook and append its values to the key.
1225 $hash: reference to a hash key string which can be modified
1227 'ParserAfterStrip': Same as ParserBeforeStrip
1229 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1230 $parser: Parser object being used
1231 $text: text that'll be returned
1233 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1234 $parser: Parser object
1235 $text: text to parse
1236 $stripState: StripState instance being used
1238 'ParserBeforeStrip': Called at start of parsing time
1239 (no more strip, deprecated ?)
1240 $parser: parser object
1241 $text: text being parsed
1242 $stripState: stripState used (object)
1244 'ParserBeforeTidy': called before tidy and custom tags replacements
1245 $parser: Parser object being used
1248 'ParserClearState': called at the end of Parser::clearState()
1249 $parser: Parser object being cleared
1251 'ParserFirstCallInit': called when the parser initialises for the first time
1252 &$parser: Parser object being cleared
1254 'ParserGetVariableValueSwitch': called when the parser need the value of a
1256 $parser: Parser object
1257 $varCache: array to store the value in case of multiples calls of the
1259 $index: index (string) of the magic
1260 $ret: value of the magic word (the hook should set it)
1261 $frame: PPFrame object to use for expanding any template variables
1263 'ParserGetVariableValueTs': use this to change the value of the time for the
1264 {{LOCAL...}} magic word
1265 $parser: Parser object
1266 $time: actual time (timestamp)
1268 'ParserGetVariableValueVarCache': use this to change the value of the
1269 variable cache or return false to not use it
1270 $parser: Parser object
1271 $varCache: varaiable cache (array)
1273 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1274 include comments about size of the text parsed
1275 $parser: Parser object
1276 $limitReport: text that will be included (without comment tags)
1278 'ParserMakeImageParams': Called before the parser make an image link, use this
1279 to modify the parameters of the image.
1280 $title: title object representing the file
1281 $file: file object that will be used to create the image
1282 &$params: 2-D array of parameters
1284 'ParserTestParser': called when creating a new instance of Parser in
1285 maintenance/parserTests.inc
1286 $parser: Parser object created
1288 'ParserTestTables': alter the list of tables to duplicate when parser tests
1289 are run. Use when page save hooks require the presence of custom tables
1290 to ensure that tests continue to run properly.
1291 &$tables: array of table names
1293 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1294 my talk page, my contributions" etc).
1296 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1297 &$title: Title object representing the current page
1299 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1300 &$user : User performing the action
1301 $action : Action being performed
1302 &$result : Whether or not the action should be prevented
1303 Change $result and return false to give a definitive answer, otherwise
1304 the built-in rate limiting checks are used, if enabled.
1306 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1307 AJAX search suggestions. Put results into &$results outparam and return false.
1308 $ns : array of int namespace keys to search in
1309 $search : search term (not guaranteed to be conveniently normalized)
1310 $limit : maximum number of results to return
1311 &$results : out param: array of page names (strings)
1313 'PrefsEmailAudit': called when user changes his email address
1314 $user: User (object) changing his email address
1315 $oldaddr: old email address (string)
1316 $newaddr: new email address (string)
1318 'PrefsPasswordAudit': called when user changes his password
1319 $user: User (object) changing his passoword
1320 $newPass: new password
1321 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1323 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1324 $article: the title being (un)protected
1325 $output: a string of the form HTML so far
1327 'ProtectionForm::save': called when a protection form is submitted
1328 $article: the title being (un)protected
1329 $errorMsg: an html message string of an error
1331 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1332 $article: the page the form is shown for
1333 $out: OutputPage object
1335 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1336 &$obj: RawPage object
1337 &$text: The text that's going to be the output
1339 'RecentChange_save': called at the end of RecenChange::save()
1340 $recentChange: RecentChange object
1342 'RevisionInsertComplete': called after a revision is inserted into the DB
1343 &$revision: the Revision
1344 $data: the data stored in old_text. The meaning depends on $flags: if external
1345 is set, it's the URL of the revision text in external storage; otherwise,
1346 it's the revision text itself. In either case, if gzip is set, the revision
1348 $flags: a comma-delimited list of strings representing the options used. May
1349 include: utf8 (this will always be set for new revisions); gzip; external.
1351 'SearchUpdate': Prior to search update completion
1353 $namespace : Page namespace
1355 $text : Current text being indexed
1357 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1358 $allSearchTerms : Array of the search terms in all content languages
1359 &$titleResult : Outparam; the value to return. A Title object or null.
1361 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1362 $term : Search term string
1363 &$title : Outparam; set to $title object and return false for a match
1365 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1366 $term : Search term string
1367 &$title : Current Title object that is being returned (null if none found).
1369 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1370 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1371 in the $searchEngine->namespaces array.
1372 $query : Original query.
1373 &$parsed : Resultant query with the prefixes stripped.
1375 'SearchableNamespaces': An option to modify which namespaces are searchable.
1376 &$arr : Array of namespaces ($nsId => $name) which will be used.
1378 'SetupAfterCache': Called in Setup.php, after cache objects are set
1380 'SetupUserMessageArticle': Called in User::leaveUserMessage() before
1381 anything has been posted to the article.
1382 $user: The user who we left the message for.
1383 &$article: The article that will be posted to.
1384 $subject: The subject of the message
1385 $text: The text of the message.
1386 $signature: The signature we used.
1387 $summary: The edit summary.
1388 $editor: The editor that performed the edit.
1390 'ShowMissingArticle': Called when generating the output for a non-existent page
1391 $article: The article object corresponding to the page
1393 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1394 $text: Text being shown
1395 $title: Title of the custom script/stylesheet page
1396 $output: Current OutputPage object
1398 'ShowSearchHitTitle': Customise display of search hit title/link.
1399 &$title: Title to link to
1400 &$text: Text to use for the link
1401 $result: The search result
1402 $terms: The search terms entered
1403 $page: The SpecialSearch object.
1405 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1406 &$siteNotice: HTML returned as the sitenotice
1407 Return true to allow the normal method of notice selection/rendering to work,
1408 or change the value of $siteNotice and return false to alter it.
1410 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1411 &$siteNotice: HTML sitenotice
1412 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1414 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1416 &$text: bottomScripts Text
1417 Append to $text to add additional text/scripts after the stock bottom scripts.
1419 'SkinAfterContent': Allows extensions to add text after the page content and
1421 &$data: (string) Text to be printed out directly (without parsing)
1423 This hook should work in all skins. Just set the &$data variable to the text
1424 you're going to add.
1426 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1428 &$bar: Sidebar contents
1429 Modify $bar to add or modify sidebar portlets.
1431 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1432 $title: displayed page title
1433 $type: 'normal' or 'history' for old/diff views
1434 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1435 &$link: overridable HTML link to be passed into the message as $1
1436 &$forContent: overridable flag if copyright footer is shown in content language.
1438 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1440 &$subpages: Subpage links HTML
1441 If false is returned $subpages will be used instead of the HTML
1442 subPageSubtitle() generates.
1443 If true is returned, $subpages will be ignored and the rest of
1444 subPageSubtitle() will run.
1446 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1447 when showing a special page
1448 $sktemplate: SkinTemplate object
1449 $content_actions: array of tabs
1451 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1452 "permanent link" tab
1453 $sktemplate: SkinTemplate object
1454 $nav_urls: array of tabs
1456 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1457 &$content_actions: Content actions
1458 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1461 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1462 &$sktemplate: SkinTemplate object
1463 &$links: Structured navigation links
1464 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1466 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1468 &$sktemplate: SkinTemplate object
1469 &$tpl: Template engine object
1471 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1472 $sktemplate: SkinTemplate object
1473 $res: set to true to prevent active tabs
1475 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1478 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1479 You can either create your own array, or alter the parameters for
1481 &$sktemplate: The SkinTemplate instance.
1482 $title: Title instance for the page.
1483 $message: Visible label of tab.
1484 $selected: Whether this is a selected tab.
1485 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1486 &$classes: Array of CSS classes to apply.
1487 &$query: Query string to add to link.
1489 &$result: Complete assoc. array if you want to return true.
1491 'SkinTemplateTabs': called when finished to build the actions tabs
1492 $sktemplate: SkinTemplate object
1493 $content_actions: array of tabs
1495 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1496 been rendered (useful for adding more)
1497 $tools: array of tools
1499 'SoftwareInfo': Called by Special:Version for returning information about
1501 $software: The array of software in format 'name' => 'version'.
1502 See SpecialVersion::softwareInformation()
1504 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1505 $id: User identifier
1507 'SpecialListusersDefaultQuery': called right before the end of
1508 UsersPager::getDefaultQuery()
1509 $pager: The UsersPager instance
1510 $query: The query array to be returned
1512 'SpecialListusersFormatRow': called right before the end of
1513 UsersPager::formatRow()
1514 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1515 $row: Database row object
1517 'SpecialListusersHeader': called before closing the <fieldset> in
1518 UsersPager::getPageHeader()
1519 $pager: The UsersPager instance
1520 $out: The header HTML
1522 'SpecialListusersHeaderForm': called before adding the submit button in
1523 UsersPager::getPageHeader()
1524 $pager: The UsersPager instance
1525 $out: The header HTML
1527 'SpecialListusersQueryInfo': called right before the end of
1528 UsersPager::getQueryInfo()
1529 $pager: The UsersPager instance
1530 $query: The query array to be returned
1532 'SpecialMovepageAfterMove': called after moving a page
1533 $movePage: MovePageForm object
1534 $oldTitle: old title (object)
1535 $newTitle: new title (object)
1537 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1538 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1539 $opts: FormOptions object containing special page options
1540 &$conds: array of WHERE conditionals for query
1542 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1543 hook to remove a core special page
1544 $list: list (array) of core special pages
1546 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1547 use this to change some selection criteria or substitute a different title
1548 &$randstr: The random number from wfRandom()
1549 &$isRedir: Boolean, whether to select a redirect or non-redirect
1550 &$namespaces: An array of namespace indexes to get the title from
1551 &$extra: An array of extra SQL statements
1552 &$title: If the hook returns false, a Title object to use instead of the
1553 result from the normal query
1555 'SpecialRecentChangesPanel': called when building form options in
1556 SpecialRecentChanges
1557 &$extraOpts: array of added items, to which can be added
1558 $opts: FormOptions for this request
1560 'SpecialRecentChangesQuery': called when building sql query for
1561 SpecialRecentChanges and SpecialRecentChangesLinked
1562 &$conds: array of WHERE conditionals for query
1563 &$tables: array of tables to be queried
1564 &$join_conds: join conditions for the tables
1565 $opts: FormOptions for this request
1566 &$query_options: array of options for the database request
1568 'SpecialSearchGomatch': called when user clicked the "Go" button and the target
1570 &$title: title object generated from the text entred by the user
1572 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1573 target doesn't exist
1574 &$title: title object generated from the text entred by the user
1576 'SpecialSearchProfiles': allows modification of search profiles
1577 &$profiles: profiles, which can be modified.
1579 'SpecialSearchResults': called before search result display when there
1581 $term: string of search term
1582 &$titleMatches: empty or SearchResultSet object
1583 &$textMatches: empty or SearchResultSet object
1585 'SpecialSearchNoResults': called before search result display when there are
1587 $term: string of search term
1589 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1590 &$extraStats: Array to save the new stats
1591 ( $extraStats['<name of statistic>'] => <value>; )
1593 'SpecialUploadComplete': Called after successfully uploading a file from
1595 $form: The SpecialUpload object
1597 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1598 use this to change the tables headers
1599 $extTypes: associative array of extensions types
1601 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1602 &$conds: array of WHERE conditionals for query
1603 &$tables: array of tables to be queried
1604 &$join_conds: join conditions for the tables
1605 &$fields: array of query fields
1607 'TitleArrayFromResult': called when creating an TitleArray object from a
1609 &$titleArray: set this to an object to override the default object returned
1610 $res: database result used to create the object
1612 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1613 that can be applied.
1614 $title: The title in question.
1615 &$types: The types of protection available.
1617 'TitleMoveComplete': after moving an article (title)
1620 $user: user who did the move
1621 $pageid: database ID of the page that's been moved
1622 $redirid: database ID of the created redirect
1624 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1625 $title: title object related to the revision
1626 $rev: revision (object) that will be viewed
1628 'UnknownAction': An unknown "action" has occured (useful for defining
1630 $action: action name
1631 $article: article "acted on"
1633 'UnitTestsList': Called when building a list of files with PHPUnit tests
1634 &$files: list of files
1636 'UnwatchArticle': before a watch is removed from an article
1637 $user: user watching
1638 $article: article object to be removed
1640 'UnwatchArticle': after a watch is removed from an article
1641 $user: user that was watching
1642 $article: article object removed
1644 'UnwatchArticleComplete': after a watch is removed from an article
1645 $user: user that watched
1646 $article: article object that was watched
1648 'UploadForm:initial': before the upload form is generated
1649 $form: UploadForm object
1650 You might set the member-variables $uploadFormTextTop and
1651 $uploadFormTextAfterSummary to inject text (HTML) either before
1652 or after the editform.
1654 'UploadForm:BeforeProcessing': DEPRECATED! at the beginning of processUpload()
1655 $form: UploadForm object
1656 Lets you poke at member variables like $mUploadDescription before the
1659 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1660 $type: (string) the requested upload type
1661 &$className: the class name of the Upload instance to be created
1663 'UploadComplete': when Upload completes an upload
1664 &$upload: an UploadBase child instance
1666 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1668 $descriptor: (array) the HTMLForm descriptor
1670 'UploadFormSourceDescriptors': after the standard source inputs have been
1671 added to the descriptor
1672 $descriptor: (array) the HTMLForm descriptor
1674 'UploadVerification': additional chances to reject an uploaded file. Consider
1675 using UploadVerifyFile instead.
1676 string $saveName: destination file name
1677 string $tempName: filesystem path to the temporary file for checks
1678 string &$error: output: message key for message to show if upload canceled
1679 by returning false. May also be an array, where the first element
1680 is the message key and the remaining elements are used as parameters to
1683 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1684 in most cases over UploadVerification.
1685 object $upload: an instance of UploadBase, with all info about the upload
1686 object $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1687 will typically only apply for specific mime types.
1688 object &$error: output: true if the file is valid. Otherwise, and indexed array
1689 representing the problem with the file, where the first element
1690 is the message key and the remaining elements are used as parameters to
1693 'UploadComplete': Upon completion of a file upload
1694 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1695 $uploadBase->getLocalFile().
1697 'User::mailPasswordInternal': before creation and mailing of a user's new
1699 $user: the user who sent the message out
1700 $ip: IP of the user who sent the message out
1701 $u: the account whose new password will be set
1703 'UserArrayFromResult': called when creating an UserArray object from a
1705 &$userArray: set this to an object to override the default object returned
1706 $res: database result used to create the object
1708 'userCan': To interrupt/advise the "user can do X to Y article" check.
1709 If you want to display an error message, try getUserPermissionsErrors.
1710 $title: Title object being checked against
1711 $user : Current user object
1712 $action: Action being checked
1713 $result: Pointer to result returned if hook returns false. If null is returned,
1714 userCan checks are continued by internal code.
1716 'UserCanSendEmail': To override User::canSendEmail() permission check
1717 $user: User (object) whose permission is being checked
1718 &$canSend: bool set on input, can override on output
1720 'UserClearNewTalkNotification': called when clearing the
1721 "You have new messages!" message, return false to not delete it
1722 $user: User (object) that'll clear the message
1724 'UserComparePasswords': called when checking passwords, return false to
1725 override the default password checks
1726 &$hash: String of the password hash (from the database)
1727 &$password: String of the plaintext password the user entered
1728 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1730 &$result: If the hook returns false, this Boolean value will be checked to
1731 determine if the password was valid
1733 'UserCreateForm': change to manipulate the login form
1734 $template: SimpleTemplate instance for the form
1736 'UserCryptPassword': called when hashing a password, return false to implement
1737 your own hashing method
1738 &$password: String of the plaintext password to encrypt
1739 &$salt: String of the password salt or Boolean false if no salt is provided
1740 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1742 &$hash: If the hook returns false, this String will be used as the hash
1744 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1745 $user: User to get groups for
1746 &$groups: Current effective groups
1748 'UserGetAllRights': after calculating a list of all available rights
1749 &$rights: Array of rights, which may be added to.
1751 'UserGetEmail': called when getting an user email address
1753 &$email: email, change this to override local email
1755 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1756 email authentification
1758 &$timestamp: timestamp, change this to override local email authentification
1761 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1762 &$groups: List of implicit (automatically-assigned) groups
1764 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1765 &$reservedUsernames: $wgReservedUsernames
1767 'UserGetRights': Called in User::getRights()
1768 $user: User to get rights for
1769 &$rights: Current rights
1771 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1773 $user: User in question
1774 $title: Title of the page in question
1775 &$blocked: Out-param, whether or not the user is blocked from that page.
1776 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1777 own user talk pages.
1779 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1781 $ip: User's IP address
1782 &$blocked: Whether the user is blocked, to be modified by the hook
1784 'UserLoadAfterLoadFromSession': called to authenticate users on
1785 external/environmental means; occurs after session is loaded
1786 $user: user object being loaded
1788 'UserLoadDefaults': called when loading a default user
1792 'UserLoadFromDatabase': called when loading a user from the database
1794 &$s: database query object
1796 'UserLoadFromSession': called to authenticate users on external/environmental
1797 means; occurs before session is loaded
1798 $user: user object being loaded
1799 &$result: set this to a boolean value to abort the normal authentification
1802 'UserLoadOptions': when user options/preferences are being loaded from
1805 &$options: Options, can be modified.
1807 'UserLoginComplete': after a user has logged in
1808 $user: the user object that was created on login
1809 $inject_html: Any HTML to inject after the "logged in" message.
1811 'UserLoginForm': change to manipulate the login form
1812 $template: SimpleTemplate instance for the form
1814 'UserLoginMailPassword': Block users from emailing passwords
1815 $name: the username to email the password of.
1816 &$error: out-param - the error message to return.
1818 'UserLogout': before a user logs out
1819 $user: the user object that is about to be logged out
1821 'UserLogoutComplete': after a user has logged out
1822 $user: the user object _after_ logout (won't have name, ID, etc.)
1823 $inject_html: Any HTML to inject after the "logged out" message.
1824 $oldName: name of the user before logout (string)
1826 'UserRights': After a user's group memberships are changed
1827 $user : User object that was changed
1828 $add : Array of strings corresponding to groups added
1829 $remove: Array of strings corresponding to groups removed
1831 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1833 $user: user retrieving new talks messages
1834 $talks: array of new talks page(s)
1836 'UserSaveSettings': called when saving user settings
1839 'UserSaveOptions': Called just before saving user preferences/options.
1841 &$options: Options, modifiable
1843 'UserSetCookies': called when setting user cookies
1845 &$session: session array, will be added to $_SESSION
1846 &$cookies: cookies array mapping cookie name to its value
1848 'UserSetEmail': called when changing user email address
1850 &$email: new email, change this to override new email address
1852 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1853 of email authentification
1855 &$timestamp: new timestamp, change this to override local email
1856 authentification timestamp
1858 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1859 alter the SQL query which gets the list of wanted pages
1860 &$wantedPages: WantedPagesPage object
1861 &$sql: raw SQL query used to get the list of wanted pages
1863 'WatchArticle': before a watch is added to an article
1864 $user: user that will watch
1865 $article: article object to be watched
1867 'WatchArticleComplete': after a watch is added to an article
1868 $user: user that watched
1869 $article: article object watched
1871 'WatchlistEditorBuildRemoveLine': when building remove lines in
1872 Special:Watchlist/edit
1873 &$tools: array of extra links
1874 $title: Title object
1875 $redirect: whether the page is a redirect
1878 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1880 One, and only one hook should set this, and return false.
1881 &$tables: Database tables to use in the SELECT query
1882 &$opts: Options to use for the query
1883 &$join: Join conditions
1885 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1886 query pages to be updated with maintenance/updateSpecialPages.php
1887 $query: $wgQueryPages itself
1889 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1890 metadata to be added.
1891 $obj: The XmlDumpWriter object.
1892 &$out: The output string.
1893 $row: The database row for the page.
1894 $title: The title of the page.
1896 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1898 $obj: The XmlDumpWriter object.
1899 &$out: The text being output.
1900 $row: The database row for the revision.
1901 $text: The revision text.
1903 More hooks might be available but undocumented, you can execute
1904 ./maintenance/findhooks.php to find hidden one.