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,
238 where normally authentication against an external auth plugin would be creating
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
254 'AbortLogin': Return false to cancel account login.
255 $user: the User object being authenticated against
256 $password: the password being submitted, not yet checked for validity
257 &$retval: a LoginForm class constant to return from authenticateUserData();
258 default is LoginForm::ABORTED. Note that the client may be using
259 a machine API rather than the HTML user interface.
260 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
262 'AbortMove': Allows to abort moving an article (title).
265 $user: user who is doing the move
267 $reason: the reason for the move (added in 1.13)
269 'AbortNewAccount': Return false to cancel explicit account creation.
270 $user: the User object about to be created (read-only, incomplete)
271 &$msg: out parameter: HTML to display on abort
273 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
274 $name: name of the action
275 &$form: HTMLForm object
276 $article: Article object
278 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
279 Allows to change the fields on the form that will be generated.
280 $name: name of the action
281 &$fields: HTMLForm descriptor array
282 $article: Article object
284 'AddNewAccount': After a user account is created.
285 $user: the User object that was created. (Parameter added in 1.7)
286 $byEmail: true when account was created "by email" (added in 1.12)
288 'AfterFinalPageOutput': At the end of OutputPage::output() but before final
289 ob_end_flush() which will send the buffered output to the client. This allows
290 for last-minute modification of the output within the buffer by using
292 &$output: OutputPage object
294 'AfterImportPage': When a page import is completed.
295 $title: Title under which the revisions were imported
296 $origTitle: Title provided by the XML file
297 $revCount: Number of revisions in the XML file
298 $sRevCount: Number of successfully imported revisions
299 $pageInfo: associative array of page information
301 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
302 before OutputPage::sendCacheControl() and final ob_end_flush() which
303 will send the buffered output to the client. This allows for last-minute
304 modification of the output within the buffer by using ob_get_clean().
305 $output: The OutputPage object where output() was called
307 'AjaxAddScript': Called in output page just before the initialisation
308 of the javascript ajax engine. The hook is only called when ajax
309 is enabled ( $wgUseAjax = true; ).
310 &$output: OutputPage object
312 'AlternateEdit': Before checking if a user can edit a page and before showing
313 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
314 $editPage: the EditPage object
316 'AlternateEditPreview': Before generating the preview of the page when editing
317 ( EditPage::getPreviewText() ).
318 $editPage: the EditPage object
319 &$content: the Content object for the text field from the edit page
320 &$previewHTML: Text to be placed into the page for the preview
321 &$parserOutput: the ParserOutput object for the preview
322 return false and set $previewHTML and $parserOutput to output custom page
325 'AlternateUserMailer': Called before mail is sent so that mail could be logged
326 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
327 the regular method of sending mail. Return a string to return a php-mail-error
328 message containing the error. Returning true will continue with sending email
330 $headers: Associative array of headers for the email
331 $to: MailAddress object or array
333 $subject: Subject of the email
334 $body: Body of the message
336 'APIAfterExecute': After calling the execute() method of an API module. Use
337 this to extend core API modules.
338 &$module: Module object
340 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
341 authenticate and authorize API clients before executing the module. Return
342 false and set a message to cancel the request.
343 $module: Module object
345 &$message: API usage message to die with, as a message key or array
346 as accepted by ApiBase::dieUsageMsg.
348 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
349 processing request parameters. Return false to let the request fail, returning
350 an error message or an <edit result="Failure"> tag if $resultArr was filled.
351 $editPage : the EditPage object
352 $text : the new text of the article (has yet to be saved)
353 &$resultArr : data in this array will be added to the API result
355 'APIGetAllowedParams': Use this hook to modify a module's parameters.
356 &$module: ApiBase Module object
357 &$params: Array of parameters
358 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
360 'APIGetDescription': Use this hook to modify a module's description.
361 &$module: ApiBase Module object
362 &$desc: Array of descriptions
364 'APIGetParamDescription': Use this hook to modify a module's parameter
366 &$module: ApiBase Module object
367 &$desc: Array of parameter descriptions
369 'APIGetResultProperties': Use this hook to modify the properties in a module's
371 &$module: ApiBase Module object
372 &$properties: Array of properties
374 'APIQueryAfterExecute': After calling the execute() method of an
375 action=query submodule. Use this to extend core API modules.
376 &$module: Module object
378 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
379 an action=query submodule. Use this to extend core API modules.
380 &$module: Module object
381 &$resultPageSet: ApiPageSet object
383 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
384 token has an action, which will be used in the intoken parameter and in the
385 output (actiontoken="..."), and a callback function which should return the
386 token, or false if the user isn't allowed to obtain it. The prototype of the
387 callback function is func($pageid, $title), where $pageid is the page ID of the
388 page the token is requested for and $title is the associated Title object. In
389 the hook, just add your callback to the $tokenFunctions array and return true
390 (returning false makes no sense).
391 $tokenFunctions: array(action => callback)
393 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
394 Every token has an action, which will be used in the rvtoken parameter and in
395 the output (actiontoken="..."), and a callback function which should return the
396 token, or false if the user isn't allowed to obtain it. The prototype of the
397 callback function is func($pageid, $title, $rev), where $pageid is the page ID
398 of the page associated to the revision the token is requested for, $title the
399 associated Title object and $rev the associated Revision object. In the hook,
400 just add your callback to the $tokenFunctions array and return true (returning
401 false makes no sense).
402 $tokenFunctions: array(action => callback)
404 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
405 list=recentchanges. Every token has an action, which will be used in the rctoken
406 parameter and in the output (actiontoken="..."), and a callback function which
407 should return the token, or false if the user isn't allowed to obtain it. The
408 prototype of the callback function is func($pageid, $title, $rc), where $pageid
409 is the page ID of the page associated to the revision the token is requested
410 for, $title the associated Title object and $rc the associated RecentChange
411 object. In the hook, just add your callback to the $tokenFunctions array and
412 return true (returning false makes no sense).
413 $tokenFunctions: array(action => callback)
415 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
416 sites general information.
417 $module: the current ApiQuerySiteInfo module
418 &$results: array of results, add things here
420 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
421 token has an action, which will be used in the ustoken parameter and in the
422 output (actiontoken="..."), and a callback function which should return the
423 token, or false if the user isn't allowed to obtain it. The prototype of the
424 callback function is func($user) where $user is the User object. In the hook,
425 just add your callback to the $tokenFunctions array and return true (returning
426 false makes no sense).
427 $tokenFunctions: array(action => callback)
429 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
430 an exception is thrown during API action execution.
431 $apiMain: Calling ApiMain instance.
432 $e: Exception object.
434 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
435 should have its own entry in the $apis array and have a unique name, passed as
436 key for the array that represents the service data. In this data array, the
437 key-value-pair identified by the apiLink key is required.
438 &$apis: array of services
440 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
442 &$tokenTypes: supported token types in format 'type' => callback function
443 used to retrieve this type of tokens.
445 'ArticleAfterFetchContent': After fetching content of an article from the
446 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
447 $article: the article (object) being loaded from the database
448 &$content: the content (string) of the article
450 'ArticleAfterFetchContentObject': After fetching content of an article from the
452 $article: the article (object) being loaded from the database
453 &$content: the content of the article, as a Content object
455 'ArticleConfirmDelete': Before writing the confirmation form for article
457 $article: the article (object) being deleted
458 $output: the OutputPage object
459 &$reason: the reason (string) the article is being deleted
461 'ArticleContentOnDiff': Before showing the article content below a diff. Use
462 this to change the content in this area or how it is loaded.
463 $diffEngine: the DifferenceEngine
464 $output: the OutputPage object
466 'ArticleDelete': Before an article is deleted.
467 $wikiPage: the WikiPage (object) being deleted
468 $user: the user (object) deleting the article
469 $reason: the reason (string) the article is being deleted
470 $error: if the deletion was prohibited, the (raw HTML) error message to display
472 $status: Status object, modify this to throw an error. Overridden by $error
475 'ArticleDeleteComplete': After an article is deleted.
476 $wikiPage: the WikiPage that was deleted
477 $user: the user that deleted the article
478 $reason: the reason the article was deleted
479 $id: id of the article that was deleted
480 $content: the Content of the deleted page
481 $logEntry: the ManualLogEntry used to record the deletion
483 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
485 $wikiPage: WikiPage (object) of the user talk page
487 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
488 article has been changed.
489 $wikiPage: the WikiPage (object)
490 $editInfo: data holder that includes the parser output ($editInfo->output) for
491 that page after the change
492 $changed: bool for if the page was changed
494 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
495 recentchanges table, return false to not delete old entries.
496 $wikiPage: WikiPage (object) being modified
498 'ArticleFromTitle': when creating an article object from a title object using
499 Wiki::articleFromTitle().
500 $title: Title (object) used to create the article object
501 $article: Article (object) that will be returned
503 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
504 PageContentInsertComplete.
505 $wikiPage: WikiPage created
506 $user: User creating the article
508 $summary: Edit summary/comment
509 $isMinor: Whether or not the edit was marked as minor
510 $isWatch: (No longer used)
511 $section: (No longer used)
512 $flags: Flags passed to WikiPage::doEditContent()
513 $revision: New Revision of the article
515 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
516 $targetTitle: target title (object)
517 $destTitle: destination title (object)
519 'ArticlePageDataAfter': After loading data of an article from the database.
520 $wikiPage: WikiPage (object) whose data were loaded
521 $row: row (object) returned from the database server
523 'ArticlePageDataBefore': Before loading data of an article from the database.
524 $wikiPage: WikiPage (object) that data will be loaded
525 $fields: fields (array) to load from the database
527 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
528 $wikiPage: the WikiPage being saved
529 $popts: parser options to be used for pre-save transformation
531 'ArticleProtect': Before an article is protected.
532 $wikiPage: the WikiPage being protected
533 $user: the user doing the protection
534 $protect: boolean whether this is a protect or an unprotect
535 $reason: Reason for protect
536 $moveonly: boolean whether this is for move only or not
538 'ArticleProtectComplete': After an article is protected.
539 $wikiPage: the WikiPage that was protected
540 $user: the user who did the protection
541 $protect: boolean whether it was a protect or an unprotect
542 $reason: Reason for protect
543 $moveonly: boolean whether it was for move only or not
545 'ArticlePurge': Before executing "&action=purge".
546 $wikiPage: WikiPage (object) to purge
548 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
549 revisions of an article.
550 &$title: Title object of the article
552 'ArticleRevisionUndeleted': After an article revision is restored.
553 $title: the article title
554 $revision: the revision
555 $oldPageID: the page ID of the revision when archived (may be null)
557 'ArticleRollbackComplete': After an article rollback is completed.
558 $wikiPage: the WikiPage that was edited
559 $user: the user who did the rollback
560 $revision: the revision the page was reverted back to
561 $current: the reverted revision
563 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
565 $wikiPage: the WikiPage (object) being saved
566 $user: the user (object) saving the article
567 $text: the new article text
568 $summary: the article summary (comment)
573 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
574 PageContentSaveComplete instead.
575 $wikiPage: WikiPage modified
576 $user: User performing the modification
578 $summary: Edit summary/comment
579 $isMinor: Whether or not the edit was marked as minor
580 $isWatch: (No longer used)
581 $section: (No longer used)
582 $flags: Flags passed to WikiPage::doEditContent()
583 $revision: New Revision of the article
584 $status: Status object about to be returned by doEditContent()
585 $baseRevId: the rev ID (or false) this edit was based on
587 'ArticleUndelete': When one or more revisions of an article are restored.
588 $title: Title corresponding to the article restored
589 $create: Whether or not the restoration caused the page to be created (i.e. it
590 didn't exist before).
591 $comment: The comment associated with the undeletion.
593 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
594 $pageArchive: the PageArchive object
595 &$logEntry: ManualLogEntry object
596 $user: User who is performing the log action
598 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
599 the user is redirected back to the page.
600 &$article: the article
601 &$sectionanchor: The section anchor link (e.g. "#overview" )
602 &$extraq: Extra query parameters which can be added via hooked functions
604 'ArticleViewFooter': After showing the footer section of an ordinary page view
605 $article: Article object
607 'ArticleViewHeader': Before the parser cache is about to be tried for article
609 &$article: the article
610 &$pcache: whether to try the parser cache or not
611 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
612 object to both indicate that the output is done and what parser output was used.
614 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
615 redirect was followed.
616 $article: target article (object)
618 'ArticleViewCustom': Allows to output the text of the article in a different
619 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
620 that it is preferable to implement proper handing for a custom data type using
621 the ContentHandler facility.
622 $text: text of the page
623 $title: title of the page
624 $output: reference to $wgOut
626 'ArticleContentViewCustom': Allows to output the text of the article in a
627 different format than wikitext. Note that it is preferable to implement proper
628 handing for a custom data type using the ContentHandler facility.
629 $content: content of the page, as a Content object
630 $title: title of the page
631 $output: reference to $wgOut
633 'AuthPluginAutoCreate': Called when creating a local account for an user logged
634 in from an external authentication method.
635 $user: User object created locally
637 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
638 Gives a chance for an extension to set it programmatically to a variable class.
639 &$auth: the $wgAuth object, probably a stub
641 'AutopromoteCondition': Check autopromote condition for user.
642 $type: condition type
645 $result: result of checking autopromote condition
647 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
651 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
652 certain title are fetched.
654 $title: title of the page to which backlinks are sought
655 &$conds: query conditions
657 'BadImage': When checking against the bad image list. Change $bad and return
658 false to override. If an image is "bad", it is not rendered inline in wiki
659 pages or galleries in category pages.
660 $name: Image name being checked
661 &$bad: Whether or not the image is "bad"
663 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
664 "noarticletext-nopermission" at Article::showMissingArticle().
665 $article: article object
667 'BeforeInitialize': Before anything is initialized in
668 MediaWiki::performRequest().
669 &$title: Title being used for request
671 &$output: OutputPage object
673 $request: WebRequest object
674 $mediaWiki: Mediawiki object
676 'BeforePageDisplay': Prior to outputting a page.
677 &$out: OutputPage object
680 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
681 override how the redirect is output by modifying, or by returning false and
682 taking over the output.
683 $out: OutputPage object
684 &$redirect: URL, modifiable
685 &$code: HTTP code (eg '301' or '302'), modifiable
687 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
688 $parser: Parser object
690 &$options: array of options to RepoGroup::findFile
691 &$descQuery: query string to add to thumbnail URL
693 FIXME: Where does the below sentence fit in?
694 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
696 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
697 $parser: Parser object
698 $title: title of the template
699 &$skip: skip this template and link it?
700 &$id: the id of the revision being parsed
702 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
703 &$parser: Parser object
704 &$ig: ImageGallery object
706 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
708 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
709 to a newly created user account.
710 &$injected_html: Any HTML to inject after the "logged in" message of a newly
713 'BitmapHandlerTransform': before a file is transformed, gives extension the
714 possibility to transform it themselves
715 $handler: BitmapHandler
717 &$scalerParams: Array with scaler parameters
718 &$mto: null, set to a MediaTransformOutput
720 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
721 normalizations have been performed, except for the $wgMaxImageArea check.
723 &$params: Array of parameters
724 &$checkImageAreaHookResult: null, set to true or false to override the
725 $wgMaxImageArea check result.
727 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
729 $block: Block object (which is set to be autoblocking)
730 &$blockIds: Array of block IDs of the autoblock
732 'BlockIp': Before an IP address or user is blocked.
733 $block: the Block object about to be saved
734 $user: the user _doing_ the block (not the one being blocked)
736 'BlockIpComplete': After an IP address or user is blocked.
737 $block: the Block object that was saved
738 $user: the user who did the block (not the one being blocked)
740 'BookInformation': Before information output on Special:Booksources.
741 $isbn: ISBN to show information for
742 $output: OutputPage object in use
744 'CanonicalNamespaces': For extensions adding their own namespaces or altering
746 &$namespaces: Array of namespace numbers with corresponding canonical names
748 'CategoryAfterPageAdded': After a page is added to a category.
749 $category: Category that page was added to
750 $wikiPage: WikiPage that was added
752 'CategoryAfterPageRemoved': After a page is removed from a category.
753 $category: Category that page was removed from
754 $wikiPage: WikiPage that was removed
756 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
757 $catpage: CategoryPage instance
759 'ChangePasswordForm': For extensions that need to add a field to the
760 ChangePassword form via the Preferences form.
761 &$extraFields: An array of arrays that hold fields like would be passed to the
764 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
765 &$changesList: ChangesList instance.
766 &$articlelink: HTML of link to article (already filled-in).
767 &$s: HTML of row that is being constructed.
768 &$rc: RecentChange instance.
769 $unpatrolled: Whether or not we are showing unpatrolled changes.
770 $watched: Whether or not the change is watched by the user.
772 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
773 $collationName: Name of the collation in question
774 &$collationObject: Null. Replace with a subclass of the Collation class that
775 implements the collation given in $collationName.
777 'ConfirmEmailComplete': Called after a user's email has been confirmed
779 $user: user (object) whose email is being confirmed
781 'ContentHandlerDefaultModelFor': Called when the default content model is determined
782 for a given title. May be used to assign a different model for that title.
783 $title: the Title in question
784 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
786 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
787 content model name, but no entry for that model exists in $wgContentHandlers.
788 $modeName: the requested content model name
789 &$handler: set this to a ContentHandler object, if desired.
791 'ConvertContent': Called by AbstractContent::convert when a conversion to another
792 content model is requested.
793 $content: The Content object to be converted.
794 $toModel: The ID of the content model to convert to.
795 $lossy: boolean indicating whether lossy conversion is allowed.
796 &$result: Output parameter, in case the handler function wants to provide a
797 converted Content object. Note that $result->getContentModel() must return $toModel.
798 Handler functions that modify $result should generally return false to further
799 attempts at conversion.
801 'ContribsPager::getQueryInfo': Before the contributions query is about to run
802 &$pager: Pager object for contributions
803 &$queryInfo: The query for the contribs Pager
805 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
806 &$data: an array of results of all contribs queries
807 $pager: The ContribsPager object hooked into
808 $offset: Index offset, inclusive
809 $limit: Exact query limit
810 $descending: Query direction, false for ascending, true for descending
812 'ContributionsLineEnding': Called before a contributions HTML line is finished
813 $page: SpecialPage object for contributions
815 $row: the DB row for this line
816 &$classes: the classes to add to the surrounding <li>
818 'ContributionsToolLinks': Change tool links above Special:Contributions
820 $title: User page title
821 &$tools: Array of tool links
823 'CustomEditor': When invoking the page editor
824 $article: Article being edited
825 $user: User performing the edit
827 Return true to allow the normal editor to be used, or false
828 if implementing a custom editor, e.g. for a special namespace,
831 'DatabaseOraclePostInit': Called after initialising an Oracle database
832 &$db: the DatabaseOracle object
834 'Debug': Called when outputting a debug log line via wfDebug() or wfDebugLog()
835 $text: plaintext string to be output
836 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
838 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
839 $title: the diff page title (nullable)
840 &$oldId: the actual old Id to use in the diff
841 &$newId: the actual new Id to use in the diff (0 means current)
842 $old: the ?old= param value from the url
843 $new: the ?new= param value from the url
845 'DiffViewHeader': Called before diff display
846 $diff: DifferenceEngine object that's calling
847 $oldRev: Revision object of the "old" revision (may be null/invalid)
848 $newRev: Revision object of the "new" revision
850 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
852 $article: article (object) being viewed
853 $oldid: oldid (int) being viewed
855 'DoEditSectionLink': Override the HTML generated for section edit links
856 $skin: Skin object rendering the UI
857 $title: Title object for the title being linked to (may not be the same as
858 $wgTitle, if the section is included from a template)
859 $section: The designation of the section being pointed to, to be included in
860 the link, like "§ion=$section"
861 $tooltip: The default tooltip. Escape before using.
862 By default, this is wrapped in the 'editsectionhint' message.
863 &$result: The HTML to return, prefilled with the default plus whatever other
864 changes earlier hooks have made
865 $lang: The language code to use for the link in the wfMessage function
867 'EditFilter': Perform checks on an edit
868 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
869 $text: Contents of the edit box
870 $section: Section being edited
871 &$error: Error message to return
872 $summary: Edit summary for page
874 'EditFilterMerged': Post-section-merge edit filter.
875 DEPRECATED, use EditFilterMergedContent instead.
876 $editor: EditPage instance (object)
877 $text: content of the edit box
878 &$error: error message to return
879 $summary: Edit summary for page
881 'EditFilterMergedContent': Post-section-merge edit filter.
882 This may be triggered by the EditPage or any other facility that modifies page content.
883 Use the $status object to indicate whether the edit should be allowed, and to provide
884 a reason for disallowing it. Return false to abort the edit, and true to continue.
885 Returning true if $status->isOK() returns false means "don't save but continue user
886 interaction", e.g. show the edit form.
887 $context: object implementing the IContextSource interface.
888 $content: content of the edit box, as a Content object.
889 $status: Status object to represent errors, etc.
890 $summary: Edit summary for page
891 $user: the User object representing the user whois performing the edit.
892 $minoredit: whether the edit was marked as minor by the user.
894 'EditFormPreloadText': Allows population of the edit form when creating
896 &$text: Text to preload with
897 &$title: Title object representing the page being created
899 'EditFormInitialText': Allows modifying the edit form when editing existing
901 $editPage: EditPage object
903 'EditPage::attemptSave': Called before an article is
904 saved, that is before WikiPage::doEditContent() is called
905 $editpage_Obj: the current EditPage object
907 'EditPage::importFormData': allow extensions to read additional data
909 $editpage: EditPage instance
911 return value is ignored (should always return true)
913 'EditPage::showEditForm:fields': allows injection of form field into edit form
914 $editor: the EditPage instance for reference
915 $out: an OutputPage instance to write to
916 return value is ignored (should always return true)
918 'EditPage::showEditForm:initial': before showing the edit form
919 $editor: EditPage instance (object)
920 $out: an OutputPage instance to write to
922 Return false to halt editing; you'll need to handle error messages, etc.
923 yourself. Alternatively, modifying $error and returning true will cause the
924 contents of $error to be echoed at the top of the edit form as wikitext.
925 Return true without altering $error to allow the edit to proceed.
927 'EditPage::showStandardInputs:options': allows injection of form fields into
929 $editor: EditPage instance (object)
930 $out: an OutputPage instance to write to
931 &$tabindex: HTML tabindex of the last edit check/button
932 return value is ignored (should always be true)
934 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
935 when there's an edit conflict. Return false to halt normal diff output; in
936 this case you're responsible for computing and outputting the entire "conflict"
937 part, i.e., the "difference between revisions" and "your text" headers and
939 &$editor: EditPage instance
940 &$out: OutputPage instance
942 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
943 textarea in the edit form.
944 &$editpage: The current EditPage object
945 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
946 &$tabindex: HTML tabindex of the last edit check/button
948 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
950 &$editpage: The current EditPage object
951 &$checks: Array of edit checks like "watch this page"/"minor edit"
952 &$tabindex: HTML tabindex of the last edit check/button
954 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
955 textarea in the edit form.
956 &$toolbar: The toolbar HTMl
958 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
959 contribution/copyright notice.
960 $title: title of page being edited
961 &$msg: localization message name, overridable. Default is either
962 'copyrightwarning' or 'copyrightwarning2'.
964 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
965 modifying the wikitext that will be used in "Show changes". Note that it is
966 preferable to implement diff handling for different data types using the
967 ContentHandler facility.
968 $editPage: EditPage object
969 &$newtext: wikitext that will be used as "your version"
971 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
972 "Show changes". Note that it is preferable to implement diff handling for
973 different data types using the ContentHandler facility.
974 $editPage: EditPage object
975 &$newtext: wikitext that will be used as "your version"
977 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
978 Allow modifying the wikitext that will be previewed. Note that it is preferable
979 to implement previews for different data types using the ContentHandler
981 $editPage: EditPage object
982 &$toparse: wikitext that will be parsed
984 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
985 previewed. Note that it is preferable to implement previews for different data
986 types using the ContentHandler facility.
987 $editPage: EditPage object
988 &$content: Content object to be previewed (may be replaced by hook function)
990 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
991 &$editpage: The current EditPage object
992 &$res: the HTML of the error text
994 'EditPageTosSummary': Give a chance for site and per-namespace customizations
995 of terms of service summary link that might exist separately from the copyright
997 $title: title of page being edited
998 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1000 'EditSectionLink': Do not use, use DoEditSectionLink instead.
1001 $skin: Skin rendering the UI
1002 $title: Title being linked to
1003 $section: Section to link to
1005 &$result: Result (alter this to override the generated links)
1006 $lang: The language code to use for the link in the wfMessage function
1008 'EmailConfirmed': When checking that the user's email address is "confirmed".
1009 $user: User being checked
1010 $confirmed: Whether or not the email address is confirmed
1011 This runs before the other checks, such as anonymity and the real check; return
1012 true to allow those checks to occur, and false if checking is done.
1014 'EmailUser': Before sending email from one user to another.
1015 $to: address of receiving user
1016 $from: address of sending user
1017 $subject: subject of the mail
1018 $text: text of the mail
1020 'EmailUserCC': Before sending the copy of the email to the author.
1021 $to: address of receiving user
1022 $from: address of sending user
1023 $subject: subject of the mail
1024 $text: text of the mail
1026 'EmailUserComplete': After sending email from one user to another.
1027 $to: address of receiving user
1028 $from: address of sending user
1029 $subject: subject of the mail
1030 $text: text of the mail
1032 'EmailUserForm': After building the email user form object.
1033 $form: HTMLForm object
1035 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1037 $user: The user who is trying to email another user.
1038 $editToken: The user's edit token.
1039 &$hookErr: Out-param for the error. Passed as the parameters to
1040 OutputPage::showErrorPage.
1042 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1044 $ip: The ip address of the user
1046 'ExtensionTypes': Called when generating the extensions credits, use this to
1047 change the tables headers.
1048 &$extTypes: associative array of extensions types
1050 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1051 thumbnail file name.
1052 $thumbname: the base name of the thumbnail file
1053 &$params: the currently extracted params (has source name, temp or archived zone)
1055 'FetchChangesList': When fetching the ChangesList derivative for a particular
1057 $user: User the list is being fetched for
1058 &$skin: Skin object to be used with the list
1059 &$list: List object (defaults to NULL, change it to an object instance and
1060 return false override the list derivative used)
1062 'FileDeleteComplete': When a file is deleted.
1063 $file: reference to the deleted file
1064 $oldimage: in case of the deletion of an old image, the name of the old file
1065 $article: in case all revisions of the file are deleted a reference to the
1066 WikiFilePage associated with the file.
1067 $user: user who performed the deletion
1070 'FileTransformed': When a file is transformed and moved into storage.
1071 $file: reference to the File object
1072 $thumb: the MediaTransformOutput object
1073 $tmpThumbPath: The temporary file system path of the transformed file
1074 $thumbPath: The permanent storage path of the transformed file
1076 'FileUpload': When a file upload occurs.
1077 $file : Image object representing the file that was uploaded
1078 $reupload : Boolean indicating if there was a previously another image there or
1080 $hasDescription : Boolean indicating that there was already a description page
1081 and a new one from the comment wasn't created (since 1.17)
1083 'FileUndeleteComplete': When a file is undeleted
1084 $title: title object to the file
1085 $fileVersions: array of undeleted versions. Empty if all versions were restored
1086 $user: user who performed the undeletion
1089 'FormatAutocomments': When an autocomment is formatted by the Linker.
1090 &$comment: Reference to the accumulated comment. Initially null, when set the
1091 default code will be skipped.
1092 $pre: Initial part of the parsed comment before the call to the hook.
1093 $auto: The extracted part of the parsed comment before the call to the hook.
1094 $post: The final part of the parsed comment before the call to the hook.
1095 $title: An optional title object used to links to sections. Can be null.
1096 $local: Boolean indicating whether section links should refer to local page.
1098 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1100 &$user: user to promote.
1101 &$promote: groups that will be added.
1103 'GetBlockedStatus': after loading blocking status of an user from the database
1104 $user: user (object) being checked
1106 'GetCacheVaryCookies': Get cookies that should vary cache options.
1107 $out: OutputPage object
1108 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1109 that have to vary cache options
1111 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1113 $title: Title object of page
1114 $url: string value as output (out parameter, can modify)
1115 $query: query options passed to Title::getCanonicalURL()
1117 'GetDefaultSortkey': Override the default sortkey for a page.
1118 $title: Title object that we need to get a sortkey for
1119 &$sortkey: Sortkey to use.
1121 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1122 underscore) magic words. Called by MagicWord.
1123 &$doubleUnderscoreIDs: array of strings
1125 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1126 $title: Title object of page
1127 $url: string value as output (out parameter, can modify)
1128 $query: query options passed to Title::getFullURL()
1130 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1131 $title: Title object of page
1132 $url: string value as output (out parameter, can modify)
1133 $query: query options passed to Title::getInternalURL()
1135 'GetIP': modify the ip of the current user (called only once).
1136 &$ip: string holding the ip as determined so far
1138 'GetLinkColours': modify the CSS class of an array of page links.
1139 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1141 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1143 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1144 working with internal urls (non-interwiki) then it may be preferable to work
1145 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1146 be buggy for internal urls on render if you do not re-implement the horrible
1147 hack that Title::getLocalURL uses in your own extension.
1148 $title: Title object of page
1149 &$url: string value as output (out parameter, can modify)
1150 $query: query options passed to Title::getLocalURL()
1152 'GetLocalURL::Internal': Modify local URLs to internal pages.
1153 $title: Title object of page
1154 &$url: string value as output (out parameter, can modify)
1155 $query: query options passed to Title::getLocalURL()
1157 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1158 without any fancy queries or variants.
1159 $title: Title object of page
1160 &$url: string value as output (out parameter, can modify)
1162 'GetMetadataVersion': Modify the image metadata version currently in use. This
1163 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1164 that need to have versioned metadata should add an element to the end of the
1165 version array of the form 'handler_name=version'. Most media handlers won't need
1166 to do this unless they broke backwards compatibility with a previous version of
1167 the media handler metadata output.
1168 &$version: Array of version strings
1170 'GetPreferences': Modify user preferences.
1171 $user: User whose preferences are being modified.
1172 &$preferences: Preferences description array, to be fed to an HTMLForm object
1174 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1175 checked for. Use instead of userCan for most cases. Return false if the user
1176 can't do it, and populate $result with the reason in the form of
1177 array( messagename, param1, param2, ... ). For consistency, error messages
1178 should be plain text with no special coloring, bolding, etc. to show that
1179 they're errors; presenting them properly to the user as errors is done by the
1181 $title: Title object being checked against
1182 $user : Current user object
1183 $action: Action being checked
1184 $result: User permissions error to add. If none, return true.
1186 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1187 called only if expensive checks are enabled. Add a permissions error when
1188 permissions errors are checked for. Return false if the user can't do it, and
1189 populate $result with the reason in the form of array( messagename, param1,
1190 param2, ... ). For consistency, error messages should be plain text with no
1191 special coloring, bolding, etc. to show that they're errors; presenting them
1192 properly to the user as errors is done by the caller.
1194 $title: Title object being checked against
1195 $user : Current user object
1196 $action: Action being checked
1197 $result: User permissions error to add. If none, return true.
1199 'GitViewers': Called when generating the list of git viewers for
1200 Special:Version, use this to change the list.
1201 &$extTypes: associative array of repo URLS to viewer URLs.
1203 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1204 image insertion. You can skip the default logic entirely by returning false, or
1205 just modify a few things using call-by-reference.
1207 &$title: Title object of the image
1208 &$file: File object, or false if it doesn't exist
1209 &$frameParams: Various parameters with special meanings; see documentation in
1210 includes/Linker.php for Linker::makeImageLink
1211 &$handlerParams: Various parameters with special meanings; see documentation in
1212 includes/Linker.php for Linker::makeImageLink
1213 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1214 &$res: Final HTML output, used if you return false
1217 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1218 the image on an image page.
1219 $imagePage: ImagePage object ($this)
1222 'ImagePageAfterImageLinks': Called after the image links section on an image
1224 $imagePage: ImagePage object ($this)
1225 &$html: HTML for the hook to add
1227 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1229 $line: the HTML of the history line
1230 $css: the line CSS class
1232 'ImagePageFindFile': Called when fetching the file associated with an image
1234 $page: ImagePage object
1236 &$displayFile: displayed File object
1238 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1239 $page: ImagePage object
1240 &$toc: Array of <li> strings
1242 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1244 &$title: the Title object of the file as it would appear for the upload page
1245 &$path: the original file and path name when img_auth was invoked by the the web
1247 &$name: the name only component of the file
1248 &$result: The location to pass back results of the hook routine (only used if
1250 $result[0]=The index of the header message
1251 $result[1]=The index of the body text message
1252 $result[2 through n]=Parameters passed to body text message. Please note the
1253 header message cannot receive/use parameters.
1255 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1256 $reader: XMLReader object
1257 $logInfo: Array of information
1258 Return false to stop further processing of the tag
1260 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1261 $reader: XMLReader object
1262 $pageInfo: Array of information
1263 Return false to stop further processing of the tag
1265 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1266 $reader: XMLReader object
1267 $pageInfo: Array of page information
1268 $revisionInfo: Array of revision information
1269 Return false to stop further processing of the tag
1271 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1272 $reader: XMLReader object
1273 Return false to stop further processing of the tag
1275 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1276 $reader: XMLReader object
1277 $revisionInfo: Array of information
1278 Return false to stop further processing of the tag
1280 'InfoAction': When building information to display on the action=info page.
1281 $context: IContextSource object
1282 &$pageInfo: Array of information
1284 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1285 $title: Title object ($wgTitle)
1286 $request: WebRequest
1287 $ignoreRedirect: boolean to skip redirect check
1288 $target: Title/string of redirect target
1289 $article: Article object
1291 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1292 Return true without providing an interwiki to continue interwiki search.
1293 $prefix: interwiki prefix we are looking for.
1294 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1295 iw_trans and optionally iw_api and iw_wikiid.
1297 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1298 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1299 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1300 template/parser function execution which respect nowiki and HTML-comments.
1301 &$parser: Parser object
1302 &$text: string containing partially parsed text
1303 &$stripState: Parser's internal StripState object
1305 'InternalParseBeforeLinks': during Parser's internalParse method before links
1306 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1307 &$parser: Parser object
1308 &$text: string containing partially parsed text
1309 &$stripState: Parser's internal StripState object
1311 'InvalidateEmailComplete': Called after a user's email has been invalidated
1313 $user: user (object) whose email is being invalidated
1315 'IRCLineURL': When constructing the URL to use in an IRC notification.
1316 Callee may modify $url and $query, URL will be constructed as $url . $query
1317 &$url: URL to index.php
1318 &$query: Query string
1320 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1321 $article: article (object) being checked
1323 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1325 $result: Change this value to override the result of wfIsTrustedProxy()
1327 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1328 instance to return false if the domain name doesn't match your organization.
1329 $addr: The e-mail address entered by the user
1330 &$result: Set this and return false to override the internal checks
1332 'isValidPassword': Override the result of User::isValidPassword()
1333 $password: The password entered by the user
1334 &$result: Set this and return false to override the internal checks
1335 $user: User the password is being validated for
1337 'Language::getMessagesFileName':
1338 $code: The language code or the language we're looking for a messages file for
1339 &$file: The messages file path, you can override this to change the location.
1341 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1342 remove namespaces. Do not use this hook to add namespaces. Use
1343 CanonicalNamespaces for that.
1344 &$namespaces: Array of namespaces indexed by their numbers
1346 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1347 $wgExtensionMessagesFiles instead.
1348 Use this to define synonyms of magic words depending of the language
1349 $magicExtensions: associative array of magic words synonyms
1350 $lang: language code (string)
1352 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1353 listed in $wgExtensionMessagesFiles instead.
1354 Use to define aliases of special pages names depending of the language
1355 $specialPageAliases: associative array of magic words synonyms
1356 $lang: language code (string)
1358 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1359 &$names: array of language code => language name
1360 $code language of the preferred translations
1362 'LinkBegin': Used when generating internal and interwiki links in
1363 Linker::link(), before processing starts. Return false to skip default
1364 processing and return $ret. See documentation for Linker::link() for details on
1365 the expected meanings of parameters.
1366 $skin: the Skin object
1367 $target: the Title that the link is pointing to
1368 &$html: the contents that the <a> tag should have (raw HTML); null means
1370 &$customAttribs: the HTML attributes that the <a> tag should have, in
1371 associative array form, with keys and values unescaped. Should be merged with
1372 default values, with a value of false meaning to suppress the attribute.
1373 &$query: the query string to add to the generated URL (the bit after the "?"),
1374 in associative array form, with keys and values unescaped.
1375 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1376 &$ret: the value to return if your hook returns false.
1378 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1379 just before the function returns a value. If you return true, an <a> element
1380 with HTML attributes $attribs and contents $html will be returned. If you
1381 return false, $ret will be returned.
1382 $skin: the Skin object
1383 $target: the Title object that the link is pointing to
1384 $options: the options. Will always include either 'known' or 'broken', and may
1385 include 'noclasses'.
1386 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1387 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1388 associative array form.
1389 &$ret: the value to return if your hook returns false.
1391 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1393 &$url: the image url
1394 &$alt: the image's alt text
1395 &$img: the new image HTML (if returning false)
1397 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1400 &$text: the link text
1401 &$link: the new link HTML (if returning false)
1402 &$attribs: the attributes to be applied.
1403 $linkType: The external link type
1405 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1407 &$linksUpdate: the LinksUpdate object
1409 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1410 each link table insert. For example, pagelinks, imagelinks, externallinks.
1411 $linksUpdate: LinksUpdate object
1412 $table: the table to insert links to
1413 $insertions: an array of links to insert
1415 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1416 including delete and insert, has completed for all link tables
1417 &$linksUpdate: the LinksUpdate object
1419 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1420 &$linksUpdate: the LinksUpdate object
1422 'ListDefinedTags': When trying to find all defined tags.
1423 &$tags: The list of tags.
1425 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1426 &updater: A DatabaseUpdater subclass
1428 'LocalFile::getHistory': Called before file history query performed.
1429 $file: the File object
1431 $fields: select fields
1433 $opts: query options
1434 $join_conds: JOIN conditions
1436 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1437 $file: the File object
1438 $archiveName: name of an old file version or false if it's the current one
1440 'LocalisationCacheRecache': Called when loading the localisation data into
1442 $cache: The LocalisationCache object
1443 $code: language code
1444 &$alldata: The localisation data from core and extensions
1446 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1447 Returning false will prevent the string from being added to the OutputPage.
1448 &$s: html string to show for the log extract
1449 $types: String or Array Log types to show
1450 $page: String or Title The page title to show log entries for
1451 $user: String The user who made the log entries
1452 $param: Associative Array with the following additional options:
1453 - lim Integer Limit of items to show, default is 50
1454 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1455 - showIfEmpty boolean Set to false if you don't want any output in case the
1456 loglist is empty if set to true (default), "No matching items in log" is
1457 displayed if loglist is empty
1458 - msgKey Array If you want a nice box with a message, set this to the key of
1459 the message. First element is the message key, additional optional elements
1460 are parameters for the key that are processed with
1461 wfMessage()->params()->parseAsBlock()
1462 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1464 - wrap String Wrap the message in html (usually something like
1465 "<div ...>$1</div>").
1466 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1468 'LoginAuthenticateAudit': A login attempt for a valid user account either
1469 succeeded or failed. No return data is accepted; this hook is for auditing only.
1470 $user: the User object being authenticated against
1471 $password: the password being submitted and found wanting
1472 $retval: a LoginForm class constant with authenticateUserData() return
1473 value (SUCCESS, WRONG_PASS, etc.).
1475 'LogLine': Processes a single log entry on Special:Log.
1476 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1477 logging.log_type database field.
1478 $log_action: string for the type of log action (e.g. 'delete', 'block',
1479 'create2'). Corresponds to logging.log_action database field.
1480 $title: Title object that corresponds to logging.log_namespace and
1481 logging.log_title database fields.
1482 $paramArray: Array of parameters that corresponds to logging.log_params field.
1483 Note that only $paramArray[0] appears to contain anything.
1484 &$comment: string that corresponds to logging.log_comment database field, and
1485 which is displayed in the UI.
1486 &$revert: string that is displayed in the UI, similar to $comment.
1487 $time: timestamp of the log entry (added in 1.12)
1489 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1491 $refreshLinks: RefreshLinks object
1493 'MagicWordwgVariableIDs': When defining new magic words IDs.
1494 $variableIDs: array of strings
1496 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1497 executed. Ideally, this hook should only be used to add variables that depend on
1498 the current page/request; static configuration should be added through
1499 ResourceLoaderGetConfigVars instead.
1500 &$vars: variable (or multiple variables) to be added into the output of
1501 Skin::makeVariablesScript
1502 $out: The OutputPage which called the hook, can be used to get the real title.
1504 'MarkPatrolled': Before an edit is marked patrolled.
1505 $rcid: ID of the revision to be marked patrolled
1506 $user: the user (object) marking the revision as patrolled
1507 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1508 sysop in order to mark an edit patrolled.
1510 'MarkPatrolledComplete': After an edit is marked patrolled.
1511 $rcid: ID of the revision marked as patrolled
1512 $user: user (object) who marked the edit patrolled
1513 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1514 sysop to patrol the edit.
1516 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1517 something completely different, after the basic globals have been set up, but
1518 before ordinary actions take place.
1520 $article: $wgArticle
1523 $request: $wgRequest
1524 $mediaWiki: The $mediawiki object
1526 'MessagesPreLoad': When loading a message from the database.
1527 $title: title of the message (string)
1528 $message: value (string), change it to the message you want to define
1530 'MessageCacheReplace': When a message page is changed. Useful for updating
1532 $title: name of the page changed.
1533 $text: new contents of the page.
1535 'ModifyExportQuery': Modify the query used by the exporter.
1536 $db: The database object to be queried.
1537 &$tables: Tables in the query.
1538 &$conds: Conditions in the query.
1539 &$opts: Options for the query.
1540 &$join_conds: Join conditions for the query.
1542 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1543 links have been rendered (useful for adding more). Note: this is only run for
1544 the Monobook skin. To add items to the toolbox you should use the
1545 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1547 $tools: array of tools
1549 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1550 and returning it for the skin to output. You can add items to the toolbox while
1551 still letting the skin make final decisions on skin-specific markup conventions
1553 &$sk: The BaseTemplate base skin template
1554 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1555 BaseTemplate::makeListItem for details on the format of individual items
1556 inside of this array.
1558 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1560 $index: Integer; the index of the namespace being checked.
1561 $result: Boolean; whether MediaWiki currently thinks that pages in this
1562 namespace are movable. Hooks may change this value to override the return
1563 value of MWNamespace::isMovable().
1565 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1567 $wikiPage: the WikiPage edited
1568 $rev: the new revision
1569 $baseID: the revision ID this was based off, if any
1570 $user: the editing user
1572 'NormalizeMessageKey': Called before the software gets the text of a message
1573 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1575 &$key: the message being looked up. Change this to something else to change
1576 what message gets displayed (string)
1577 &$useDB: whether or not to look up the message in the database (bool)
1578 &$langCode: the language code to get the message for (string) - or -
1579 whether to use the content language (true) or site language (false) (bool)
1580 &$transform: whether or not to expand variables and templates
1581 in the message (bool)
1583 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1584 return false to omit the line from RecentChanges and Watchlist special pages.
1585 &$changeslist: The OldChangesList instance.
1586 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1587 &$rc: The RecentChange object.
1588 &$classes: array of css classes for the <li> element
1590 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1591 can alter or append to the array of URLs for search & suggestion formats.
1592 &$urls: array of associative arrays with Url element attributes
1594 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1595 users and/or IP addresses too.
1596 $otherBlockLink: An array with links to other block logs
1597 $ip: The requested IP address or username
1599 'OutputPageBeforeHTML': A page has been processed by the parser and the
1600 resulting HTML is about to be displayed.
1601 $parserOutput: the parserOutput (object) that corresponds to the page
1602 $text: the text that will be displayed, in HTML (string)
1604 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1605 body tag to allow for extensions to add attributes to the body of the page they
1606 might need. Or to allow building extensions to add body classes that aren't of
1607 high enough demand to be included in core.
1608 $out: The OutputPage which called the hook, can be used to get the real title
1609 $sk: The Skin that called OutputPage::headElement
1610 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1612 'OutputPageCheckLastModified': when checking if the page has been modified
1613 since the last visit.
1614 &$modifiedTimes: array of timestamps.
1615 The following keys are set: page, user, epoch
1617 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1618 $out: OutputPage instance (object)
1619 $parserOutput: parserOutput instance being added in $out
1621 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1622 categories. Implementations should return false if they generate the category
1623 links, so the default link generation is skipped.
1624 $out: OutputPage instance (object)
1625 $categories: associative array, keys are category names, values are category
1626 types ("normal" or "hidden")
1627 $links: array, intended to hold the result. Must be an associative array with
1628 category types as keys and arrays of HTML links as values.
1630 'PageContentInsertComplete': After a new article is created.
1631 $wikiPage: WikiPage created
1632 $user: User creating the article
1633 $content: New content as a Content object
1634 $summary: Edit summary/comment
1635 $isMinor: Whether or not the edit was marked as minor
1636 $isWatch: (No longer used)
1637 $section: (No longer used)
1638 $flags: Flags passed to WikiPage::doEditContent()
1639 $revision: New Revision of the article
1641 'PageContentLanguage': Allows changing the language in which the content of a
1642 page is written. Defaults to the wiki content language ($wgContLang).
1643 $title: Title object
1644 &$pageLang: the page content language (either an object or a language code)
1645 $wgLang: the user language
1647 'PageContentSave': Before an article is saved.
1648 $wikiPage: the WikiPage (object) being saved
1649 $user: the user (object) saving the article
1650 $content: the new article content, as a Content object
1651 $summary: the article summary (comment)
1652 $isminor: minor flag
1653 $iswatch: watch flag
1656 'PageContentSaveComplete': After an article has been updated.
1657 $wikiPage: WikiPage modified
1658 $user: User performing the modification
1659 $content: New content, as a Content object
1660 $summary: Edit summary/comment
1661 $isMinor: Whether or not the edit was marked as minor
1662 $isWatch: (No longer used)
1663 $section: (No longer used)
1664 $flags: Flags passed to WikiPage::doEditContent()
1665 $revision: New Revision of the article
1666 $status: Status object about to be returned by doEditContent()
1667 $baseRevId: the rev ID (or false) this edit was based on
1669 'PageHistoryBeforeList': When a history page list is about to be constructed.
1670 $article: the article that the history is loading for
1672 'PageHistoryLineEnding' : Right before the end <li> is added to a history line.
1673 $row: the revision row for this line
1674 $s: the string representing this parsed line
1675 $classes: array containing the <li> element classes
1677 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1680 $queryInfo: the query parameters
1682 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1683 which depends on user options should install this hook and append its values to
1685 $hash: reference to a hash key string which can be modified
1687 'ParserAfterParse': Called from Parser::parse() just after the call to
1688 Parser::internalParse() returns.
1689 $parser: parser object
1690 $text: text being parsed
1691 $stripState: stripState used (object)
1693 'ParserAfterStrip': Called at end of parsing time.
1694 TODO: No more strip, deprecated ?
1695 $parser: parser object
1696 $text: text being parsed
1697 $stripState: stripState used (object)
1699 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1700 $parser: Parser object being used
1701 $text: text that will be returned
1703 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1704 $parser: Parser object
1705 $text: text to parse
1706 $stripState: StripState instance being used
1708 'ParserBeforeStrip': Called at start of parsing time.
1709 TODO: No more strip, deprecated ?
1710 $parser: parser object
1711 $text: text being parsed
1712 $stripState: stripState used (object)
1714 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1715 $parser: Parser object being used
1718 'ParserClearState': Called at the end of Parser::clearState().
1719 $parser: Parser object being cleared
1721 'ParserCloned': Called when the parser is cloned.
1722 $parser: Newly-cloned Parser object
1724 'ParserFirstCallInit': Called when the parser initialises for the first time.
1725 &$parser: Parser object being cleared
1727 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1729 $parser: Parser object
1730 $varCache: array to store the value in case of multiples calls of the
1732 $index: index (string) of the magic
1733 $ret: value of the magic word (the hook should set it)
1734 $frame: PPFrame object to use for expanding any template variables
1736 'ParserGetVariableValueTs': Use this to change the value of the time for the
1737 {{LOCAL...}} magic word.
1738 $parser: Parser object
1739 $time: actual time (timestamp)
1741 'ParserGetVariableValueVarCache': use this to change the value of the variable
1742 cache or return false to not use it.
1743 $parser: Parser object
1744 $varCache: variable cache (array)
1746 'ParserLimitReport': Called at the end of Parser:parse() when the parser will
1747 include comments about size of the text parsed.
1748 $parser: Parser object
1749 $limitReport: text that will be included (without comment tags)
1751 'ParserMakeImageParams': Called before the parser make an image link, use this
1752 to modify the parameters of the image.
1753 $title: title object representing the file
1754 $file: file object that will be used to create the image
1755 &$params: 2-D array of parameters
1756 $parser: Parser object that called the hook
1758 'ParserSectionCreate': Called each time the parser creates a document section
1759 from wikitext. Use this to apply per-section modifications to HTML (like
1760 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1761 can begin in one section and end in another. Make sure your code can handle
1762 that case gracefully. See the EditSectionClearerLink extension for an example.
1763 $parser: the calling Parser instance
1764 $section: the section number, zero-based, but section 0 is usually empty
1765 &$sectionContent: ref to the content of the section. modify this.
1766 $showEditLinks: boolean describing whether this section has an edit link
1768 'ParserTestParser': Called when creating a new instance of Parser in
1769 maintenance/parserTests.inc.
1770 $parser: Parser object created
1772 'ParserTestGlobals': Allows to define globals for parser tests.
1773 &$globals: Array with all the globals which should be set for parser tests.
1774 The arrays keys serve as the globals names, its values are the globals values.
1776 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
1777 run. Use when page save hooks require the presence of custom tables to ensure
1778 that tests continue to run properly.
1779 &$tables: array of table names
1781 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1782 my talk page, my contributions" etc).
1783 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1784 &$title: Title object representing the current page
1786 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
1787 &$user : User performing the action
1788 $action : Action being performed
1789 &$result : Whether or not the action should be prevented
1790 Change $result and return false to give a definitive answer, otherwise
1791 the built-in rate limiting checks are used, if enabled.
1793 'PlaceNewSection': Override placement of new sections. Return false and put the
1794 merged text into $text to override the default behavior.
1795 $wikipage : WikiPage object
1796 $oldtext : the text of the article before editing
1797 $subject : subject of the new section
1798 &$text : text of the new section
1800 'PreferencesGetLegend': Override the text used for the <legend> of a
1801 preferences section.
1802 $form: the PreferencesForm object. This is a ContextSource as well
1803 $key: the section name
1804 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1806 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1807 AJAX search suggestions. Put results into &$results outparam and return false.
1808 $ns : array of int namespace keys to search in
1809 $search : search term (not guaranteed to be conveniently normalized)
1810 $limit : maximum number of results to return
1811 &$results : out param: array of page names (strings)
1813 'PrefsEmailAudit': Called when user changes their email address.
1814 $user: User (object) changing his email address
1815 $oldaddr: old email address (string)
1816 $newaddr: new email address (string)
1818 'PrefsPasswordAudit': Called when user changes his password.
1819 $user: User (object) changing his password
1820 $newPass: new password
1821 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1823 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
1825 $article: the title being (un)protected
1826 $output: a string of the form HTML so far
1828 'ProtectionForm::save': Called when a protection form is submitted.
1829 $article: the title being (un)protected
1830 $errorMsg: an html message string of an error or an array of message name and
1833 'ProtectionForm::showLogExtract': Called after the protection log extract is
1835 $article: the page the form is shown for
1836 $out: OutputPage object
1838 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
1839 &$obj: RawPage object
1840 &$text: The text that's going to be the output
1842 'RecentChange_save': Called at the end of RecentChange::save().
1843 $recentChange: RecentChange object
1845 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
1846 names such as "oldid" that are preserved when using redirecting special pages
1847 such as Special:MyPage and Special:MyTalk.
1848 &$redirectParams: An array of parameters preserved by redirecting special pages.
1850 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
1851 instance. Can be used by an extension override what skin is used in certain
1853 IContextSource $context: The RequestContext the skin is being created for.
1854 &$skin: A variable reference you may set a Skin instance or string key on to
1855 override the skin that will be used for the context.
1857 'ResourceLoaderGetConfigVars': Called at the end of
1858 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1859 configuration variables to JavaScript. Things that depend on the current page
1860 or request state must be added through MakeGlobalVariablesScript instead.
1861 &$vars: array( variable name => value )
1863 'ResourceLoaderGetStartupModules': Run once the startup module is being
1864 generated. This allows you to add modules to the startup module. This hook
1865 should be used sparingly since any module added here will be loaded on all
1866 pages. This hook is useful if you want to make code available to module loader
1869 'ResourceLoaderRegisterModules': Right before modules information is required,
1870 such as when responding to a resource
1871 loader request or generating HTML output.
1872 &$resourceLoader: ResourceLoader object
1874 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
1875 called after the addition of 'qunit' and MediaWiki testing resources.
1876 &testModules: array of JavaScript testing modules. The 'qunit' framework,
1877 included in core, is fed using tests/qunit/QUnitTestResources.php.
1878 &ResourceLoader object
1880 To add a new qunit module named 'myext.tests':
1881 testModules['qunit']['myext.tests'] = array(
1882 'script' => 'extension/myext/tests.js',
1883 'dependencies' => <any module dependency you might have>
1885 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
1886 added to any module.
1888 'RevisionInsertComplete': Called after a revision is inserted into the database.
1889 &$revision: the Revision
1890 $data: the data stored in old_text. The meaning depends on $flags: if external
1891 is set, it's the URL of the revision text in external storage; otherwise,
1892 it's the revision text itself. In either case, if gzip is set, the revision
1894 $flags: a comma-delimited list of strings representing the options used. May
1895 include: utf8 (this will always be set for new revisions); gzip; external.
1897 'SearchUpdate': Prior to search update completion.
1899 $namespace : Page namespace
1901 $text : Current text being indexed
1903 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
1904 the normal operations.
1905 $allSearchTerms : Array of the search terms in all content languages
1906 &$titleResult : Outparam; the value to return. A Title object or null.
1908 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
1909 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
1911 $term : Search term string
1912 &$title : Outparam; set to $title object and return false for a match
1914 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1915 if nothing was found.
1916 $term : Search term string
1917 &$title : Outparam; set to $title object and return false for a match
1919 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
1921 $term : Search term string
1922 &$title : Current Title object that is being returned (null if none found).
1924 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1925 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1926 in the $searchEngine->namespaces array.
1927 $query : Original query.
1928 &$parsed : Resultant query with the prefixes stripped.
1930 'SearchResultInitFromTitle': Set the revision used when displaying a page in
1932 $title : Current Title object being displayed in search results.
1933 &$id: Revision ID (default is false, for latest)
1935 'SearchableNamespaces': An option to modify which namespaces are searchable.
1936 &$arr : Array of namespaces ($nsId => $name) which will be used.
1938 'SeleniumSettings': TODO
1940 'SetupAfterCache': Called in Setup.php, after cache objects are set
1942 'ShowMissingArticle': Called when generating the output for a non-existent page.
1943 $article: The article object corresponding to the page
1945 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
1946 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
1947 $text: Text being shown
1948 $title: Title of the custom script/stylesheet page
1949 $output: Current OutputPage object
1951 'ShowSearchHitTitle': Customise display of search hit title/link.
1952 &$title: Title to link to
1953 &$text: Text to use for the link
1954 $result: The search result
1955 $terms: The search terms entered
1956 $page: The SpecialSearch object.
1958 'ShowSearchHit': Customize display of search hit.
1959 $searchPage: The SpecialSearch instance.
1960 $result: The SearchResult to show
1961 $terms: Search terms, for highlighting
1962 &$link: HTML of link to the matching page. May be modified.
1963 &$redirect: HTML of redirect info. May be modified.
1964 &$section: HTML of matching section. May be modified.
1965 &$extract: HTML of content extract. May be modified.
1966 &$score: HTML of score. May be modified.
1967 &$size: HTML of page size. May be modified.
1968 &$date: HTML of of page modification date. May be modified.
1969 &$related: HTML of additional info for the matching page. May be modified.
1970 &$html: May be set to the full HTML that should be used to represent the search
1971 hit. Must include the <li> ... </li> tags. Will only be used if the hook
1972 function returned false.
1974 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
1975 allow the normal method of notice selection/rendering to work, or change the
1976 value of $siteNotice and return false to alter it.
1977 &$siteNotice: HTML returned as the sitenotice
1980 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
1981 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
1982 the sitenotice/anonnotice.
1985 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
1987 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
1988 the stock bottom scripts.
1990 'SkinAfterContent': Allows extensions to add text after the page content and
1991 article metadata. This hook should work in all skins. Set the &$data variable to
1992 the text you're going to add.
1993 &$data: (string) Text to be printed out directly (without parsing)
1996 'SkinBuildSidebar': At the end of Skin::buildSidebar().
1998 &$bar: Sidebar contents
1999 Modify $bar to add or modify sidebar portlets.
2001 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2003 $title: displayed page title
2004 $type: 'normal' or 'history' for old/diff views
2005 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2006 message must be in HTML format, not wikitext!
2007 &$link: overridable HTML link to be passed into the message as $1
2008 &$forContent: overridable flag if copyright footer is shown in content language.
2010 'SkinGetPoweredBy': TODO
2011 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2012 the MediaWiki icon but plain text instead.
2015 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2016 &$subpages: Subpage links HTML
2018 $out: OutputPage object
2019 If false is returned $subpages will be used instead of the HTML
2020 subPageSubtitle() generates.
2021 If true is returned, $subpages will be ignored and the rest of
2022 subPageSubtitle() will run.
2024 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2026 $sktemplate: SkinTemplate object
2027 $nav_urls: array of tabs
2029 To alter the structured navigation links in SkinTemplates, there are three
2030 hooks called in different spots:
2032 'SkinTemplateNavigation': Called on content pages after the tabs have been
2033 added, but before variants have been added.
2034 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2035 tab is added but before variants have been added.
2036 'SkinTemplateNavigation::Universal': Called on both content and special pages
2037 after variants have been added.
2038 &$sktemplate: SkinTemplate object
2039 &$links: Structured navigation links. This is used to alter the navigation for
2040 skins which use buildNavigationUrls such as Vector.
2042 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2044 &$sktemplate: SkinTemplate object
2045 &$tpl: Template engine object
2047 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2048 $sktemplate: SkinTemplate object
2049 $res: set to true to prevent active tabs
2051 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2052 You can either create your own array, or alter the parameters for
2054 &$sktemplate: The SkinTemplate instance.
2055 $title: Title instance for the page.
2056 $message: Visible label of tab.
2057 $selected: Whether this is a selected tab.
2058 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2059 &$classes: Array of CSS classes to apply.
2060 &$query: Query string to add to link.
2062 &$result: Complete assoc. array if you want to return true.
2064 'SkinTemplateTabs': TODO
2066 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2067 been rendered (useful for adding more).
2068 $sk: The QuickTemplate based skin template running the hook.
2069 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2070 extensions that add support for BaseTemplateToolbox should watch for this
2071 dummy parameter with "$dummy=false" in their code and return without echoing
2072 any HTML to avoid creating duplicate toolbox items.
2074 'SoftwareInfo': Called by Special:Version for returning information about the
2076 $software: The array of software in format 'name' => 'version'. See
2077 SpecialVersion::softwareInformation().
2079 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2080 $id: User identifier
2082 'SpecialListusersDefaultQuery': Called right before the end of
2083 UsersPager::getDefaultQuery().
2084 $pager: The UsersPager instance
2085 $query: The query array to be returned
2087 'SpecialListusersFormatRow': Called right before the end of
2088 UsersPager::formatRow().
2089 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2090 $row: Database row object
2092 'SpecialListusersHeader': Called before closing the <fieldset> in
2093 UsersPager::getPageHeader().
2094 $pager: The UsersPager instance
2095 $out: The header HTML
2097 'SpecialListusersHeaderForm': Called before adding the submit button in
2098 UsersPager::getPageHeader().
2099 $pager: The UsersPager instance
2100 $out: The header HTML
2102 'SpecialListusersQueryInfo': Called right before the end of.
2103 UsersPager::getQueryInfo()
2104 $pager: The UsersPager instance
2105 $query: The query array to be returned
2107 'SpecialMovepageAfterMove': Called after moving a page.
2108 $movePage: MovePageForm object
2109 $oldTitle: old title (object)
2110 $newTitle: new title (object)
2112 'SpecialNewpagesConditions': Called when building sql query for
2114 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2115 $opts: FormOptions object containing special page options
2116 &$conds: array of WHERE conditionals for query
2117 &tables: array of tables to be queried
2118 &$fields: array of columns to select
2119 &$join_conds: join conditions for the tables
2121 'SpecialNewPagesFilters': Called after building form options at NewPages.
2122 $special: the special page object
2123 &$filters: associative array of filter definitions. The keys are the HTML
2124 name/URL parameters. Each key maps to an associative array with a 'msg'
2125 (message key) and a 'default' value.
2127 'SpecialPage_initList': Called when setting up SpecialPage::$mList, use this
2128 hook to remove a core special page.
2129 $list: list (array) of core special pages
2131 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2132 $special: the SpecialPage object
2133 $subPage: the subpage string or null if no subpage was specified
2135 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2136 $special: the SpecialPage object
2137 $subPage: the subpage string or null if no subpage was specified
2139 'SpecialPasswordResetOnSubmit': When executing a form submission on
2140 Special:PasswordReset.
2141 $users: array of User objects.
2142 $data: array of data submitted by the user
2143 &$error: string, error code (message key) used to describe to error (out
2144 parameter). The hook needs to return false when setting this, otherwise it
2145 will have no effect.
2147 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2148 use this to change some selection criteria or substitute a different title.
2149 &$randstr: The random number from wfRandom()
2150 &$isRedir: Boolean, whether to select a redirect or non-redirect
2151 &$namespaces: An array of namespace indexes to get the title from
2152 &$extra: An array of extra SQL statements
2153 &$title: If the hook returns false, a Title object to use instead of the
2154 result from the normal query
2156 'SpecialRecentChangesFilters': Called after building form options at
2158 $special: the special page object
2159 &$filters: associative array of filter definitions. The keys are the HTML
2160 name/URL parameters. Each key maps to an associative array with a 'msg'
2161 (message key) and a 'default' value.
2163 'SpecialRecentChangesPanel': Called when building form options in
2164 SpecialRecentChanges.
2165 &$extraOpts: array of added items, to which can be added
2166 $opts: FormOptions for this request
2168 'SpecialRecentChangesQuery': Called when building SQL query for
2169 SpecialRecentChanges and SpecialRecentChangesLinked.
2170 &$conds: array of WHERE conditionals for query
2171 &$tables: array of tables to be queried
2172 &$join_conds: join conditions for the tables
2173 $opts: FormOptions for this request
2174 &$query_options: array of options for the database request
2175 &$select: Array of columns to select
2177 'SpecialSearchCreateLink': Called when making the message to create a page or
2178 go to the existing page.
2179 $t: title object searched for
2180 &$params: an array of the default message name and page title (as parameter)
2182 'SpecialSearchGo': Called when user clicked the "Go".
2183 &$title: title object generated from the text entered by the user
2184 &$term: the search term entered by the user
2186 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2187 target doesn't exist.
2188 &$title: title object generated from the text entered by the user
2190 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2191 the advanced form, a.k.a. power search box.
2192 &$showSections: an array to add values with more options to
2193 $term: the search term (not a title object)
2194 $opts: an array of hidden options (containing 'redirs' and 'profile')
2196 'SpecialSearchProfiles': Allows modification of search profiles.
2197 &$profiles: profiles, which can be modified.
2199 'SpecialSearchProfileForm': Allows modification of search profile forms.
2200 $search: special page object
2201 &$form: String: form html
2202 $profile: String: current search profile
2203 $term: String: search term
2204 $opts: Array: key => value of hidden options for inclusion in custom forms
2206 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2207 $search: SpecialSearch special page object
2208 $profile: String: current search profile
2209 $engine: the search engine
2211 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2212 on the search results page. Useful for including an external search
2213 provider. To disable the output of MediaWiki search output, return
2215 $specialSearch: SpecialSearch object ($this)
2217 $term: Search term specified by the user
2219 'SpecialSearchResultsAppend': Called after all search results HTML has
2220 been output. Note that in some cases, this hook will not be called (no
2221 results, too many results, SpecialSearchResultsPrepend returned false,
2223 $specialSearch: SpecialSearch object ($this)
2225 $term: Search term specified by the user
2227 'SpecialSearchResults': Called before search result display when there are
2229 $term: string of search term
2230 &$titleMatches: empty or SearchResultSet object
2231 &$textMatches: empty or SearchResultSet object
2233 'SpecialSearchNoResults': Called before search result display when there are no
2235 $term: string of search term
2237 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2238 &$extraStats: Array to save the new stats
2239 ( $extraStats['<name of statistic>'] => <value>; )
2241 'SpecialUploadComplete': Called after successfully uploading a file from
2243 $form: The SpecialUpload object
2245 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2246 use this to change the tables headers.
2247 $extTypes: associative array of extensions types
2249 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2250 $wgVersion: Current $wgVersion for you to use
2251 &$versionUrl: Raw url to link to (eg: release notes)
2253 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2254 $special: the special page object
2255 &$filters: associative array of filter definitions. The keys are the HTML
2256 name/URL parameters. Each key maps to an associative array with a 'msg'
2257 (message key) and a 'default' value.
2259 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2260 &$conds: array of WHERE conditionals for query
2261 &$tables: array of tables to be queried
2262 &$join_conds: join conditions for the tables
2263 &$fields: array of query fields
2265 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2266 URL for a title when we have no other parameters on the URL. Gives a chance for
2267 extensions that alter page view behavior radically to abort that redirect or
2269 $request: WebRequest
2270 $title: Title of the currently found title obj
2271 $output: OutputPage object
2273 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2274 rendered (by ThumbnailImage:toHtml method).
2275 $thumbnail: the ThumbnailImage object
2276 &$attribs: image attribute array
2277 &$linkAttribs: image link attribute array
2279 'TitleArrayFromResult': Called when creating an TitleArray object from a
2281 &$titleArray: set this to an object to override the default object returned
2282 $res: database result used to create the object
2284 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2285 that can be applied.
2286 $title: The title in question.
2287 &$types: The types of protection available.
2289 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2290 $title: Title object that is being checked
2291 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2292 Hooks may change this value to override the return value of
2293 Title::isCssOrJsPage().
2295 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2296 overriding default behavior for determining if a page exists. If $isKnown is
2297 kept as null, regular checks happen. If it's a boolean, this value is returned
2298 by the isKnown method.
2299 $title: Title object that is being checked
2300 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2302 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2303 that this hook is not called for interwiki pages or pages in immovable
2304 namespaces: for these, isMovable() always returns false.
2305 $title: Title object that is being checked
2306 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2307 Hooks may change this value to override the return value of
2310 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2311 be handled by separate handler (via ArticleViewCustom).
2312 $title: Title object that is being checked
2313 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2314 Hooks may change this value to override the return value of
2315 Title::isWikitextPage()
2317 'TitleMoveComplete': After moving an article (title).
2320 $user: user who did the move
2321 $pageid: database ID of the page that's been moved
2322 $redirid: database ID of the created redirect
2324 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2325 adding the default error message if nothing allows the user to read the page. If
2326 a handler wants a title to *not* be whitelisted, it should also return false.
2327 $title: Title object being checked against
2328 $user: Current user object
2329 &$whitelisted: Boolean value of whether this title is whitelisted
2331 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2332 PageArchive object has been created but before any further processing is done.
2333 &$archive: PageArchive object
2334 $title: Title object of the page that we're viewing
2336 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2337 PageArchive object has been created but before any further processing is done.
2338 &$archive: PageArchive object
2339 $title: Title object of the page that we're viewing
2341 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2342 the site is not in read-only mode, that the Title object is not null and after
2343 a PageArchive object has been constructed but before performing any further
2345 &$archive: PageArchive object
2346 $title: Title object of the page that we're about to undelete
2348 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2349 $title: title object related to the revision
2350 $rev: revision (object) that will be viewed
2352 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2354 $action: action name
2355 $article: article "acted on"
2357 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2358 &$files: list of files
2360 'UnwatchArticle': Before a watch is removed from an article.
2361 $user: user watching
2362 $page: WikiPage object to be removed
2364 'UnwatchArticleComplete': After a watch is removed from an article.
2365 $user: user that watched
2366 $page: WikiPage object that was watched
2368 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2369 $formattedPageStatus: list of valid page states
2371 'UploadForm:initial': Before the upload form is generated. You might set the
2372 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2373 text (HTML) either before or after the editform.
2374 $form: UploadForm object
2376 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2377 poke at member variables like $mUploadDescription before the file is saved. Do
2378 not use this hook to break upload processing. This will return the user to a
2379 blank form with no error message; use UploadVerification and UploadVerifyFile
2381 $form: UploadForm object
2383 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2384 $type: (string) the requested upload type
2385 &$className: the class name of the Upload instance to be created
2387 'UploadComplete': when Upload completes an upload.
2388 &$upload: an UploadBase child instance
2390 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2392 $descriptor: (array) the HTMLForm descriptor
2394 'UploadFormSourceDescriptors': after the standard source inputs have been
2395 added to the descriptor
2396 $descriptor: (array) the HTMLForm descriptor
2398 'UploadVerification': Additional chances to reject an uploaded file. Consider
2399 using UploadVerifyFile instead.
2400 string $saveName: destination file name
2401 string $tempName: filesystem path to the temporary file for checks
2402 string &$error: output: message key for message to show if upload canceled by
2403 returning false. May also be an array, where the first element is the message
2404 key and the remaining elements are used as parameters to the message.
2406 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2407 in most cases over UploadVerification.
2408 object $upload: an instance of UploadBase, with all info about the upload
2409 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2410 will typically only apply for specific mime types.
2411 object &$error: output: true if the file is valid. Otherwise, an indexed array
2412 representing the problem with the file, where the first element is the message
2413 key and the remaining elements are used as parameters to the message.
2415 'UploadComplete': Upon completion of a file upload.
2416 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2417 $uploadBase->getLocalFile().
2419 'User::mailPasswordInternal': before creation and mailing of a user's new
2421 $user: the user who sent the message out
2422 $ip: IP of the user who sent the message out
2423 $u: the account whose new password will be set
2425 'UserAddGroup': Called when adding a group; return false to override
2426 stock group addition.
2427 $user: the user object that is to have a group added
2428 &$group: the group to add, can be modified
2430 'UserArrayFromResult': Called when creating an UserArray object from a database
2432 &$userArray: set this to an object to override the default object returned
2433 $res: database result used to create the object
2435 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2436 want to display an error message, try getUserPermissionsErrors.
2437 $title: Title object being checked against
2438 $user : Current user object
2439 $action: Action being checked
2440 $result: Pointer to result returned if hook returns false. If null is returned,
2441 userCan checks are continued by internal code.
2443 'UserCanSendEmail': To override User::canSendEmail() permission check.
2444 $user: User (object) whose permission is being checked
2445 &$canSend: bool set on input, can override on output
2447 'UserClearNewTalkNotification': Called when clearing the "You have new
2448 messages!" message, return false to not delete it.
2449 $user: User (object) that will clear the message
2451 'UserComparePasswords': Called when checking passwords, return false to
2452 override the default password checks.
2453 &$hash: String of the password hash (from the database)
2454 &$password: String of the plaintext password the user entered
2455 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2457 &$result: If the hook returns false, this Boolean value will be checked to
2458 determine if the password was valid
2460 'UserCreateForm': change to manipulate the login form
2461 $template: SimpleTemplate instance for the form
2463 'UserCryptPassword': Called when hashing a password, return false to implement
2464 your own hashing method.
2465 &$password: String of the plaintext password to encrypt
2466 &$salt: String of the password salt or Boolean false if no salt is provided
2467 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2469 &$hash: If the hook returns false, this String will be used as the hash
2471 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2472 $user: User to get groups for
2473 &$groups: Current effective groups
2475 'UserGetAllRights': After calculating a list of all available rights.
2476 &$rights: Array of rights, which may be added to.
2478 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2479 before returning the options to the caller. Warning: This hook is called for
2480 every call to User::getDefaultOptions(), which means it's potentially called
2481 dozens or hundreds of times. You may want to cache the results of non-trivial
2482 operations in your hook function for this reason.
2483 &$defaultOptions: Array of preference keys and their default values.
2485 'UserGetEmail': Called when getting an user email address.
2487 &$email: email, change this to override local email
2489 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2490 email authentication.
2492 &$timestamp: timestamp, change this to override local email authentication
2495 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2496 &$groups: List of implicit (automatically-assigned) groups
2498 'UserGetLanguageObject': Called when getting user's interface language object.
2500 &$code: Language code that will be used to create the object
2501 $context: RequestContext object
2503 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2504 &$reservedUsernames: $wgReservedUsernames
2506 'UserGetRights': Called in User::getRights().
2507 $user: User to get rights for
2508 &$rights: Current rights
2510 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2511 specific block exemptions).
2512 $user: User in question
2513 $title: Title of the page in question
2514 &$blocked: Out-param, whether or not the user is blocked from that page.
2515 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2516 to edit their own user talk pages.
2518 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2520 $ip: User's IP address
2521 &$blocked: Whether the user is blocked, to be modified by the hook
2523 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2524 environmental means; occurs after session is loaded.
2525 $user: user object being loaded
2527 'UserLoadDefaults': Called when loading a default user.
2531 'UserLoadFromDatabase': Called when loading a user from the database.
2533 &$s: database query object
2535 'UserLoadFromSession': Called to authenticate users on external/environmental
2536 means; occurs before session is loaded.
2537 $user: user object being loaded
2538 &$result: set this to a boolean value to abort the normal authentication
2541 'UserLoadOptions': When user options/preferences are being loaded from the
2544 &$options: Options, can be modified.
2546 'UserLoginComplete': After a user has logged in.
2547 $user: the user object that was created on login
2548 $inject_html: Any HTML to inject after the "logged in" message.
2550 'UserLoginForm': change to manipulate the login form
2551 $template: SimpleTemplate instance for the form
2553 'UserLogout': Before a user logs out.
2554 $user: the user object that is about to be logged out
2556 'UserLogoutComplete': After a user has logged out.
2557 $user: the user object _after_ logout (won't have name, ID, etc.)
2558 $inject_html: Any HTML to inject after the "logged out" message.
2559 $oldName: name of the user before logout (string)
2561 'UserRemoveGroup': Called when removing a group; return false to override stock
2563 $user: the user object that is to have a group removed
2564 &$group: the group to be removed, can be modified
2566 'UserRights': After a user's group memberships are changed.
2567 $user : User object that was changed
2568 $add : Array of strings corresponding to groups added
2569 $remove: Array of strings corresponding to groups removed
2571 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2573 $user: user retrieving new talks messages
2574 $talks: array of new talks page(s)
2576 'UserSaveSettings': Called when saving user settings.
2579 'UserSaveOptions': Called just before saving user preferences/options.
2581 &$options: Options, modifiable
2583 'UserSetCookies': Called when setting user cookies.
2585 &$session: session array, will be added to $_SESSION
2586 &$cookies: cookies array mapping cookie name to its value
2588 'UserSetEmail': Called when changing user email address.
2590 &$email: new email, change this to override new email address
2592 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2593 email authentication.
2595 &$timestamp: new timestamp, change this to override local email
2596 authentication timestamp
2598 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2599 "Foobar (Talk | Contribs | Block)".
2600 $userId: User id of the current user
2601 $userText: User name of the current user
2602 &$items: Array of user tool links as HTML fragments
2604 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2605 used to alter the SQL query which gets the list of wanted pages.
2606 &$wantedPages: WantedPagesPage object
2607 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2609 'WatchArticle': Before a watch is added to an article.
2610 $user: user that will watch
2611 $page: WikiPage object to be watched
2613 'WatchArticleComplete': After a watch is added to an article.
2614 $user: user that watched
2615 $page: WikiPage object watched
2617 'WatchlistEditorBuildRemoveLine': when building remove lines in
2618 Special:Watchlist/edit.
2619 &$tools: array of extra links
2620 $title: Title object
2621 $redirect: whether the page is a redirect
2624 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2626 $router: The PathRouter instance
2628 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2629 dumps. One, and only one hook should set this, and return false.
2630 &$tables: Database tables to use in the SELECT query
2631 &$opts: Options to use for the query
2632 &$join: Join conditions
2634 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2635 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2636 specific to a content model should be provided by the respective Content's
2637 getDeletionUpdates() method.
2639 $content: the Content to generate updates for
2640 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2642 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2643 run a MediaWiki cli script.
2644 &$script: MediaWiki cli script path
2645 &$parameters: Array of arguments and options to the script
2646 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2649 'wgQueryPages': Called when initialising $wgQueryPages, use this to add new
2650 query pages to be updated with maintenance/updateSpecialPages.php.
2651 $query: $wgQueryPages itself
2653 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2654 extra metadata to be added.
2655 $obj: The XmlDumpWriter object.
2656 &$out: The output string.
2657 $row: The database row for the page.
2658 $title: The title of the page.
2660 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2662 $obj: The XmlDumpWriter object.
2663 &$out: The text being output.
2664 $row: The database row for the revision.
2665 $text: The revision text.
2667 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2668 to add additional tags to extract.
2669 &$items: Array containing information on which items to extract. See XMPInfo for
2670 details on the format.
2672 'XMPGetResults': Called just before returning the results array of parsing xmp
2673 data. Can be used to post-process the results.
2674 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2675 is an array of metadata tags returned (each tag is either a value, or an array
2678 More hooks might be available but undocumented, you can execute
2679 'php maintenance/findHooks.php' to find hidden ones.