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 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
749 $catpage: CategoryPage instance
751 'ChangePasswordForm': For extensions that need to add a field to the
752 ChangePassword form via the Preferences form.
753 &$extraFields: An array of arrays that hold fields like would be passed to the
756 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
757 &$changesList: ChangesList instance.
758 &$articlelink: HTML of link to article (already filled-in).
759 &$s: HTML of row that is being constructed.
760 &$rc: RecentChange instance.
761 $unpatrolled: Whether or not we are showing unpatrolled changes.
762 $watched: Whether or not the change is watched by the user.
764 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
765 $collationName: Name of the collation in question
766 &$collationObject: Null. Replace with a subclass of the Collation class that
767 implements the collation given in $collationName.
769 'ConfirmEmailComplete': Called after a user's email has been confirmed
771 $user: user (object) whose email is being confirmed
773 'ContentHandlerDefaultModelFor': Called when the default content model is determined
774 for a given title. May be used to assign a different model for that title.
775 $title: the Title in question
776 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
778 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
779 content model name, but no entry for that model exists in $wgContentHandlers.
780 $modeName: the requested content model name
781 &$handler: set this to a ContentHandler object, if desired.
783 'ConvertContent': Called by AbstractContent::convert when a conversion to another
784 content model is requested.
785 $content: The Content object to be converted.
786 $toModel: The ID of the content model to convert to.
787 $lossy: boolean indicating whether lossy conversion is allowed.
788 &$result: Output parameter, in case the handler function wants to provide a
789 converted Content object. Note that $result->getContentModel() must return $toModel.
790 Handler functions that modify $result should generally return false to further
791 attempts at conversion.
793 'ContribsPager::getQueryInfo': Before the contributions query is about to run
794 &$pager: Pager object for contributions
795 &$queryInfo: The query for the contribs Pager
797 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
798 &$data: an array of results of all contribs queries
799 $pager: The ContribsPager object hooked into
800 $offset: Index offset, inclusive
801 $limit: Exact query limit
802 $descending: Query direction, false for ascending, true for descending
804 'ContributionsLineEnding': Called before a contributions HTML line is finished
805 $page: SpecialPage object for contributions
807 $row: the DB row for this line
808 &$classes: the classes to add to the surrounding <li>
810 'ContributionsToolLinks': Change tool links above Special:Contributions
812 $title: User page title
813 &$tools: Array of tool links
815 'CustomEditor': When invoking the page editor
816 $article: Article being edited
817 $user: User performing the edit
819 Return true to allow the normal editor to be used, or false
820 if implementing a custom editor, e.g. for a special namespace,
823 'DatabaseOraclePostInit': Called after initialising an Oracle database
824 &$db: the DatabaseOracle object
826 'Debug': Called when outputting a debug log line via wfDebug() or wfDebugLog()
827 $text: plaintext string to be output
828 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
830 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
831 $title: the diff page title (nullable)
832 &$oldId: the actual old Id to use in the diff
833 &$newId: the actual new Id to use in the diff (0 means current)
834 $old: the ?old= param value from the url
835 $new: the ?new= param value from the url
837 'DiffViewHeader': Called before diff display
838 $diff: DifferenceEngine object that's calling
839 $oldRev: Revision object of the "old" revision (may be null/invalid)
840 $newRev: Revision object of the "new" revision
842 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
844 $article: article (object) being viewed
845 $oldid: oldid (int) being viewed
847 'DoEditSectionLink': Override the HTML generated for section edit links
848 $skin: Skin object rendering the UI
849 $title: Title object for the title being linked to (may not be the same as
850 $wgTitle, if the section is included from a template)
851 $section: The designation of the section being pointed to, to be included in
852 the link, like "§ion=$section"
853 $tooltip: The default tooltip. Escape before using.
854 By default, this is wrapped in the 'editsectionhint' message.
855 &$result: The HTML to return, prefilled with the default plus whatever other
856 changes earlier hooks have made
857 $lang: The language code to use for the link in the wfMessage function
859 'EditFilter': Perform checks on an edit
860 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
861 $text: Contents of the edit box
862 $section: Section being edited
863 &$error: Error message to return
864 $summary: Edit summary for page
866 'EditFilterMerged': Post-section-merge edit filter.
867 DEPRECATED, use EditFilterMergedContent instead.
868 $editor: EditPage instance (object)
869 $text: content of the edit box
870 &$error: error message to return
871 $summary: Edit summary for page
873 'EditFilterMergedContent': Post-section-merge edit filter.
874 This may be triggered by the EditPage or any other facility that modifies page content.
875 Use the $status object to indicate whether the edit should be allowed, and to provide
876 a reason for disallowing it. Return false to abort the edit, and true to continue.
877 Returning true if $status->isOK() returns false means "don't save but continue user
878 interaction", e.g. show the edit form.
879 $context: object implementing the IContextSource interface.
880 $content: content of the edit box, as a Content object.
881 $status: Status object to represent errors, etc.
882 $summary: Edit summary for page
883 $user: the User object representing the user whois performing the edit.
884 $minoredit: whether the edit was marked as minor by the user.
886 'EditFormPreloadText': Allows population of the edit form when creating
888 &$text: Text to preload with
889 &$title: Title object representing the page being created
891 'EditFormInitialText': Allows modifying the edit form when editing existing
893 $editPage: EditPage object
895 'EditPage::attemptSave': Called before an article is
896 saved, that is before WikiPage::doEditContent() is called
897 $editpage_Obj: the current EditPage object
899 'EditPage::importFormData': allow extensions to read additional data
901 $editpage: EditPage instance
903 return value is ignored (should always return true)
905 'EditPage::showEditForm:fields': allows injection of form field into edit form
906 $editor: the EditPage instance for reference
907 $out: an OutputPage instance to write to
908 return value is ignored (should always return true)
910 'EditPage::showEditForm:initial': before showing the edit form
911 $editor: EditPage instance (object)
912 $out: an OutputPage instance to write to
914 Return false to halt editing; you'll need to handle error messages, etc.
915 yourself. Alternatively, modifying $error and returning true will cause the
916 contents of $error to be echoed at the top of the edit form as wikitext.
917 Return true without altering $error to allow the edit to proceed.
919 'EditPage::showStandardInputs:options': allows injection of form fields into
921 $editor: EditPage instance (object)
922 $out: an OutputPage instance to write to
923 &$tabindex: HTML tabindex of the last edit check/button
924 return value is ignored (should always be true)
926 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
927 when there's an edit conflict. Return false to halt normal diff output; in
928 this case you're responsible for computing and outputting the entire "conflict"
929 part, i.e., the "difference between revisions" and "your text" headers and
931 &$editor: EditPage instance
932 &$out: OutputPage instance
934 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
935 textarea in the edit form.
936 &$editpage: The current EditPage object
937 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
938 &$tabindex: HTML tabindex of the last edit check/button
940 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
942 &$editpage: The current EditPage object
943 &$checks: Array of edit checks like "watch this page"/"minor edit"
944 &$tabindex: HTML tabindex of the last edit check/button
946 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
947 textarea in the edit form.
948 &$toolbar: The toolbar HTMl
950 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
951 contribution/copyright notice.
952 $title: title of page being edited
953 &$msg: localization message name, overridable. Default is either
954 'copyrightwarning' or 'copyrightwarning2'.
956 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
957 modifying the wikitext that will be used in "Show changes". Note that it is
958 preferable to implement diff handling for different data types using the
959 ContentHandler facility.
960 $editPage: EditPage object
961 &$newtext: wikitext that will be used as "your version"
963 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
964 "Show changes". Note that it is preferable to implement diff handling for
965 different data types using the ContentHandler facility.
966 $editPage: EditPage object
967 &$newtext: wikitext that will be used as "your version"
969 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
970 Allow modifying the wikitext that will be previewed. Note that it is preferable
971 to implement previews for different data types using the ContentHandler
973 $editPage: EditPage object
974 &$toparse: wikitext that will be parsed
976 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
977 previewed. Note that it is preferable to implement previews for different data
978 types using the ContentHandler facility.
979 $editPage: EditPage object
980 &$content: Content object to be previewed (may be replaced by hook function)
982 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
983 &$editpage: The current EditPage object
984 &$res: the HTML of the error text
986 'EditPageTosSummary': Give a chance for site and per-namespace customizations
987 of terms of service summary link that might exist separately from the copyright
989 $title: title of page being edited
990 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
992 'EditSectionLink': Do not use, use DoEditSectionLink instead.
993 $skin: Skin rendering the UI
994 $title: Title being linked to
995 $section: Section to link to
997 &$result: Result (alter this to override the generated links)
998 $lang: The language code to use for the link in the wfMessage function
1000 'EmailConfirmed': When checking that the user's email address is "confirmed".
1001 $user: User being checked
1002 $confirmed: Whether or not the email address is confirmed
1003 This runs before the other checks, such as anonymity and the real check; return
1004 true to allow those checks to occur, and false if checking is done.
1006 'EmailUser': Before sending email from one user to another.
1007 $to: address of receiving user
1008 $from: address of sending user
1009 $subject: subject of the mail
1010 $text: text of the mail
1012 'EmailUserCC': Before sending the copy of the email to the author.
1013 $to: address of receiving user
1014 $from: address of sending user
1015 $subject: subject of the mail
1016 $text: text of the mail
1018 'EmailUserComplete': After sending email from one user to another.
1019 $to: address of receiving user
1020 $from: address of sending user
1021 $subject: subject of the mail
1022 $text: text of the mail
1024 'EmailUserForm': After building the email user form object.
1025 $form: HTMLForm object
1027 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1029 $user: The user who is trying to email another user.
1030 $editToken: The user's edit token.
1031 &$hookErr: Out-param for the error. Passed as the parameters to
1032 OutputPage::showErrorPage.
1034 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1036 $ip: The ip address of the user
1038 'ExtensionTypes': Called when generating the extensions credits, use this to
1039 change the tables headers.
1040 &$extTypes: associative array of extensions types
1042 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1043 thumbnail file name.
1044 $thumbname: the base name of the thumbnail file
1045 &$params: the currently extracted params (has source name, temp or archived zone)
1047 'FetchChangesList': When fetching the ChangesList derivative for a particular
1049 $user: User the list is being fetched for
1050 &$skin: Skin object to be used with the list
1051 &$list: List object (defaults to NULL, change it to an object instance and
1052 return false override the list derivative used)
1054 'FileDeleteComplete': When a file is deleted.
1055 $file: reference to the deleted file
1056 $oldimage: in case of the deletion of an old image, the name of the old file
1057 $article: in case all revisions of the file are deleted a reference to the
1058 WikiFilePage associated with the file.
1059 $user: user who performed the deletion
1062 'FileTransformed': When a file is transformed and moved into storage.
1063 $file: reference to the File object
1064 $thumb: the MediaTransformOutput object
1065 $tmpThumbPath: The temporary file system path of the transformed file
1066 $thumbPath: The permanent storage path of the transformed file
1068 'FileUpload': When a file upload occurs.
1069 $file : Image object representing the file that was uploaded
1070 $reupload : Boolean indicating if there was a previously another image there or
1072 $hasDescription : Boolean indicating that there was already a description page
1073 and a new one from the comment wasn't created (since 1.17)
1075 'FileUndeleteComplete': When a file is undeleted
1076 $title: title object to the file
1077 $fileVersions: array of undeleted versions. Empty if all versions were restored
1078 $user: user who performed the undeletion
1081 'FormatAutocomments': When an autocomment is formatted by the Linker.
1082 &$comment: Reference to the accumulated comment. Initially null, when set the
1083 default code will be skipped.
1084 $pre: Initial part of the parsed comment before the call to the hook.
1085 $auto: The extracted part of the parsed comment before the call to the hook.
1086 $post: The final part of the parsed comment before the call to the hook.
1087 $title: An optional title object used to links to sections. Can be null.
1088 $local: Boolean indicating whether section links should refer to local page.
1090 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1092 &$user: user to promote.
1093 &$promote: groups that will be added.
1095 'GetBlockedStatus': after loading blocking status of an user from the database
1096 $user: user (object) being checked
1098 'GetCacheVaryCookies': Get cookies that should vary cache options.
1099 $out: OutputPage object
1100 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1101 that have to vary cache options
1103 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1105 $title: Title object of page
1106 $url: string value as output (out parameter, can modify)
1107 $query: query options passed to Title::getCanonicalURL()
1109 'GetDefaultSortkey': Override the default sortkey for a page.
1110 $title: Title object that we need to get a sortkey for
1111 &$sortkey: Sortkey to use.
1113 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1114 underscore) magic words. Called by MagicWord.
1115 &$doubleUnderscoreIDs: array of strings
1117 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1118 $title: Title object of page
1119 $url: string value as output (out parameter, can modify)
1120 $query: query options passed to Title::getFullURL()
1122 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1123 $title: Title object of page
1124 $url: string value as output (out parameter, can modify)
1125 $query: query options passed to Title::getInternalURL()
1127 'GetIP': modify the ip of the current user (called only once).
1128 &$ip: string holding the ip as determined so far
1130 'GetLinkColours': modify the CSS class of an array of page links.
1131 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1133 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1135 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1136 working with internal urls (non-interwiki) then it may be preferable to work
1137 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1138 be buggy for internal urls on render if you do not re-implement the horrible
1139 hack that Title::getLocalURL uses in your own extension.
1140 $title: Title object of page
1141 &$url: string value as output (out parameter, can modify)
1142 $query: query options passed to Title::getLocalURL()
1144 'GetLocalURL::Internal': Modify local URLs to internal pages.
1145 $title: Title object of page
1146 &$url: string value as output (out parameter, can modify)
1147 $query: query options passed to Title::getLocalURL()
1149 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1150 without any fancy queries or variants.
1151 $title: Title object of page
1152 &$url: string value as output (out parameter, can modify)
1154 'GetMetadataVersion': Modify the image metadata version currently in use. This
1155 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1156 that need to have versioned metadata should add an element to the end of the
1157 version array of the form 'handler_name=version'. Most media handlers won't need
1158 to do this unless they broke backwards compatibility with a previous version of
1159 the media handler metadata output.
1160 &$version: Array of version strings
1162 'GetPreferences': Modify user preferences.
1163 $user: User whose preferences are being modified.
1164 &$preferences: Preferences description array, to be fed to an HTMLForm object
1166 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1167 checked for. Use instead of userCan for most cases. Return false if the user
1168 can't do it, and populate $result with the reason in the form of
1169 array( messagename, param1, param2, ... ). For consistency, error messages
1170 should be plain text with no special coloring, bolding, etc. to show that
1171 they're errors; presenting them properly to the user as errors is done by the
1173 $title: Title object being checked against
1174 $user : Current user object
1175 $action: Action being checked
1176 $result: User permissions error to add. If none, return true.
1178 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1179 called only if expensive checks are enabled. Add a permissions error when
1180 permissions errors are checked for. Return false if the user can't do it, and
1181 populate $result with the reason in the form of array( messagename, param1,
1182 param2, ... ). For consistency, error messages should be plain text with no
1183 special coloring, bolding, etc. to show that they're errors; presenting them
1184 properly to the user as errors is done by the caller.
1186 $title: Title object being checked against
1187 $user : Current user object
1188 $action: Action being checked
1189 $result: User permissions error to add. If none, return true.
1191 'GitViewers': Called when generating the list of git viewers for
1192 Special:Version, use this to change the list.
1193 &$extTypes: associative array of repo URLS to viewer URLs.
1195 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1196 image insertion. You can skip the default logic entirely by returning false, or
1197 just modify a few things using call-by-reference.
1199 &$title: Title object of the image
1200 &$file: File object, or false if it doesn't exist
1201 &$frameParams: Various parameters with special meanings; see documentation in
1202 includes/Linker.php for Linker::makeImageLink
1203 &$handlerParams: Various parameters with special meanings; see documentation in
1204 includes/Linker.php for Linker::makeImageLink
1205 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1206 &$res: Final HTML output, used if you return false
1209 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1210 the image on an image page.
1211 $imagePage: ImagePage object ($this)
1214 'ImagePageAfterImageLinks': Called after the image links section on an image
1216 $imagePage: ImagePage object ($this)
1217 &$html: HTML for the hook to add
1219 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1221 $line: the HTML of the history line
1222 $css: the line CSS class
1224 'ImagePageFindFile': Called when fetching the file associated with an image
1226 $page: ImagePage object
1228 &$displayFile: displayed File object
1230 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1231 $page: ImagePage object
1232 &$toc: Array of <li> strings
1234 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1236 &$title: the Title object of the file as it would appear for the upload page
1237 &$path: the original file and path name when img_auth was invoked by the the web
1239 &$name: the name only component of the file
1240 &$result: The location to pass back results of the hook routine (only used if
1242 $result[0]=The index of the header message
1243 $result[1]=The index of the body text message
1244 $result[2 through n]=Parameters passed to body text message. Please note the
1245 header message cannot receive/use parameters.
1247 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1248 $reader: XMLReader object
1249 $logInfo: Array of information
1250 Return false to stop further processing of the tag
1252 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1253 $reader: XMLReader object
1254 $pageInfo: Array of information
1255 Return false to stop further processing of the tag
1257 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1258 $reader: XMLReader object
1259 $pageInfo: Array of page information
1260 $revisionInfo: Array of revision information
1261 Return false to stop further processing of the tag
1263 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1264 $reader: XMLReader object
1265 Return false to stop further processing of the tag
1267 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1268 $reader: XMLReader object
1269 $revisionInfo: Array of information
1270 Return false to stop further processing of the tag
1272 'InfoAction': When building information to display on the action=info page.
1273 $context: IContextSource object
1274 &$pageInfo: Array of information
1276 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1277 $title: Title object ($wgTitle)
1278 $request: WebRequest
1279 $ignoreRedirect: boolean to skip redirect check
1280 $target: Title/string of redirect target
1281 $article: Article object
1283 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1284 Return true without providing an interwiki to continue interwiki search.
1285 $prefix: interwiki prefix we are looking for.
1286 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1287 iw_trans and optionally iw_api and iw_wikiid.
1289 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1290 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1291 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1292 template/parser function execution which respect nowiki and HTML-comments.
1293 &$parser: Parser object
1294 &$text: string containing partially parsed text
1295 &$stripState: Parser's internal StripState object
1297 'InternalParseBeforeLinks': during Parser's internalParse method before links
1298 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1299 &$parser: Parser object
1300 &$text: string containing partially parsed text
1301 &$stripState: Parser's internal StripState object
1303 'InvalidateEmailComplete': Called after a user's email has been invalidated
1305 $user: user (object) whose email is being invalidated
1307 'IRCLineURL': When constructing the URL to use in an IRC notification.
1308 Callee may modify $url and $query, URL will be constructed as $url . $query
1309 &$url: URL to index.php
1310 &$query: Query string
1312 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1313 $article: article (object) being checked
1315 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1317 $result: Change this value to override the result of wfIsTrustedProxy()
1319 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for
1320 instance to return false if the domain name doesn't match your organization.
1321 $addr: The e-mail address entered by the user
1322 &$result: Set this and return false to override the internal checks
1324 'isValidPassword': Override the result of User::isValidPassword()
1325 $password: The password entered by the user
1326 &$result: Set this and return false to override the internal checks
1327 $user: User the password is being validated for
1329 'Language::getMessagesFileName':
1330 $code: The language code or the language we're looking for a messages file for
1331 &$file: The messages file path, you can override this to change the location.
1333 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1334 remove namespaces. Do not use this hook to add namespaces. Use
1335 CanonicalNamespaces for that.
1336 &$namespaces: Array of namespaces indexed by their numbers
1338 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1339 $wgExtensionMessagesFiles instead.
1340 Use this to define synonyms of magic words depending of the language
1341 $magicExtensions: associative array of magic words synonyms
1342 $lang: language code (string)
1344 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1345 listed in $wgExtensionMessagesFiles instead.
1346 Use to define aliases of special pages names depending of the language
1347 $specialPageAliases: associative array of magic words synonyms
1348 $lang: language code (string)
1350 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1351 &$names: array of language code => language name
1352 $code language of the preferred translations
1354 'LinkBegin': Used when generating internal and interwiki links in
1355 Linker::link(), before processing starts. Return false to skip default
1356 processing and return $ret. See documentation for Linker::link() for details on
1357 the expected meanings of parameters.
1358 $skin: the Skin object
1359 $target: the Title that the link is pointing to
1360 &$html: the contents that the <a> tag should have (raw HTML); null means
1362 &$customAttribs: the HTML attributes that the <a> tag should have, in
1363 associative array form, with keys and values unescaped. Should be merged with
1364 default values, with a value of false meaning to suppress the attribute.
1365 &$query: the query string to add to the generated URL (the bit after the "?"),
1366 in associative array form, with keys and values unescaped.
1367 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1368 &$ret: the value to return if your hook returns false.
1370 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1371 just before the function returns a value. If you return true, an <a> element
1372 with HTML attributes $attribs and contents $html will be returned. If you
1373 return false, $ret will be returned.
1374 $skin: the Skin object
1375 $target: the Title object that the link is pointing to
1376 $options: the options. Will always include either 'known' or 'broken', and may
1377 include 'noclasses'.
1378 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1379 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1380 associative array form.
1381 &$ret: the value to return if your hook returns false.
1383 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1385 &$url: the image url
1386 &$alt: the image's alt text
1387 &$img: the new image HTML (if returning false)
1389 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1392 &$text: the link text
1393 &$link: the new link HTML (if returning false)
1394 &$attribs: the attributes to be applied.
1395 $linkType: The external link type
1397 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1399 &$linksUpdate: the LinksUpdate object
1401 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1402 each link table insert. For example, pagelinks, imagelinks, externallinks.
1403 $linksUpdate: LinksUpdate object
1404 $table: the table to insert links to
1405 $insertions: an array of links to insert
1407 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1408 including delete and insert, has completed for all link tables
1409 &$linksUpdate: the LinksUpdate object
1411 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1412 &$linksUpdate: the LinksUpdate object
1414 'ListDefinedTags': When trying to find all defined tags.
1415 &$tags: The list of tags.
1417 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1418 &updater: A DatabaseUpdater subclass
1420 'LocalFile::getHistory': Called before file history query performed.
1421 $file: the File object
1423 $fields: select fields
1425 $opts: query options
1426 $join_conds: JOIN conditions
1428 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1429 $file: the File object
1430 $archiveName: name of an old file version or false if it's the current one
1432 'LocalisationCacheRecache': Called when loading the localisation data into
1434 $cache: The LocalisationCache object
1435 $code: language code
1436 &$alldata: The localisation data from core and extensions
1438 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1439 Returning false will prevent the string from being added to the OutputPage.
1440 &$s: html string to show for the log extract
1441 $types: String or Array Log types to show
1442 $page: String or Title The page title to show log entries for
1443 $user: String The user who made the log entries
1444 $param: Associative Array with the following additional options:
1445 - lim Integer Limit of items to show, default is 50
1446 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1447 - showIfEmpty boolean Set to false if you don't want any output in case the
1448 loglist is empty if set to true (default), "No matching items in log" is
1449 displayed if loglist is empty
1450 - msgKey Array If you want a nice box with a message, set this to the key of
1451 the message. First element is the message key, additional optional elements
1452 are parameters for the key that are processed with
1453 wfMessage()->params()->parseAsBlock()
1454 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1456 - wrap String Wrap the message in html (usually something like
1457 "<div ...>$1</div>").
1458 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1460 'LoginAuthenticateAudit': A login attempt for a valid user account either
1461 succeeded or failed. No return data is accepted; this hook is for auditing only.
1462 $user: the User object being authenticated against
1463 $password: the password being submitted and found wanting
1464 $retval: a LoginForm class constant with authenticateUserData() return
1465 value (SUCCESS, WRONG_PASS, etc.).
1467 'LogLine': Processes a single log entry on Special:Log.
1468 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1469 logging.log_type database field.
1470 $log_action: string for the type of log action (e.g. 'delete', 'block',
1471 'create2'). Corresponds to logging.log_action database field.
1472 $title: Title object that corresponds to logging.log_namespace and
1473 logging.log_title database fields.
1474 $paramArray: Array of parameters that corresponds to logging.log_params field.
1475 Note that only $paramArray[0] appears to contain anything.
1476 &$comment: string that corresponds to logging.log_comment database field, and
1477 which is displayed in the UI.
1478 &$revert: string that is displayed in the UI, similar to $comment.
1479 $time: timestamp of the log entry (added in 1.12)
1481 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1483 $refreshLinks: RefreshLinks object
1485 'MagicWordwgVariableIDs': When defining new magic words IDs.
1486 $variableIDs: array of strings
1488 'MakeGlobalVariablesScript': Called right before Skin::makeVariablesScript is
1489 executed. Ideally, this hook should only be used to add variables that depend on
1490 the current page/request; static configuration should be added through
1491 ResourceLoaderGetConfigVars instead.
1492 &$vars: variable (or multiple variables) to be added into the output of
1493 Skin::makeVariablesScript
1494 $out: The OutputPage which called the hook, can be used to get the real title.
1496 'MarkPatrolled': Before an edit is marked patrolled.
1497 $rcid: ID of the revision to be marked patrolled
1498 $user: the user (object) marking the revision as patrolled
1499 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1500 sysop in order to mark an edit patrolled.
1502 'MarkPatrolledComplete': After an edit is marked patrolled.
1503 $rcid: ID of the revision marked as patrolled
1504 $user: user (object) who marked the edit patrolled
1505 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1506 sysop to patrol the edit.
1508 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1509 something completely different, after the basic globals have been set up, but
1510 before ordinary actions take place.
1512 $article: $wgArticle
1515 $request: $wgRequest
1516 $mediaWiki: The $mediawiki object
1518 'MessagesPreLoad': When loading a message from the database.
1519 $title: title of the message (string)
1520 $message: value (string), change it to the message you want to define
1522 'MessageCacheReplace': When a message page is changed. Useful for updating
1524 $title: name of the page changed.
1525 $text: new contents of the page.
1527 'ModifyExportQuery': Modify the query used by the exporter.
1528 $db: The database object to be queried.
1529 &$tables: Tables in the query.
1530 &$conds: Conditions in the query.
1531 &$opts: Options for the query.
1532 &$join_conds: Join conditions for the query.
1534 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1535 links have been rendered (useful for adding more). Note: this is only run for
1536 the Monobook skin. To add items to the toolbox you should use the
1537 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1539 $tools: array of tools
1541 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1542 and returning it for the skin to output. You can add items to the toolbox while
1543 still letting the skin make final decisions on skin-specific markup conventions
1545 &$sk: The BaseTemplate base skin template
1546 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1547 BaseTemplate::makeListItem for details on the format of individual items
1548 inside of this array.
1550 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1552 $index: Integer; the index of the namespace being checked.
1553 $result: Boolean; whether MediaWiki currently thinks that pages in this
1554 namespace are movable. Hooks may change this value to override the return
1555 value of MWNamespace::isMovable().
1557 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1559 $wikiPage: the WikiPage edited
1560 $rev: the new revision
1561 $baseID: the revision ID this was based off, if any
1562 $user: the editing user
1564 'NormalizeMessageKey': Called before the software gets the text of a message
1565 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1567 &$key: the message being looked up. Change this to something else to change
1568 what message gets displayed (string)
1569 &$useDB: whether or not to look up the message in the database (bool)
1570 &$langCode: the language code to get the message for (string) - or -
1571 whether to use the content language (true) or site language (false) (bool)
1572 &$transform: whether or not to expand variables and templates
1573 in the message (bool)
1575 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1576 return false to omit the line from RecentChanges and Watchlist special pages.
1577 &$changeslist: The OldChangesList instance.
1578 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1579 &$rc: The RecentChange object.
1580 &$classes: array of css classes for the <li> element
1582 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1583 can alter or append to the array of URLs for search & suggestion formats.
1584 &$urls: array of associative arrays with Url element attributes
1586 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1587 users and/or IP addresses too.
1588 $otherBlockLink: An array with links to other block logs
1589 $ip: The requested IP address or username
1591 'OutputPageBeforeHTML': A page has been processed by the parser and the
1592 resulting HTML is about to be displayed.
1593 $parserOutput: the parserOutput (object) that corresponds to the page
1594 $text: the text that will be displayed, in HTML (string)
1596 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1597 body tag to allow for extensions to add attributes to the body of the page they
1598 might need. Or to allow building extensions to add body classes that aren't of
1599 high enough demand to be included in core.
1600 $out: The OutputPage which called the hook, can be used to get the real title
1601 $sk: The Skin that called OutputPage::headElement
1602 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1604 'OutputPageCheckLastModified': when checking if the page has been modified
1605 since the last visit.
1606 &$modifiedTimes: array of timestamps.
1607 The following keys are set: page, user, epoch
1609 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1610 $out: OutputPage instance (object)
1611 $parserOutput: parserOutput instance being added in $out
1613 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1614 categories. Implementations should return false if they generate the category
1615 links, so the default link generation is skipped.
1616 $out: OutputPage instance (object)
1617 $categories: associative array, keys are category names, values are category
1618 types ("normal" or "hidden")
1619 $links: array, intended to hold the result. Must be an associative array with
1620 category types as keys and arrays of HTML links as values.
1622 'PageContentInsertComplete': After a new article is created.
1623 $wikiPage: WikiPage created
1624 $user: User creating the article
1625 $content: New content as a Content object
1626 $summary: Edit summary/comment
1627 $isMinor: Whether or not the edit was marked as minor
1628 $isWatch: (No longer used)
1629 $section: (No longer used)
1630 $flags: Flags passed to WikiPage::doEditContent()
1631 $revision: New Revision of the article
1633 'PageContentLanguage': Allows changing the language in which the content of a
1634 page is written. Defaults to the wiki content language ($wgContLang).
1635 $title: Title object
1636 &$pageLang: the page content language (either an object or a language code)
1637 $wgLang: the user language
1639 'PageContentSave': Before an article is saved.
1640 $wikiPage: the WikiPage (object) being saved
1641 $user: the user (object) saving the article
1642 $content: the new article content, as a Content object
1643 $summary: the article summary (comment)
1644 $isminor: minor flag
1645 $iswatch: watch flag
1648 'PageContentSaveComplete': After an article has been updated.
1649 $wikiPage: WikiPage modified
1650 $user: User performing the modification
1651 $content: New content, as a Content object
1652 $summary: Edit summary/comment
1653 $isMinor: Whether or not the edit was marked as minor
1654 $isWatch: (No longer used)
1655 $section: (No longer used)
1656 $flags: Flags passed to WikiPage::doEditContent()
1657 $revision: New Revision of the article
1658 $status: Status object about to be returned by doEditContent()
1659 $baseRevId: the rev ID (or false) this edit was based on
1661 'PageHistoryBeforeList': When a history page list is about to be constructed.
1662 $article: the article that the history is loading for
1664 'PageHistoryLineEnding' : Right before the end <li> is added to a history line.
1665 $row: the revision row for this line
1666 $s: the string representing this parsed line
1667 $classes: array containing the <li> element classes
1669 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1672 $queryInfo: the query parameters
1674 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1675 which depends on user options should install this hook and append its values to
1677 $hash: reference to a hash key string which can be modified
1679 'ParserAfterParse': Called from Parser::parse() just after the call to
1680 Parser::internalParse() returns.
1681 $parser: parser object
1682 $text: text being parsed
1683 $stripState: stripState used (object)
1685 'ParserAfterStrip': Called at end of parsing time.
1686 TODO: No more strip, deprecated ?
1687 $parser: parser object
1688 $text: text being parsed
1689 $stripState: stripState used (object)
1691 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1692 $parser: Parser object being used
1693 $text: text that will be returned
1695 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1696 $parser: Parser object
1697 $text: text to parse
1698 $stripState: StripState instance being used
1700 'ParserBeforeStrip': Called at start of parsing time.
1701 TODO: No more strip, deprecated ?
1702 $parser: parser object
1703 $text: text being parsed
1704 $stripState: stripState used (object)
1706 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1707 $parser: Parser object being used
1710 'ParserClearState': Called at the end of Parser::clearState().
1711 $parser: Parser object being cleared
1713 'ParserCloned': Called when the parser is cloned.
1714 $parser: Newly-cloned Parser object
1716 'ParserFirstCallInit': Called when the parser initialises for the first time.
1717 &$parser: Parser object being cleared
1719 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1721 $parser: Parser object
1722 $varCache: array to store the value in case of multiples calls of the
1724 $index: index (string) of the magic
1725 $ret: value of the magic word (the hook should set it)
1726 $frame: PPFrame object to use for expanding any template variables
1728 'ParserGetVariableValueTs': Use this to change the value of the time for the
1729 {{LOCAL...}} magic word.
1730 $parser: Parser object
1731 $time: actual time (timestamp)
1733 'ParserGetVariableValueVarCache': use this to change the value of the variable
1734 cache or return false to not use it.
1735 $parser: Parser object
1736 $varCache: variable cache (array)
1738 'ParserLimitReport': Called at the end of Parser:parse() when the parser will
1739 include comments about size of the text parsed.
1740 $parser: Parser object
1741 $limitReport: text that will be included (without comment tags)
1743 'ParserMakeImageParams': Called before the parser make an image link, use this
1744 to modify the parameters of the image.
1745 $title: title object representing the file
1746 $file: file object that will be used to create the image
1747 &$params: 2-D array of parameters
1748 $parser: Parser object that called the hook
1750 'ParserSectionCreate': Called each time the parser creates a document section
1751 from wikitext. Use this to apply per-section modifications to HTML (like
1752 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1753 can begin in one section and end in another. Make sure your code can handle
1754 that case gracefully. See the EditSectionClearerLink extension for an example.
1755 $parser: the calling Parser instance
1756 $section: the section number, zero-based, but section 0 is usually empty
1757 &$sectionContent: ref to the content of the section. modify this.
1758 $showEditLinks: boolean describing whether this section has an edit link
1760 'ParserTestParser': Called when creating a new instance of Parser in
1761 maintenance/parserTests.inc.
1762 $parser: Parser object created
1764 'ParserTestGlobals': Allows to define globals for parser tests.
1765 &$globals: Array with all the globals which should be set for parser tests.
1766 The arrays keys serve as the globals names, its values are the globals values.
1768 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
1769 run. Use when page save hooks require the presence of custom tables to ensure
1770 that tests continue to run properly.
1771 &$tables: array of table names
1773 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1774 my talk page, my contributions" etc).
1775 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1776 &$title: Title object representing the current page
1778 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
1779 &$user : User performing the action
1780 $action : Action being performed
1781 &$result : Whether or not the action should be prevented
1782 Change $result and return false to give a definitive answer, otherwise
1783 the built-in rate limiting checks are used, if enabled.
1785 'PlaceNewSection': Override placement of new sections. Return false and put the
1786 merged text into $text to override the default behavior.
1787 $wikipage : WikiPage object
1788 $oldtext : the text of the article before editing
1789 $subject : subject of the new section
1790 &$text : text of the new section
1792 'PreferencesGetLegend': Override the text used for the <legend> of a
1793 preferences section.
1794 $form: the PreferencesForm object. This is a ContextSource as well
1795 $key: the section name
1796 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1798 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1799 AJAX search suggestions. Put results into &$results outparam and return false.
1800 $ns : array of int namespace keys to search in
1801 $search : search term (not guaranteed to be conveniently normalized)
1802 $limit : maximum number of results to return
1803 &$results : out param: array of page names (strings)
1805 'PrefsEmailAudit': Called when user changes their email address.
1806 $user: User (object) changing his email address
1807 $oldaddr: old email address (string)
1808 $newaddr: new email address (string)
1810 'PrefsPasswordAudit': Called when user changes his password.
1811 $user: User (object) changing his password
1812 $newPass: new password
1813 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1815 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
1817 $article: the title being (un)protected
1818 $output: a string of the form HTML so far
1820 'ProtectionForm::save': Called when a protection form is submitted.
1821 $article: the title being (un)protected
1822 $errorMsg: an html message string of an error or an array of message name and
1825 'ProtectionForm::showLogExtract': Called after the protection log extract is
1827 $article: the page the form is shown for
1828 $out: OutputPage object
1830 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
1831 &$obj: RawPage object
1832 &$text: The text that's going to be the output
1834 'RecentChange_save': Called at the end of RecentChange::save().
1835 $recentChange: RecentChange object
1837 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
1838 names such as "oldid" that are preserved when using redirecting special pages
1839 such as Special:MyPage and Special:MyTalk.
1840 &$redirectParams: An array of parameters preserved by redirecting special pages.
1842 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
1843 instance. Can be used by an extension override what skin is used in certain
1845 IContextSource $context: The RequestContext the skin is being created for.
1846 &$skin: A variable reference you may set a Skin instance or string key on to
1847 override the skin that will be used for the context.
1849 'ResourceLoaderGetConfigVars': Called at the end of
1850 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1851 configuration variables to JavaScript. Things that depend on the current page
1852 or request state must be added through MakeGlobalVariablesScript instead.
1853 &$vars: array( variable name => value )
1855 'ResourceLoaderGetStartupModules': Run once the startup module is being
1856 generated. This allows you to add modules to the startup module. This hook
1857 should be used sparingly since any module added here will be loaded on all
1858 pages. This hook is useful if you want to make code available to module loader
1861 'ResourceLoaderRegisterModules': Right before modules information is required,
1862 such as when responding to a resource
1863 loader request or generating HTML output.
1864 &$resourceLoader: ResourceLoader object
1866 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
1867 called after the addition of 'qunit' and MediaWiki testing resources.
1868 &testModules: array of JavaScript testing modules. The 'qunit' framework,
1869 included in core, is fed using tests/qunit/QUnitTestResources.php.
1870 &ResourceLoader object
1872 To add a new qunit module named 'myext.tests':
1873 testModules['qunit']['myext.tests'] = array(
1874 'script' => 'extension/myext/tests.js',
1875 'dependencies' => <any module dependency you might have>
1877 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
1878 added to any module.
1880 'RevisionInsertComplete': Called after a revision is inserted into the database.
1881 &$revision: the Revision
1882 $data: the data stored in old_text. The meaning depends on $flags: if external
1883 is set, it's the URL of the revision text in external storage; otherwise,
1884 it's the revision text itself. In either case, if gzip is set, the revision
1886 $flags: a comma-delimited list of strings representing the options used. May
1887 include: utf8 (this will always be set for new revisions); gzip; external.
1889 'SearchUpdate': Prior to search update completion.
1891 $namespace : Page namespace
1893 $text : Current text being indexed
1895 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
1896 the normal operations.
1897 $allSearchTerms : Array of the search terms in all content languages
1898 &$titleResult : Outparam; the value to return. A Title object or null.
1900 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
1901 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
1903 $term : Search term string
1904 &$title : Outparam; set to $title object and return false for a match
1906 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1907 if nothing was found.
1908 $term : Search term string
1909 &$title : Outparam; set to $title object and return false for a match
1911 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
1913 $term : Search term string
1914 &$title : Current Title object that is being returned (null if none found).
1916 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1917 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1918 in the $searchEngine->namespaces array.
1919 $query : Original query.
1920 &$parsed : Resultant query with the prefixes stripped.
1922 'SearchResultInitFromTitle': Set the revision used when displaying a page in
1924 $title : Current Title object being displayed in search results.
1925 &$id: Revision ID (default is false, for latest)
1927 'SearchableNamespaces': An option to modify which namespaces are searchable.
1928 &$arr : Array of namespaces ($nsId => $name) which will be used.
1930 'SeleniumSettings': TODO
1932 'SetupAfterCache': Called in Setup.php, after cache objects are set
1934 'ShowMissingArticle': Called when generating the output for a non-existent page.
1935 $article: The article object corresponding to the page
1937 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
1938 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
1939 $text: Text being shown
1940 $title: Title of the custom script/stylesheet page
1941 $output: Current OutputPage object
1943 'ShowSearchHitTitle': Customise display of search hit title/link.
1944 &$title: Title to link to
1945 &$text: Text to use for the link
1946 $result: The search result
1947 $terms: The search terms entered
1948 $page: The SpecialSearch object.
1950 'ShowSearchHit': Customize display of search hit.
1951 $searchPage: The SpecialSearch instance.
1952 $result: The SearchResult to show
1953 $terms: Search terms, for highlighting
1954 &$link: HTML of link to the matching page. May be modified.
1955 &$redirect: HTML of redirect info. May be modified.
1956 &$section: HTML of matching section. May be modified.
1957 &$extract: HTML of content extract. May be modified.
1958 &$score: HTML of score. May be modified.
1959 &$size: HTML of page size. May be modified.
1960 &$date: HTML of of page modification date. May be modified.
1961 &$related: HTML of additional info for the matching page. May be modified.
1962 &$html: May be set to the full HTML that should be used to represent the search
1963 hit. Must include the <li> ... </li> tags. Will only be used if the hook
1964 function returned false.
1966 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
1967 allow the normal method of notice selection/rendering to work, or change the
1968 value of $siteNotice and return false to alter it.
1969 &$siteNotice: HTML returned as the sitenotice
1972 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
1973 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
1974 the sitenotice/anonnotice.
1977 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
1979 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
1980 the stock bottom scripts.
1982 'SkinAfterContent': Allows extensions to add text after the page content and
1983 article metadata. This hook should work in all skins. Set the &$data variable to
1984 the text you're going to add.
1985 &$data: (string) Text to be printed out directly (without parsing)
1988 'SkinBuildSidebar': At the end of Skin::buildSidebar().
1990 &$bar: Sidebar contents
1991 Modify $bar to add or modify sidebar portlets.
1993 'SkinCopyrightFooter': Allow for site and per-namespace customization of
1995 $title: displayed page title
1996 $type: 'normal' or 'history' for old/diff views
1997 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
1998 message must be in HTML format, not wikitext!
1999 &$link: overridable HTML link to be passed into the message as $1
2000 &$forContent: overridable flag if copyright footer is shown in content language.
2002 'SkinGetPoweredBy': TODO
2003 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2004 the MediaWiki icon but plain text instead.
2007 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2008 &$subpages: Subpage links HTML
2010 $out: OutputPage object
2011 If false is returned $subpages will be used instead of the HTML
2012 subPageSubtitle() generates.
2013 If true is returned, $subpages will be ignored and the rest of
2014 subPageSubtitle() will run.
2016 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2018 $sktemplate: SkinTemplate object
2019 $nav_urls: array of tabs
2021 To alter the structured navigation links in SkinTemplates, there are three
2022 hooks called in different spots:
2024 'SkinTemplateNavigation': Called on content pages after the tabs have been
2025 added, but before variants have been added.
2026 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2027 tab is added but before variants have been added.
2028 'SkinTemplateNavigation::Universal': Called on both content and special pages
2029 after variants have been added.
2030 &$sktemplate: SkinTemplate object
2031 &$links: Structured navigation links. This is used to alter the navigation for
2032 skins which use buildNavigationUrls such as Vector.
2034 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2036 &$sktemplate: SkinTemplate object
2037 &$tpl: Template engine object
2039 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2040 $sktemplate: SkinTemplate object
2041 $res: set to true to prevent active tabs
2043 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2044 You can either create your own array, or alter the parameters for
2046 &$sktemplate: The SkinTemplate instance.
2047 $title: Title instance for the page.
2048 $message: Visible label of tab.
2049 $selected: Whether this is a selected tab.
2050 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2051 &$classes: Array of CSS classes to apply.
2052 &$query: Query string to add to link.
2054 &$result: Complete assoc. array if you want to return true.
2056 'SkinTemplateTabs': TODO
2058 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2059 been rendered (useful for adding more).
2060 $sk: The QuickTemplate based skin template running the hook.
2061 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2062 extensions that add support for BaseTemplateToolbox should watch for this
2063 dummy parameter with "$dummy=false" in their code and return without echoing
2064 any HTML to avoid creating duplicate toolbox items.
2066 'SoftwareInfo': Called by Special:Version for returning information about the
2068 $software: The array of software in format 'name' => 'version'. See
2069 SpecialVersion::softwareInformation().
2071 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2072 $id: User identifier
2074 'SpecialListusersDefaultQuery': Called right before the end of
2075 UsersPager::getDefaultQuery().
2076 $pager: The UsersPager instance
2077 $query: The query array to be returned
2079 'SpecialListusersFormatRow': Called right before the end of
2080 UsersPager::formatRow().
2081 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2082 $row: Database row object
2084 'SpecialListusersHeader': Called before closing the <fieldset> in
2085 UsersPager::getPageHeader().
2086 $pager: The UsersPager instance
2087 $out: The header HTML
2089 'SpecialListusersHeaderForm': Called before adding the submit button in
2090 UsersPager::getPageHeader().
2091 $pager: The UsersPager instance
2092 $out: The header HTML
2094 'SpecialListusersQueryInfo': Called right before the end of.
2095 UsersPager::getQueryInfo()
2096 $pager: The UsersPager instance
2097 $query: The query array to be returned
2099 'SpecialMovepageAfterMove': Called after moving a page.
2100 $movePage: MovePageForm object
2101 $oldTitle: old title (object)
2102 $newTitle: new title (object)
2104 'SpecialNewpagesConditions': Called when building sql query for
2106 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2107 $opts: FormOptions object containing special page options
2108 &$conds: array of WHERE conditionals for query
2109 &tables: array of tables to be queried
2110 &$fields: array of columns to select
2111 &$join_conds: join conditions for the tables
2113 'SpecialNewPagesFilters': Called after building form options at NewPages.
2114 $special: the special page object
2115 &$filters: associative array of filter definitions. The keys are the HTML
2116 name/URL parameters. Each key maps to an associative array with a 'msg'
2117 (message key) and a 'default' value.
2119 'SpecialPage_initList': Called when setting up SpecialPage::$mList, use this
2120 hook to remove a core special page.
2121 $list: list (array) of core special pages
2123 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2124 $special: the SpecialPage object
2125 $subPage: the subpage string or null if no subpage was specified
2127 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2128 $special: the SpecialPage object
2129 $subPage: the subpage string or null if no subpage was specified
2131 'SpecialPasswordResetOnSubmit': When executing a form submission on
2132 Special:PasswordReset.
2133 $users: array of User objects.
2134 $data: array of data submitted by the user
2135 &$error: string, error code (message key) used to describe to error (out
2136 parameter). The hook needs to return false when setting this, otherwise it
2137 will have no effect.
2139 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2140 use this to change some selection criteria or substitute a different title.
2141 &$randstr: The random number from wfRandom()
2142 &$isRedir: Boolean, whether to select a redirect or non-redirect
2143 &$namespaces: An array of namespace indexes to get the title from
2144 &$extra: An array of extra SQL statements
2145 &$title: If the hook returns false, a Title object to use instead of the
2146 result from the normal query
2148 'SpecialRecentChangesFilters': Called after building form options at
2150 $special: the special page object
2151 &$filters: associative array of filter definitions. The keys are the HTML
2152 name/URL parameters. Each key maps to an associative array with a 'msg'
2153 (message key) and a 'default' value.
2155 'SpecialRecentChangesPanel': Called when building form options in
2156 SpecialRecentChanges.
2157 &$extraOpts: array of added items, to which can be added
2158 $opts: FormOptions for this request
2160 'SpecialRecentChangesQuery': Called when building SQL query for
2161 SpecialRecentChanges and SpecialRecentChangesLinked.
2162 &$conds: array of WHERE conditionals for query
2163 &$tables: array of tables to be queried
2164 &$join_conds: join conditions for the tables
2165 $opts: FormOptions for this request
2166 &$query_options: array of options for the database request
2167 &$select: Array of columns to select
2169 'SpecialSearchCreateLink': Called when making the message to create a page or
2170 go to the existing page.
2171 $t: title object searched for
2172 &$params: an array of the default message name and page title (as parameter)
2174 'SpecialSearchGo': Called when user clicked the "Go".
2175 &$title: title object generated from the text entered by the user
2176 &$term: the search term entered by the user
2178 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2179 target doesn't exist.
2180 &$title: title object generated from the text entered by the user
2182 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2183 the advanced form, a.k.a. power search box.
2184 &$showSections: an array to add values with more options to
2185 $term: the search term (not a title object)
2186 $opts: an array of hidden options (containing 'redirs' and 'profile')
2188 'SpecialSearchProfiles': Allows modification of search profiles.
2189 &$profiles: profiles, which can be modified.
2191 'SpecialSearchProfileForm': Allows modification of search profile forms.
2192 $search: special page object
2193 &$form: String: form html
2194 $profile: String: current search profile
2195 $term: String: search term
2196 $opts: Array: key => value of hidden options for inclusion in custom forms
2198 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2199 $search: SpecialSearch special page object
2200 $profile: String: current search profile
2201 $engine: the search engine
2203 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2204 on the search results page. Useful for including an external search
2205 provider. To disable the output of MediaWiki search output, return
2207 $specialSearch: SpecialSearch object ($this)
2209 $term: Search term specified by the user
2211 'SpecialSearchResultsAppend': Called after all search results HTML has
2212 been output. Note that in some cases, this hook will not be called (no
2213 results, too many results, SpecialSearchResultsPrepend returned false,
2215 $specialSearch: SpecialSearch object ($this)
2217 $term: Search term specified by the user
2219 'SpecialSearchResults': Called before search result display when there are
2221 $term: string of search term
2222 &$titleMatches: empty or SearchResultSet object
2223 &$textMatches: empty or SearchResultSet object
2225 'SpecialSearchNoResults': Called before search result display when there are no
2227 $term: string of search term
2229 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2230 &$extraStats: Array to save the new stats
2231 ( $extraStats['<name of statistic>'] => <value>; )
2233 'SpecialUploadComplete': Called after successfully uploading a file from
2235 $form: The SpecialUpload object
2237 'SpecialVersionExtensionTypes': Called when generating the extensions credits,
2238 use this to change the tables headers.
2239 $extTypes: associative array of extensions types
2241 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2242 $wgVersion: Current $wgVersion for you to use
2243 &$versionUrl: Raw url to link to (eg: release notes)
2245 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2246 $special: the special page object
2247 &$filters: associative array of filter definitions. The keys are the HTML
2248 name/URL parameters. Each key maps to an associative array with a 'msg'
2249 (message key) and a 'default' value.
2251 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2252 &$conds: array of WHERE conditionals for query
2253 &$tables: array of tables to be queried
2254 &$join_conds: join conditions for the tables
2255 &$fields: array of query fields
2257 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2258 URL for a title when we have no other parameters on the URL. Gives a chance for
2259 extensions that alter page view behavior radically to abort that redirect or
2261 $request: WebRequest
2262 $title: Title of the currently found title obj
2263 $output: OutputPage object
2265 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2266 rendered (by ThumbnailImage:toHtml method).
2267 $thumbnail: the ThumbnailImage object
2268 &$attribs: image attribute array
2269 &$linkAttribs: image link attribute array
2271 'TitleArrayFromResult': Called when creating an TitleArray object from a
2273 &$titleArray: set this to an object to override the default object returned
2274 $res: database result used to create the object
2276 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2277 that can be applied.
2278 $title: The title in question.
2279 &$types: The types of protection available.
2281 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2282 $title: Title object that is being checked
2283 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2284 Hooks may change this value to override the return value of
2285 Title::isCssOrJsPage().
2287 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2288 overriding default behaviour for determining if a page exists. If $isKnown is
2289 kept as null, regular checks happen. If it's a boolean, this value is returned
2290 by the isKnown method.
2291 $title: Title object that is being checked
2292 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2294 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2295 that this hook is not called for interwiki pages or pages in immovable
2296 namespaces: for these, isMovable() always returns false.
2297 $title: Title object that is being checked
2298 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2299 Hooks may change this value to override the return value of
2302 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2303 be handled by separate handler (via ArticleViewCustom).
2304 $title: Title object that is being checked
2305 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2306 Hooks may change this value to override the return value of
2307 Title::isWikitextPage()
2309 'TitleMoveComplete': After moving an article (title).
2312 $user: user who did the move
2313 $pageid: database ID of the page that's been moved
2314 $redirid: database ID of the created redirect
2316 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2317 adding the default error message if nothing allows the user to read the page. If
2318 a handler wants a title to *not* be whitelisted, it should also return false.
2319 $title: Title object being checked against
2320 $user: Current user object
2321 &$whitelisted: Boolean value of whether this title is whitelisted
2323 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2324 PageArchive object has been created but before any further processing is done.
2325 &$archive: PageArchive object
2326 $title: Title object of the page that we're viewing
2328 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2329 PageArchive object has been created but before any further processing is done.
2330 &$archive: PageArchive object
2331 $title: Title object of the page that we're viewing
2333 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2334 the site is not in read-only mode, that the Title object is not null and after
2335 a PageArchive object has been constructed but before performing any further
2337 &$archive: PageArchive object
2338 $title: Title object of the page that we're about to undelete
2340 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2341 $title: title object related to the revision
2342 $rev: revision (object) that will be viewed
2344 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2346 $action: action name
2347 $article: article "acted on"
2349 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2350 &$files: list of files
2352 'UnwatchArticle': Before a watch is removed from an article.
2353 $user: user watching
2354 $page: WikiPage object to be removed
2356 'UnwatchArticleComplete': After a watch is removed from an article.
2357 $user: user that watched
2358 $page: WikiPage object that was watched
2360 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2361 $formattedPageStatus: list of valid page states
2363 'UploadForm:initial': Before the upload form is generated. You might set the
2364 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2365 text (HTML) either before or after the editform.
2366 $form: UploadForm object
2368 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2369 poke at member variables like $mUploadDescription before the file is saved. Do
2370 not use this hook to break upload processing. This will return the user to a
2371 blank form with no error message; use UploadVerification and UploadVerifyFile
2373 $form: UploadForm object
2375 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2376 $type: (string) the requested upload type
2377 &$className: the class name of the Upload instance to be created
2379 'UploadComplete': when Upload completes an upload.
2380 &$upload: an UploadBase child instance
2382 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2384 $descriptor: (array) the HTMLForm descriptor
2386 'UploadFormSourceDescriptors': after the standard source inputs have been
2387 added to the descriptor
2388 $descriptor: (array) the HTMLForm descriptor
2390 'UploadVerification': Additional chances to reject an uploaded file. Consider
2391 using UploadVerifyFile instead.
2392 string $saveName: destination file name
2393 string $tempName: filesystem path to the temporary file for checks
2394 string &$error: output: message key for message to show if upload canceled by
2395 returning false. May also be an array, where the first element is the message
2396 key and the remaining elements are used as parameters to the message.
2398 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2399 in most cases over UploadVerification.
2400 object $upload: an instance of UploadBase, with all info about the upload
2401 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2402 will typically only apply for specific mime types.
2403 object &$error: output: true if the file is valid. Otherwise, an indexed array
2404 representing the problem with the file, where the first element is the message
2405 key and the remaining elements are used as parameters to the message.
2407 'UploadComplete': Upon completion of a file upload.
2408 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2409 $uploadBase->getLocalFile().
2411 'User::mailPasswordInternal': before creation and mailing of a user's new
2413 $user: the user who sent the message out
2414 $ip: IP of the user who sent the message out
2415 $u: the account whose new password will be set
2417 'UserAddGroup': Called when adding a group; return false to override
2418 stock group addition.
2419 $user: the user object that is to have a group added
2420 &$group: the group to add, can be modified
2422 'UserArrayFromResult': Called when creating an UserArray object from a database
2424 &$userArray: set this to an object to override the default object returned
2425 $res: database result used to create the object
2427 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2428 want to display an error message, try getUserPermissionsErrors.
2429 $title: Title object being checked against
2430 $user : Current user object
2431 $action: Action being checked
2432 $result: Pointer to result returned if hook returns false. If null is returned,
2433 userCan checks are continued by internal code.
2435 'UserCanSendEmail': To override User::canSendEmail() permission check.
2436 $user: User (object) whose permission is being checked
2437 &$canSend: bool set on input, can override on output
2439 'UserClearNewTalkNotification': Called when clearing the "You have new
2440 messages!" message, return false to not delete it.
2441 $user: User (object) that will clear the message
2443 'UserComparePasswords': Called when checking passwords, return false to
2444 override the default password checks.
2445 &$hash: String of the password hash (from the database)
2446 &$password: String of the plaintext password the user entered
2447 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2449 &$result: If the hook returns false, this Boolean value will be checked to
2450 determine if the password was valid
2452 'UserCreateForm': change to manipulate the login form
2453 $template: SimpleTemplate instance for the form
2455 'UserCryptPassword': Called when hashing a password, return false to implement
2456 your own hashing method.
2457 &$password: String of the plaintext password to encrypt
2458 &$salt: String of the password salt or Boolean false if no salt is provided
2459 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2461 &$hash: If the hook returns false, this String will be used as the hash
2463 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2464 $user: User to get groups for
2465 &$groups: Current effective groups
2467 'UserGetAllRights': After calculating a list of all available rights.
2468 &$rights: Array of rights, which may be added to.
2470 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2471 before returning the options to the caller. Warning: This hook is called for
2472 every call to User::getDefaultOptions(), which means it's potentially called
2473 dozens or hundreds of times. You may want to cache the results of non-trivial
2474 operations in your hook function for this reason.
2475 &$defaultOptions: Array of preference keys and their default values.
2477 'UserGetEmail': Called when getting an user email address.
2479 &$email: email, change this to override local email
2481 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2482 email authentication.
2484 &$timestamp: timestamp, change this to override local email authentication
2487 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2488 &$groups: List of implicit (automatically-assigned) groups
2490 'UserGetLanguageObject': Called when getting user's interface language object.
2492 &$code: Language code that will be used to create the object
2493 $context: RequestContext object
2495 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2496 &$reservedUsernames: $wgReservedUsernames
2498 'UserGetRights': Called in User::getRights().
2499 $user: User to get rights for
2500 &$rights: Current rights
2502 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2503 specific block exemptions).
2504 $user: User in question
2505 $title: Title of the page in question
2506 &$blocked: Out-param, whether or not the user is blocked from that page.
2507 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2508 to edit their own user talk pages.
2510 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2512 $ip: User's IP address
2513 &$blocked: Whether the user is blocked, to be modified by the hook
2515 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2516 environmental means; occurs after session is loaded.
2517 $user: user object being loaded
2519 'UserLoadDefaults': Called when loading a default user.
2523 'UserLoadFromDatabase': Called when loading a user from the database.
2525 &$s: database query object
2527 'UserLoadFromSession': Called to authenticate users on external/environmental
2528 means; occurs before session is loaded.
2529 $user: user object being loaded
2530 &$result: set this to a boolean value to abort the normal authentication
2533 'UserLoadOptions': When user options/preferences are being loaded from the
2536 &$options: Options, can be modified.
2538 'UserLoginComplete': After a user has logged in.
2539 $user: the user object that was created on login
2540 $inject_html: Any HTML to inject after the "logged in" message.
2542 'UserLoginForm': change to manipulate the login form
2543 $template: SimpleTemplate instance for the form
2545 'UserLogout': Before a user logs out.
2546 $user: the user object that is about to be logged out
2548 'UserLogoutComplete': After a user has logged out.
2549 $user: the user object _after_ logout (won't have name, ID, etc.)
2550 $inject_html: Any HTML to inject after the "logged out" message.
2551 $oldName: name of the user before logout (string)
2553 'UserRemoveGroup': Called when removing a group; return false to override stock
2555 $user: the user object that is to have a group removed
2556 &$group: the group to be removed, can be modified
2558 'UserRights': After a user's group memberships are changed.
2559 $user : User object that was changed
2560 $add : Array of strings corresponding to groups added
2561 $remove: Array of strings corresponding to groups removed
2563 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2565 $user: user retrieving new talks messages
2566 $talks: array of new talks page(s)
2568 'UserSaveSettings': Called when saving user settings.
2571 'UserSaveOptions': Called just before saving user preferences/options.
2573 &$options: Options, modifiable
2575 'UserSetCookies': Called when setting user cookies.
2577 &$session: session array, will be added to $_SESSION
2578 &$cookies: cookies array mapping cookie name to its value
2580 'UserSetEmail': Called when changing user email address.
2582 &$email: new email, change this to override new email address
2584 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2585 email authentication.
2587 &$timestamp: new timestamp, change this to override local email
2588 authentication timestamp
2590 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2591 "Foobar (Talk | Contribs | Block)".
2592 $userId: User id of the current user
2593 $userText: User name of the current user
2594 &$items: Array of user tool links as HTML fragments
2596 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2597 used to alter the SQL query which gets the list of wanted pages.
2598 &$wantedPages: WantedPagesPage object
2599 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2601 'WatchArticle': Before a watch is added to an article.
2602 $user: user that will watch
2603 $page: WikiPage object to be watched
2605 'WatchArticleComplete': After a watch is added to an article.
2606 $user: user that watched
2607 $page: WikiPage object watched
2609 'WatchlistEditorBuildRemoveLine': when building remove lines in
2610 Special:Watchlist/edit.
2611 &$tools: array of extra links
2612 $title: Title object
2613 $redirect: whether the page is a redirect
2616 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2618 $router: The PathRouter instance
2620 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2621 dumps. One, and only one hook should set this, and return false.
2622 &$tables: Database tables to use in the SELECT query
2623 &$opts: Options to use for the query
2624 &$join: Join conditions
2626 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2627 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
2628 specific to a content model should be provided by the respective Content's
2629 getDeletionUpdates() method.
2631 $content: the Content to generate updates for
2632 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2634 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
2635 run a MediaWiki cli script.
2636 &$script: MediaWiki cli script path
2637 &$parameters: Array of arguments and options to the script
2638 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2641 'wgQueryPages': Called when initialising $wgQueryPages, use this to add new
2642 query pages to be updated with maintenance/updateSpecialPages.php.
2643 $query: $wgQueryPages itself
2645 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
2646 extra metadata to be added.
2647 $obj: The XmlDumpWriter object.
2648 &$out: The output string.
2649 $row: The database row for the page.
2650 $title: The title of the page.
2652 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
2654 $obj: The XmlDumpWriter object.
2655 &$out: The text being output.
2656 $row: The database row for the revision.
2657 $text: The revision text.
2659 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
2660 to add additional tags to extract.
2661 &$items: Array containing information on which items to extract. See XMPInfo for
2662 details on the format.
2664 'XMPGetResults': Called just before returning the results array of parsing xmp
2665 data. Can be used to post-process the results.
2666 &$data: Array of metadata sections (such as $data['xmp-general']) each section
2667 is an array of metadata tags returned (each tag is either a value, or an array
2670 More hooks might be available but undocumented, you can execute
2671 'php maintenance/findHooks.php' to find hidden ones.