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 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
249 $editor: The User who made the change.
250 $title: The Title of the page that was edited.
252 'AbortLogin': Return false to cancel account login.
253 $user: the User object being authenticated against
254 $password: the password being submitted, not yet checked for validity
255 &$retval: a LoginForm class constant to return from authenticateUserData();
256 default is LoginForm::ABORTED. Note that the client may be using
257 a machine API rather than the HTML user interface.
258 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
260 'AbortMove': allows to abort moving an article (title)
263 $user: user who is doing the move
265 $reason: the reason for the move (added in 1.13)
267 'AbortNewAccount': Return false to cancel explicit account creation.
268 $user: the User object about to be created (read-only, incomplete)
269 &$msg: out parameter: HTML to display on abort
271 'ActionBeforeFormDisplay': before executing the HTMLForm object
272 $name: name of the action
273 &$form: HTMLForm object
274 $article: Article object
276 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
277 allows to change the fields on the form that will be generated
278 $name: name of the action
279 &$fields: HTMLForm descriptor array
280 $article: Article object
282 'AddNewAccount': after a user account is created
283 $user: the User object that was created. (Parameter added in 1.7)
284 $byEmail: true when account was created "by email" (added in 1.12)
286 'AfterFinalPageOutput': At the end of OutputPage::output() but before
287 final ob_end_flush() which will send the buffered output to the client.
288 This allows for last-minute modification of the output within the buffer
289 by using ob_get_clean().
291 'AfterImportPage': When a page import is completed
292 $title: Title under which the revisions were imported
293 $origTitle: Title provided by the XML file
294 $revCount: Number of revisions in the XML file
295 $sRevCount: Number of sucessfully imported revisions
296 $pageInfo: associative array of page information
298 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
299 before OutputPage::sendCacheControl() and final ob_end_flush() which
300 will send the buffered output to the client. This allows for last-minute
301 modification of the output within the buffer by using ob_get_clean().
302 $output: The OutputPage object where output() was called
304 'AjaxAddScript': Called in output page just before the initialisation
305 of the javascript ajax engine. The hook is only called when ajax
306 is enabled ( $wgUseAjax = true; ).
308 'AlternateEdit': before checking if a user can edit a page and
309 before showing the edit form ( EditPage::edit() ). This is triggered
311 $EditPage: the EditPage object
313 'AlternateUserMailer': Called before mail is sent so that mail could
314 be logged (or something else) instead of using PEAR or PHP's mail().
315 Return false to skip the regular method of sending mail. Return a
316 string to return a php-mail-error message containing the error.
317 Returning true will continue with sending email in the regular way.
318 $headers: Associative array of headers for the email
319 $to: MailAddress object or array
321 $subject: Subject of the email
322 $body: Body of the message
324 'APIAfterExecute': after calling the execute() method of an API module.
325 Use this to extend core API modules.
326 &$module: Module object
328 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to
329 further authenticate and authorize API clients before executing the
330 module. Return false and set a message to cancel the request.
331 $module: Module object
333 &$message: API usage message to die with, as a message key or array
334 as accepted by ApiBase::dieUsageMsg.
336 'APIEditBeforeSave': before saving a page with api.php?action=edit,
337 after processing request parameters. Return false to let the request
338 fail, returning an error message or an <edit result="Failure"> tag
339 if $resultArr was filled.
340 $EditPage : the EditPage object
341 $text : the new text of the article (has yet to be saved)
342 &$resultArr : data in this array will be added to the API result
344 'APIGetAllowedParams': use this hook to modify a module's parameters.
345 &$module: ApiBase Module object
346 &$params: Array of parameters
348 'APIGetDescription': use this hook to modify a module's description
349 &$module: ApiBase Module object
350 &$desc: Array of descriptions
352 'APIGetParamDescription': use this hook to modify a module's parameter
354 &$module: ApiBase Module object
355 &$desc: Array of parameter descriptions
357 'APIGetResultProperties': use this hook to mofify the properties
358 in a module's result.
359 &$module: ApiBase Module object
360 &$properties: Array of properties
362 'APIQueryAfterExecute': after calling the execute() method of an
363 action=query submodule. Use this to extend core API modules.
364 &$module: Module object
366 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
367 method of an action=query submodule. Use this to extend core API modules.
368 &$module: Module object
369 &$resultPageSet: ApiPageSet object
371 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
372 Every token has an action, which will be used in the intoken parameter
373 and in the output (actiontoken="..."), and a callback function which
374 should return the token, or false if the user isn't allowed to obtain
375 it. The prototype of the callback function is func($pageid, $title)
376 where $pageid is the page ID of the page the token is requested for
377 and $title is the associated Title object. In the hook, just add
378 your callback to the $tokenFunctions array and return true (returning
379 false makes no sense)
380 $tokenFunctions: array(action => callback)
382 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
383 Every token has an action, which will be used in the rvtoken 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($pageid, $title, $rev)
387 where $pageid is the page ID of the page associated to the revision the
388 token is requested for, $title the associated Title object and $rev the
389 associated Revision object. In the hook, just add your callback to the
390 $tokenFunctions array and return true (returning false makes no sense)
391 $tokenFunctions: array(action => callback)
393 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
395 Every token has an action, which will be used in the rctoken parameter
396 and in the output (actiontoken="..."), and a callback function which
397 should return the token, or false if the user isn't allowed to obtain
398 it. The prototype of the callback function is func($pageid, $title, $rc)
399 where $pageid is the page ID of the page associated to the revision the
400 token is requested for, $title the associated Title object and $rc the
401 associated RecentChange object. In the hook, just add your callback to the
402 $tokenFunctions array and return true (returning false makes no sense)
403 $tokenFunctions: array(action => callback)
405 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
406 the sites general information.
407 $module: the current ApiQuerySiteInfo module
408 &$results: array of results, add things here
410 'APIQueryUsersTokens': use this hook to add custom token to list=users.
411 Every token has an action, which will be used in the ustoken parameter
412 and in the output (actiontoken="..."), and a callback function which
413 should return the token, or false if the user isn't allowed to obtain
414 it. The prototype of the callback function is func($user) where $user
415 is the User object. In the hook, just add your callback to the
416 $tokenFunctions array and return true (returning false makes no sense)
417 $tokenFunctions: array(action => callback)
419 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling()
420 when an exception is thrown during API action execution.
421 $apiMain: Calling ApiMain instance.
422 $e: Exception object.
424 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
425 Each service should have its own entry in the $apis array and have a
426 unique name, passed as key for the array that represents the service data.
427 In this data array, the key-value-pair identified by the apiLink key is
429 &$apis: array of services
431 'ApiTokensGetTokenTypes': use this hook to extend action=tokens with new
433 &$tokenTypes: supported token types in format 'type' => callback function
434 used to retrieve this type of tokens.
436 'ArticleAfterFetchContent': after fetching content of an article from
437 the database. DEPRECATED, use ArticleAfterFetchContentObject instead.
438 $article: the article (object) being loaded from the database
439 &$content: the content (string) of the article
441 'ArticleAfterFetchContentObject': after fetching content of an article from
443 $article: the article (object) being loaded from the database
444 &$content: the content of the article, as a Content object
446 'ArticleConfirmDelete': before writing the confirmation form for article
448 $article: the article (object) being deleted
449 $output: the OutputPage object ($wgOut)
450 &$reason: the reason (string) the article is being deleted
452 'ArticleContentOnDiff': before showing the article content below a diff.
453 Use this to change the content in this area or how it is loaded.
454 $diffEngine: the DifferenceEngine
455 $output: the OutputPage object ($wgOut)
457 'ArticleDelete': before an article is deleted
458 $article: the WikiPage (object) being deleted
459 $user: the user (object) deleting the article
460 $reason: the reason (string) the article is being deleted
461 $error: if the deletion was prohibited, the (raw HTML) error message to display
463 $status: Status object, modify this to throw an error. Overridden by $error
466 'ArticleDeleteComplete': after an article is deleted
467 $article: the WikiPage that was deleted
468 $user: the user that deleted the article
469 $reason: the reason the article was deleted
470 $id: id of the article that was deleted
471 $content: the Content of the deleted page
472 $logEntry: the ManualLogEntry used to record the deletion
474 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
476 $article: WikiPage (object) of the user talk page
478 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
479 article has been changed
480 $article: the WikiPage (object)
481 $editInfo: data holder that includes the parser output ($editInfo->output) for
482 that page after the change
483 $changed: bool for if the page was changed
485 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
486 recentchanges table, return false to not delete old entries
487 $article: WikiPage (object) being modified
489 'ArticleFromTitle': when creating an article object from a title object using
490 Wiki::articleFromTitle()
491 $title: title (object) used to create the article object
492 $article: article (object) that will be returned
494 'ArticleInsertComplete': After a new article is created. DEPRECATED, use PageContentInsertComplete
495 $article: WikiPage created
496 $user: User creating the article
498 $summary: Edit summary/comment
499 $isMinor: Whether or not the edit was marked as minor
500 $isWatch: (No longer used)
501 $section: (No longer used)
502 $flags: Flags passed to WikiPage::doEditContent()
503 $revision: New Revision of the article
505 'ArticleMergeComplete': after merging to article using Special:Mergehistory
506 $targetTitle: target title (object)
507 $destTitle: destination title (object)
509 'ArticlePageDataAfter': after loading data of an article from the database
510 $article: WikiPage (object) whose data were loaded
511 $row: row (object) returned from the database server
513 'ArticlePageDataBefore': before loading data of an article from the database
514 $article: WikiPage (object) that data will be loaded
515 $fields: fileds (array) to load from the database
517 'ArticlePrepareTextForEdit': called when preparing text to be saved
518 $article: the WikiPage being saved
519 $popts: parser options to be used for pre-save transformation
521 'ArticleProtect': before an article is protected
522 $article: the WikiPage being protected
523 $user: the user doing the protection
524 $protect: boolean whether this is a protect or an unprotect
525 $reason: Reason for protect
526 $moveonly: boolean whether this is for move only or not
528 'ArticleProtectComplete': after an article is protected
529 $article: the WikiPage that was protected
530 $user: the user who did the protection
531 $protect: boolean whether it was a protect or an unprotect
532 $reason: Reason for protect
533 $moveonly: boolean whether it was for move only or not
535 'ArticlePurge': before executing "&action=purge"
536 $article: WikiPage (object) to purge
538 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
539 revision of an article
540 &$title: title object of the article
542 'ArticleRevisionUndeleted': after an article revision is restored
543 $title: the article title
544 $revision: the revision
545 $oldPageID: the page ID of the revision when archived (may be null)
547 'ArticleRollbackComplete': after an article rollback is completed
548 $article: the WikiPage that was edited
549 $user: the user who did the rollback
550 $revision: the revision the page was reverted back to
551 $current: the reverted revision
553 'ArticleSave': before an article is saved. DEPRECATED, use PageContentSave instead
554 $article: the WikiPage (object) being saved
555 $user: the user (object) saving the article
556 $text: the new article text
557 $summary: the article summary (comment)
562 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use PageContentSaveComplete instead.
563 $article: WikiPage modified
564 $user: User performing the modification
566 $summary: Edit summary/comment
567 $isMinor: Whether or not the edit was marked as minor
568 $isWatch: (No longer used)
569 $section: (No longer used)
570 $flags: Flags passed to WikiPage::doEditContent()
571 $revision: New Revision of the article
572 $status: Status object about to be returned by doEditContent()
573 $baseRevId: the rev ID (or false) this edit was based on
575 'ArticleUndelete': When one or more revisions of an article are restored
576 $title: Title corresponding to the article restored
577 $create: Whether or not the restoration caused the page to be created
578 (i.e. it didn't exist before)
579 $comment: The comment associated with the undeletion.
581 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
582 before the user is redirected back to the page
583 &$article: the article
584 &$sectionanchor: The section anchor link (e.g. "#overview" )
585 &$extraq: Extra query parameters which can be added via hooked functions
587 'ArticleViewFooter': After showing the footer section of an ordinary page view
588 $article: Article object
590 'ArticleViewHeader': Before the parser cache is about to be tried for article
592 &$article: the article
593 &$pcache: whether to try the parser cache or not
594 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
595 object to both indicate that the output is done and what parser output was used.
597 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
599 $article: target article (object)
601 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext.
602 DEPRECATED, use ArticleContentViewCustom instead.
603 Note that it is preferrable to implement proper handing for a custom data type using the ContentHandler facility.
604 $text: text of the page
605 $title: title of the page
606 $output: reference to $wgOut
608 'ArticleContentViewCustom': allows to output the text of the article in a different format than wikitext.
609 Note that it is preferrable to implement proper handing for a custom data type using the ContentHandler facility.
610 $content: content of the page, as a Content object
611 $title: title of the page
612 $output: reference to $wgOut
614 'AuthPluginAutoCreate': Called when creating a local account for an user logged
615 in from an external authentication method
616 $user: User object created locally
618 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
619 Gives a chance for an extension to set it programattically to a variable class.
620 &$auth: the $wgAuth object, probably a stub
622 'AutopromoteCondition': check autopromote condition for user.
623 $type: condition type
626 $result: result of checking autopromote condition
628 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
632 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
635 $title: title of the page to which backlinks are sought
636 &$conds: query conditions
638 'BadImage': When checking against the bad image list
639 $name: Image name being checked
640 &$bad: Whether or not the image is "bad"
642 Change $bad and return false to override. If an image is "bad", it is not
643 rendered inline in wiki pages or galleries in category pages.
645 'BeforeDisplayNoArticleText': before displaying noarticletext or noarticletext-nopermission
646 at Article::showMissingArticle()
648 $article: article object
650 'BeforeInitialize': before anything is initialized in MediaWiki::performRequest()
651 &$title: Title being used for request
653 &$output: OutputPage object
655 $request: WebRequest object
656 $mediaWiki: Mediawiki object
658 'BeforePageDisplay': Prior to outputting a page
659 &$out: OutputPage object
662 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
663 override how the redirect is output by modifying, or by returning false and
664 taking over the output.
665 $out: OutputPage object
666 &$redirect: URL, modifiable
667 &$code: HTTP code (eg '301' or '302'), modifiable
669 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
670 $parser: Parser object
672 &$options: array of options to RepoGroup::findFile
673 &$descQuery: query string to add to thumbnail URL
675 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
677 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
678 $parser: Parser object
679 $title: title of the template
680 &$skip: skip this template and link it?
681 &$id: the id of the revision being parsed
683 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
684 &$parser: Parser object
685 &$ig: ImageGallery object
687 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
688 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
689 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
691 'BitmapHandlerTransform': before a file is transformed, gives extension the
692 possibility to transform it themselves
693 $handler: BitmapHandler
695 &$scalerParams: Array with scaler parameters
696 &$mto: null, set to a MediaTransformOutput
698 'BitmapHandlerCheckImageArea': by BitmapHandler::normaliseParams, after all normalizations have been performed, except for the $wgMaxImageArea check
700 &$params: Array of parameters
701 &$checkImageAreaHookResult: null, set to true or false to override the $wgMaxImageArea check result
703 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
704 $block: Block object (which is set to be autoblocking)
705 &$blockIds: Array of block IDs of the autoblock
707 'BlockIp': before an IP address or user is blocked
708 $block: the Block object about to be saved
709 $user: the user _doing_ the block (not the one being blocked)
711 'BlockIpComplete': after an IP address or user is blocked
712 $block: the Block object that was saved
713 $user: the user who did the block (not the one being blocked)
715 'BookInformation': Before information output on Special:Booksources
716 $isbn: ISBN to show information for
717 $output: OutputPage object in use
719 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
720 &$namespaces: Array of namespace numbers with corresponding canonical names
722 'CategoryPageView': before viewing a categorypage in CategoryPage::view
723 $catpage: CategoryPage instance
725 'ChangePasswordForm': For extensions that need to add a field to the ChangePassword form
726 via the Preferences form
727 &$extraFields: An array of arrays that hold fields like would be passed to the pretty function.
729 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
730 &$changesList: ChangesList instance.
731 &$articlelink: HTML of link to article (already filled-in).
732 &$s: HTML of row that is being constructed.
733 &$rc: RecentChange instance.
734 $unpatrolled: Whether or not we are showing unpatrolled changes.
735 $watched: Whether or not the change is watched by the user.
737 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
738 $collationName: Name of the collation in question
739 &$collationObject: Null. Replace with a subclass of the Collation class that implements
740 the collation given in $collationName.
742 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
743 $user: user (object) whose email is being confirmed
745 'ContentHandlerDefaultModelFor': Called when the default content model is determiend
746 for a given title. May be used to assign a different model for that title.
747 $title: the Title in question
748 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
750 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
751 cointent model name, but no entry for that model exists in $wgContentHandlers.
752 $modeName: the requested content model name
753 &$handler: set this to a ContentHandler object, if desired.
755 'ContribsPager::getQueryInfo': Before the contributions query is about to run
756 &$pager: Pager object for contributions
757 &$queryInfo: The query for the contribs Pager
759 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
760 &$data: an array of results of all contribs queries
761 $pager: The ContribsPager object hooked into
762 $offset: Index offset, inclusive
763 $limit: Exact query limit
764 $descending: Query direction, false for ascending, true for descending
766 'ContributionsLineEnding': Called before a contributions HTML line is finished
767 $page: SpecialPage object for contributions
769 $row: the DB row for this line
770 &$classes: the classes to add to the surrounding <li>
772 'ContributionsToolLinks': Change tool links above Special:Contributions
774 $title: User page title
775 &$tools: Array of tool links
777 'CustomEditor': When invoking the page editor
778 $article: Article being edited
779 $user: User performing the edit
781 Return true to allow the normal editor to be used, or false
782 if implementing a custom editor, e.g. for a special namespace,
785 'DatabaseOraclePostInit': Called after initialising an Oracle database
786 &$db: the DatabaseOracle object
788 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
789 $text: plaintext string to be output
790 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
792 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
793 $title: the diff page title (nullable)
794 &$oldId: the actual old Id to use in the diff
795 &$newId: the actual new Id to use in the diff (0 means current)
796 $old: the ?old= param value from the url
797 $new: the ?new= param value from the url
799 'DiffViewHeader': called before diff display
800 $diff: DifferenceEngine object that's calling
801 $oldRev: Revision object of the "old" revision (may be null/invalid)
802 $newRev: Revision object of the "new" revision
804 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
806 $article: article (object) being viewed
807 $oldid: oldid (int) being viewed
809 'DoEditSectionLink': Override the HTML generated for section edit links
810 $skin: Skin object rendering the UI
811 $title: Title object for the title being linked to (may not be the same as
812 $wgTitle, if the section is included from a template)
813 $section: The designation of the section being pointed to, to be included in
814 the link, like "§ion=$section"
815 $tooltip: The default tooltip. Escape before using.
816 By default, this is wrapped in the 'editsectionhint' message.
817 &$result: The HTML to return, prefilled with the default plus whatever other
818 changes earlier hooks have made
819 $lang: The language code to use for the link in the wfMessage function
821 'EditFilter': Perform checks on an edit
822 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
823 $text: Contents of the edit box
824 $section: Section being edited
825 &$error: Error message to return
826 $summary: Edit summary for page
828 'EditFilterMerged': Post-section-merge edit filter.
829 DEPRECATED, use EditFilterMergedContent instead.
830 $editor: EditPage instance (object)
831 $text: content of the edit box
832 &$error: error message to return
833 $summary: Edit summary for page
835 'EditFilterMergedContent': Post-section-merge edit filter
836 $editor: EditPage instance (object)
837 $content: content of the edit box, as a Content object
838 &$error: error message to return
839 $summary: Edit summary for page
841 'EditFormPreloadText': Allows population of the edit form when creating
843 &$text: Text to preload with
844 &$title: Title object representing the page being created
846 'EditFormInitialText': Allows modifying the edit form when editing existing
848 $editPage: EditPage object
850 'EditPage::attemptSave': called before an article is
851 saved, that is before WikiPage::doEditContent() is called
852 $editpage_Obj: the current EditPage object
854 'EditPage::importFormData': allow extensions to read additional data
856 $editpage: EditPage instance
858 return value is ignored (should always return true)
860 'EditPage::showEditForm:fields': allows injection of form field into edit form
861 $editor: the EditPage instance for reference
862 $out: an OutputPage instance to write to
863 return value is ignored (should always return true)
865 'EditPage::showEditForm:initial': before showing the edit form
866 $editor: EditPage instance (object)
867 $out: an OutputPage instance to write to
869 Return false to halt editing; you'll need to handle error messages, etc.
870 yourself. Alternatively, modifying $error and returning true will cause the
871 contents of $error to be echoed at the top of the edit form as wikitext.
872 Return true without altering $error to allow the edit to proceed.
874 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
875 when there's an edit conflict. Return false to halt normal diff output; in
876 this case you're responsible for computing and outputting the entire "conflict"
877 part, i.e., the "difference between revisions" and "your text" headers and
879 &$editor: EditPage instance
880 &$out: OutputPage instance
882 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
883 textarea in the edit form
884 &$editpage: The current EditPage object
885 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
886 &$tabindex: HTML tabindex of the last edit check/button
888 'EditPageBeforeEditChecks': allows modifying the edit checks below the
889 textarea in the edit form
890 &$editpage: The current EditPage object
891 &$checks: Array of edit checks like "watch this page"/"minor edit"
892 &$tabindex: HTML tabindex of the last edit check/button
894 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
895 textarea in the edit form
896 &$toolbar: The toolbar HTMl
898 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
899 $title: title of page being edited
900 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
902 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
903 "Show changes". DEPRECATED. Use EditPageGetDiffContent instead.
904 Note that it is preferrable to implement diff handling for different data types using the ContentHandler facility.
905 $editPage: EditPage object
906 &$newtext: wikitext that will be used as "your version"
908 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
910 Note that it is preferrable to implement diff handling for different data types using the ContentHandler facility.
911 $editPage: EditPage object
912 &$newtext: wikitext that will be used as "your version"
914 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed.
915 DEPRECATED. Use EditPageGetPreviewContent instead.
916 Note that it is preferrable to implement previews for different data types using the COntentHandler facility.
917 $editPage: EditPage object
918 &$toparse: wikitext that will be parsed
920 'EditPageGetPreviewContent': Allow modifying the wikitext that will be previewed.
921 Note that it is preferrable to implement previews for different data types using the COntentHandler facility.
922 $editPage: EditPage object
923 &$content: Content object to be previewed (may be replaced by hook function)
925 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
926 &$editpage: The current EditPage object
927 &$res: the HTML of the error text
929 'EditPageTosSummary': Give a chance for site and per-namespace customizations
930 of terms of service summary link that might exist separately from the copyright
932 $title: title of page being edited
933 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
935 'EditSectionLink': Do not use, use DoEditSectionLink instead.
936 $skin: Skin rendering the UI
937 $title: Title being linked to
938 $section: Section to link to
940 &$result: Result (alter this to override the generated links)
941 $lang: The language code to use for the link in the wfMessage function
943 'EmailConfirmed': When checking that the user's email address is "confirmed"
944 $user: User being checked
945 $confirmed: Whether or not the email address is confirmed
946 This runs before the other checks, such as anonymity and the real check; return
947 true to allow those checks to occur, and false if checking is done.
949 'EmailUser': before sending email from one user to another
950 $to: address of receiving user
951 $from: address of sending user
952 $subject: subject of the mail
953 $text: text of the mail
955 'EmailUserCC': before sending the copy of the email to the author
956 $to: address of receiving user
957 $from: address of sending user
958 $subject: subject of the mail
959 $text: text of the mail
961 'EmailUserComplete': after sending email from one user to another
962 $to: address of receiving user
963 $from: address of sending user
964 $subject: subject of the mail
965 $text: text of the mail
967 'EmailUserForm': after building the email user form object
968 $form: HTMLForm object
970 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
971 $user: The user who is trying to email another user.
972 $editToken: The user's edit token.
973 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
975 'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle
976 $ip: The ip address of the user
978 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
979 &$extTypes: associative array of extensions types
981 'ExtractThumbParameters': called when extracting thumbnail parameters from a thumbnail file name
982 $thumbname: the base name of the thumbnail file
983 &$params: the currently extracted params (has source name, temp or archived zone)
985 'FetchChangesList': When fetching the ChangesList derivative for
987 $user: User the list is being fetched for
988 &$skin: Skin object to be used with the list
989 &$list: List object (defaults to NULL, change it to an object
990 instance and return false override the list derivative used)
992 'FileDeleteComplete': When a file is deleted
993 $file: reference to the deleted file
994 $oldimage: in case of the deletion of an old image, the name of the old file
995 $article: in case all revisions of the file are deleted a reference to the
996 WikiFilePage associated with the file.
997 $user: user who performed the deletion
1000 'FileTransformed': When a file is transformed and moved into storage
1001 $file: reference to the File object
1002 $thumb: the MediaTransformOutput object
1003 $tmpThumbPath: The temporary file system path of the transformed file
1004 $thumbPath: The permanent storage path of the transformed file
1006 'FileUpload': When a file upload occurs
1007 $file : Image object representing the file that was uploaded
1008 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
1009 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
1011 'FileUndeleteComplete': When a file is undeleted
1012 $title: title object to the file
1013 $fileVersions: array of undeleted versions. Empty if all versions were restored
1014 $user: user who performed the undeletion
1017 'FormatAutocomments': When an autocomment is formatted by the Linker
1018 &$comment: Reference to the accumulated comment. Initially null, when set the default code will be skipped.
1019 $pre: Initial part of the parsed comment before the call to the hook.
1020 $auto: The extracted part of the parsed comment before the call to the hook.
1021 $post: The final part of the parsed comment before the call to the hook.
1022 $title: An optional title object used to links to sections. Can be null.
1023 $local: Boolean indicating whether section links should refer to local page.
1025 'GetAutoPromoteGroups': When determining which autopromote groups a user
1026 is entitled to be in.
1027 &$user: user to promote.
1028 &$promote: groups that will be added.
1030 'GetBlockedStatus': after loading blocking status of an user from the database
1031 $user: user (object) being checked
1033 'GetCacheVaryCookies': get cookies that should vary cache options
1034 $out: OutputPage object
1035 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1036 that have to vary cache options
1038 'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
1039 $title: Title object of page
1040 $url: string value as output (out parameter, can modify)
1041 $query: query options passed to Title::getCanonicalURL()
1043 'GetDefaultSortkey': Override the default sortkey for a page.
1044 $title: Title object that we need to get a sortkey for
1045 &$sortkey: Sortkey to use.
1047 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
1048 $title: Title object of page
1049 $url: string value as output (out parameter, can modify)
1050 $query: query options passed to Title::getFullURL()
1052 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
1053 $title: Title object of page
1054 $url: string value as output (out parameter, can modify)
1055 $query: query options passed to Title::getInternalURL()
1057 'GetIP': modify the ip of the current user (called only once)
1058 &$ip: string holding the ip as determined so far
1060 'GetLinkColours': modify the CSS class of an array of page links
1061 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1063 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1065 'GetLocalURL': modify local URLs as output into page links. Note that if you
1066 are working with internal urls (non-interwiki) then it may be preferable
1067 to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
1068 GetLocalURL can be buggy for internal urls on render if you do not
1069 re-implement the horrible hack that Title::getLocalURL uses
1070 in your own extension.
1071 $title: Title object of page
1072 &$url: string value as output (out parameter, can modify)
1073 $query: query options passed to Title::getLocalURL()
1075 'GetLocalURL::Internal': modify local URLs to internal pages.
1076 $title: Title object of page
1077 &$url: string value as output (out parameter, can modify)
1078 $query: query options passed to Title::getLocalURL()
1080 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
1081 without any fancy queries or variants.
1082 $title: Title object of page
1083 &$url: string value as output (out parameter, can modify)
1085 'GetMetadataVersion': modify the image metadata version currently in use. This is
1086 used when requesting image metadata from a ForiegnApiRepo. Media handlers
1087 that need to have versioned metadata should add an element to the end of
1088 the version array of the form 'handler_name=version'. Most media handlers
1089 won't need to do this unless they broke backwards compatibility with a
1090 previous version of the media handler metadata output.
1091 &$version: Array of version strings
1093 'GetPreferences': modify user preferences
1094 $user: User whose preferences are being modified.
1095 &$preferences: Preferences description array, to be fed to an HTMLForm object
1097 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1098 checked for. Use instead of userCan for most cases. Return false if the
1099 user can't do it, and populate $result with the reason in the form of
1100 array( messagename, param1, param2, ... ). For consistency, error messages
1101 should be plain text with no special coloring, bolding, etc. to show that
1102 they're errors; presenting them properly to the user as errors is done by
1104 $title: Title object being checked against
1105 $user : Current user object
1106 $action: Action being checked
1107 $result: User permissions error to add. If none, return true.
1109 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
1110 if expensive checks are enabled.
1112 'GitViewers': called when generating the list of git viewers for Special:Version, use
1113 this to change the list.
1114 &$extTypes: associative array of repo URLS to viewer URLs.
1117 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1118 image insertion. You can skip the default logic entirely by returning
1119 false, or just modify a few things using call-by-reference.
1121 &$title: Title object of the image
1122 &$file: File object, or false if it doesn't exist
1123 &$frameParams: Various parameters with special meanings; see documentation in
1124 includes/Linker.php for Linker::makeImageLink
1125 &$handlerParams: Various parameters with special meanings; see documentation in
1126 includes/Linker.php for Linker::makeImageLink
1127 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1128 &$res: Final HTML output, used if you return false
1131 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1132 the image on an image page
1133 $imagePage: ImagePage object ($this)
1136 'ImagePageAfterImageLinks': called after the image links section on an image
1138 $imagePage: ImagePage object ($this)
1139 &$html: HTML for the hook to add
1141 'ImagePageFileHistoryLine': called when a file history line is contructed
1143 $line: the HTML of the history line
1144 $css: the line CSS class
1146 'ImagePageFindFile': called when fetching the file associated with an image page
1147 $page: ImagePage object
1149 &$displayFile: displayed File object
1151 'ImagePageShowTOC': called when the file toc on an image page is generated
1152 $page: ImagePage object
1153 &$toc: Array of <li> strings
1155 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1157 &$title: the Title object of the file as it would appear for the upload page
1158 &$path: the original file and path name when img_auth was invoked by the the web
1160 &$name: the name only component of the file
1161 &$result: The location to pass back results of the hook routine (only used if
1163 $result[0]=The index of the header message
1164 $result[1]=The index of the body text message
1165 $result[2 through n]=Parameters passed to body text message. Please note the
1166 header message cannot receive/use parameters.
1168 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1169 $reader: XMLReader object
1170 $logInfo: Array of information
1171 Return false to stop further processing of the tag
1173 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1174 $reader: XMLReader object
1175 $pageInfo: Array of information
1176 Return false to stop further processing of the tag
1178 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1179 $reader: XMLReader object
1180 $pageInfo: Array of page information
1181 $revisionInfo: Array of revision information
1182 Return false to stop further processing of the tag
1184 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1185 $reader: XMLReader object
1186 Return false to stop further processing of the tag
1188 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1189 $reader: XMLReader object
1190 $revisionInfo: Array of information
1191 Return false to stop further processing of the tag
1193 'InfoAction': When building information to display on the action=info page
1194 $context: IContextSource object
1195 &$pageInfo: Array of information
1197 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1198 $title: Title object ($wgTitle)
1199 $request: WebRequest
1200 $ignoreRedirect: boolean to skip redirect check
1201 $target: Title/string of redirect target
1202 $article: Article object
1204 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1205 Return true without providing an interwiki to continue interwiki search.
1206 $prefix: interwiki prefix we are looking for.
1207 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1208 iw_trans and optionally iw_api and iw_wikiid.
1210 'InternalParseBeforeSanitize': during Parser's internalParse method just before the
1211 parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/
1212 onlyinclude and other processings. Ideal for syntax-extensions after template/parser
1213 function execution which respect nowiki and HTML-comments.
1214 &$parser: Parser object
1215 &$text: string containing partially parsed text
1216 &$stripState: Parser's internal StripState object
1218 'InternalParseBeforeLinks': during Parser's internalParse method before links
1219 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1220 &$parser: Parser object
1221 &$text: string containing partially parsed text
1222 &$stripState: Parser's internal StripState object
1224 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1225 $user: user (object) whose email is being invalidated
1227 'IRCLineURL': When constructing the URL to use in an IRC notification.
1228 Callee may modify $url and $query, URL will be constructed as $url . $query
1229 &$url: URL to index.php
1230 &$query: Query string
1232 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1233 $article: article (object) being checked
1235 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1237 $result: Change this value to override the result of wfIsTrustedProxy()
1239 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1240 tance to return false if the domain name doesn't match your organization
1241 $addr: The e-mail address entered by the user
1242 &$result: Set this and return false to override the internal checks
1244 'isValidPassword': Override the result of User::isValidPassword()
1245 $password: The password entered by the user
1246 &$result: Set this and return false to override the internal checks
1247 $user: User the password is being validated for
1249 'Language::getMessagesFileName':
1250 $code: The language code or the language we're looking for a messages file for
1251 &$file: The messages file path, you can override this to change the location.
1253 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1254 remove namespaces. Do not use this hook to add namespaces. Use
1255 CanonicalNamespaces for that.
1256 &$namespaces: Array of namespaces indexed by their numbers
1258 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1259 $wgExtensionMessagesFiles instead.
1260 Use this to define synonyms of magic words depending of the language
1261 $magicExtensions: associative array of magic words synonyms
1262 $lang: laguage code (string)
1264 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1265 listed in $wgExtensionMessagesFiles instead.
1266 Use to define aliases of special pages names depending of the language
1267 $specialPageAliases: associative array of magic words synonyms
1268 $lang: laguage code (string)
1270 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1271 &$names: array of language code => language name
1272 $code language of the preferred translations
1274 'LinkBegin': Used when generating internal and interwiki links in
1275 Linker::link(), before processing starts. Return false to skip default proces-
1276 sing and return $ret. See documentation for Linker::link() for details on the
1277 expected meanings of parameters.
1278 $skin: the Skin object
1279 $target: the Title that the link is pointing to
1280 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1282 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1283 tive array form, with keys and values unescaped. Should be merged with de-
1284 fault values, with a value of false meaning to suppress the attribute.
1285 &$query: the query string to add to the generated URL (the bit after the "?"),
1286 in associative array form, with keys and values unescaped.
1287 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1288 &$ret: the value to return if your hook returns false.
1290 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1291 just before the function returns a value. If you return true, an <a> element
1292 with HTML attributes $attribs and contents $html will be returned. If you re-
1293 turn false, $ret will be returned.
1294 $skin: the Skin object
1295 $target: the Title object that the link is pointing to
1296 $options: the options. Will always include either 'known' or 'broken', and may
1297 include 'noclasses'.
1298 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1299 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1301 &$ret: the value to return if your hook returns false.
1303 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1305 &$url: the image url
1306 &$alt: the image's alt text
1307 &$img: the new image HTML (if returning false)
1309 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1312 &$text: the link text
1313 &$link: the new link HTML (if returning false)
1314 &$attribs: the attributes to be applied.
1315 $linkType: The external link type
1317 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1319 &$linksUpdate: the LinksUpdate object
1321 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1323 &$linksUpdate: the LinksUpdate object
1325 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1326 &$linksUpdate: the LinksUpdate object
1328 'ListDefinedTags': When trying to find all defined tags.
1329 &$tags: The list of tags.
1331 'LoadExtensionSchemaUpdates': called during database installation and updates
1332 &updater: A DatabaseUpdater subclass
1334 'LocalFile::getHistory': called before file history query performed
1335 $file: the File object
1337 $fields: select fields
1339 $opts: query options
1340 $join_conds: JOIN conditions
1342 'LocalFilePurgeThumbnails': called before thumbnails for a local file a purged
1343 $file: the File object
1344 $archiveName: name of an old file version or false if it's the current one
1346 'LocalisationCacheRecache': Called when loading the localisation data into cache
1347 $cache: The LocalisationCache object
1348 $code: language code
1349 &$alldata: The localisation data from core and extensions
1351 'LogEventsListShowLogExtract': called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage
1352 &$s: html string to show for the log extract
1353 $types: String or Array Log types to show
1354 $page: String or Title The page title to show log entries for
1355 $user: String The user who made the log entries
1356 $param: Associative Array with the following additional options:
1357 - lim Integer Limit of items to show, default is 50
1358 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1359 - 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
1360 - 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 wfMessage()->params()->parseAsBlock()
1361 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset
1362 - wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
1363 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1365 'LoggableUserIPData': called when IP data for a user action can be logged by extensions like CheckUser.
1366 This is intended for when users do things that do not already create edits or log entries.
1367 $context: The context the of the action, which includes the user and request
1368 $data: Associative array of data for handlers to record. It must include values for:
1369 - 'namespace' Integer namespace for target title (NS_SPECIAL is allowed)
1370 - 'title' Database key string for target title (empty string if not applicable)
1371 - 'pageid' Integer page ID for target title (zero if not applicable)
1372 - 'action' Wikitext string in the same format as an edit summary
1373 - 'comment' Wikitext string in the same format as an edit summary
1374 - 'timestamp' Timestamp when the action occured
1376 'LoginAuthenticateAudit': a login attempt for a valid user account either
1377 succeeded or failed. No return data is accepted; this hook is for auditing only.
1378 $user: the User object being authenticated against
1379 $password: the password being submitted and found wanting
1380 $retval: a LoginForm class constant with authenticateUserData() return
1381 value (SUCCESS, WRONG_PASS, etc)
1383 'LogLine': Processes a single log entry on Special:Log
1384 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1385 logging.log_type database field.
1386 $log_action: string for the type of log action (e.g. 'delete', 'block',
1387 'create2'). Corresponds to logging.log_action database field.
1388 $title: Title object that corresponds to logging.log_namespace and
1389 logging.log_title database fields.
1390 $paramArray: Array of parameters that corresponds to logging.log_params field.
1391 Note that only $paramArray[0] appears to contain anything.
1392 &$comment: string that corresponds to logging.log_comment database field, and
1393 which is displayed in the UI.
1394 &$revert: string that is displayed in the UI, similar to $comment.
1395 $time: timestamp of the log entry (added in 1.12)
1397 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1398 $refreshLinks: RefreshLinks object
1400 'MagicWordwgVariableIDs': When definig new magic words IDs.
1401 $variableIDs: array of strings
1403 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1404 is executed. Ideally, this hook should only be used to add variables that
1405 depend on the current page/request; static configuration should be added
1406 through ResourceLoaderGetConfigVars instead.
1407 &$vars: variable (or multiple variables) to be added into the output
1408 of Skin::makeVariablesScript
1409 $out: The OutputPage which called the hook,
1410 can be used to get the real title
1412 'MarkPatrolled': before an edit is marked patrolled
1413 $rcid: ID of the revision to be marked patrolled
1414 $user: the user (object) marking the revision as patrolled
1415 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1416 needs to be a sysop in order to mark an edit patrolled
1418 'MarkPatrolledComplete': after an edit is marked patrolled
1419 $rcid: ID of the revision marked as patrolled
1420 $user: user (object) who marked the edit patrolled
1421 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1422 must be a sysop to patrol the edit
1424 'MediaWikiPerformAction': Override MediaWiki::performAction().
1425 Use this to do something completely different, after the basic
1426 globals have been set up, but before ordinary actions take place.
1428 $article: $wgArticle
1431 $request: $wgRequest
1432 $mediaWiki: The $mediawiki object
1434 'MessagesPreLoad': When loading a message from the database
1435 $title: title of the message (string)
1436 $message: value (string), change it to the message you want to define
1438 'MessageCacheReplace': When a message page is changed.
1439 Useful for updating caches.
1440 $title: name of the page changed.
1441 $text: new contents of the page.
1443 'ModifyExportQuery': Modify the query used by the exporter.
1444 $db: The database object to be queried.
1445 &$tables: Tables in the query.
1446 &$conds: Conditions in the query.
1447 &$opts: Options for the query.
1448 &$join_conds: Join conditions for the query.
1450 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1451 been rendered (useful for adding more)
1452 Note: this is only run for the Monobook skin. This hook is deprecated and
1453 may be removed in the future. To add items to the toolbox you should use
1454 the SkinTemplateToolboxEnd hook instead, which works for all
1455 "SkinTemplate"-type skins.
1456 $tools: array of tools
1458 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1459 and returning it for the skin to output. You can add items to the toolbox while
1460 still letting the skin make final decisions on skin-specific markup conventions
1462 &$sk: The BaseTemplate base skin template
1463 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1464 BaseTemplate::makeListItem for details on the format of individual
1465 items inside of this array
1467 'NamespaceIsMovable': Called when determining if it is possible to pages in a namespace.
1468 $index: Integer; the index of the namespace being checked.
1469 $result: Boolean; whether MediaWiki currently thinks that pages in this namespace are movable.
1470 Hooks may change this value to override the return value of MWNamespace::isMovable()
1472 'NewRevisionFromEditComplete': called when a revision was inserted
1474 $article: the WikiPage edited
1475 $rev: the new revision
1476 $baseID: the revision ID this was based off, if any
1477 $user: the editing user
1479 'NormalizeMessageKey': Called before the software gets the text of a message
1480 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1482 &$key: the message being looked up. Change this to something else to change
1483 what message gets displayed (string)
1484 &$useDB: whether or not to look up the message in the database (bool)
1485 &$langCode: the language code to get the message for (string) - or -
1486 whether to use the content language (true) or site language (false) (bool)
1487 &$transform: whether or not to expand variables and templates
1488 in the message (bool)
1490 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1491 &$changeslist: The OldChangesList instance.
1492 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1493 &$rc: The RecentChange object.
1495 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1496 Hooks can alter or append to the array of URLs for search & suggestion formats.
1497 &$urls: array of associative arrays with Url element attributes
1499 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1500 users and/or IP addresses too
1501 $otherBlockLink: An array with links to other block logs
1502 $ip: The requested IP address or username
1504 'OutputPageBeforeHTML': a page has been processed by the parser and
1505 the resulting HTML is about to be displayed.
1506 $parserOutput: the parserOutput (object) that corresponds to the page
1507 $text: the text that will be displayed, in HTML (string)
1509 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1510 tag to allow for extensions to add attributes to the body of the page they might
1511 need. Or to allow building extensions to add body classes that aren't of high
1512 enough demand to be included in core.
1513 $out: The OutputPage which called the hook, can be used to get the real title
1514 $sk: The Skin that called OutputPage::headElement
1515 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1517 'OutputPageCheckLastModified': when checking if the page has been modified
1518 since the last visit
1519 &$modifiedTimes: array of timestamps.
1520 The following keys are set: page, user, epoch
1522 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1523 $out: OutputPage instance (object)
1524 $parserOutput: parserOutput instance being added in $out
1526 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1527 categories. Implementations should return false if they generate the category
1528 links, so the default link generation is skipped.
1529 $out: OutputPage instance (object)
1530 $categories: associative array, keys are category names, values are category
1531 types ("normal" or "hidden")
1532 $links: array, intended to hold the result. Must be an associative array with
1533 category types as keys and arrays of HTML links as values.
1535 'PageContentInsertComplete': After a new article is created
1536 $article: WikiPage created
1537 $user: User creating the article
1538 $content: New content as a Content object
1539 $summary: Edit summary/comment
1540 $isMinor: Whether or not the edit was marked as minor
1541 $isWatch: (No longer used)
1542 $section: (No longer used)
1543 $flags: Flags passed to WikiPage::doEditContent()
1544 $revision: New Revision of the article
1546 'PageContentLanguage': allows changing the language in which the content of
1547 a page is written. Defaults to the wiki content language ($wgContLang).
1548 $title: Title object
1549 &$pageLang: the page content language (either an object or a language code)
1550 $wgLang: the user language
1552 'PageContentSave': before an article is saved.
1553 $article: the WikiPage (object) being saved
1554 $user: the user (object) saving the article
1555 $content: the new article content, as a Content object
1556 $summary: the article summary (comment)
1557 $isminor: minor flag
1558 $iswatch: watch flag
1561 'PageContentSaveComplete': After an article has been updated
1562 $article: WikiPage modified
1563 $user: User performing the modification
1564 $content: New content, as a Content object
1565 $summary: Edit summary/comment
1566 $isMinor: Whether or not the edit was marked as minor
1567 $isWatch: (No longer used)
1568 $section: (No longer used)
1569 $flags: Flags passed to WikiPage::doEditContent()
1570 $revision: New Revision of the article
1571 $status: Status object about to be returned by doEditContent()
1572 $baseRevId: the rev ID (or false) this edit was based on
1574 'PageHistoryBeforeList': When a history page list is about to be constructed.
1575 $article: the article that the history is loading for
1577 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1578 $row: the revision row for this line
1579 $s: the string representing this parsed line
1580 $classes: array containing the <li> element classes
1582 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1585 $queryInfo: the query parameters
1587 'PageRenderingHash': alter the parser cache option hash key
1588 A parser extension which depends on user options should install
1589 this hook and append its values to the key.
1590 $hash: reference to a hash key string which can be modified
1592 'ParserAfterParse': Called from Parser::parse() just after the call to
1593 Parser::internalParse() returns
1594 $parser: parser object
1595 $text: text being parsed
1596 $stripState: stripState used (object)
1598 'ParserAfterStrip': Same as ParserBeforeStrip
1600 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1601 $parser: Parser object being used
1602 $text: text that'll be returned
1604 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1605 $parser: Parser object
1606 $text: text to parse
1607 $stripState: StripState instance being used
1609 'ParserBeforeStrip': Called at start of parsing time
1610 (no more strip, deprecated ?)
1611 $parser: parser object
1612 $text: text being parsed
1613 $stripState: stripState used (object)
1615 'ParserBeforeTidy': called before tidy and custom tags replacements
1616 $parser: Parser object being used
1619 'ParserClearState': called at the end of Parser::clearState()
1620 $parser: Parser object being cleared
1622 'ParserFirstCallInit': called when the parser initialises for the first time
1623 &$parser: Parser object being cleared
1625 'ParserGetVariableValueSwitch': called when the parser need the value of a
1627 $parser: Parser object
1628 $varCache: array to store the value in case of multiples calls of the
1630 $index: index (string) of the magic
1631 $ret: value of the magic word (the hook should set it)
1632 $frame: PPFrame object to use for expanding any template variables
1634 'ParserGetVariableValueTs': use this to change the value of the time for the
1635 {{LOCAL...}} magic word
1636 $parser: Parser object
1637 $time: actual time (timestamp)
1639 'ParserGetVariableValueVarCache': use this to change the value of the
1640 variable cache or return false to not use it
1641 $parser: Parser object
1642 $varCache: varaiable cache (array)
1644 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1645 include comments about size of the text parsed
1646 $parser: Parser object
1647 $limitReport: text that will be included (without comment tags)
1649 'ParserMakeImageParams': Called before the parser make an image link, use this
1650 to modify the parameters of the image.
1651 $title: title object representing the file
1652 $file: file object that will be used to create the image
1653 &$params: 2-D array of parameters
1654 $parser: Parser object that called the hook
1656 'ParserSectionCreate': Called each time the parser creates a document section
1657 from wikitext. Use this to apply per-section modifications to HTML (like
1658 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1659 can begin in one section and end in another. Make sure your code can handle
1660 that case gracefully. See the EditSectionClearerLink extension for an
1662 $parser: the calling Parser instance
1663 $section: the section number, zero-based, but section 0 is usually empty
1664 &$sectionContent: ref to the content of the section. modify this.
1665 $showEditLinks: boolean describing whether this section has an edit link
1667 'ParserTestParser': called when creating a new instance of Parser in
1668 maintenance/parserTests.inc
1669 $parser: Parser object created
1671 'ParserTestGlobals': Allows to define globals for parser tests.
1672 &$globals: Array with all the globals which should be set for parser tests.
1673 The arrays keys serve as the globals names, its values are the globals values.
1675 'ParserTestTables': alter the list of tables to duplicate when parser tests
1676 are run. Use when page save hooks require the presence of custom tables
1677 to ensure that tests continue to run properly.
1678 &$tables: array of table names
1680 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1681 my talk page, my contributions" etc).
1682 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1683 &$title: Title object representing the current page
1685 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1686 &$user : User performing the action
1687 $action : Action being performed
1688 &$result : Whether or not the action should be prevented
1689 Change $result and return false to give a definitive answer, otherwise
1690 the built-in rate limiting checks are used, if enabled.
1692 'PlaceNewSection': Override placement of new sections.
1693 $wikipage : WikiPage object
1694 $oldtext : the text of the article before editing
1695 $subject : subject of the new section
1696 &$text : text of the new section
1697 Return false and put the merged text into $text to override the default behavior.
1699 'PreferencesGetLegend': Override the text used for the <legend> of a preferences section
1700 $form: the PreferencesForm object. This is a ContextSource as well
1701 $key: the section name
1702 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1704 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1705 AJAX search suggestions. Put results into &$results outparam and return false.
1706 $ns : array of int namespace keys to search in
1707 $search : search term (not guaranteed to be conveniently normalized)
1708 $limit : maximum number of results to return
1709 &$results : out param: array of page names (strings)
1711 'PrefsEmailAudit': called when user changes his email address
1712 $user: User (object) changing his email address
1713 $oldaddr: old email address (string)
1714 $newaddr: new email address (string)
1716 'PrefsPasswordAudit': called when user changes his password
1717 $user: User (object) changing his passoword
1718 $newPass: new password
1719 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1721 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1722 $article: the title being (un)protected
1723 $output: a string of the form HTML so far
1725 'ProtectionForm::save': called when a protection form is submitted
1726 $article: the title being (un)protected
1727 $errorMsg: an html message string of an error or an array of message name and its parameters
1729 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1730 $article: the page the form is shown for
1731 $out: OutputPage object
1733 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1734 &$obj: RawPage object
1735 &$text: The text that's going to be the output
1737 'RecentChange_save': called at the end of RecentChange::save()
1738 $recentChange: RecentChange object
1740 'RedirectSpecialArticleRedirectParams': lets you alter the set of
1741 parameter names such as "oldid" that are preserved when using
1742 redirecting special pages such as Special:MyPage and Special:MyTalk.
1743 &$redirectParams: An array of parameters preserved by redirecting special pages.
1745 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin instance.
1746 Can be used by an extension override what skin is used in certain contexts.
1747 IContextSource $context: The RequestContext the skin is being created for.
1748 &$skin: A variable reference you may set a Skin instance or string key on to override the skin that will be used for the context.
1750 'ResourceLoaderGetConfigVars': called at the end of
1751 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1752 configuration variables to JavaScript. Things that depend on the current
1753 page/request state must be added through MakeGlobalVariablesScript instead.
1754 &$vars: array( variable name => value )
1756 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1757 to add modules to the startup module. This hook should be used sparingly since any module added here
1758 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1761 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1762 loader request or generating HTML output.
1763 &$resourceLoader: ResourceLoader object
1765 'ResourceLoaderTestModules': let you add new JavaScript testing modules. This is called after the addition of 'qunit' and MediaWiki testing resources.
1766 &testModules: array of JavaScript testing modules. The 'qunit' framework, included in core, is fed using tests/qunit/QUnitTestResources.php.
1767 &ResourceLoader object
1768 To add a new qunit module named 'myext.tests':
1769 testModules['qunit']['myext.tests'] = array(
1770 'script' => 'extension/myext/tests.js',
1771 'dependencies' => <any module dependency you might have>
1773 For qunit framework, the mediawiki.tests.qunit.testrunner dependency will be added to any module.
1775 'RevisionInsertComplete': called after a revision is inserted into the DB
1776 &$revision: the Revision
1777 $data: the data stored in old_text. The meaning depends on $flags: if external
1778 is set, it's the URL of the revision text in external storage; otherwise,
1779 it's the revision text itself. In either case, if gzip is set, the revision
1781 $flags: a comma-delimited list of strings representing the options used. May
1782 include: utf8 (this will always be set for new revisions); gzip; external.
1784 'SearchUpdate': Prior to search update completion
1786 $namespace : Page namespace
1788 $text : Current text being indexed
1790 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1791 $allSearchTerms : Array of the search terms in all content languages
1792 &$titleResult : Outparam; the value to return. A Title object or null.
1794 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1795 $term : Search term string
1796 &$title : Outparam; set to $title object and return false for a match
1798 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1799 $term : Search term string
1800 &$title : Current Title object that is being returned (null if none found).
1802 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1803 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1804 in the $searchEngine->namespaces array.
1805 $query : Original query.
1806 &$parsed : Resultant query with the prefixes stripped.
1808 'SearchResultInitFromTitle': Set the revision used when displaying a page in
1810 $title : Current Title object being displayed in search results.
1811 &$id: Revision ID (default is false, for latest)
1813 'SearchableNamespaces': An option to modify which namespaces are searchable.
1814 &$arr : Array of namespaces ($nsId => $name) which will be used.
1816 'SetupAfterCache': Called in Setup.php, after cache objects are set
1818 'ShowMissingArticle': Called when generating the output for a non-existent page
1819 $article: The article object corresponding to the page
1821 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
1822 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
1823 $text: Text being shown
1824 $title: Title of the custom script/stylesheet page
1825 $output: Current OutputPage object
1827 'ShowSearchHitTitle': Customise display of search hit title/link.
1828 &$title: Title to link to
1829 &$text: Text to use for the link
1830 $result: The search result
1831 $terms: The search terms entered
1832 $page: The SpecialSearch object.
1834 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1835 &$siteNotice: HTML returned as the sitenotice
1837 Return true to allow the normal method of notice selection/rendering to work,
1838 or change the value of $siteNotice and return false to alter it.
1840 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1841 &$siteNotice: HTML sitenotice
1843 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1845 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1847 &$text: bottomScripts Text
1848 Append to $text to add additional text/scripts after the stock bottom scripts.
1850 'SkinAfterContent': Allows extensions to add text after the page content and
1852 &$data: (string) Text to be printed out directly (without parsing)
1854 This hook should work in all skins. Just set the &$data variable to the text
1855 you're going to add.
1857 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1859 &$bar: Sidebar contents
1860 Modify $bar to add or modify sidebar portlets.
1862 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1863 $title: displayed page title
1864 $type: 'normal' or 'history' for old/diff views
1865 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1866 &$link: overridable HTML link to be passed into the message as $1
1867 &$forContent: overridable flag if copyright footer is shown in content language.
1870 &$text: additional 'powered by' icons in HTML.
1871 Note: Modern skin does not use the MediaWiki icon but plain text instead
1874 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1875 &$subpages: Subpage links HTML
1877 $out: OutputPage object
1878 If false is returned $subpages will be used instead of the HTML
1879 subPageSubtitle() generates.
1880 If true is returned, $subpages will be ignored and the rest of
1881 subPageSubtitle() will run.
1883 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1884 "permanent link" tab
1885 $sktemplate: SkinTemplate object
1886 $nav_urls: array of tabs
1888 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1889 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1890 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1891 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1892 &$sktemplate: SkinTemplate object
1893 &$links: Structured navigation links
1894 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1896 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1898 &$sktemplate: SkinTemplate object
1899 &$tpl: Template engine object
1901 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1902 $sktemplate: SkinTemplate object
1903 $res: set to true to prevent active tabs
1905 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1906 You can either create your own array, or alter the parameters for
1908 &$sktemplate: The SkinTemplate instance.
1909 $title: Title instance for the page.
1910 $message: Visible label of tab.
1911 $selected: Whether this is a selected tab.
1912 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1913 &$classes: Array of CSS classes to apply.
1914 &$query: Query string to add to link.
1916 &$result: Complete assoc. array if you want to return true.
1918 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1919 been rendered (useful for adding more)
1920 $sk: The QuickTemplate based skin template running the hook.
1921 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
1922 extensions that add support for BaseTemplateToolbox should watch for this dummy
1923 parameter with "$dummy=false" in their code and return without echoing any html
1924 to avoid creating duplicate toolbox items.
1926 'SoftwareInfo': Called by Special:Version for returning information about
1928 $software: The array of software in format 'name' => 'version'.
1929 See SpecialVersion::softwareInformation()
1931 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1932 $id: User identifier
1934 'SpecialListusersDefaultQuery': called right before the end of
1935 UsersPager::getDefaultQuery()
1936 $pager: The UsersPager instance
1937 $query: The query array to be returned
1939 'SpecialListusersFormatRow': called right before the end of
1940 UsersPager::formatRow()
1941 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1942 $row: Database row object
1944 'SpecialListusersHeader': called before closing the <fieldset> in
1945 UsersPager::getPageHeader()
1946 $pager: The UsersPager instance
1947 $out: The header HTML
1949 'SpecialListusersHeaderForm': called before adding the submit button in
1950 UsersPager::getPageHeader()
1951 $pager: The UsersPager instance
1952 $out: The header HTML
1954 'SpecialListusersQueryInfo': called right before the end of
1955 UsersPager::getQueryInfo()
1956 $pager: The UsersPager instance
1957 $query: The query array to be returned
1959 'SpecialMovepageAfterMove': called after moving a page
1960 $movePage: MovePageForm object
1961 $oldTitle: old title (object)
1962 $newTitle: new title (object)
1964 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1965 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1966 $opts: FormOptions object containing special page options
1967 &$conds: array of WHERE conditionals for query
1968 &tables: array of tables to be queried
1969 &$fields: array of columns to select
1970 &$join_conds: join conditions for the tables
1972 'SpecialNewPagesFilters': called after building form options at NewPages
1973 $special: the special page object
1974 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1975 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1977 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1978 hook to remove a core special page
1979 $list: list (array) of core special pages
1981 'SpecialPageAfterExecute': called after SpecialPage::execute
1982 $special: the SpecialPage object
1983 $subPage: the subpage string or null if no subpage was specified
1985 'SpecialPageBeforeExecute': called before SpecialPage::execute
1986 $special: the SpecialPage object
1987 $subPage: the subpage string or null if no subpage was specified
1989 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1990 $users: array of User objects
1991 $data: array of data submitted by the user
1992 &$error: string, error code (message name) used to describe to error (out paramater).
1993 The hook needs to return false when setting this, otherwise it will have no effect.
1995 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1996 use this to change some selection criteria or substitute a different title
1997 &$randstr: The random number from wfRandom()
1998 &$isRedir: Boolean, whether to select a redirect or non-redirect
1999 &$namespaces: An array of namespace indexes to get the title from
2000 &$extra: An array of extra SQL statements
2001 &$title: If the hook returns false, a Title object to use instead of the
2002 result from the normal query
2004 'SpecialRecentChangesFilters': called after building form options at RecentChanges
2005 $special: the special page object
2006 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
2007 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2009 'SpecialRecentChangesPanel': called when building form options in
2010 SpecialRecentChanges
2011 &$extraOpts: array of added items, to which can be added
2012 $opts: FormOptions for this request
2014 'SpecialRecentChangesQuery': called when building sql query for
2015 SpecialRecentChanges and SpecialRecentChangesLinked
2016 &$conds: array of WHERE conditionals for query
2017 &$tables: array of tables to be queried
2018 &$join_conds: join conditions for the tables
2019 $opts: FormOptions for this request
2020 &$query_options: array of options for the database request
2021 &$select: Array of columns to select
2023 'SpecialSearchCreateLink': called when making the message to create a page or
2024 go to the existing page
2025 $t: title object searched for
2026 &$params: an array of the default message name and page title (as parameter)
2028 'SpecialSearchGo': called when user clicked the "Go"
2029 &$title: title object generated from the text entered by the user
2030 &$term: the search term entered by the user
2032 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
2033 target doesn't exist
2034 &$title: title object generated from the text entered by the user
2036 'SpecialSearchPowerBox': the equivalent of SpecialSearchProfileForm for
2037 the advanced form, a.k.a. power search box
2038 &$showSections: an array to add values with more options to
2039 $term: the search term (not a title object)
2040 $opts: an array of hidden options (containing 'redirs' and 'profile')
2042 'SpecialSearchProfiles': allows modification of search profiles
2043 &$profiles: profiles, which can be modified.
2045 'SpecialSearchProfileForm': allows modification of search profile forms
2046 $search: special page object
2047 &$form: String: form html
2048 $profile: String: current search profile
2049 $term: String: search term
2050 $opts: Array: key => value of hidden options for inclusion in custom forms
2052 'SpecialSearchSetupEngine': allows passing custom data to search engine
2053 $search: special page object
2054 $profile: String: current search profile
2055 $engine: the search engine
2057 'SpecialSearchResults': called before search result display when there
2059 $term: string of search term
2060 &$titleMatches: empty or SearchResultSet object
2061 &$textMatches: empty or SearchResultSet object
2063 'SpecialSearchNoResults': called before search result display when there are
2065 $term: string of search term
2067 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
2068 &$extraStats: Array to save the new stats
2069 ( $extraStats['<name of statistic>'] => <value>; )
2071 'SpecialUploadComplete': Called after successfully uploading a file from
2073 $form: The SpecialUpload object
2075 'SpecialVersionExtensionTypes': called when generating the extensions credits,
2076 use this to change the tables headers
2077 $extTypes: associative array of extensions types
2079 'SpecialWatchlistFilters': called after building form options at Watchlist
2080 $special: the special page object
2081 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
2082 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2084 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
2085 &$conds: array of WHERE conditionals for query
2086 &$tables: array of tables to be queried
2087 &$join_conds: join conditions for the tables
2088 &$fields: array of query fields
2090 '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.
2091 $request: WebRequest
2092 $title: Title of the currently found title obj
2093 $output: OutputPage object
2095 'TitleArrayFromResult': called when creating an TitleArray object from a
2097 &$titleArray: set this to an object to override the default object returned
2098 $res: database result used to create the object
2100 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2101 that can be applied.
2102 $title: The title in question.
2103 &$types: The types of protection available.
2105 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
2106 $title: Title object that is being checked
2107 $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()
2109 'TitleIsAlwaysKnown': Called when determining if a page exists.
2110 Allows overriding default behaviour for determining if a page exists.
2111 If $isKnown is kept as null, regular checks happen. If it's a boolean, this value is returned by the isKnown method.
2112 $title: Title object that is being checked
2113 $result: Boolean|null; whether MediaWiki currently thinks this page is known
2115 'TitleIsMovable': Called when determining if it is possible to move a page.
2116 Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
2117 $title: Title object that is being checked
2118 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
2120 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2121 be handled by seperate handler (via ArticleViewCustom)
2122 $title: Title object that is being checked
2123 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
2125 'TitleMoveComplete': after moving an article (title)
2128 $user: user who did the move
2129 $pageid: database ID of the page that's been moved
2130 $redirid: database ID of the created redirect
2132 'TitleReadWhitelist': called at the end of read permissions checks, just before
2133 adding the default error message if nothing allows the user to read the page.
2134 If a handler wants a title to *not* be whitelisted, it should also return false.
2135 $title: Title object being checked against
2136 $user: Current user object
2137 &$whitelisted: Boolean value of whether this title is whitelisted
2139 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
2140 PageArchive object has been created but before any further processing is done.
2141 &$archive: PageArchive object
2142 $title: Title object of the page that we're viewing
2144 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
2145 PageArchive object has been created but before any further processing is done.
2146 &$archive: PageArchive object
2147 $title: Title object of the page that we're viewing
2149 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
2150 the site is not in read-only mode, that the Title object is not null and after
2151 a PageArchive object has been constructed but before performing any further
2153 &$archive: PageArchive object
2154 $title: Title object of the page that we're about to undelete
2156 'UndeleteShowRevision': called when showing a revision in Special:Undelete
2157 $title: title object related to the revision
2158 $rev: revision (object) that will be viewed
2160 'UnknownAction': An unknown "action" has occured (useful for defining
2162 $action: action name
2163 $article: article "acted on"
2165 'UnitTestsList': Called when building a list of files with PHPUnit tests
2166 &$files: list of files
2168 'UnwatchArticle': before a watch is removed from an article
2169 $user: user watching
2170 $page: WikiPage object to be removed
2172 'UnwatchArticleComplete': after a watch is removed from an article
2173 $user: user that watched
2174 $page: WikiPage object that was watched
2176 'UploadForm:initial': before the upload form is generated
2177 $form: UploadForm object
2178 You might set the member-variables $uploadFormTextTop and
2179 $uploadFormTextAfterSummary to inject text (HTML) either before
2180 or after the editform.
2182 'UploadForm:BeforeProcessing': at the beginning of processUpload()
2183 $form: UploadForm object
2184 Lets you poke at member variables like $mUploadDescription before the
2186 Do not use this hook to break upload processing. This will return the user to
2187 a blank form with no error message; use UploadVerification and
2188 UploadVerifyFile instead
2190 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
2191 $type: (string) the requested upload type
2192 &$className: the class name of the Upload instance to be created
2194 'UploadComplete': when Upload completes an upload
2195 &$upload: an UploadBase child instance
2197 'UploadFormInitDescriptor': after the descriptor for the upload form as been
2199 $descriptor: (array) the HTMLForm descriptor
2201 'UploadFormSourceDescriptors': after the standard source inputs have been
2202 added to the descriptor
2203 $descriptor: (array) the HTMLForm descriptor
2205 'UploadVerification': additional chances to reject an uploaded file. Consider
2206 using UploadVerifyFile instead.
2207 string $saveName: destination file name
2208 string $tempName: filesystem path to the temporary file for checks
2209 string &$error: output: message key for message to show if upload canceled
2210 by returning false. May also be an array, where the first element
2211 is the message key and the remaining elements are used as parameters to
2214 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2215 in most cases over UploadVerification.
2216 object $upload: an instance of UploadBase, with all info about the upload
2217 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
2218 will typically only apply for specific mime types.
2219 object &$error: output: true if the file is valid. Otherwise, an indexed array
2220 representing the problem with the file, where the first element
2221 is the message key and the remaining elements are used as parameters to
2224 'UploadComplete': Upon completion of a file upload
2225 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2226 $uploadBase->getLocalFile().
2228 'User::mailPasswordInternal': before creation and mailing of a user's new
2230 $user: the user who sent the message out
2231 $ip: IP of the user who sent the message out
2232 $u: the account whose new password will be set
2234 'UserAddGroup': called when adding a group; return false to override
2235 stock group addition.
2236 $user: the user object that is to have a group added
2237 &$group: the group to add, can be modified
2239 'UserArrayFromResult': called when creating an UserArray object from a
2241 &$userArray: set this to an object to override the default object returned
2242 $res: database result used to create the object
2244 'userCan': To interrupt/advise the "user can do X to Y article" check.
2245 If you want to display an error message, try getUserPermissionsErrors.
2246 $title: Title object being checked against
2247 $user : Current user object
2248 $action: Action being checked
2249 $result: Pointer to result returned if hook returns false. If null is returned,
2250 userCan checks are continued by internal code.
2252 'UserCanSendEmail': To override User::canSendEmail() permission check
2253 $user: User (object) whose permission is being checked
2254 &$canSend: bool set on input, can override on output
2256 'UserClearNewTalkNotification': called when clearing the
2257 "You have new messages!" message, return false to not delete it
2258 $user: User (object) that'll clear the message
2260 'UserComparePasswords': called when checking passwords, return false to
2261 override the default password checks
2262 &$hash: String of the password hash (from the database)
2263 &$password: String of the plaintext password the user entered
2264 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2266 &$result: If the hook returns false, this Boolean value will be checked to
2267 determine if the password was valid
2269 'UserCreateForm': change to manipulate the login form
2270 $template: SimpleTemplate instance for the form
2272 'UserCryptPassword': called when hashing a password, return false to implement
2273 your own hashing method
2274 &$password: String of the plaintext password to encrypt
2275 &$salt: String of the password salt or Boolean false if no salt is provided
2276 &$wgPasswordSalt: Boolean of whether the salt is used in the default
2278 &$hash: If the hook returns false, this String will be used as the hash
2280 'UserEffectiveGroups': Called in User::getEffectiveGroups()
2281 $user: User to get groups for
2282 &$groups: Current effective groups
2284 'UserGetAllRights': after calculating a list of all available rights
2285 &$rights: Array of rights, which may be added to.
2287 'UserGetDefaultOptions': after fetching the core default, this hook is ran
2288 right before returning the options to the caller. WARNING: this hook is
2289 called for every call to User::getDefaultOptions(), which means it's
2290 potentially called dozens or hundreds of times. You may want to cache
2291 the results of non-trivial operations in your hook function for this reason.
2292 &$defaultOptions: Array of preference keys and their default values.
2294 'UserGetEmail': called when getting an user email address
2296 &$email: email, change this to override local email
2298 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
2299 email authentification
2301 &$timestamp: timestamp, change this to override local email authentification
2304 'UserGetImplicitGroups': Called in User::getImplicitGroups()
2305 &$groups: List of implicit (automatically-assigned) groups
2307 'UserGetLanguageObject': Called when getting user's interface language object
2309 &$code: Langauge code that will be used to create the object
2311 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2312 &$reservedUsernames: $wgReservedUsernames
2314 'UserGetRights': Called in User::getRights()
2315 $user: User to get rights for
2316 &$rights: Current rights
2318 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
2320 $user: User in question
2321 $title: Title of the page in question
2322 &$blocked: Out-param, whether or not the user is blocked from that page.
2323 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2324 own user talk pages.
2326 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2328 $ip: User's IP address
2329 &$blocked: Whether the user is blocked, to be modified by the hook
2331 'UserLoadAfterLoadFromSession': called to authenticate users on
2332 external/environmental means; occurs after session is loaded
2333 $user: user object being loaded
2335 'UserLoadDefaults': called when loading a default user
2339 'UserLoadFromDatabase': called when loading a user from the database
2341 &$s: database query object
2343 'UserLoadFromSession': called to authenticate users on external/environmental
2344 means; occurs before session is loaded
2345 $user: user object being loaded
2346 &$result: set this to a boolean value to abort the normal authentification
2349 'UserLoadOptions': when user options/preferences are being loaded from
2352 &$options: Options, can be modified.
2354 'UserLoginComplete': after a user has logged in
2355 $user: the user object that was created on login
2356 $inject_html: Any HTML to inject after the "logged in" message.
2358 'UserLoginForm': change to manipulate the login form
2359 $template: SimpleTemplate instance for the form
2361 'UserLogout': before a user logs out
2362 $user: the user object that is about to be logged out
2364 'UserLogoutComplete': after a user has logged out
2365 $user: the user object _after_ logout (won't have name, ID, etc.)
2366 $inject_html: Any HTML to inject after the "logged out" message.
2367 $oldName: name of the user before logout (string)
2369 'UserRemoveGroup': called when removing a group; return false to override
2370 stock group removal.
2371 $user: the user object that is to have a group removed
2372 &$group: the group to be removed, can be modified
2374 'UserRights': After a user's group memberships are changed
2375 $user : User object that was changed
2376 $add : Array of strings corresponding to groups added
2377 $remove: Array of strings corresponding to groups removed
2379 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2381 $user: user retrieving new talks messages
2382 $talks: array of new talks page(s)
2384 'UserSaveSettings': called when saving user settings
2387 'UserSaveOptions': Called just before saving user preferences/options.
2389 &$options: Options, modifiable
2391 'UserSetCookies': called when setting user cookies
2393 &$session: session array, will be added to $_SESSION
2394 &$cookies: cookies array mapping cookie name to its value
2396 'UserSetEmail': called when changing user email address
2398 &$email: new email, change this to override new email address
2400 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2401 of email authentification
2403 &$timestamp: new timestamp, change this to override local email
2404 authentification timestamp
2406 'UserToolLinksEdit': Called when generating a list of user tool links, eg "Foobar (Talk | Contribs | Block)"
2407 $userId: User id of the current user
2408 $userText: User name of the current user
2409 &$items: Array of user tool links as HTML fragments
2411 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2412 used to alter the SQL query which gets the list of wanted pages
2413 &$wantedPages: WantedPagesPage object
2414 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2416 'WatchArticle': before a watch is added to an article
2417 $user: user that will watch
2418 $page: WikiPage object to be watched
2420 'WatchArticleComplete': after a watch is added to an article
2421 $user: user that watched
2422 $page: WikiPage object watched
2424 'WatchlistEditorBuildRemoveLine': when building remove lines in
2425 Special:Watchlist/edit
2426 &$tools: array of extra links
2427 $title: Title object
2428 $redirect: whether the page is a redirect
2431 'WebRequestPathInfoRouter': While building the PathRouter to parse the REQUEST_URI.
2432 $router: The PathRouter instance
2434 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2436 One, and only one hook should set this, and return false.
2437 &$tables: Database tables to use in the SELECT query
2438 &$opts: Options to use for the query
2439 &$join: Join conditions
2441 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2442 a page is deleted. Called in WikiPage::getDeletionUpdates().
2443 Note that updates specific to a content model should be provided by the
2444 respective Content's getDeletionUpdates() method.
2446 $content: the Content to generate updates for
2447 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2449 'wfShellWikiCmd': Called when generating a shell-escaped command line
2450 string to run a MediaWiki cli script.
2451 &$script: MediaWiki cli script path
2452 &$parameters: Array of arguments and options to the script
2453 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2456 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2457 query pages to be updated with maintenance/updateSpecialPages.php
2458 $query: $wgQueryPages itself
2460 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2461 metadata to be added.
2462 $obj: The XmlDumpWriter object.
2463 &$out: The output string.
2464 $row: The database row for the page.
2465 $title: The title of the page.
2467 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2469 $obj: The XmlDumpWriter object.
2470 &$out: The text being output.
2471 $row: The database row for the revision.
2472 $text: The revision text.
2474 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2475 additional tags to extract.
2476 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2478 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2479 used to post-process the results.
2480 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2481 metadata tags returned (each tag is either a value, or an array of values).
2483 More hooks might be available but undocumented, you can execute
2484 ./maintenance/findhooks.php to find hidden one.