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