3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252 default is LoginForm::ABORTED. Note that the client may be using
253 a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
256 'AbortMove': allows to abort moving an article (title)
259 $user: user who is doing the move
261 $reason: the reason for the move (added in 1.13)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: name of error message to display on abort
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273 allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
293 'AlternateEdit': before checking if an user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
296 $EditPage: the EditPage object
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or PHP's mail().
300 Return false to skip the regular method of sending mail. Return a
301 string to return a php-mail-error message containing the error.
302 Returning true will continue with sending email in the regular way.
303 $headers: Associative array of headers for the email
304 $to: MailAddress object or array
306 $subject: Subject of the email
307 $body: Body of the message
309 'APIAfterExecute': after calling the execute() method of an API module.
310 Use this to extend core API modules.
311 &$module: Module object
313 'APIEditBeforeSave': before saving a page with api.php?action=edit,
314 after processing request parameters. Return false to let the request
315 fail, returning an error message or an <edit result="Failure"> tag
316 if $resultArr was filled.
317 $EditPage : the EditPage object
318 $text : the new text of the article (has yet to be saved)
319 &$resultArr : data in this array will be added to the API result
321 'APIGetAllowedParams': use this hook to modify a module's parameters.
322 &$module: ApiBase Module object
323 &$params: Array of parameters
325 'APIGetDescription': use this hook to modify a module's description
326 &$module: ApiBase Module object
327 &$desc: Array of descriptions
329 'APIGetParamDescription': use this hook to modify a module's parameter
331 &$module: ApiBase Module object
332 &$desc: Array of parameter descriptions
334 'APIQueryAfterExecute': after calling the execute() method of an
335 action=query submodule. Use this to extend core API modules.
336 &$module: Module object
338 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
339 method of an action=query submodule. Use this to extend core API modules.
340 &$module: Module object
341 &$resultPageSet: ApiPageSet object
343 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
344 Every token has an action, which will be used in the intoken parameter
345 and in the output (actiontoken="..."), and a callback function which
346 should return the token, or false if the user isn't allowed to obtain
347 it. The prototype of the callback function is func($pageid, $title)
348 where $pageid is the page ID of the page the token is requested for
349 and $title is the associated Title object. In the hook, just add
350 your callback to the $tokenFunctions array and return true (returning
351 false makes no sense)
352 $tokenFunctions: array(action => callback)
354 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
355 Every token has an action, which will be used in the rvtoken parameter
356 and in the output (actiontoken="..."), and a callback function which
357 should return the token, or false if the user isn't allowed to obtain
358 it. The prototype of the callback function is func($pageid, $title, $rev)
359 where $pageid is the page ID of the page associated to the revision the
360 token is requested for, $title the associated Title object and $rev the
361 associated Revision 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 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
367 Every token has an action, which will be used in the rctoken parameter
368 and in the output (actiontoken="..."), and a callback function which
369 should return the token, or false if the user isn't allowed to obtain
370 it. The prototype of the callback function is func($pageid, $title, $rc)
371 where $pageid is the page ID of the page associated to the revision the
372 token is requested for, $title the associated Title object and $rc the
373 associated RecentChange object. In the hook, just add your callback to the
374 $tokenFunctions array and return true (returning false makes no sense)
375 $tokenFunctions: array(action => callback)
377 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
378 the sites general information.
379 $module: the current ApiQuerySiteInfo module
380 &$results: array of results, add things here
382 'APIQueryUsersTokens': use this hook to add custom token to list=users.
383 Every token has an action, which will be used in the ustoken parameter
384 and in the output (actiontoken="..."), and a callback function which
385 should return the token, or false if the user isn't allowed to obtain
386 it. The prototype of the callback function is func($user) where $user
387 is the User object. In the hook, just add your callback to the
388 $tokenFunctions array and return true (returning false makes no sense)
389 $tokenFunctions: array(action => callback)
391 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
392 Each service should have its own entry in the $apis array and have a
393 unique name, passed as key for the array that represents the service data.
394 In this data array, the key-value-pair identified by the apiLink key is
396 &$apis: array of services
398 'ArticleAfterFetchContent': after fetching content of an article from
400 $article: the article (object) being loaded from the database
401 $content: the content (string) of the article
403 'ArticleConfirmDelete': before writing the confirmation form for article
405 $article: the article (object) being deleted
406 $output: the OutputPage object ($wgOut)
407 &$reason: the reason (string) the article is being deleted
409 'ArticleContentOnDiff': before showing the article content below a diff.
410 Use this to change the content in this area or how it is loaded.
411 $diffEngine: the DifferenceEngine
412 $output: the OutputPage object ($wgOut)
414 'ArticleDelete': before an article is deleted
415 $article: the WikiPage (object) being deleted
416 $user: the user (object) deleting the article
417 $reason: the reason (string) the article is being deleted
418 $error: if the deletion was prohibited, the (raw HTML) error message to display
421 'ArticleDeleteComplete': after an article is deleted
422 $article: the WikiPage that was deleted
423 $user: the user that deleted the article
424 $reason: the reason the article was deleted
425 $id: id of the article that was deleted
427 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
429 $article: WikiPage (object) of the user talk page
431 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
432 article has been changed
433 $article: the WikiPage (object)
434 $editInfo: data holder that includes the parser output ($editInfo->output) for
435 that page after the change
436 $changed: bool for if the page was changed
438 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
439 recentchanges table, return false to not delete old entries
440 $article: WikiPage (object) being modified
442 'ArticleFromTitle': when creating an article object from a title object using
443 Wiki::articleFromTitle()
444 $title: title (object) used to create the article object
445 $article: article (object) that will be returned
447 'ArticleInsertComplete': After a new article is created
448 $article: WikiPage created
449 $user: User creating the article
451 $summary: Edit summary/comment
452 $isMinor: Whether or not the edit was marked as minor
453 $isWatch: (No longer used)
454 $section: (No longer used)
455 $flags: Flags passed to Article::doEdit()
456 $revision: New Revision of the article
458 'ArticleMergeComplete': after merging to article using Special:Mergehistory
459 $targetTitle: target title (object)
460 $destTitle: destination title (object)
462 'ArticlePageDataAfter': after loading data of an article from the database
463 $article: WikiPage (object) whose data were loaded
464 $row: row (object) returned from the database server
466 'ArticlePageDataBefore': before loading data of an article from the database
467 $article: WikiPage (object) that data will be loaded
468 $fields: fileds (array) to load from the database
470 'ArticlePrepareTextForEdit': called when preparing text to be saved
471 $article: the WikiPage being saved
472 $popts: parser options to be used for pre-save transformation
474 'ArticleProtect': before an article is protected
475 $article: the WikiPage being protected
476 $user: the user doing the protection
477 $protect: boolean whether this is a protect or an unprotect
478 $reason: Reason for protect
479 $moveonly: boolean whether this is for move only or not
481 'ArticleProtectComplete': after an article is protected
482 $article: the WikiPage that was protected
483 $user: the user who did the protection
484 $protect: boolean whether it was a protect or an unprotect
485 $reason: Reason for protect
486 $moveonly: boolean whether it was for move only or not
488 'ArticlePurge': before executing "&action=purge"
489 $article: WikiPage (object) to purge
491 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
492 revision of an article
493 &$title: title object of the article
495 'ArticleRevisionUndeleted': after an article revision is restored
496 $title: the article title
497 $revision: the revision
498 $oldPageID: the page ID of the revision when archived (may be null)
500 'ArticleRollbackComplete': after an article rollback is completed
501 $article: the WikiPage that was edited
502 $user: the user who did the rollback
503 $revision: the revision the page was reverted back to
504 $current: the reverted revision
506 'ArticleSave': before an article is saved
507 $article: the WikiPage (object) being saved
508 $user: the user (object) saving the article
509 $text: the new article text
510 $summary: the article summary (comment)
515 'ArticleSaveComplete': After an article has been updated
516 $article: WikiPage modified
517 $user: User performing the modification
519 $summary: Edit summary/comment
520 $isMinor: Whether or not the edit was marked as minor
521 $isWatch: (No longer used)
522 $section: (No longer used)
523 $flags: Flags passed to Article::doEdit()
524 $revision: New Revision of the article
525 $status: Status object about to be returned by doEdit()
526 $baseRevId: the rev ID (or false) this edit was based on
528 'ArticleUndelete': When one or more revisions of an article are restored
529 $title: Title corresponding to the article restored
530 $create: Whether or not the restoration caused the page to be created
531 (i.e. it didn't exist before)
532 $comment: The comment associated with the undeletion.
534 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
535 before the user is redirected back to the page
536 &$article: the article
537 &$sectionanchor: The section anchor link (e.g. "#overview" )
538 &$extraq: Extra query parameters which can be added via hooked functions
540 'ArticleViewFooter': After showing the footer section of an ordinary page view
541 $article: Article object
543 'ArticleViewHeader': Before the parser cache is about to be tried for article
545 &$article: the article
546 &$pcache: whether to try the parser cache or not
547 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
548 object to both indicate that the output is done and what parser output was used.
550 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
552 $article: target article (object)
554 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext
555 $text: text of the page
556 $title: title of the page
557 $output: reference to $wgOut
559 'AuthPluginAutoCreate': Called when creating a local account for an user logged
560 in from an external authentication method
561 $user: User object created locally
563 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
564 Gives a chance for an extension to set it programattically to a variable class.
565 &$auth: the $wgAuth object, probably a stub
567 'AutopromoteCondition': check autopromote condition for user.
568 $type: condition type
571 $result: result of checking autopromote condition
573 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
577 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
580 $title: title of the page to which backlinks are sought
581 &$conds: query conditions
583 'BadImage': When checking against the bad image list
584 $name: Image name being checked
585 &$bad: Whether or not the image is "bad"
587 Change $bad and return false to override. If an image is "bad", it is not
588 rendered inline in wiki pages or galleries in category pages.
590 'BeforeInitialize': before anything is initialized in performRequestForTitle()
591 &$title: Title being used for request
592 &$article: The associated Article object
593 &$output: OutputPage object
595 $request: WebRequest object
596 $mediaWiki: Mediawiki object
598 'BeforePageDisplay': Prior to outputting a page
599 &$out: OutputPage object
602 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
603 $parser: Parser object
605 &$options: array of options to RepoGroup::findFile
606 &$descQuery: query string to add to thumbnail URL
608 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
610 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
611 $parser: Parser object
612 $title: title of the template
613 &$skip: skip this template and link it?
614 &$id: the id of the revision being parsed
616 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
617 &$parser: Parser object
618 &$ig: ImageGallery object
620 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
621 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
622 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
624 'BitmapHandlerTransform': before a file is transformed, gives extension the
625 possibility to transform it themselves
626 $handler: BitmapHandler
628 &$scalerParams: Array with scaler parameters
629 &$mto: null, set to a MediaTransformOutput
631 'BitmapHandlerCheckImageArea': by BitmapHandler::normaliseParams, after all normalizations have been performed, except for the $wgMaxImageArea check
633 &$params: Array of parameters
634 &$checkImageAreaHookResult: null, set to true or false to override the $wgMaxImageArea check result
636 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
637 $block: Block object (which is set to be autoblocking)
638 &$blockIds: Array of block IDs of the autoblock
640 'BlockIp': before an IP address or user is blocked
641 $block: the Block object about to be saved
642 $user: the user _doing_ the block (not the one being blocked)
644 'BlockIpComplete': after an IP address or user is blocked
645 $block: the Block object that was saved
646 $user: the user who did the block (not the one being blocked)
648 'BookInformation': Before information output on Special:Booksources
649 $isbn: ISBN to show information for
650 $output: OutputPage object in use
652 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
653 &$namespaces: Array of namespace numbers with corresponding canonical names
655 'CategoryPageView': before viewing a categorypage in CategoryPage::view
656 $catpage: CategoryPage instance
658 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
659 &$changesList: ChangesList instance.
660 &$articlelink: HTML of link to article (already filled-in).
661 &$s: HTML of row that is being constructed.
662 &$rc: RecentChange instance.
663 $unpatrolled: Whether or not we are showing unpatrolled changes.
664 $watched: Whether or not the change is watched by the user.
666 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
667 $collationName: Name of the collation in question
668 &$collationObject: Null. Replace with a subclass of the Collation class that implements
669 the collation given in $collationName.
671 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
672 $user: user (object) whose email is being confirmed
674 'ContribsPager::getQueryInfo': Before the contributions query is about to run
675 &$pager: Pager object for contributions
676 &$queryInfo: The query for the contribs Pager
678 'ContributionsLineEnding': Called before a contributions HTML line is finished
679 $page: SpecialPage object for contributions
681 $row: the DB row for this line
683 'ContributionsToolLinks': Change tool links above Special:Contributions
685 $title: User page title
686 &$tools: Array of tool links
688 'CustomEditor': When invoking the page editor
689 $article: Article being edited
690 $user: User performing the edit
692 Return true to allow the normal editor to be used, or false
693 if implementing a custom editor, e.g. for a special namespace,
696 'DatabaseOraclePostInit': Called after initialising an Oracle database
697 &$db: the DatabaseOracle object
699 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
700 $text: plaintext string to be output
701 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
703 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
704 $title: the diff page title (nullable)
705 &$oldId: the actual old Id to use in the diff
706 &$newId: the actual new Id to use in the diff (0 means current)
707 $old: the ?old= param value from the url
708 $new: the ?new= param value from the url
710 'DiffViewHeader': called before diff display
711 $diff: DifferenceEngine object that's calling
712 $oldRev: Revision object of the "old" revision (may be null/invalid)
713 $newRev: Revision object of the "new" revision
715 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
717 $article: article (object) being viewed
718 $oldid: oldid (int) being viewed
720 'DoEditSectionLink': Override the HTML generated for section edit links
721 $skin: Skin object rendering the UI
722 $title: Title object for the title being linked to (may not be the same as
723 $wgTitle, if the section is included from a template)
724 $section: The designation of the section being pointed to, to be included in
725 the link, like "§ion=$section"
726 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
727 By default, this is wrapped in the 'editsectionhint' message.
728 &$result: The HTML to return, prefilled with the default plus whatever other
729 changes earlier hooks have made
730 $lang: The language code to use for the link in the wfMsg* functions
732 'EditFilter': Perform checks on an edit
733 $editor: Edit form (see includes/EditPage.php)
734 $text: Contents of the edit box
735 $section: Section being edited
736 &$error: Error message to return
737 $summary: Edit summary for page
739 'EditFilterMerged': Post-section-merge edit filter
740 $editor: EditPage instance (object)
741 $text: content of the edit box
742 &$error: error message to return
743 $summary: Edit summary for page
745 'EditFormPreloadText': Allows population of the edit form when creating
747 &$text: Text to preload with
748 &$title: Title object representing the page being created
750 'EditFormInitialText': Allows modifying the edit form when editing existing
752 $editPage: EditPage object
754 'EditPage::attemptSave': called before an article is
755 saved, that is before Article::doEdit() is called
756 $editpage_Obj: the current EditPage object
758 'EditPage::importFormData': allow extensions to read additional data
760 $editpage: EditPage instance
762 return value is ignored (should always return true)
764 'EditPage::showEditForm:fields': allows injection of form field into edit form
765 &$editor: the EditPage instance for reference
766 &$out: an OutputPage instance to write to
767 return value is ignored (should always return true)
769 'EditPage::showEditForm:initial': before showing the edit form
770 $editor: EditPage instance (object)
772 Return false to halt editing; you'll need to handle error messages, etc.
773 yourself. Alternatively, modifying $error and returning true will cause the
774 contents of $error to be echoed at the top of the edit form as wikitext.
775 Return true without altering $error to allow the edit to proceed.
777 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
778 when there's an edit conflict. Return false to halt normal diff output; in
779 this case you're responsible for computing and outputting the entire "conflict"
780 part, i.e., the "difference between revisions" and "your text" headers and
782 &$editor: EditPage instance
783 &$out: OutputPage instance
785 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
786 textarea in the edit form
787 &$editpage: The current EditPage object
788 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
789 &$tabindex: HTML tabindex of the last edit check/button
791 'EditPageBeforeEditChecks': allows modifying the edit checks below the
792 textarea in the edit form
793 &$editpage: The current EditPage object
794 &$checks: Array of edit checks like "watch this page"/"minor edit"
795 &$tabindex: HTML tabindex of the last edit check/button
797 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
798 textarea in the edit form
799 &$toolbar: The toolbar HTMl
801 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
802 $title: title of page being edited
803 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
805 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
807 $editPage: EditPage object
808 &$newtext: wikitext that will be used as "your version"
810 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
811 $editPage: EditPage object
812 &$toparse: wikitext that will be parsed
814 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
815 &$editpage: The current EditPage object
816 &$res: the HTML of the error text
818 'EditPageTosSummary': Give a chance for site and per-namespace customizations
819 of terms of service summary link that might exist separately from the copyright
821 $title: title of page being edited
822 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
824 'EditSectionLink': Do not use, use DoEditSectionLink instead.
825 $skin: Skin rendering the UI
826 $title: Title being linked to
827 $section: Section to link to
829 &$result: Result (alter this to override the generated links)
830 $lang: The language code to use for the link in the wfMsg* functions
832 'EmailConfirmed': When checking that the user's email address is "confirmed"
833 $user: User being checked
834 $confirmed: Whether or not the email address is confirmed
835 This runs before the other checks, such as anonymity and the real check; return
836 true to allow those checks to occur, and false if checking is done.
838 'EmailUser': before sending email from one user to another
839 $to: address of receiving user
840 $from: address of sending user
841 $subject: subject of the mail
842 $text: text of the mail
844 'EmailUserCC': before sending the copy of the email to the author
845 $to: address of receiving user
846 $from: address of sending user
847 $subject: subject of the mail
848 $text: text of the mail
850 'EmailUserComplete': after sending email from one user to another
851 $to: address of receiving user
852 $from: address of sending user
853 $subject: subject of the mail
854 $text: text of the mail
856 'EmailUserForm': after building the email user form object
857 $form: HTMLForm object
859 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
860 $user: The user who is trying to email another user.
861 $editToken: The user's edit token.
862 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
864 'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle
865 $ip: The ip address of the user
867 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
868 &$extTypes: associative array of extensions types
870 'FetchChangesList': When fetching the ChangesList derivative for
872 $user: User the list is being fetched for
873 &$skin: Skin object to be used with the list
874 &$list: List object (defaults to NULL, change it to an object
875 instance and return false override the list derivative used)
877 'FileDeleteComplete': When a file is deleted
878 $file: reference to the deleted file
879 $oldimage: in case of the deletion of an old image, the name of the old file
880 $article: in case all revisions of the file are deleted a reference to the
881 WikiFilePage associated with the file.
882 $user: user who performed the deletion
885 'FileUpload': When a file upload occurs
886 $file : Image object representing the file that was uploaded
887 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
888 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
890 'FileUndeleteComplete': When a file is undeleted
891 $title: title object to the file
892 $fileVersions: array of undeleted versions. Empty if all versions were restored
893 $user: user who performed the undeletion
896 'GetAutoPromoteGroups': When determining which autopromote groups a user
897 is entitled to be in.
898 &$user: user to promote.
899 &$promote: groups that will be added.
901 'GetBlockedStatus': after loading blocking status of an user from the database
902 $user: user (object) being checked
904 'GetCacheVaryCookies': get cookies that should vary cache options
905 $out: OutputPage object
906 &$cookies: array of cookies name, add a value to it if you want to add a cookie
907 that have to vary cache options
909 'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
910 $title: Title object of page
911 $url: string value as output (out parameter, can modify)
912 $query: query options passed to Title::getCanonicalURL()
913 $variant: variant passed to Title::getCanonicalURL()
915 'GetDefaultSortkey': Override the default sortkey for a page.
916 $title: Title object that we need to get a sortkey for
917 &$sortkey: Sortkey to use.
919 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
920 $title: Title object of page
921 $url: string value as output (out parameter, can modify)
922 $query: query options passed to Title::getFullURL()
923 $variant: variant passed to Title::getFullURL()
925 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
926 $title: Title object of page
927 $url: string value as output (out parameter, can modify)
928 $query: query options passed to Title::getInternalURL()
929 $variant: variant passed to Title::getFullURL()
931 'GetIP': modify the ip of the current user (called only once)
932 &$ip: string holding the ip as determined so far
934 'GetLinkColours': modify the CSS class of an array of page links
935 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
937 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
939 'GetLocalURL': modify local URLs as output into page links. Note that if you
940 are working with internal urls (non-interwiki) then it may be preferable
941 to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
942 GetLocalURL can be buggy for internal urls on render if you do not
943 re-implement the horrible hack that Title::getLocalURL uses
944 in your own extension.
945 $title: Title object of page
946 &$url: string value as output (out parameter, can modify)
947 $query: query options passed to Title::getLocalURL()
948 $variant: variant passed to Title::getLocalURL()
950 'GetLocalURL::Internal': modify local URLs to internal pages.
951 $title: Title object of page
952 &$url: string value as output (out parameter, can modify)
953 $query: query options passed to Title::getLocalURL()
954 $variant: variant passed to Title::getLocalURL()
956 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
957 without any fancy queries or variants.
958 $title: Title object of page
959 &$url: string value as output (out parameter, can modify)
961 'GetMetadataVersion': modify the image metadata version currently in use. This is
962 used when requesting image metadata from a ForiegnApiRepo. Media handlers
963 that need to have versioned metadata should add an element to the end of
964 the version array of the form 'handler_name=version'. Most media handlers
965 won't need to do this unless they broke backwards compatibility with a
966 previous version of the media handler metadata output.
967 &$version: Array of version strings
969 'GetPreferences': modify user preferences
970 $user: User whose preferences are being modified.
971 &$preferences: Preferences description array, to be fed to an HTMLForm object
973 'getUserPermissionsErrors': Add a permissions error when permissions errors are
974 checked for. Use instead of userCan for most cases. Return false if the
975 user can't do it, and populate $result with the reason in the form of
976 array( messagename, param1, param2, ... ). For consistency, error messages
977 should be plain text with no special coloring, bolding, etc. to show that
978 they're errors; presenting them properly to the user as errors is done by
980 $title: Title object being checked against
981 $user : Current user object
982 $action: Action being checked
983 $result: User permissions error to add. If none, return true.
985 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
986 if expensive checks are enabled.
988 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
989 image insertion. You can skip the default logic entirely by returning
990 false, or just modify a few things using call-by-reference.
992 &$title: Title object of the image
993 &$file: File object, or false if it doesn't exist
994 &$frameParams: Various parameters with special meanings; see documentation in
995 includes/Linker.php for Linker::makeImageLink2
996 &$handlerParams: Various parameters with special meanings; see documentation in
997 includes/Linker.php for Linker::makeImageLink2
998 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
999 &$res: Final HTML output, used if you return false
1002 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1003 the image on an image page
1004 $imagePage: ImagePage object ($this)
1007 'ImagePageAfterImageLinks': called after the image links section on an image
1009 $imagePage: ImagePage object ($this)
1010 &$html: HTML for the hook to add
1012 'ImagePageFileHistoryLine': called when a file history line is contructed
1014 $line: the HTML of the history line
1015 $css: the line CSS class
1017 'ImagePageFindFile': called when fetching the file associated with an image page
1018 $page: ImagePage object
1020 &$displayFile: displayed File object
1022 'ImagePageShowTOC': called when the file toc on an image page is generated
1023 $page: ImagePage object
1024 &$toc: Array of <li> strings
1026 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1028 &$title: the Title object of the file as it would appear for the upload page
1029 &$path: the original file and path name when img_auth was invoked by the the web
1031 &$name: the name only component of the file
1032 &$result: The location to pass back results of the hook routine (only used if
1034 $result[0]=The index of the header message
1035 $result[1]=The index of the body text message
1036 $result[2 through n]=Parameters passed to body text message. Please note the
1037 header message cannot receive/use parameters.
1039 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1040 $reader: XMLReader object
1041 $logInfo: Array of information
1042 Return false to stop further processing of the tag
1044 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1045 $reader: XMLReader object
1046 $pageInfo: Array of information
1047 Return false to stop further processing of the tag
1049 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1050 $reader: XMLReader object
1051 $revInfo: Array of information
1052 Return false to stop further processing of the tag
1054 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1055 $reader: XMLReader object
1056 Return false to stop further processing of the tag
1058 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1059 $reader: XMLReader object
1060 $revisionInfo: Array of information
1061 Return false to stop further processing of the tag
1063 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1064 $title: Title object ($wgTitle)
1065 $request: WebRequest
1066 $ignoreRedirect: boolean to skip redirect check
1067 $target: Title/string of redirect target
1068 $article: Article object
1070 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1071 Return true without providing an interwiki to continue interwiki search.
1072 $prefix: interwiki prefix we are looking for.
1073 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1074 iw_trans and optionally iw_api and iw_wikiid.
1076 'InternalParseBeforeLinks': during Parser's internalParse method before links
1077 but after noinclude/includeonly/onlyinclude and other processing.
1078 &$parser: Parser object
1079 &$text: string containing partially parsed text
1080 &$stripState: Parser's internal StripState object
1082 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1083 $user: user (object) whose email is being invalidated
1085 'IRCLineURL': When constructing the URL to use in an IRC notification.
1086 Callee may modify $url and $query, URL will be constructed as $url . $query
1087 &$url: URL to index.php
1088 &$query: Query string
1090 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1091 $article: article (object) being checked
1093 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1095 $result: Change this value to override the result of wfIsTrustedProxy()
1097 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1098 tance to return false if the domain name doesn't match your organization
1099 $addr: The e-mail address entered by the user
1100 &$result: Set this and return false to override the internal checks
1102 'isValidPassword': Override the result of User::isValidPassword()
1103 $password: The password entered by the user
1104 &$result: Set this and return false to override the internal checks
1105 $user: User the password is being validated for
1107 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1108 remove namespaces. Do not use this hook to add namespaces. Use
1109 CanonicalNamespaces for that.
1110 &$namespaces: Array of namespaces indexed by their numbers
1112 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1113 $wgExtensionMessagesFiles instead.
1114 Use this to define synonyms of magic words depending of the language
1115 $magicExtensions: associative array of magic words synonyms
1116 $lang: laguage code (string)
1118 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1119 listed in $wgExtensionMessagesFiles instead.
1120 Use to define aliases of special pages names depending of the language
1121 $specialPageAliases: associative array of magic words synonyms
1122 $lang: laguage code (string)
1124 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1125 &$names: array of language code => language name
1126 $code language of the preferred translations
1128 'LinkBegin': Used when generating internal and interwiki links in
1129 Linker::link(), before processing starts. Return false to skip default proces-
1130 sing and return $ret. See documentation for Linker::link() for details on the
1131 expected meanings of parameters.
1132 $skin: the Skin object
1133 $target: the Title that the link is pointing to
1134 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1136 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1137 tive array form, with keys and values unescaped. Should be merged with de-
1138 fault values, with a value of false meaning to suppress the attribute.
1139 &$query: the query string to add to the generated URL (the bit after the "?"),
1140 in associative array form, with keys and values unescaped.
1141 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1142 &$ret: the value to return if your hook returns false.
1144 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1145 just before the function returns a value. If you return true, an <a> element
1146 with HTML attributes $attribs and contents $html will be returned. If you re-
1147 turn false, $ret will be returned.
1148 $skin: the Skin object
1149 $target: the Title object that the link is pointing to
1150 $options: the options. Will always include either 'known' or 'broken', and may
1151 include 'noclasses'.
1152 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1153 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1155 &$ret: the value to return if your hook returns false.
1157 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1159 &$url: the image url
1160 &$alt: the image's alt text
1161 &$img: the new image HTML (if returning false)
1163 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1166 &$text: the link text
1167 &$link: the new link HTML (if returning false)
1168 &$attribs: the attributes to be applied.
1169 $linkType: The external link type
1171 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1173 &$linksUpdate: the LinksUpdate object
1175 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1177 &$linksUpdate: the LinksUpdate object
1179 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1180 &$linksUpdate: the LinksUpdate object
1182 'ListDefinedTags': When trying to find all defined tags.
1183 &$tags: The list of tags.
1185 'LoadExtensionSchemaUpdates': called during database installation and updates
1186 &updater: A DatabaseUpdater subclass
1188 'LocalFile::getHistory': called before file history query performed
1189 $file: the File object
1191 $fields: select fields
1193 $opts: query options
1194 $join_conds: JOIN conditions
1196 'LocalFilePurgeThumbnails': called before thumbnails for a local file a purged
1197 $file: the File object
1198 $archiveName: name of an old file version or false if it's the current one
1200 'LocalisationCacheRecache': Called when loading the localisation data into cache
1201 $cache: The LocalisationCache object
1202 $code: language code
1203 &$alldata: The localisation data from core and extensions
1205 'LogEventsListShowLogExtract': called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage
1206 &$s: html string to show for the log extract
1207 $types: String or Array Log types to show
1208 $page: String or Title The page title to show log entries for
1209 $user: String The user who made the log entries
1210 $param: Associative Array with the following additional options:
1211 - lim Integer Limit of items to show, default is 50
1212 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1213 - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
1214 - msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wgMsgExt and option 'parse'
1215 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset
1216 - wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
1217 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1219 'LoginAuthenticateAudit': a login attempt either succeeded or
1220 failed. This may be called before the User object is populated, so a
1221 user object equivalent to an anonymous user. No return data is
1222 accepted; this hook is for auditing only.
1223 $user: the User object being authenticated against
1224 $password: the password being submitted and found wanting
1225 $retval: a LoginForm class constant with authenticateUserData() return
1226 value (SUCCESS, WRONG_PASS, etc)
1228 'LogLine': Processes a single log entry on Special:Log
1229 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1230 logging.log_type database field.
1231 $log_action: string for the type of log action (e.g. 'delete', 'block',
1232 'create2'). Corresponds to logging.log_action database field.
1233 $title: Title object that corresponds to logging.log_namespace and
1234 logging.log_title database fields.
1235 $paramArray: Array of parameters that corresponds to logging.log_params field.
1236 Note that only $paramArray[0] appears to contain anything.
1237 &$comment: string that corresponds to logging.log_comment database field, and
1238 which is displayed in the UI.
1239 &$revert: string that is displayed in the UI, similar to $comment.
1240 $time: timestamp of the log entry (added in 1.12)
1242 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1243 $refreshLinks: RefreshLinks object
1245 'MagicWordMagicWords': When defining new magic word.
1246 DEPRECATED: use $magicWords in a file listed in
1247 $wgExtensionMessagesFiles instead.
1248 $magicWords: array of strings
1250 'MagicWordwgVariableIDs': When definig new magic words IDs.
1251 $variableIDs: array of strings
1253 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1254 is executed. Ideally, this hook should only be used to add variables that
1255 depend on the current page/request; static configuration should be added
1256 through ResourceLoaderGetConfigVars instead.
1257 &$vars: variable (or multiple variables) to be added into the output
1258 of Skin::makeVariablesScript
1259 $out: The OutputPage which called the hook,
1260 can be used to get the real title
1262 'MarkPatrolled': before an edit is marked patrolled
1263 $rcid: ID of the revision to be marked patrolled
1264 $user: the user (object) marking the revision as patrolled
1265 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1266 needs to be a sysop in order to mark an edit patrolled
1268 'MarkPatrolledComplete': after an edit is marked patrolled
1269 $rcid: ID of the revision marked as patrolled
1270 $user: user (object) who marked the edit patrolled
1271 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1272 must be a sysop to patrol the edit
1274 'MediaWikiPerformAction': Override MediaWiki::performAction().
1275 Use this to do something completely different, after the basic
1276 globals have been set up, but before ordinary actions take place.
1278 $article: $wgArticle
1281 $request: $wgRequest
1282 $mediaWiki: The $mediawiki object
1284 'MessagesPreLoad': When loading a message from the database
1285 $title: title of the message (string)
1286 $message: value (string), change it to the message you want to define
1288 'MessageCacheReplace': When a message page is changed.
1289 Useful for updating caches.
1290 $title: name of the page changed.
1291 $text: new contents of the page.
1293 'ModifyExportQuery': Modify the query used by the exporter.
1294 $db: The database object to be queried.
1295 &$tables: Tables in the query.
1296 &$conds: Conditions in the query.
1297 &$opts: Options for the query.
1298 &$join_conds: Join conditions for the query.
1300 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1301 been rendered (useful for adding more)
1302 Note: this is only run for the Monobook skin. This hook is deprecated and
1303 may be removed in the future. To add items to the toolbox you should use
1304 the SkinTemplateToolboxEnd hook instead, which works for all
1305 "SkinTemplate"-type skins.
1306 $tools: array of tools
1308 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1309 and returning it for the skin to output. You can add items to the toolbox while
1310 still letting the skin make final decisions on skin-specific markup conventions
1312 &$sk: The BaseTemplate base skin template
1313 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1314 BaseTemplate::makeListItem for details on the format of individual
1315 items inside of this array
1317 'NewRevisionFromEditComplete': called when a revision was inserted
1319 $article: the WikiPage edited
1320 $rev: the new revision
1321 $baseID: the revision ID this was based off, if any
1322 $user: the editing user
1324 'NormalizeMessageKey': Called before the software gets the text of a message
1325 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1327 &$key: the message being looked up. Change this to something else to change
1328 what message gets displayed (string)
1329 &$useDB: whether or not to look up the message in the database (bool)
1330 &$langCode: the language code to get the message for (string) - or -
1331 whether to use the content language (true) or site language (false) (bool)
1332 &$transform: whether or not to expand variables and templates
1333 in the message (bool)
1335 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1336 &$changeslist: The OldChangesList instance.
1337 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1338 &$rc: The RecentChange object.
1340 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1341 Hooks can alter or append to the array of URLs for search & suggestion formats.
1342 &$urls: array of associative arrays with Url element attributes
1344 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1345 users and/or IP addresses too
1346 $otherBlockLink: An array with links to other block logs
1347 $ip: The requested IP address or username
1349 'OutputPageBeforeHTML': a page has been processed by the parser and
1350 the resulting HTML is about to be displayed.
1351 $parserOutput: the parserOutput (object) that corresponds to the page
1352 $text: the text that will be displayed, in HTML (string)
1354 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1355 tag to allow for extensions to add attributes to the body of the page they might
1356 need. Or to allow building extensions to add body classes that aren't of high
1357 enough demand to be included in core.
1358 $out: The OutputPage which called the hook, can be used to get the real title
1359 $sk: The Skin that called OutputPage::headElement
1360 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1362 'OutputPageCheckLastModified': when checking if the page has been modified
1363 since the last visit
1364 &$modifiedTimes: array of timestamps.
1365 The following keys are set: page, user, epoch
1367 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1368 $out: OutputPage instance (object)
1369 $parserOutput: parserOutput instance being added in $out
1371 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1372 categories. Implementations should return false if they generate the category
1373 links, so the default link generation is skipped.
1374 $out: OutputPage instance (object)
1375 $categories: associative array, keys are category names, values are category
1376 types ("normal" or "hidden")
1377 $links: array, intended to hold the result. Must be an associative array with
1378 category types as keys and arrays of HTML links as values.
1380 'PageContentLanguage': allows changing the language in which the content of
1381 a page is written. Defaults to the wiki content language ($wgContLang).
1382 $title: Title object
1383 &$pageLang: the page content language (either an object or a language code)
1384 $wgLang: the user language
1386 'PageHistoryBeforeList': When a history page list is about to be constructed.
1387 $article: the article that the history is loading for
1389 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1390 $row: the revision row for this line
1391 $s: the string representing this parsed line
1392 $classes: array containing the <li> element classes
1394 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1397 $queryInfo: the query parameters
1399 'PageRenderingHash': alter the parser cache option hash key
1400 A parser extension which depends on user options should install
1401 this hook and append its values to the key.
1402 $hash: reference to a hash key string which can be modified
1404 'ParserAfterStrip': Same as ParserBeforeStrip
1406 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1407 $parser: Parser object being used
1408 $text: text that'll be returned
1410 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1411 $parser: Parser object
1412 $text: text to parse
1413 $stripState: StripState instance being used
1415 'ParserBeforeStrip': Called at start of parsing time
1416 (no more strip, deprecated ?)
1417 $parser: parser object
1418 $text: text being parsed
1419 $stripState: stripState used (object)
1421 'ParserBeforeTidy': called before tidy and custom tags replacements
1422 $parser: Parser object being used
1425 'ParserClearState': called at the end of Parser::clearState()
1426 $parser: Parser object being cleared
1428 'ParserFirstCallInit': called when the parser initialises for the first time
1429 &$parser: Parser object being cleared
1431 'ParserGetVariableValueSwitch': called when the parser need the value of a
1433 $parser: Parser object
1434 $varCache: array to store the value in case of multiples calls of the
1436 $index: index (string) of the magic
1437 $ret: value of the magic word (the hook should set it)
1438 $frame: PPFrame object to use for expanding any template variables
1440 'ParserGetVariableValueTs': use this to change the value of the time for the
1441 {{LOCAL...}} magic word
1442 $parser: Parser object
1443 $time: actual time (timestamp)
1445 'ParserGetVariableValueVarCache': use this to change the value of the
1446 variable cache or return false to not use it
1447 $parser: Parser object
1448 $varCache: varaiable cache (array)
1450 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1451 include comments about size of the text parsed
1452 $parser: Parser object
1453 $limitReport: text that will be included (without comment tags)
1455 'ParserMakeImageParams': Called before the parser make an image link, use this
1456 to modify the parameters of the image.
1457 $title: title object representing the file
1458 $file: file object that will be used to create the image
1459 &$params: 2-D array of parameters
1461 'ParserSectionCreate': Called each time the parser creates a document section
1462 from wikitext. Use this to apply per-section modifications to HTML (like
1463 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1464 can begin in one section and end in another. Make sure your code can handle
1465 that case gracefully. See the EditSectionClearerLink extension for an
1467 $parser: the calling Parser instance
1468 $section: the section number, zero-based, but section 0 is usually empty
1469 &$sectionContent: ref to the content of the section. modify this.
1470 $showEditLinks: boolean describing whether this section has an edit link
1472 'ParserTestParser': called when creating a new instance of Parser in
1473 maintenance/parserTests.inc
1474 $parser: Parser object created
1476 'ParserTestTables': alter the list of tables to duplicate when parser tests
1477 are run. Use when page save hooks require the presence of custom tables
1478 to ensure that tests continue to run properly.
1479 &$tables: array of table names
1481 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1482 my talk page, my contributions" etc).
1483 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1484 &$title: Title object representing the current page
1486 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1487 &$user : User performing the action
1488 $action : Action being performed
1489 &$result : Whether or not the action should be prevented
1490 Change $result and return false to give a definitive answer, otherwise
1491 the built-in rate limiting checks are used, if enabled.
1493 'PlaceNewSection': Override placement of new sections.
1494 $wikipage : WikiPage object
1495 $oldtext : the text of the article before editing
1496 $subject : subject of the new section
1497 &$text : text of the new section
1498 Return false and put the merged text into $text to override the default behavior.
1500 'PreferencesGetLegend': Override the text used for the <legend> of a preferences section
1501 $form: the PreferencesForm object. This is a ContextSource as well
1502 $key: the section name
1503 &$legend: the legend text. Defaults to wfMsg( "prefs-$key" ) but may be overridden
1505 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1506 AJAX search suggestions. Put results into &$results outparam and return false.
1507 $ns : array of int namespace keys to search in
1508 $search : search term (not guaranteed to be conveniently normalized)
1509 $limit : maximum number of results to return
1510 &$results : out param: array of page names (strings)
1512 'PrefsEmailAudit': called when user changes his email address
1513 $user: User (object) changing his email address
1514 $oldaddr: old email address (string)
1515 $newaddr: new email address (string)
1517 'PrefsPasswordAudit': called when user changes his password
1518 $user: User (object) changing his passoword
1519 $newPass: new password
1520 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1522 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1523 $article: the title being (un)protected
1524 $output: a string of the form HTML so far
1526 'ProtectionForm::save': called when a protection form is submitted
1527 $article: the title being (un)protected
1528 $errorMsg: an html message string of an error or an array of message name and its parameters
1530 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1531 $article: the page the form is shown for
1532 $out: OutputPage object
1534 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1535 &$obj: RawPage object
1536 &$text: The text that's going to be the output
1538 'RecentChange_save': called at the end of RecentChange::save()
1539 $recentChange: RecentChange object
1541 'ResourceLoaderGetConfigVars': called at the end of
1542 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1543 configuration variables to JavaScript. Things that depend on the current
1544 page/request state must be added through MakeGlobalVariablesScript instead.
1545 &$vars: array( variable name => value )
1547 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1548 to add modules to the startup module. This hook should be used sparingly since any module added here
1549 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1552 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1553 loader request or generating HTML output.
1554 &$resourceLoader: ResourceLoader object
1556 'RevisionInsertComplete': called after a revision is inserted into the DB
1557 &$revision: the Revision
1558 $data: the data stored in old_text. The meaning depends on $flags: if external
1559 is set, it's the URL of the revision text in external storage; otherwise,
1560 it's the revision text itself. In either case, if gzip is set, the revision
1562 $flags: a comma-delimited list of strings representing the options used. May
1563 include: utf8 (this will always be set for new revisions); gzip; external.
1565 'SearchUpdate': Prior to search update completion
1567 $namespace : Page namespace
1569 $text : Current text being indexed
1571 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1572 $allSearchTerms : Array of the search terms in all content languages
1573 &$titleResult : Outparam; the value to return. A Title object or null.
1575 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1576 $term : Search term string
1577 &$title : Outparam; set to $title object and return false for a match
1579 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1580 $term : Search term string
1581 &$title : Current Title object that is being returned (null if none found).
1583 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1584 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1585 in the $searchEngine->namespaces array.
1586 $query : Original query.
1587 &$parsed : Resultant query with the prefixes stripped.
1589 'SearchableNamespaces': An option to modify which namespaces are searchable.
1590 &$arr : Array of namespaces ($nsId => $name) which will be used.
1592 'SetupAfterCache': Called in Setup.php, after cache objects are set
1594 'ShowMissingArticle': Called when generating the output for a non-existent page
1595 $article: The article object corresponding to the page
1597 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1598 $text: Text being shown
1599 $title: Title of the custom script/stylesheet page
1600 $output: Current OutputPage object
1602 'ShowSearchHitTitle': Customise display of search hit title/link.
1603 &$title: Title to link to
1604 &$text: Text to use for the link
1605 $result: The search result
1606 $terms: The search terms entered
1607 $page: The SpecialSearch object.
1609 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1610 &$siteNotice: HTML returned as the sitenotice
1612 Return true to allow the normal method of notice selection/rendering to work,
1613 or change the value of $siteNotice and return false to alter it.
1615 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1616 &$siteNotice: HTML sitenotice
1618 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1620 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1622 &$text: bottomScripts Text
1623 Append to $text to add additional text/scripts after the stock bottom scripts.
1625 'SkinAfterContent': Allows extensions to add text after the page content and
1627 &$data: (string) Text to be printed out directly (without parsing)
1629 This hook should work in all skins. Just set the &$data variable to the text
1630 you're going to add.
1632 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1634 &$bar: Sidebar contents
1635 Modify $bar to add or modify sidebar portlets.
1637 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1638 $title: displayed page title
1639 $type: 'normal' or 'history' for old/diff views
1640 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1641 &$link: overridable HTML link to be passed into the message as $1
1642 &$forContent: overridable flag if copyright footer is shown in content language.
1645 &$text: additional 'powered by' icons in HTML.
1646 Note: Modern skin does not use the MediaWiki icon but plain text instead
1649 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1650 &$subpages: Subpage links HTML
1652 $out: OutputPage object
1653 If false is returned $subpages will be used instead of the HTML
1654 subPageSubtitle() generates.
1655 If true is returned, $subpages will be ignored and the rest of
1656 subPageSubtitle() will run.
1658 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1659 "permanent link" tab
1660 $sktemplate: SkinTemplate object
1661 $nav_urls: array of tabs
1663 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1664 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1665 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1666 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1667 &$sktemplate: SkinTemplate object
1668 &$links: Structured navigation links
1669 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1671 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1673 &$sktemplate: SkinTemplate object
1674 &$tpl: Template engine object
1676 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1677 $sktemplate: SkinTemplate object
1678 $res: set to true to prevent active tabs
1680 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1681 You can either create your own array, or alter the parameters for
1683 &$sktemplate: The SkinTemplate instance.
1684 $title: Title instance for the page.
1685 $message: Visible label of tab.
1686 $selected: Whether this is a selected tab.
1687 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1688 &$classes: Array of CSS classes to apply.
1689 &$query: Query string to add to link.
1691 &$result: Complete assoc. array if you want to return true.
1693 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1694 been rendered (useful for adding more)
1695 $sk: The QuickTemplate based skin template running the hook.
1696 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
1697 extensions that add support for BaseTemplateToolbox should watch for this dummy
1698 parameter with "$dummy=false" in their code and return without echoing any html
1699 to avoid creating duplicate toolbox items.
1701 'SoftwareInfo': Called by Special:Version for returning information about
1703 $software: The array of software in format 'name' => 'version'.
1704 See SpecialVersion::softwareInformation()
1706 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1707 $id: User identifier
1709 'SpecialListusersDefaultQuery': called right before the end of
1710 UsersPager::getDefaultQuery()
1711 $pager: The UsersPager instance
1712 $query: The query array to be returned
1714 'SpecialListusersFormatRow': called right before the end of
1715 UsersPager::formatRow()
1716 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1717 $row: Database row object
1719 'SpecialListusersHeader': called before closing the <fieldset> in
1720 UsersPager::getPageHeader()
1721 $pager: The UsersPager instance
1722 $out: The header HTML
1724 'SpecialListusersHeaderForm': called before adding the submit button in
1725 UsersPager::getPageHeader()
1726 $pager: The UsersPager instance
1727 $out: The header HTML
1729 'SpecialListusersQueryInfo': called right before the end of
1730 UsersPager::getQueryInfo()
1731 $pager: The UsersPager instance
1732 $query: The query array to be returned
1734 'SpecialMovepageAfterMove': called after moving a page
1735 $movePage: MovePageForm object
1736 $oldTitle: old title (object)
1737 $newTitle: new title (object)
1739 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1740 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1741 $opts: FormOptions object containing special page options
1742 &$conds: array of WHERE conditionals for query
1743 &tables: array of tables to be queried
1744 &$fields: array of columns to select
1745 &$join_conds: join conditions for the tables
1747 'SpecialNewPagesFilters': called after building form options at NewPages
1748 $special: the special page object
1749 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1750 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1752 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1753 hook to remove a core special page
1754 $list: list (array) of core special pages
1756 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1757 $users: array of User objects
1758 $data: array of data submitted by the user
1759 &$error: string, error code (message name) used to describe to error (out paramater).
1760 The hook needs to return false when setting this, otherwise it will have no effect.
1762 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1763 use this to change some selection criteria or substitute a different title
1764 &$randstr: The random number from wfRandom()
1765 &$isRedir: Boolean, whether to select a redirect or non-redirect
1766 &$namespaces: An array of namespace indexes to get the title from
1767 &$extra: An array of extra SQL statements
1768 &$title: If the hook returns false, a Title object to use instead of the
1769 result from the normal query
1771 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1772 $special: the special page object
1773 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1774 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1776 'SpecialRecentChangesPanel': called when building form options in
1777 SpecialRecentChanges
1778 &$extraOpts: array of added items, to which can be added
1779 $opts: FormOptions for this request
1781 'SpecialRecentChangesQuery': called when building sql query for
1782 SpecialRecentChanges and SpecialRecentChangesLinked
1783 &$conds: array of WHERE conditionals for query
1784 &$tables: array of tables to be queried
1785 &$join_conds: join conditions for the tables
1786 $opts: FormOptions for this request
1787 &$query_options: array of options for the database request
1788 &$select: Array of columns to select
1790 'SpecialSearchCreateLink': called when making the message to create a page or
1791 go to the existing page
1792 $t: title object searched for
1793 &$params: an array of the default message name and page title (as parameter)
1795 'SpecialSearchGo': called when user clicked the "Go"
1796 &$title: title object generated from the text entered by the user
1797 &$term: the search term entered by the user
1799 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1800 target doesn't exist
1801 &$title: title object generated from the text entered by the user
1803 'SpecialSearchPowerBox': the equivalent of SpecialSearchProfileForm for
1804 the advanced form, a.k.a. power search box
1805 &$showSections: an array to add values with more options to
1806 $term: the search term (not a title object)
1807 $opts: an array of hidden options (containing 'redirs' and 'profile')
1809 'SpecialSearchProfiles': allows modification of search profiles
1810 &$profiles: profiles, which can be modified.
1812 'SpecialSearchProfileForm': allows modification of search profile forms
1813 $search: special page object
1814 &$form: String: form html
1815 $profile: String: current search profile
1816 $term: String: search term
1817 $opts: Array: key => value of hidden options for inclusion in custom forms
1819 'SpecialSearchSetupEngine': allows passing custom data to search engine
1820 $search: special page object
1821 $profile: String: current search profile
1822 $engine: the search engine
1824 'SpecialSearchResults': called before search result display when there
1826 $term: string of search term
1827 &$titleMatches: empty or SearchResultSet object
1828 &$textMatches: empty or SearchResultSet object
1830 'SpecialSearchNoResults': called before search result display when there are
1832 $term: string of search term
1834 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1835 &$extraStats: Array to save the new stats
1836 ( $extraStats['<name of statistic>'] => <value>; )
1838 'SpecialUploadComplete': Called after successfully uploading a file from
1840 $form: The SpecialUpload object
1842 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1843 use this to change the tables headers
1844 $extTypes: associative array of extensions types
1846 'SpecialWatchlistFilters': called after building form options at Watchlist
1847 $special: the special page object
1848 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1849 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1851 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1852 &$conds: array of WHERE conditionals for query
1853 &$tables: array of tables to be queried
1854 &$join_conds: join conditions for the tables
1855 &$fields: array of query fields
1857 'TestCanonicalRedirect': called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. Gives a chance for extensions that alter page view behavior radically to abort that redirect or handle it manually.
1858 $request: WebRequest
1859 $title: Title of the currently found title obj
1860 $output: OutputPage object
1862 'TitleArrayFromResult': called when creating an TitleArray object from a
1864 &$titleArray: set this to an object to override the default object returned
1865 $res: database result used to create the object
1867 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1868 that can be applied.
1869 $title: The title in question.
1870 &$types: The types of protection available.
1872 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1873 $title: Title object that is being checked
1874 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
1876 'TitleIsMovable': Called when determining if it is possible to move a page.
1877 Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
1878 $title: Title object that is being checked
1879 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
1881 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
1882 be handled by seperate handler (via ArticleViewCustom)
1883 $title: Title object that is being checked
1884 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
1886 'TitleMoveComplete': after moving an article (title)
1889 $user: user who did the move
1890 $pageid: database ID of the page that's been moved
1891 $redirid: database ID of the created redirect
1893 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1894 PageArchive object has been created but before any further processing is done.
1895 &$archive: PageArchive object
1896 $title: Title object of the page that we're viewing
1898 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1899 PageArchive object has been created but before any further processing is done.
1900 &$archive: PageArchive object
1901 $title: Title object of the page that we're viewing
1903 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1904 the site is not in read-only mode, that the Title object is not null and after
1905 a PageArchive object has been constructed but before performing any further
1907 &$archive: PageArchive object
1908 $title: Title object of the page that we're about to undelete
1910 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1911 $title: title object related to the revision
1912 $rev: revision (object) that will be viewed
1914 'UnknownAction': An unknown "action" has occured (useful for defining
1916 $action: action name
1917 $article: article "acted on"
1919 'UnitTestsList': Called when building a list of files with PHPUnit tests
1920 &$files: list of files
1922 'UnwatchArticle': before a watch is removed from an article
1923 $user: user watching
1924 $article: article object to be removed
1926 'UnwatchArticle': after a watch is removed from an article
1927 $user: user that was watching
1928 $article: article object removed
1930 'UnwatchArticleComplete': after a watch is removed from an article
1931 $user: user that watched
1932 $article: article object that was watched
1934 'UploadForm:initial': before the upload form is generated
1935 $form: UploadForm object
1936 You might set the member-variables $uploadFormTextTop and
1937 $uploadFormTextAfterSummary to inject text (HTML) either before
1938 or after the editform.
1940 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1941 $form: UploadForm object
1942 Lets you poke at member variables like $mUploadDescription before the
1944 Do not use this hook to break upload processing. This will return the user to
1945 a blank form with no error message; use UploadVerification and
1946 UploadVerifyFile instead
1948 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1949 $type: (string) the requested upload type
1950 &$className: the class name of the Upload instance to be created
1952 'UploadComplete': when Upload completes an upload
1953 &$upload: an UploadBase child instance
1955 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1957 $descriptor: (array) the HTMLForm descriptor
1959 'UploadFormSourceDescriptors': after the standard source inputs have been
1960 added to the descriptor
1961 $descriptor: (array) the HTMLForm descriptor
1963 'UploadVerification': additional chances to reject an uploaded file. Consider
1964 using UploadVerifyFile instead.
1965 string $saveName: destination file name
1966 string $tempName: filesystem path to the temporary file for checks
1967 string &$error: output: message key for message to show if upload canceled
1968 by returning false. May also be an array, where the first element
1969 is the message key and the remaining elements are used as parameters to
1972 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1973 in most cases over UploadVerification.
1974 object $upload: an instance of UploadBase, with all info about the upload
1975 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1976 will typically only apply for specific mime types.
1977 object &$error: output: true if the file is valid. Otherwise, an indexed array
1978 representing the problem with the file, where the first element
1979 is the message key and the remaining elements are used as parameters to
1982 'UploadComplete': Upon completion of a file upload
1983 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1984 $uploadBase->getLocalFile().
1986 'User::mailPasswordInternal': before creation and mailing of a user's new
1988 $user: the user who sent the message out
1989 $ip: IP of the user who sent the message out
1990 $u: the account whose new password will be set
1992 'UserAddGroup': called when adding a group; return false to override
1993 stock group addition.
1994 $user: the user object that is to have a group added
1995 &$group: the group to add, can be modified
1997 'UserArrayFromResult': called when creating an UserArray object from a
1999 &$userArray: set this to an object to override the default object returned
2000 $res: database result used to create the object
2002 'userCan': To interrupt/advise the "user can do X to Y article" check.
2003 If you want to display an error message, try getUserPermissionsErrors.
2004 $title: Title object being checked against
2005 $user : Current user object
2006 $action: Action being checked
2007 $result: Pointer to result returned if hook returns false. If null is returned,
2008 userCan checks are continued by internal code.
2010 'UserCanSendEmail': To override User::canSendEmail() permission check
2011 $user: User (object) whose permission is being checked
2012 &$canSend: bool set on input, can override on output
2014 'UserClearNewTalkNotification': called when clearing the
2015 "You have new messages!" message, return false to not delete it
2016 $user: User (object) that'll clear the message
2018 'UserComparePasswords': called when checking passwords, return false to
2019 override the default password checks
2020 &$hash: String of the password hash (from the database)
2021 &$password: String of the plaintext password the user entered
2022 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2024 &$result: If the hook returns false, this Boolean value will be checked to
2025 determine if the password was valid
2027 'UserCreateForm': change to manipulate the login form
2028 $template: SimpleTemplate instance for the form
2030 'UserCryptPassword': called when hashing a password, return false to implement
2031 your own hashing method
2032 &$password: String of the plaintext password to encrypt
2033 &$salt: String of the password salt or Boolean false if no salt is provided
2034 &$wgPasswordSalt: Boolean of whether the salt is used in the default
2036 &$hash: If the hook returns false, this String will be used as the hash
2038 'UserDisplayName': Called in User::getDisplayName()
2039 $user: The user object to fetch the display name for
2040 &$displayName: The display name. Will be null. Set to a name to override default name.
2042 'UserEffectiveGroups': Called in User::getEffectiveGroups()
2043 $user: User to get groups for
2044 &$groups: Current effective groups
2046 'UserGetAllRights': after calculating a list of all available rights
2047 &$rights: Array of rights, which may be added to.
2049 'UserGetDefaultOptions': after fetching the core default, this hook is ran
2050 right before returning the options to the caller. WARNING: this hook is
2051 called for every call to User::getDefaultOptions(), which means it's
2052 potentially called dozens or hundreds of times. You may want to cache
2053 the results of non-trivial operations in your hook function for this reason.
2054 &$defaultOptions: Array of preference keys and their default values.
2056 'UserGetEmail': called when getting an user email address
2058 &$email: email, change this to override local email
2060 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
2061 email authentification
2063 &$timestamp: timestamp, change this to override local email authentification
2066 'UserGetImplicitGroups': Called in User::getImplicitGroups()
2067 &$groups: List of implicit (automatically-assigned) groups
2069 'UserGetLanguageObject': Called when getting user's interface language object
2071 &$code: Langauge code that will be used to create the object
2073 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2074 &$reservedUsernames: $wgReservedUsernames
2076 'UserGetRights': Called in User::getRights()
2077 $user: User to get rights for
2078 &$rights: Current rights
2079 $namespace: Namespace to get permissions for; if null all namespaces
2081 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
2083 $user: User in question
2084 $title: Title of the page in question
2085 &$blocked: Out-param, whether or not the user is blocked from that page.
2086 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2087 own user talk pages.
2089 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2091 $ip: User's IP address
2092 &$blocked: Whether the user is blocked, to be modified by the hook
2094 'UserLoadAfterLoadFromSession': called to authenticate users on
2095 external/environmental means; occurs after session is loaded
2096 $user: user object being loaded
2098 'UserLoadDefaults': called when loading a default user
2102 'UserLoadFromDatabase': called when loading a user from the database
2104 &$s: database query object
2106 'UserLoadFromSession': called to authenticate users on external/environmental
2107 means; occurs before session is loaded
2108 $user: user object being loaded
2109 &$result: set this to a boolean value to abort the normal authentification
2112 'UserLoadOptions': when user options/preferences are being loaded from
2115 &$options: Options, can be modified.
2117 'UserLoginComplete': after a user has logged in
2118 $user: the user object that was created on login
2119 $inject_html: Any HTML to inject after the "logged in" message.
2121 'UserLoginForm': change to manipulate the login form
2122 $template: SimpleTemplate instance for the form
2124 'UserLogout': before a user logs out
2125 $user: the user object that is about to be logged out
2127 'UserLogoutComplete': after a user has logged out
2128 $user: the user object _after_ logout (won't have name, ID, etc.)
2129 $inject_html: Any HTML to inject after the "logged out" message.
2130 $oldName: name of the user before logout (string)
2132 'UserRemoveGroup': called when removing a group; return false to override
2133 stock group removal.
2134 $user: the user object that is to have a group removed
2135 &$group: the group to be removed, can be modified
2137 'UserRights': After a user's group memberships are changed
2138 $user : User object that was changed
2139 $add : Array of strings corresponding to groups added
2140 $remove: Array of strings corresponding to groups removed
2142 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2144 $user: user retrieving new talks messages
2145 $talks: array of new talks page(s)
2147 'UserSaveSettings': called when saving user settings
2150 'UserSaveOptions': Called just before saving user preferences/options.
2152 &$options: Options, modifiable
2154 'UserSetCookies': called when setting user cookies
2156 &$session: session array, will be added to $_SESSION
2157 &$cookies: cookies array mapping cookie name to its value
2159 'UserSetEmail': called when changing user email address
2161 &$email: new email, change this to override new email address
2163 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2164 of email authentification
2166 &$timestamp: new timestamp, change this to override local email
2167 authentification timestamp
2169 'UserToolLinksEdit': Called when generating a list of user tool links, eg "Foobar (Talk | Contribs | Block)"
2170 $userId: User id of the current user
2171 $userText: User name of the current user
2172 &$items: Array of user tool links as HTML fragments
2174 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2175 used to alter the SQL query which gets the list of wanted pages
2176 &$wantedPages: WantedPagesPage object
2177 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2179 'WatchArticle': before a watch is added to an article
2180 $user: user that will watch
2181 $article: article object to be watched
2183 'WatchArticleComplete': after a watch is added to an article
2184 $user: user that watched
2185 $article: article object watched
2187 'WatchlistEditorBuildRemoveLine': when building remove lines in
2188 Special:Watchlist/edit
2189 &$tools: array of extra links
2190 $title: Title object
2191 $redirect: whether the page is a redirect
2194 'WebRequestPathInfoRouter': While building the PathRouter to parse the REQUEST_URI.
2195 $router: The PathRouter instance
2197 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2199 One, and only one hook should set this, and return false.
2200 &$tables: Database tables to use in the SELECT query
2201 &$opts: Options to use for the query
2202 &$join: Join conditions
2204 'wfShellMaintenanceCmd': Called when generating a shell-escaped command line
2205 string to run a maintenance script.
2206 &$script: MediaWiki maintenance script path
2207 &$parameters: Array of arguments and options to the script
2208 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2211 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2212 query pages to be updated with maintenance/updateSpecialPages.php
2213 $query: $wgQueryPages itself
2215 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2216 metadata to be added.
2217 $obj: The XmlDumpWriter object.
2218 &$out: The output string.
2219 $row: The database row for the page.
2220 $title: The title of the page.
2222 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2224 $obj: The XmlDumpWriter object.
2225 &$out: The text being output.
2226 $row: The database row for the revision.
2227 $text: The revision text.
2229 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2230 additional tags to extract.
2231 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2233 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2234 used to post-process the results.
2235 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2236 metadata tags returned (each tag is either a value, or an array of values).
2238 More hooks might be available but undocumented, you can execute
2239 ./maintenance/findhooks.php to find hidden one.