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.
253 $rc: The current RecentChange object.
255 'AbortLogin': Return false to cancel account login.
256 $user: the User object being authenticated against
257 $password: the password being submitted, not yet checked for validity
258 &$retval: a LoginForm class constant to return from authenticateUserData();
259 default is LoginForm::ABORTED. Note that the client may be using
260 a machine API rather than the HTML user interface.
261 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: HTML to display on abort
266 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
267 Create the object with Status::newFatal() to ensure proper API error messages
268 are returned when creating account through API clients.
270 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
271 $targetUser: the user whom to send talk page email notification
272 $title: the page title
274 'SendWatchlistEmailNotification': Return true to send watchlist email notification
275 $targetUser: the user whom to send watchlist email notification
276 $title: the page title
277 $enotif: EmailNotification object
279 'AbortChangePassword': Return false to cancel password change.
280 $user: the User object to which the password change is occuring
281 $mOldpass: the old password provided by the user
282 $newpass: the new password provided by the user
283 &$abortMsg: the message identifier for abort reason
285 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
286 $name: name of the action
287 &$form: HTMLForm object
288 $article: Article object
290 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
291 Allows to change the fields on the form that will be generated.
292 $name: name of the action
293 &$fields: HTMLForm descriptor array
294 $article: Article object
296 'AddNewAccount': After a user account is created.
297 $user: the User object that was created. (Parameter added in 1.7)
298 $byEmail: true when account was created "by email" (added in 1.12)
300 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
301 $apiModule: the ApiCreateAccount module calling
302 $loginForm: the LoginForm used
304 'AddNewAccountApiResult': Modify API output when creating a new account via API.
305 $apiModule: the ApiCreateAccount module calling
306 $loginForm: the LoginForm used
307 &$result: associative array for API result data
309 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
310 before OutputPage::sendCacheControl() and final ob_end_flush() which
311 will send the buffered output to the client. This allows for last-minute
312 modification of the output within the buffer by using ob_get_clean().
313 $output: The OutputPage object where output() was called
315 'AfterImportPage': When a page import is completed.
316 $title: Title under which the revisions were imported
317 $foreignTitle: ForeignTitle object based on data provided by the XML file
318 $revCount: Number of revisions in the XML file
319 $sRevCount: Number of successfully imported revisions
320 $pageInfo: associative array of page information
322 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
323 just before adding its HTML to parser output.
324 $parser: Parser object that called the hook
325 $ig: Gallery, an object of one of the gallery classes (inheriting from
327 $html: HTML generated by the gallery
329 'AlternateEdit': Before checking if a user can edit a page and before showing
330 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
331 $editPage: the EditPage object
333 'AlternateEditPreview': Before generating the preview of the page when editing
334 ( EditPage::getPreviewText() ).
335 $editPage: the EditPage object
336 &$content: the Content object for the text field from the edit page
337 &$previewHTML: Text to be placed into the page for the preview
338 &$parserOutput: the ParserOutput object for the preview
339 return false and set $previewHTML and $parserOutput to output custom page
342 'AlternateUserMailer': Called before mail is sent so that mail could be logged
343 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
344 the regular method of sending mail. Return a string to return a php-mail-error
345 message containing the error. Returning true will continue with sending email
347 $headers: Associative array of headers for the email
348 $to: MailAddress object or array
350 $subject: Subject of the email
351 $body: Body of the message
353 'APIAfterExecute': After calling the execute() method of an API module. Use
354 this to extend core API modules.
355 &$module: Module object
357 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
358 &$main: ApiMain object
360 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
361 authenticate and authorize API clients before executing the module. Return
362 false and set a message to cancel the request.
363 $module: Module object
365 &$message: API usage message to die with, as a message key or array
366 as accepted by ApiBase::dieUsageMsg.
368 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
369 processing request parameters. Return false to let the request fail, returning
370 an error message or an <edit result="Failure"> tag if $resultArr was filled.
371 $editPage : the EditPage object
372 $text : the new text of the article (has yet to be saved)
373 &$resultArr : data in this array will be added to the API result
375 'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager
376 into a FeedItem instance that ApiFeedContributions can consume. Implementors of
377 this hook may cancel the hook to signal that the item is not viewable in the
379 $row: A row of data from ContribsPager. The set of data returned by ContribsPager
380 can be adjusted by handling the ContribsPager::reallyDoQuery hook.
381 $context: An IContextSource implementation.
382 &$feedItem: Set this to a FeedItem instance if the callback can handle the provided
383 row. This is provided to the hook as a null, if it is non null then another callback
384 has already handled the hook.
386 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
387 highlighting, add output to $context->getOutput() and return false.
388 $context: An IContextSource.
389 $text: Text to be highlighted.
390 $mime: MIME type of $text.
391 $format: API format code for $text.
393 'APIGetAllowedParams': Use this hook to modify a module's parameters.
394 &$module: ApiBase Module object
395 &$params: Array of parameters
396 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
398 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
399 Use this hook to modify a module's description.
400 &$module: ApiBase Module object
401 &$desc: String description, or array of description strings
403 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
404 $module: ApiBase Module object
405 &$msg: Array of Message objects
407 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages instead.
408 Use this hook to modify a module's parameter descriptions.
409 &$module: ApiBase Module object
410 &$desc: Array of parameter descriptions
412 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter descriptions.
413 $module: ApiBase Module object
414 &$msg: Array of arrays of Message objects
416 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
417 $module: ApiBase Module object
418 &$help: Array of HTML strings to be joined for the output.
419 $options: Array Options passed to ApiHelp::getHelp
421 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
422 can alter or append to the array.
423 &$results: array with integer keys to associative arrays. Keys in associative
425 - title: Title object.
426 - redirect from: Title or null.
427 - extract: Description for this result.
428 - extract trimmed: If truthy, the extract will not be trimmed to
429 $wgOpenSearchDescriptionLength.
430 - image: Thumbnail for this result. Value is an array with subkeys 'source'
431 (url), 'width', 'height', 'alt', 'align'.
432 - url: Url for the given title.
434 'APIQueryAfterExecute': After calling the execute() method of an
435 action=query submodule. Use this to extend core API modules.
436 &$module: Module object
438 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
439 an action=query submodule. Use this to extend core API modules.
440 &$module: Module object
441 &$resultPageSet: ApiPageSet object
443 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
444 Use this hook to add custom tokens to prop=info. Every token has an action,
445 which will be used in the intoken parameter and in the output
446 (actiontoken="..."), and a callback function which should return the token, or
447 false if the user isn't allowed to obtain it. The prototype of the callback
448 function is func($pageid, $title), where $pageid is the page ID of the page the
449 token is requested for and $title is the associated Title object. In the hook,
450 just add your callback to the $tokenFunctions array and return true (returning
451 false makes no sense).
452 $tokenFunctions: array(action => callback)
454 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
455 Use this hook to add custom tokens to prop=revisions. Every token has an
456 action, which will be used in the rvtoken parameter and in the output
457 (actiontoken="..."), and a callback function which should return the token, or
458 false if the user isn't allowed to obtain it. The prototype of the callback
459 function is func($pageid, $title, $rev), where $pageid is the page ID of the
460 page associated to the revision the token is requested for, $title the
461 associated Title object and $rev the associated Revision object. In the hook,
462 just add your callback to the $tokenFunctions array and return true (returning
463 false makes no sense).
464 $tokenFunctions: array(action => callback)
466 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
467 Use this hook to add custom tokens to list=recentchanges. Every token has an
468 action, which will be used in the rctoken parameter and in the output
469 (actiontoken="..."), and a callback function which should return the token, or
470 false if the user isn't allowed to obtain it. The prototype of the callback
471 function is func($pageid, $title, $rc), where $pageid is the page ID of the
472 page associated to the revision the token is requested for, $title the
473 associated Title object and $rc the associated RecentChange object. In the
474 hook, just add your callback to the $tokenFunctions array and return true
475 (returning false makes no sense).
476 $tokenFunctions: array(action => callback)
478 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
479 sites general information.
480 $module: the current ApiQuerySiteInfo module
481 &$results: array of results, add things here
483 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
484 sites statistics information.
485 &$results: array of results, add things here
487 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
488 action=query&meta=tokens. Note that most modules will probably be able to use
489 the 'csrf' token instead of creating their own token types.
490 &$salts: array( type => salt to pass to User::getEditToken() )
492 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
493 Use this hook to add custom token to list=users. Every token has an action,
494 which will be used in the ustoken parameter and in the output
495 (actiontoken="..."), and a callback function which should return the token, or
496 false if the user isn't allowed to obtain it. The prototype of the callback
497 function is func($user) where $user is the User object. In the hook, just add
498 your callback to the $tokenFunctions array and return true (returning false
500 $tokenFunctions: array(action => callback)
502 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
503 an exception is thrown during API action execution.
504 $apiMain: Calling ApiMain instance.
505 $e: Exception object.
507 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
508 should have its own entry in the $apis array and have a unique name, passed as
509 key for the array that represents the service data. In this data array, the
510 key-value-pair identified by the apiLink key is required.
511 &$apis: array of services
513 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
514 Use this hook to extend action=tokens with new token types.
515 &$tokenTypes: supported token types in format 'type' => callback function
516 used to retrieve this type of tokens.
518 'Article::MissingArticleConditions': Before fetching deletion & move log entries
519 to display a message of a non-existing page being deleted/moved, give extensions
520 a chance to hide their (unrelated) log entries.
521 &$conds: Array of query conditions (all of which have to be met; conditions will
522 AND in the final query)
523 $logTypes: Array of log types being queried
525 'ArticleAfterFetchContent': After fetching content of an article from the
526 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
527 $article: the article (object) being loaded from the database
528 &$content: the content (string) of the article
530 'ArticleAfterFetchContentObject': After fetching content of an article from the
532 $article: the article (object) being loaded from the database
533 &$content: the content of the article, as a Content object
535 'ArticleConfirmDelete': Before writing the confirmation form for article
537 $article: the article (object) being deleted
538 $output: the OutputPage object
539 &$reason: the reason (string) the article is being deleted
541 'ArticleContentOnDiff': Before showing the article content below a diff. Use
542 this to change the content in this area or how it is loaded.
543 $diffEngine: the DifferenceEngine
544 $output: the OutputPage object
546 'ArticleDelete': Before an article is deleted.
547 $wikiPage: the WikiPage (object) being deleted
548 $user: the user (object) deleting the article
549 $reason: the reason (string) the article is being deleted
550 $error: if the deletion was prohibited, the (raw HTML) error message to display
552 $status: Status object, modify this to throw an error. Overridden by $error
555 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
556 $title: Title of the article that has been deleted.
557 $outputPage: OutputPage that can be used to append the output.
559 'ArticleDeleteComplete': After an article is deleted.
560 $wikiPage: the WikiPage that was deleted
561 $user: the user that deleted the article
562 $reason: the reason the article was deleted
563 $id: id of the article that was deleted
564 $content: the Content of the deleted page
565 $logEntry: the ManualLogEntry used to record the deletion
567 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
569 &$wikiPage: WikiPage (object) of the user talk page
570 $recipient: User (object) who's talk page was edited
572 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
573 article has been changed.
574 $wikiPage: the WikiPage (object)
575 $editInfo: data holder that includes the parser output ($editInfo->output) for
576 that page after the change
577 $changed: bool for if the page was changed
579 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
580 recentchanges table, return false to not delete old entries.
581 $wikiPage: WikiPage (object) being modified
583 'ArticleFromTitle': when creating an article object from a title object using
584 Wiki::articleFromTitle().
585 $title: Title (object) used to create the article object
586 $article: Article (object) that will be returned
587 $context: IContextSource (object)
589 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
590 PageContentInsertComplete.
591 $wikiPage: WikiPage created
592 $user: User creating the article
594 $summary: Edit summary/comment
595 $isMinor: Whether or not the edit was marked as minor
596 $isWatch: (No longer used)
597 $section: (No longer used)
598 $flags: Flags passed to WikiPage::doEditContent()
599 $revision: New Revision of the article
601 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
602 $targetTitle: target title (object)
603 $destTitle: destination title (object)
605 'ArticlePageDataAfter': After loading data of an article from the database.
606 $wikiPage: WikiPage (object) whose data were loaded
607 $row: row (object) returned from the database server
609 'ArticlePageDataBefore': Before loading data of an article from the database.
610 $wikiPage: WikiPage (object) that data will be loaded
611 $fields: fields (array) to load from the database
613 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
614 $wikiPage: the WikiPage being saved
615 $popts: parser options to be used for pre-save transformation
617 'ArticleProtect': Before an article is protected.
618 $wikiPage: the WikiPage being protected
619 $user: the user doing the protection
620 $protect: boolean whether this is a protect or an unprotect
621 $reason: Reason for protect
622 $moveonly: boolean whether this is for move only or not
624 'ArticleProtectComplete': After an article is protected.
625 $wikiPage: the WikiPage that was protected
626 $user: the user who did the protection
627 $protect: boolean whether it was a protect or an unprotect
628 $reason: Reason for protect
629 $moveonly: boolean whether it was for move only or not
631 'ArticlePurge': Before executing "&action=purge".
632 $wikiPage: WikiPage (object) to purge
634 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
635 revisions of an article.
636 &$title: Title object of the article
638 'ArticleRevisionUndeleted': After an article revision is restored.
639 $title: the article title
640 $revision: the revision
641 $oldPageID: the page ID of the revision when archived (may be null)
643 'ArticleRollbackComplete': After an article rollback is completed.
644 $wikiPage: the WikiPage that was edited
645 $user: the user who did the rollback
646 $revision: the revision the page was reverted back to
647 $current: the reverted revision
649 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
651 $wikiPage: the WikiPage (object) being saved
652 $user: the user (object) saving the article
653 $text: the new article text
654 $summary: the article summary (comment)
659 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
660 PageContentSaveComplete instead.
661 $wikiPage: WikiPage modified
662 $user: User performing the modification
664 $summary: Edit summary/comment
665 $isMinor: Whether or not the edit was marked as minor
666 $isWatch: (No longer used)
667 $section: (No longer used)
668 $flags: Flags passed to WikiPage::doEditContent()
669 $revision: New Revision of the article
670 $status: Status object about to be returned by doEditContent()
671 $baseRevId: the rev ID (or false) this edit was based on
673 'ArticleUndelete': When one or more revisions of an article are restored.
674 $title: Title corresponding to the article restored
675 $create: Whether or not the restoration caused the page to be created (i.e. it
676 didn't exist before).
677 $comment: The comment associated with the undeletion.
678 $oldPageId: ID of page previously deleted (from archive table)
680 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
681 $pageArchive: the PageArchive object
682 &$logEntry: ManualLogEntry object
683 $user: User who is performing the log action
685 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
686 the user is redirected back to the page.
687 &$article: the article
688 &$sectionanchor: The section anchor link (e.g. "#overview" )
689 &$extraq: Extra query parameters which can be added via hooked functions
691 'ArticleViewFooter': After showing the footer section of an ordinary page view
692 $article: Article object
693 $patrolFooterShown: boolean whether patrol footer is shown
695 'ArticleViewHeader': Before the parser cache is about to be tried for article
697 &$article: the article
698 &$pcache: whether to try the parser cache or not
699 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
700 object to both indicate that the output is done and what parser output was used.
702 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
703 redirect was followed.
704 $article: target article (object)
706 'ArticleViewCustom': Allows to output the text of the article in a different
707 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
708 that it is preferable to implement proper handing for a custom data type using
709 the ContentHandler facility.
710 $text: text of the page
711 $title: title of the page
712 $output: reference to $wgOut
714 'ArticleContentViewCustom': Allows to output the text of the article in a
715 different format than wikitext. Note that it is preferable to implement proper
716 handing for a custom data type using the ContentHandler facility.
717 $content: content of the page, as a Content object
718 $title: title of the page
719 $output: reference to $wgOut
721 'AuthPluginAutoCreate': Called when creating a local account for an user logged
722 in from an external authentication method.
723 $user: User object created locally
725 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
726 Gives a chance for an extension to set it programmatically to a variable class.
727 &$auth: the $wgAuth object, probably a stub
729 'AutopromoteCondition': Check autopromote condition for user.
730 $type: condition type
733 $result: result of checking autopromote condition
735 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
739 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
740 certain title are fetched.
742 $title: title of the page to which backlinks are sought
743 &$conds: query conditions
745 'BadImage': When checking against the bad image list. Change $bad and return
746 false to override. If an image is "bad", it is not rendered inline in wiki
747 pages or galleries in category pages.
748 $name: Image name being checked
749 &$bad: Whether or not the image is "bad"
751 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
752 custom HTML after the section. Any uses of the hook need to handle escaping.
753 $template BaseTemplate
754 $portlet: string portlet name
757 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
758 "noarticletext-nopermission" at Article::showMissingArticle().
759 $article: article object
761 'BeforeInitialize': Before anything is initialized in
762 MediaWiki::performRequest().
763 &$title: Title being used for request
765 &$output: OutputPage object
767 $request: WebRequest object
768 $mediaWiki: Mediawiki object
770 'BeforePageDisplay': Prior to outputting a page.
771 &$out: OutputPage object
774 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
775 override how the redirect is output by modifying, or by returning false, and
776 letting standard HTTP rendering take place.
777 ATTENTION: This hook is likely to be removed soon due to overall design of the system.
778 $context: IContextSource object
779 &$redirect: string URL, modifiable
781 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
782 override how the redirect is output by modifying, or by returning false and
783 taking over the output.
784 $out: OutputPage object
785 &$redirect: URL, modifiable
786 &$code: HTTP code (eg '301' or '302'), modifiable
788 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
789 $parser: Parser object
791 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
792 as a key then the file will appear as a broken thumbnail.
793 &$descQuery: query string to add to thumbnail URL
795 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
796 $parser: Parser object
797 $title: title of the template
798 &$skip: skip this template and link it?
799 &$id: the id of the revision being parsed
801 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
802 &$parser: Parser object
803 &$ig: ImageGallery object
805 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
807 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
808 to a newly created user account.
809 &$injected_html: Any HTML to inject after the "logged in" message of a newly
812 'BitmapHandlerTransform': before a file is transformed, gives extension the
813 possibility to transform it themselves
814 $handler: BitmapHandler
816 &$scalerParams: Array with scaler parameters
817 &$mto: null, set to a MediaTransformOutput
819 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
820 normalizations have been performed, except for the $wgMaxImageArea check.
822 &$params: Array of parameters
823 &$checkImageAreaHookResult: null, set to true or false to override the
824 $wgMaxImageArea check result.
826 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
828 $block: Block object (which is set to be autoblocking)
829 &$blockIds: Array of block IDs of the autoblock
831 'BlockIp': Before an IP address or user is blocked.
832 $block: the Block object about to be saved
833 $user: the user _doing_ the block (not the one being blocked)
834 &$reason: if the hook is aborted, the error message to be returned in an array
836 'BlockIpComplete': After an IP address or user is blocked.
837 $block: the Block object that was saved
838 $user: the user who did the block (not the one being blocked)
840 'BookInformation': Before information output on Special:Booksources.
841 $isbn: ISBN to show information for
842 $output: OutputPage object in use
844 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
845 to be able to access the wiki via HTTPS.
846 $ip: The IP address in human-readable form
847 &$canDo: This reference should be set to false if the client may not be able
850 'CanonicalNamespaces': For extensions adding their own namespaces or altering
852 Note that if you need to specify namespace protection or content model for
853 a namespace that is added in a CanonicalNamespaces hook handler, you
854 should do so by altering $wgNamespaceProtection and
855 $wgNamespaceContentModels outside the handler, in top-level scope. The
856 point at which the CanonicalNamespaces hook fires is too late for altering
857 these variables. This applies even if the namespace addition is
858 conditional; it is permissible to declare a content model and protection
859 for a namespace and then decline to actually register it.
860 &$namespaces: Array of namespace numbers with corresponding canonical names
862 'CategoryAfterPageAdded': After a page is added to a category.
863 $category: Category that page was added to
864 $wikiPage: WikiPage that was added
866 'CategoryAfterPageRemoved': After a page is removed from a category.
867 $category: Category that page was removed from
868 $wikiPage: WikiPage that was removed
870 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
871 $catpage: CategoryPage instance
873 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
874 in a Category page. Gives extensions the opportunity to batch load any
875 related data about the pages.
876 $type: The category type. Either 'page', 'file' or 'subcat'
877 $res: Query result from DatabaseBase::select()
879 'CategoryViewer::generateLink': Before generating an output link allow
880 extensions opportunity to generate a more specific or relevant link.
881 $type: The category type. Either 'page', 'img' or 'subcat'
882 $title: Title object for the categorized page
883 $html: Requested html content of anchor
884 &$link: Returned value. When set to a non-null value by a hook subscriber
885 this value will be used as the anchor instead of Linker::link
887 'ChangePasswordForm': For extensions that need to add a field to the
888 ChangePassword form via the Preferences form.
889 &$extraFields: An array of arrays that hold fields like would be passed to the
892 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
893 &$changesList: ChangesList instance.
894 &$articlelink: HTML of link to article (already filled-in).
895 &$s: HTML of row that is being constructed.
896 &$rc: RecentChange instance.
897 $unpatrolled: Whether or not we are showing unpatrolled changes.
898 $watched: Whether or not the change is watched by the user.
900 'ChangesListInitRows': Batch process change list rows prior to rendering.
901 $changesList: ChangesList instance
902 $rows: The data that will be rendered. May be a ResultWrapper instance or
905 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
906 $special: ChangesListSpecialPage instance
907 &$filters: associative array of filter definitions. The keys are the HTML
908 name/URL parameters. Each key maps to an associative array with a 'msg'
909 (message key) and a 'default' value.
911 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
912 $name: name of the special page, e.g. 'Watchlist'
913 &$tables: array of tables to be queried
914 &$fields: array of columns to select
915 &$conds: array of WHERE conditionals for query
916 &$query_options: array of options for the database request
917 &$join_conds: join conditions for the tables
918 $opts: FormOptions for this request
920 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
921 removed from all revisions and log entries to which it was applied). This gives
922 extensions a chance to take it off their books.
923 $tag: name of the tag
924 &$status: Status object. Add warnings to this as required. There is no point
925 setting errors, as the deletion has already been partly carried out by this
928 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
929 from the UI (Special:Tags) or via the API. You could use this hook if you want
930 to reserve a specific "namespace" of tags, or something similar.
931 $tag: name of the tag
932 $user: user initiating the action
933 &$status: Status object. Add your errors using `$status->fatal()` or warnings
934 using `$status->warning()`. Errors and warnings will be relayed to the user.
935 If you set an error, the user will be unable to create the tag.
937 'ChangeTagCanDelete': Tell whether a change tag should be able to be
938 deleted from the UI (Special:Tags) or via the API. The default is that tags
939 defined using the ListDefinedTags hook are not allowed to be deleted unless
940 specifically allowed. If you wish to allow deletion of the tag, set
941 `$status = Status::newGood()` to allow deletion, and then `return false` from
942 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
943 out custom deletion actions.
944 $tag: name of the tag
945 $user: user initiating the action
946 &$status: Status object. See above.
948 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
949 uses are in active use.
950 &$tags: list of all active tags. Append to this array.
952 'LoginUserMigrated': Called during login to allow extensions the opportunity to
953 inform a user that their username doesn't exist for a specific reason, instead
954 of letting the login form give the generic error message that the account does
955 not exist. For example, when the account has been renamed or deleted.
956 $user: the User object being authenticated against.
957 &$msg: the message identifier for abort reason, or an array to pass a message
960 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
961 $collationName: Name of the collation in question
962 &$collationObject: Null. Replace with a subclass of the Collation class that
963 implements the collation given in $collationName.
965 'ConfirmEmailComplete': Called after a user's email has been confirmed
967 $user: user (object) whose email is being confirmed
969 'ContentHandlerDefaultModelFor': Called when the default content model is determined
970 for a given title. May be used to assign a different model for that title.
971 $title: the Title in question
972 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
974 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
975 content model name, but no entry for that model exists in $wgContentHandlers.
976 $modeName: the requested content model name
977 &$handler: set this to a ContentHandler object, if desired.
979 'ContentModelCanBeUsedOn': Called to determine whether that content model can
980 be used on a given page. This is especially useful to prevent some content models
981 to be used in some special location.
982 $contentModel: ID of the content model in question
983 $title: the Title in question.
984 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
985 Handler functions that modify $ok should generally return false to prevent further
986 hooks from further modifying $ok.
988 'ContentGetParserOutput': Customize parser output for a given content object,
989 called by AbstractContent::getParserOutput. May be used to override the normal
990 model-specific rendering of page content.
991 $content: The Content to render
992 $title: Title of the page, as context
993 $revId: The revision ID, as context
994 $options: ParserOptions for rendering. To avoid confusing the parser cache,
995 the output can only depend on parameters provided to this hook function, not on global state.
996 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
997 generation of HTML may be skipped, but other information should still be present in the
999 &$output: ParserOutput, to manipulate or replace
1001 'ContentAlterParserOutput': Modify parser output for a given content object.
1002 Called by Content::getParserOutput after parsing has finished. Can be used
1003 for changes that depend on the result of the parsing but have to be done
1004 before LinksUpdate is called (such as adding tracking categories based on
1006 $content: The Content to render
1007 $title: Title of the page, as context
1008 $parserOutput: ParserOutput to manipulate
1010 'ConvertContent': Called by AbstractContent::convert when a conversion to another
1011 content model is requested.
1012 $content: The Content object to be converted.
1013 $toModel: The ID of the content model to convert to.
1014 $lossy: boolean indicating whether lossy conversion is allowed.
1015 &$result: Output parameter, in case the handler function wants to provide a
1016 converted Content object. Note that $result->getContentModel() must return $toModel.
1017 Handler functions that modify $result should generally return false to further
1018 attempts at conversion.
1020 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1021 &$pager: Pager object for contributions
1022 &$queryInfo: The query for the contribs Pager
1024 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
1025 &$data: an array of results of all contribs queries
1026 $pager: The ContribsPager object hooked into
1027 $offset: Index offset, inclusive
1028 $limit: Exact query limit
1029 $descending: Query direction, false for ascending, true for descending
1031 'ContributionsLineEnding': Called before a contributions HTML line is finished
1032 $page: SpecialPage object for contributions
1033 &$ret: the HTML line
1034 $row: the DB row for this line
1035 &$classes: the classes to add to the surrounding <li>
1037 'ContributionsToolLinks': Change tool links above Special:Contributions
1038 $id: User identifier
1039 $title: User page title
1040 &$tools: Array of tool links
1042 'CustomEditor': When invoking the page editor
1043 $article: Article being edited
1044 $user: User performing the edit
1046 Return true to allow the normal editor to be used, or false
1047 if implementing a custom editor, e.g. for a special namespace,
1050 'DatabaseOraclePostInit': Called after initialising an Oracle database
1051 &$db: the DatabaseOracle object
1053 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
1054 $title: the diff page title (nullable)
1055 &$oldId: the actual old Id to use in the diff
1056 &$newId: the actual new Id to use in the diff (0 means current)
1057 $old: the ?old= param value from the url
1058 $new: the ?new= param value from the url
1060 'GetDifferenceEngine': Called when getting a new difference engine interface object
1061 Return false for valid object in $differenceEngine or true for the default difference engine
1062 $context: IContextSource context to be used for diff
1063 $old: Revision ID to show and diff with
1064 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1065 $refreshCache: If set, refreshes the diff cache
1066 $unhide: If set, allow viewing deleted revs
1067 &$differenceEngine: output parameter, difference engine object to be used for diff
1069 'DiffRevisionTools': Override or extend the revision tools available from the
1070 diff view, i.e. undo, etc.
1071 $newRev: Revision object of the "new" revision
1072 &$links: Array of HTML links
1073 $oldRev: Revision object of the "old" revision (may be null)
1075 'DiffViewHeader': Called before diff display
1076 $diff: DifferenceEngine object that's calling
1077 $oldRev: Revision object of the "old" revision (may be null/invalid)
1078 $newRev: Revision object of the "new" revision
1080 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1082 $article: article (object) being viewed
1083 $oldid: oldid (int) being viewed
1085 'DoEditSectionLink': Override the HTML generated for section edit links
1086 * Deprecated in favour of SkinEditSectionLinks hook *
1087 $skin: Skin object rendering the UI
1088 $title: Title object for the title being linked to (may not be the same as
1089 the page title, if the section is included from a template)
1090 $section: The designation of the section being pointed to, to be included in
1091 the link, like "§ion=$section"
1092 $tooltip: The default tooltip. Escape before using.
1093 By default, this is wrapped in the 'editsectionhint' message.
1094 &$result: The HTML to return, prefilled with the default plus whatever other
1095 changes earlier hooks have made
1096 $lang: The language code to use for the link in the wfMessage function
1098 'EditFilter': Perform checks on an edit
1099 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1100 $text: Contents of the edit box
1101 $section: Section being edited
1102 &$error: Error message to return
1103 $summary: Edit summary for page
1105 'EditFilterMerged': Post-section-merge edit filter.
1106 DEPRECATED, use EditFilterMergedContent instead.
1107 $editor: EditPage instance (object)
1108 $text: content of the edit box
1109 &$error: error message to return
1110 $summary: Edit summary for page
1112 'EditFilterMergedContent': Post-section-merge edit filter.
1113 This may be triggered by the EditPage or any other facility that modifies page content.
1114 Use the $status object to indicate whether the edit should be allowed, and to provide
1115 a reason for disallowing it. Return false to abort the edit, and true to continue.
1116 Returning true if $status->isOK() returns false means "don't save but continue user
1117 interaction", e.g. show the edit form. $status->apiHookResult can be set to an array
1118 to be returned by api.php action=edit. This is used to deliver captchas.
1119 $context: object implementing the IContextSource interface.
1120 $content: content of the edit box, as a Content object.
1121 $status: Status object to represent errors, etc.
1122 $summary: Edit summary for page
1123 $user: the User object representing the user whois performing the edit.
1124 $minoredit: whether the edit was marked as minor by the user.
1126 'EditFormPreloadText': Allows population of the edit form when creating
1128 &$text: Text to preload with
1129 &$title: Title object representing the page being created
1131 'EditFormInitialText': Allows modifying the edit form when editing existing
1133 $editPage: EditPage object
1135 'EditPage::attemptSave': Called before an article is
1136 saved, that is before WikiPage::doEditContent() is called
1137 $editpage_Obj: the current EditPage object
1139 'EditPage::importFormData': allow extensions to read additional data
1141 $editpage: EditPage instance
1142 $request: Webrequest
1143 return value is ignored (should always return true)
1145 'EditPage::showEditForm:fields': allows injection of form field into edit form
1146 $editor: the EditPage instance for reference
1147 $out: an OutputPage instance to write to
1148 return value is ignored (should always return true)
1150 'EditPage::showEditForm:initial': before showing the edit form
1151 $editor: EditPage instance (object)
1152 $out: an OutputPage instance to write to
1154 Return false to halt editing; you'll need to handle error messages, etc.
1155 yourself. Alternatively, modifying $error and returning true will cause the
1156 contents of $error to be echoed at the top of the edit form as wikitext.
1157 Return true without altering $error to allow the edit to proceed.
1159 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1160 but for the read-only 'view source' variant of the edit form.
1161 $editor: EditPage instance (object)
1162 &$out: an OutputPage instance to write to
1163 return value is ignored (should always return true)
1165 'EditPage::showStandardInputs:options': allows injection of form fields into
1166 the editOptions area
1167 $editor: EditPage instance (object)
1168 $out: an OutputPage instance to write to
1169 &$tabindex: HTML tabindex of the last edit check/button
1170 return value is ignored (should always be true)
1172 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1173 when there's an edit conflict. Return false to halt normal diff output; in
1174 this case you're responsible for computing and outputting the entire "conflict"
1175 part, i.e., the "difference between revisions" and "your text" headers and
1177 &$editor: EditPage instance
1178 &$out: OutputPage instance
1180 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1181 textarea in the edit form.
1182 &$editpage: The current EditPage object
1183 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1184 &$tabindex: HTML tabindex of the last edit check/button
1186 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1188 &$editpage: The current EditPage object
1189 &$checks: Array of edit checks like "watch this page"/"minor edit"
1190 &$tabindex: HTML tabindex of the last edit check/button
1192 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1193 textarea in the edit form.
1194 &$toolbar: The toolbar HTMl
1196 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1197 contribution/copyright notice.
1198 $title: title of page being edited
1199 &$msg: localization message name, overridable. Default is either
1200 'copyrightwarning' or 'copyrightwarning2'.
1202 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1203 modifying the wikitext that will be used in "Show changes". Note that it is
1204 preferable to implement diff handling for different data types using the
1205 ContentHandler facility.
1206 $editPage: EditPage object
1207 &$newtext: wikitext that will be used as "your version"
1209 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1210 "Show changes". Note that it is preferable to implement diff handling for
1211 different data types using the ContentHandler facility.
1212 $editPage: EditPage object
1213 &$newtext: wikitext that will be used as "your version"
1215 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1216 Allow modifying the wikitext that will be previewed. Note that it is preferable
1217 to implement previews for different data types using the ContentHandler
1219 $editPage: EditPage object
1220 &$toparse: wikitext that will be parsed
1222 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1223 previewed. Note that it is preferable to implement previews for different data
1224 types using the ContentHandler facility.
1225 $editPage: EditPage object
1226 &$content: Content object to be previewed (may be replaced by hook function)
1228 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1229 &$editpage: The current EditPage object
1230 &$res: the HTML of the error text
1232 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1233 of terms of service summary link that might exist separately from the copyright
1235 $title: title of page being edited
1236 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1238 'EmailConfirmed': When checking that the user's email address is "confirmed".
1239 $user: User being checked
1240 $confirmed: Whether or not the email address is confirmed
1241 This runs before the other checks, such as anonymity and the real check; return
1242 true to allow those checks to occur, and false if checking is done.
1244 'EmailUser': Before sending email from one user to another.
1245 $to: address of receiving user
1246 $from: address of sending user
1247 $subject: subject of the mail
1248 $text: text of the mail
1250 'EmailUserCC': Before sending the copy of the email to the author.
1251 $to: address of receiving user
1252 $from: address of sending user
1253 $subject: subject of the mail
1254 $text: text of the mail
1256 'EmailUserComplete': After sending email from one user to another.
1257 $to: address of receiving user
1258 $from: address of sending user
1259 $subject: subject of the mail
1260 $text: text of the mail
1262 'EmailUserForm': After building the email user form object.
1263 $form: HTMLForm object
1265 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1267 $user: The user who is trying to email another user.
1268 $editToken: The user's edit token.
1269 &$hookErr: Out-param for the error. Passed as the parameters to
1270 OutputPage::showErrorPage.
1272 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1274 $ip: The ip address of the user
1276 'ExtensionTypes': Called when generating the extensions credits, use this to
1277 change the tables headers.
1278 &$extTypes: associative array of extensions types
1280 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1281 thumbnail file name.
1282 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1283 $thumbname: the base name of the thumbnail file
1284 &$params: the currently extracted params (has source name, temp or archived zone)
1286 'FetchChangesList': When fetching the ChangesList derivative for a particular
1288 $user: User the list is being fetched for
1289 &$skin: Skin object to be used with the list
1290 &$list: List object (defaults to NULL, change it to an object instance and
1291 return false override the list derivative used)
1293 'FileDeleteComplete': When a file is deleted.
1294 $file: reference to the deleted file
1295 $oldimage: in case of the deletion of an old image, the name of the old file
1296 $article: in case all revisions of the file are deleted a reference to the
1297 WikiFilePage associated with the file.
1298 $user: user who performed the deletion
1301 'FileTransformed': When a file is transformed and moved into storage.
1302 $file: reference to the File object
1303 $thumb: the MediaTransformOutput object
1304 $tmpThumbPath: The temporary file system path of the transformed file
1305 $thumbPath: The permanent storage path of the transformed file
1307 'FileUpload': When a file upload occurs.
1308 $file : Image object representing the file that was uploaded
1309 $reupload : Boolean indicating if there was a previously another image there or
1311 $hasDescription : Boolean indicating that there was already a description page
1312 and a new one from the comment wasn't created (since 1.17)
1314 'FileUndeleteComplete': When a file is undeleted
1315 $title: title object to the file
1316 $fileVersions: array of undeleted versions. Empty if all versions were restored
1317 $user: user who performed the undeletion
1320 'FormatAutocomments': When an autocomment is formatted by the Linker.
1321 &$comment: Reference to the accumulated comment. Initially null, when set the
1322 default code will be skipped.
1323 $pre: Boolean, true if there is text before this autocomment
1324 $auto: The extracted part of the parsed comment before the call to the hook.
1325 $post: Boolean, true if there is text after this autocomment
1326 $title: An optional title object used to links to sections. Can be null.
1327 $local: Boolean indicating whether section links should refer to local page.
1329 'GalleryGetModes': Get list of classes that can render different modes of a
1331 &$modeArray: An associative array mapping mode names to classes that implement
1332 that mode. It is expected all registered classes are a subclass of
1335 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1337 &$user: user to promote.
1338 &$promote: groups that will be added.
1340 'GetBlockedStatus': after loading blocking status of an user from the database
1341 $user: user (object) being checked
1343 'GetCacheVaryCookies': Get cookies that should vary cache options.
1344 $out: OutputPage object
1345 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1346 that have to vary cache options
1348 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1350 $title: Title object of page
1351 $url: string value as output (out parameter, can modify)
1352 $query: query options passed to Title::getCanonicalURL()
1354 'GetDefaultSortkey': Override the default sortkey for a page.
1355 $title: Title object that we need to get a sortkey for
1356 &$sortkey: Sortkey to use.
1358 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1359 underscore) magic words. Called by MagicWord.
1360 &$doubleUnderscoreIDs: array of strings
1362 'GetExtendedMetadata': Get extended file metadata for the API
1363 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1364 'value' => prop value, 'source' => 'name of hook' ).
1365 $file: File object of file in question
1366 $context: RequestContext (including language to use)
1367 $single: Only extract the current language; if false, the prop value should
1368 be in the metadata multi-language array format:
1369 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1370 &$maxCacheTime: how long the results can be cached
1372 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1373 $title: Title object of page
1374 $url: string value as output (out parameter, can modify)
1375 $query: query options passed to Title::getFullURL()
1377 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1378 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1380 &$output: string for the output timestamp
1381 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1382 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1383 $user: User whose preferences are being used to make timestamp
1384 $lang: Language that will be used to render the timestamp
1386 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1387 $title: Title object of page
1388 $url: string value as output (out parameter, can modify)
1389 $query: query options passed to Title::getInternalURL()
1391 'GetIP': modify the ip of the current user (called only once).
1392 &$ip: string holding the ip as determined so far
1394 'GetLinkColours': modify the CSS class of an array of page links.
1395 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1397 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1399 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1400 working with internal urls (non-interwiki) then it may be preferable to work
1401 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1402 be buggy for internal urls on render if you do not re-implement the horrible
1403 hack that Title::getLocalURL uses in your own extension.
1404 $title: Title object of page
1405 &$url: string value as output (out parameter, can modify)
1406 $query: query options passed to Title::getLocalURL()
1408 'GetLocalURL::Internal': Modify local URLs to internal pages.
1409 $title: Title object of page
1410 &$url: string value as output (out parameter, can modify)
1411 $query: query options passed to Title::getLocalURL()
1413 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1414 without any fancy queries or variants.
1415 $title: Title object of page
1416 &$url: string value as output (out parameter, can modify)
1418 'GetLogTypesOnUser': Add log types where the target is a userpage
1419 &$types: Array of log types
1421 'GetMetadataVersion': Modify the image metadata version currently in use. This
1422 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1423 that need to have versioned metadata should add an element to the end of the
1424 version array of the form 'handler_name=version'. Most media handlers won't need
1425 to do this unless they broke backwards compatibility with a previous version of
1426 the media handler metadata output.
1427 &$version: Array of version strings
1429 'GetNewMessagesAlert': Disable or modify the new messages alert
1430 &$newMessagesAlert: An empty string by default. If the user has new talk page
1431 messages, this should be populated with an alert message to that effect
1432 $newtalks: An empty array if the user has no new messages or an array containing
1433 links and revisions if there are new messages (See User::getNewMessageLinks)
1434 $user: The user object of the user who is loading the page
1435 $out: OutputPage object (to check what type of page the user is on)
1437 'GetPreferences': Modify user preferences.
1438 $user: User whose preferences are being modified.
1439 &$preferences: Preferences description array, to be fed to an HTMLForm object
1441 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1442 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1444 &$output: string for the output timestamp
1445 &$diff: DateInterval representing the difference between the timestamps
1446 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1447 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1448 $user: User whose preferences are being used to make timestamp
1449 $lang: Language that will be used to render the timestamp
1451 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1452 checked for. Use instead of userCan for most cases. Return false if the user
1453 can't do it, and populate $result with the reason in the form of
1454 array( messagename, param1, param2, ... ). For consistency, error messages
1455 should be plain text with no special coloring, bolding, etc. to show that
1456 they're errors; presenting them properly to the user as errors is done by the
1458 $title: Title object being checked against
1459 $user : Current user object
1460 $action: Action being checked
1461 $result: User permissions error to add. If none, return true.
1463 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1464 called only if expensive checks are enabled. Add a permissions error when
1465 permissions errors are checked for. Return false if the user can't do it, and
1466 populate $result with the reason in the form of array( messagename, param1,
1467 param2, ... ). For consistency, error messages should be plain text with no
1468 special coloring, bolding, etc. to show that they're errors; presenting them
1469 properly to the user as errors is done by the caller.
1471 $title: Title object being checked against
1472 $user : Current user object
1473 $action: Action being checked
1474 $result: User permissions error to add. If none, return true.
1476 'GitViewers': Called when generating the list of git viewers for
1477 Special:Version, use this to change the list.
1478 &$extTypes: associative array of repo URLS to viewer URLs.
1480 'HistoryRevisionTools': Override or extend the revision tools available from the
1481 page history view, i.e. undo, rollback, etc.
1482 $rev: Revision object
1483 &$links: Array of HTML links
1485 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1487 $context: An IContextSource object with information about the request being served.
1489 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1490 image insertion. You can skip the default logic entirely by returning false, or
1491 just modify a few things using call-by-reference.
1493 &$title: Title object of the image
1494 &$file: File object, or false if it doesn't exist
1495 &$frameParams: Various parameters with special meanings; see documentation in
1496 includes/Linker.php for Linker::makeImageLink
1497 &$handlerParams: Various parameters with special meanings; see documentation in
1498 includes/Linker.php for Linker::makeImageLink
1499 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1500 &$res: Final HTML output, used if you return false
1503 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1504 the image on an image page.
1505 $imagePage: ImagePage object ($this)
1508 'ImagePageAfterImageLinks': Called after the image links section on an image
1510 $imagePage: ImagePage object ($this)
1511 &$html: HTML for the hook to add
1513 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1515 $line: the HTML of the history line
1516 $css: the line CSS class
1518 'ImagePageFindFile': Called when fetching the file associated with an image
1520 $page: ImagePage object
1522 &$displayFile: displayed File object
1524 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1525 $page: ImagePage object
1526 &$toc: Array of <li> strings
1528 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1530 &$title: the Title object of the file as it would appear for the upload page
1531 &$path: the original file and path name when img_auth was invoked by the web
1533 &$name: the name only component of the file
1534 &$result: The location to pass back results of the hook routine (only used if
1536 $result[0]=The index of the header message
1537 $result[1]=The index of the body text message
1538 $result[2 through n]=Parameters passed to body text message. Please note the
1539 header message cannot receive/use parameters.
1541 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1542 $reader: XMLReader object
1543 $logInfo: Array of information
1544 Return false to stop further processing of the tag
1546 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1547 $reader: XMLReader object
1548 $pageInfo: Array of information
1549 Return false to stop further processing of the tag
1551 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1552 $reader: XMLReader object
1553 $pageInfo: Array of page information
1554 $revisionInfo: Array of revision information
1555 Return false to stop further processing of the tag
1557 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1558 $reader: XMLReader object
1559 Return false to stop further processing of the tag
1561 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1562 $reader: XMLReader object
1563 $revisionInfo: Array of information
1564 Return false to stop further processing of the tag
1566 'InfoAction': When building information to display on the action=info page.
1567 $context: IContextSource object
1568 &$pageInfo: Array of information
1570 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1571 $title: Title object for the current page
1572 $request: WebRequest
1573 $ignoreRedirect: boolean to skip redirect check
1574 $target: Title/string of redirect target
1575 $article: Article object
1577 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1578 Return true without providing an interwiki to continue interwiki search.
1579 $prefix: interwiki prefix we are looking for.
1580 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1581 iw_trans and optionally iw_api and iw_wikiid.
1583 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1584 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1585 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1586 template/parser function execution which respect nowiki and HTML-comments.
1587 &$parser: Parser object
1588 &$text: string containing partially parsed text
1589 &$stripState: Parser's internal StripState object
1591 'InternalParseBeforeLinks': during Parser's internalParse method before links
1592 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1593 &$parser: Parser object
1594 &$text: string containing partially parsed text
1595 &$stripState: Parser's internal StripState object
1597 'InvalidateEmailComplete': Called after a user's email has been invalidated
1599 $user: user (object) whose email is being invalidated
1601 'IRCLineURL': When constructing the URL to use in an IRC notification.
1602 Callee may modify $url and $query, URL will be constructed as $url . $query
1603 &$url: URL to index.php
1604 &$query: Query string
1605 $rc: RecentChange object that triggered url generation
1607 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1608 $article: article (object) being checked
1610 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1612 $result: Change this value to override the result of wfIsTrustedProxy()
1614 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1615 $url: URL used to upload from
1616 &$allowed: Boolean indicating if uploading is allowed for given URL
1618 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1619 instance to return false if the domain name doesn't match your organization.
1620 $addr: The e-mail address entered by the user
1621 &$result: Set this and return false to override the internal checks
1623 'isValidPassword': Override the result of User::isValidPassword()
1624 $password: The password entered by the user
1625 &$result: Set this and return false to override the internal checks
1626 $user: User the password is being validated for
1628 'Language::getMessagesFileName':
1629 $code: The language code or the language we're looking for a messages file for
1630 &$file: The messages file path, you can override this to change the location.
1632 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1633 remove namespaces. Do not use this hook to add namespaces. Use
1634 CanonicalNamespaces for that.
1635 &$namespaces: Array of namespaces indexed by their numbers
1637 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1638 $wgExtensionMessagesFiles instead.
1639 Use this to define synonyms of magic words depending of the language
1640 $magicExtensions: associative array of magic words synonyms
1641 $lang: language code (string)
1643 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1644 listed in $wgExtensionMessagesFiles instead.
1645 Use to define aliases of special pages names depending of the language
1646 $specialPageAliases: associative array of magic words synonyms
1647 $lang: language code (string)
1649 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1650 &$names: array of language code => language name
1651 $code language of the preferred translations
1653 'LanguageLinks': Manipulate a page's language links. This is called
1654 in various places to allow extensions to define the effective language
1656 $title: The page's Title.
1657 &$links: Associative array mapping language codes to prefixed links of the
1658 form "language:title".
1659 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1660 Currently unused, but planned to provide support for marking individual
1661 language links in the UI, e.g. for featured articles.
1663 'LanguageSelector': Hook to change the language selector available on a page.
1664 $out: The output page.
1665 $cssClassName: CSS class name of the language selector.
1667 'LinkBegin': Used when generating internal and interwiki links in
1668 Linker::link(), before processing starts. Return false to skip default
1669 processing and return $ret. See documentation for Linker::link() for details on
1670 the expected meanings of parameters.
1671 $skin: the Skin object
1672 $target: the Title that the link is pointing to
1673 &$html: the contents that the <a> tag should have (raw HTML); null means
1675 &$customAttribs: the HTML attributes that the <a> tag should have, in
1676 associative array form, with keys and values unescaped. Should be merged with
1677 default values, with a value of false meaning to suppress the attribute.
1678 &$query: the query string to add to the generated URL (the bit after the "?"),
1679 in associative array form, with keys and values unescaped.
1680 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1681 &$ret: the value to return if your hook returns false.
1683 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1684 just before the function returns a value. If you return true, an <a> element
1685 with HTML attributes $attribs and contents $html will be returned. If you
1686 return false, $ret will be returned.
1687 $skin: the Skin object
1688 $target: the Title object that the link is pointing to
1689 $options: the options. Will always include either 'known' or 'broken', and may
1690 include 'noclasses'.
1691 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1692 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1693 associative array form.
1694 &$ret: the value to return if your hook returns false.
1696 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1698 &$url: the image url
1699 &$alt: the image's alt text
1700 &$img: the new image HTML (if returning false)
1702 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1705 &$text: the link text
1706 &$link: the new link HTML (if returning false)
1707 &$attribs: the attributes to be applied.
1708 $linkType: The external link type
1710 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1712 $title: the Title object that the link is pointing to
1713 $file: the File object or false if broken link
1714 &$html: the link text
1715 &$attribs: the attributes to be applied
1716 &$ret: the value to return if your hook returns false
1718 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1720 &$linksUpdate: the LinksUpdate object
1722 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1723 each link table insert. For example, pagelinks, imagelinks, externallinks.
1724 $linksUpdate: LinksUpdate object
1725 $table: the table to insert links to
1726 $insertions: an array of links to insert
1728 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1729 including delete and insert, has completed for all link tables
1730 &$linksUpdate: the LinksUpdate object
1732 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1733 &$linksUpdate: the LinksUpdate object
1735 'ListDefinedTags': When trying to find all defined tags.
1736 &$tags: The list of tags.
1738 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1739 &updater: A DatabaseUpdater subclass
1741 'LocalFile::getHistory': Called before file history query performed.
1742 $file: the File object
1744 $fields: select fields
1746 $opts: query options
1747 $join_conds: JOIN conditions
1749 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1750 $file: the File object
1751 $archiveName: name of an old file version or false if it's the current one
1753 'LocalisationCacheRecache': Called when loading the localisation data into
1755 $cache: The LocalisationCache object
1756 $code: language code
1757 &$alldata: The localisation data from core and extensions
1758 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1760 'LocalisationCacheRecacheFallback': Called for each language when merging
1761 fallback data into the cache.
1762 $cache: The LocalisationCache object
1763 $code: language code
1764 &$alldata: The localisation data from core and extensions. Note some keys may
1765 be omitted if they won't be merged into the final result.
1767 'LocalisationChecksBlacklist': When fetching the blacklist of
1768 localisation checks.
1769 &$blacklist: array of checks to blacklist. See the bottom of
1770 maintenance/language/checkLanguage.inc for the format of this variable.
1772 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1773 optional localisation messages
1774 &$ignored Array of ignored message keys
1775 &$optional Array of optional message keys
1777 'LogEventsListGetExtraInputs': When getting extra inputs to display on Special:Log
1778 for a specific log type
1779 $type: String of log type being displayed
1780 $logEventsList: LogEventsList object for context and access to the WebRequest
1781 &$input: string HTML of an input element
1784 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1785 Returning false will prevent the string from being added to the OutputPage.
1786 &$s: html string to show for the log extract
1787 $types: String or Array Log types to show
1788 $page: String or Title The page title to show log entries for
1789 $user: String The user who made the log entries
1790 $param: Associative Array with the following additional options:
1791 - lim Integer Limit of items to show, default is 50
1792 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1793 - showIfEmpty boolean Set to false if you don't want any output in case the
1794 loglist is empty if set to true (default), "No matching items in log" is
1795 displayed if loglist is empty
1796 - msgKey Array If you want a nice box with a message, set this to the key of
1797 the message. First element is the message key, additional optional elements
1798 are parameters for the key that are processed with
1799 wfMessage()->params()->parseAsBlock()
1800 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1802 - wrap String Wrap the message in html (usually something like
1803 "<div ...>$1</div>").
1804 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1806 'LoginAuthenticateAudit': A login attempt for a valid user account either
1807 succeeded or failed. No return data is accepted; this hook is for auditing only.
1808 $user: the User object being authenticated against
1809 $password: the password being submitted and found wanting
1810 $retval: a LoginForm class constant with authenticateUserData() return
1811 value (SUCCESS, WRONG_PASS, etc.).
1813 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1814 Use this hook to change the Message that will be output on Special:ChangePassword.
1815 &$msg: Message object that will be shown to the user
1816 $username: Username of the user who's password was expired.
1818 'LogLine': Processes a single log entry on Special:Log.
1819 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1820 logging.log_type database field.
1821 $log_action: string for the type of log action (e.g. 'delete', 'block',
1822 'create2'). Corresponds to logging.log_action database field.
1823 $title: Title object that corresponds to logging.log_namespace and
1824 logging.log_title database fields.
1825 $paramArray: Array of parameters that corresponds to logging.log_params field.
1826 Note that only $paramArray[0] appears to contain anything.
1827 &$comment: string that corresponds to logging.log_comment database field, and
1828 which is displayed in the UI.
1829 &$revert: string that is displayed in the UI, similar to $comment.
1830 $time: timestamp of the log entry (added in 1.12)
1832 'LonelyPagesQuery': Allow extensions to modify the query used by
1833 Special:LonelyPages.
1834 &$tables: tables to join in the query
1835 &$conds: conditions for the query
1836 &$joinConds: join conditions for the query
1838 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1840 $refreshLinks: RefreshLinks object
1842 'MagicWordwgVariableIDs': When defining new magic words IDs.
1843 $variableIDs: array of strings
1845 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1846 Ideally, this hook should only be used to add variables that depend on
1847 the current page/request; static configuration should be added through
1848 ResourceLoaderGetConfigVars instead.
1849 &$vars: variable (or multiple variables) to be added into the output of
1850 Skin::makeVariablesScript
1851 $out: The OutputPage which called the hook, can be used to get the real title.
1853 'MarkPatrolled': Before an edit is marked patrolled.
1854 $rcid: ID of the revision to be marked patrolled
1855 $user: the user (object) marking the revision as patrolled
1856 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1857 sysop in order to mark an edit patrolled.
1859 'MarkPatrolledComplete': After an edit is marked patrolled.
1860 $rcid: ID of the revision marked as patrolled
1861 $user: user (object) who marked the edit patrolled
1862 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1863 sysop to patrol the edit.
1865 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1866 something completely different, after the basic globals have been set up, but
1867 before ordinary actions take place.
1869 $article: Article on which the action will be performed
1870 $title: Title on which the action will be performed
1872 $request: $wgRequest
1873 $mediaWiki: The $mediawiki object
1875 'MessagesPreLoad': When loading a message from the database.
1876 $title: title of the message (string)
1877 $message: value (string), change it to the message you want to define
1879 'MessageCache::get': When fetching a message. Can be used to override the key
1880 for customisations. Given and returned message key must be in special format:
1881 1) first letter must be in lower case according to the content language.
1882 2) spaces must be replaced with underscores
1883 &$key: message key (string)
1885 'MessageCacheReplace': When a message page is changed. Useful for updating
1887 $title: name of the page changed.
1888 $text: new contents of the page.
1890 'MimeMagicInit': Before processing the list mapping MIME types to media types
1891 and the list mapping MIME types to file extensions.
1892 As an extension author, you are encouraged to submit patches to MediaWiki's
1893 core to add new MIME types to mime.types.
1894 $mimeMagic: Instance of MimeMagic.
1895 Use $mimeMagic->addExtraInfo( $stringOfInfo );
1896 for adding new MIME info to the list.
1897 Use $mimeMagic->addExtraTypes( $stringOfTypes );
1898 for adding new MIME types to the list.
1900 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1901 MIME type detected by considering the file extension.
1902 $mimeMagic: Instance of MimeMagic.
1903 $ext: File extension.
1904 &$mime: MIME type (in/out).
1906 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1907 $mimeMagic: Instance of MimeMagic.
1908 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1909 &$tail: More or equal than last 65558 bytes of the file in a string
1910 (in - Do not alter!).
1912 &$mime: MIME type (out).
1914 'ModifyExportQuery': Modify the query used by the exporter.
1915 $db: The database object to be queried.
1916 &$tables: Tables in the query.
1917 &$conds: Conditions in the query.
1918 &$opts: Options for the query.
1919 &$join_conds: Join conditions for the query.
1921 'MovePageCheckPermissions': Specify whether the user is allowed to move the page.
1922 $oldTitle: Title object of the current (old) location
1923 $newTitle: Title object of the new location
1924 $user: User making the move
1925 $reason: string of the reason provided by the user
1926 $status: Status object to pass error messages to
1928 'MovePageIsValidMove': Specify whether a page can be moved for technical reasons.
1929 $oldTitle: Title object of the current (old) location
1930 $newTitle: Title object of the new location
1931 $status: Status object to pass error messages to
1933 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1934 and returning it for the skin to output. You can add items to the toolbox while
1935 still letting the skin make final decisions on skin-specific markup conventions
1937 &$sk: The BaseTemplate base skin template
1938 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1939 BaseTemplate::makeListItem for details on the format of individual items
1940 inside of this array.
1942 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1944 $index: Integer; the index of the namespace being checked.
1945 $result: Boolean; whether MediaWiki currently thinks that pages in this
1946 namespace are movable. Hooks may change this value to override the return
1947 value of MWNamespace::isMovable().
1949 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1951 $wikiPage: the WikiPage edited
1952 $rev: the new revision
1953 $baseID: the revision ID this was based off, if any
1954 $user: the editing user
1956 'NormalizeMessageKey': Called before the software gets the text of a message
1957 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1959 &$key: the message being looked up. Change this to something else to change
1960 what message gets displayed (string)
1961 &$useDB: whether or not to look up the message in the database (bool)
1962 &$langCode: the language code to get the message for (string) - or -
1963 whether to use the content language (true) or site language (false) (bool)
1964 &$transform: whether or not to expand variables and templates
1965 in the message (bool)
1967 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1968 return false to omit the line from RecentChanges and Watchlist special pages.
1969 &$changeslist: The OldChangesList instance.
1970 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1971 &$rc: The RecentChange object.
1972 &$classes: array of css classes for the <li> element
1974 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1975 can alter or append to the array of URLs for search & suggestion formats.
1976 &$urls: array of associative arrays with Url element attributes
1978 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1979 users and/or IP addresses too.
1980 $otherBlockLink: An array with links to other block logs
1981 $ip: The requested IP address or username
1983 'OutputPageBeforeHTML': A page has been processed by the parser and the
1984 resulting HTML is about to be displayed.
1985 $parserOutput: the parserOutput (object) that corresponds to the page
1986 $text: the text that will be displayed, in HTML (string)
1988 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1989 body tag to allow for extensions to add attributes to the body of the page they
1990 might need. Or to allow building extensions to add body classes that aren't of
1991 high enough demand to be included in core.
1992 $out: The OutputPage which called the hook, can be used to get the real title
1993 $sk: The Skin that called OutputPage::headElement
1994 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1996 'OutputPageCheckLastModified': when checking if the page has been modified
1997 since the last visit.
1998 &$modifiedTimes: array of timestamps.
1999 The following keys are set: page, user, epoch
2001 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2002 $out: OutputPage instance (object)
2003 $parserOutput: parserOutput instance being added in $out
2005 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2006 categories. Implementations should return false if they generate the category
2007 links, so the default link generation is skipped.
2008 $out: OutputPage instance (object)
2009 $categories: associative array, keys are category names, values are category
2010 types ("normal" or "hidden")
2011 $links: array, intended to hold the result. Must be an associative array with
2012 category types as keys and arrays of HTML links as values.
2014 'PageContentInsertComplete': After a new article is created.
2015 $wikiPage: WikiPage created
2016 $user: User creating the article
2017 $content: New content as a Content object
2018 $summary: Edit summary/comment
2019 $isMinor: Whether or not the edit was marked as minor
2020 $isWatch: (No longer used)
2021 $section: (No longer used)
2022 $flags: Flags passed to WikiPage::doEditContent()
2023 $revision: New Revision of the article
2025 'PageContentLanguage': Allows changing the language in which the content of a
2026 page is written. Defaults to the wiki content language ($wgContLang).
2027 $title: Title object
2028 &$pageLang: the page content language (either an object or a language code)
2029 $wgLang: the user language
2031 'PageContentSave': Before an article is saved.
2032 $wikiPage: the WikiPage (object) being saved
2033 $user: the user (object) saving the article
2034 $content: the new article content, as a Content object
2035 $summary: the article summary (comment)
2036 $isminor: minor flag
2037 $iswatch: watch flag
2040 'PageContentSaveComplete': After an article has been updated.
2041 $wikiPage: WikiPage modified
2042 $user: User performing the modification
2043 $content: New content, as a Content object
2044 $summary: Edit summary/comment
2045 $isMinor: Whether or not the edit was marked as minor
2046 $isWatch: (No longer used)
2047 $section: (No longer used)
2048 $flags: Flags passed to WikiPage::doEditContent()
2049 $revision: New Revision of the article (can be null for edits that change nothing)
2050 $status: Status object about to be returned by doEditContent()
2051 $baseRevId: the rev ID (or false) this edit was based on
2053 'PageHistoryBeforeList': When a history page list is about to be constructed.
2054 $article: the article that the history is loading for
2055 $context: RequestContext object
2057 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2058 $row: the revision row for this line
2059 $s: the string representing this parsed line
2060 $classes: array containing the <li> element classes
2062 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2065 $queryInfo: the query parameters
2067 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2068 which depends on user options should install this hook and append its values to
2070 &$confstr: reference to a hash key string which can be modified
2071 $user: User (object) requesting the page
2073 'ParserAfterParse': Called from Parser::parse() just after the call to
2074 Parser::internalParse() returns.
2075 $parser: parser object
2076 $text: text being parsed
2077 $stripState: stripState used (object)
2079 'ParserAfterStrip': Called at end of parsing time.
2080 TODO: No more strip, deprecated ?
2081 $parser: parser object
2082 $text: text being parsed
2083 $stripState: stripState used (object)
2085 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2086 $parser: Parser object being used
2087 $text: text that will be returned
2089 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2090 $parser: Parser object
2091 $text: text to parse
2092 $stripState: StripState instance being used
2094 'ParserBeforeStrip': Called at start of parsing time.
2095 TODO: No more strip, deprecated ?
2096 $parser: parser object
2097 $text: text being parsed
2098 $stripState: stripState used (object)
2100 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2101 $parser: Parser object being used
2104 'ParserClearState': Called at the end of Parser::clearState().
2105 $parser: Parser object being cleared
2107 'ParserCloned': Called when the parser is cloned.
2108 $parser: Newly-cloned Parser object
2110 'ParserFirstCallInit': Called when the parser initialises for the first time.
2111 &$parser: Parser object being cleared
2113 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2115 $parser: Parser object
2116 $varCache: array to store the value in case of multiples calls of the
2118 $index: index (string) of the magic
2119 $ret: value of the magic word (the hook should set it)
2120 $frame: PPFrame object to use for expanding any template variables
2122 'ParserGetVariableValueTs': Use this to change the value of the time for the
2123 {{LOCAL...}} magic word.
2124 $parser: Parser object
2125 $time: actual time (timestamp)
2127 'ParserGetVariableValueVarCache': use this to change the value of the variable
2128 cache or return false to not use it.
2129 $parser: Parser object
2130 $varCache: variable cache (array)
2132 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
2133 ParserLimitReportFormat instead.
2134 Called at the end of Parser:parse() when the parser will
2135 include comments about size of the text parsed.
2136 $parser: Parser object
2137 &$limitReport: text that will be included (without comment tags)
2139 'ParserLimitReportFormat': Called for each row in the parser limit report that
2140 needs formatting. If nothing handles this hook, the default is to use "$key" to
2141 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2143 $key: Key for the limit report item (string)
2144 &$value: Value of the limit report item
2145 &$report: String onto which to append the data
2146 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2147 text intended for display in a monospaced font.
2148 $localize: If false, $report should be output in English.
2150 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2151 include comments about size of the text parsed. Hooks should use
2152 $output->setLimitReportData() to populate data. Functions for this hook should
2153 not use $wgLang; do that in ParserLimitReportFormat instead.
2154 $parser: Parser object
2155 $output: ParserOutput object
2157 'ParserMakeImageParams': Called before the parser make an image link, use this
2158 to modify the parameters of the image.
2159 $title: title object representing the file
2160 $file: file object that will be used to create the image
2161 &$params: 2-D array of parameters
2162 $parser: Parser object that called the hook
2164 'ParserSectionCreate': Called each time the parser creates a document section
2165 from wikitext. Use this to apply per-section modifications to HTML (like
2166 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2167 can begin in one section and end in another. Make sure your code can handle
2168 that case gracefully. See the EditSectionClearerLink extension for an example.
2169 $parser: the calling Parser instance
2170 $section: the section number, zero-based, but section 0 is usually empty
2171 &$sectionContent: ref to the content of the section. modify this.
2172 $showEditLinks: boolean describing whether this section has an edit link
2174 'ParserTestParser': Called when creating a new instance of Parser in
2175 tests/parser/parserTest.inc.
2176 $parser: Parser object created
2178 'ParserTestGlobals': Allows to define globals for parser tests.
2179 &$globals: Array with all the globals which should be set for parser tests.
2180 The arrays keys serve as the globals names, its values are the globals values.
2182 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2183 run. Use when page save hooks require the presence of custom tables to ensure
2184 that tests continue to run properly.
2185 &$tables: array of table names
2187 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2188 my talk page, my contributions" etc).
2189 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2190 &$title: Title object representing the current page
2191 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2193 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2194 &$user : User performing the action
2195 $action : Action being performed
2196 &$result : Whether or not the action should be prevented
2197 Change $result and return false to give a definitive answer, otherwise
2198 the built-in rate limiting checks are used, if enabled.
2199 $incrBy: Amount to increment counter by
2201 'PlaceNewSection': Override placement of new sections. Return false and put the
2202 merged text into $text to override the default behavior.
2203 $wikipage : WikiPage object
2204 $oldtext : the text of the article before editing
2205 $subject : subject of the new section
2206 &$text : text of the new section
2208 'PostLoginRedirect': Modify the post login redirect behavior.
2209 Occurs after signing up or logging in, allows for interception of redirect.
2210 &$returnTo: The page name to return to, as a string
2211 &$returnToQuery: array of url parameters, mapping parameter names to values
2212 &$type: type of login redirect as string;
2213 error: display a return to link ignoring $wgRedirectOnLogin
2214 signup: display a return to link using $wgRedirectOnLogin if needed
2215 success: display a return to link using $wgRedirectOnLogin if needed
2216 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2218 'PreferencesGetLegend': Override the text used for the <legend> of a
2219 preferences section.
2220 $form: the PreferencesForm object. This is a ContextSource as well
2221 $key: the section name
2222 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2224 'PreferencesFormPreSave': Override preferences being saved
2225 $formData: array of user submitted data
2226 $form: PreferencesForm object, also a ContextSource
2227 $user: User object with preferences to be saved set
2228 &$result: boolean indicating success
2230 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2231 AJAX search suggestions. Put results into &$results outparam and return false.
2232 $ns : array of int namespace keys to search in
2233 $search : search term (not guaranteed to be conveniently normalized)
2234 $limit : maximum number of results to return
2235 &$results : out param: array of page names (strings)
2236 $offset : number of results to offset from the beginning
2238 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2239 namespace from the search string so that extensions can attempt it.
2240 $namespaces : array of int namespace keys to search in (change this if you can
2242 $search : search term (replace this with term without the namespace if you can
2245 'PrefsEmailAudit': Called when user changes their email address.
2246 $user: User (object) changing his email address
2247 $oldaddr: old email address (string)
2248 $newaddr: new email address (string)
2250 'PrefsPasswordAudit': Called when user changes his password.
2251 $user: User (object) changing his password
2252 $newPass: new password
2253 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2255 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2257 $article: the title being (un)protected
2258 $output: a string of the form HTML so far
2260 'ProtectionForm::save': Called when a protection form is submitted.
2261 $article: the Page being (un)protected
2262 &$errorMsg: an html message string of an error or an array of message name and
2264 $reasonstr: a string describing the reason page protection level is altered
2266 'ProtectionForm::showLogExtract': Called after the protection log extract is
2268 $article: the page the form is shown for
2269 $out: OutputPage object
2271 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2272 &$obj: RawAction object
2273 &$text: The text that's going to be the output
2275 'RecentChange_save': Called at the end of RecentChange::save().
2276 $recentChange: RecentChange object
2278 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2279 names such as "oldid" that are preserved when using redirecting special pages
2280 such as Special:MyPage and Special:MyTalk.
2281 &$redirectParams: An array of parameters preserved by redirecting special pages.
2283 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2284 instance. Can be used by an extension override what skin is used in certain
2286 IContextSource $context: The RequestContext the skin is being created for.
2287 &$skin: A variable reference you may set a Skin instance or string key on to
2288 override the skin that will be used for the context.
2290 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2291 $user: The user having their password expiration reset
2292 &$newExpire: The new expiration date
2294 'ResetSessionID': Called from wfResetSessionID
2295 $oldSessionID: old session id
2296 $newSessionID: new session id
2298 'ResourceLoaderGetConfigVars': Called at the end of
2299 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2300 configuration variables to JavaScript. Things that depend on the current page
2301 or request state must be added through MakeGlobalVariablesScript instead.
2302 &$vars: array( variable name => value )
2304 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after variables
2305 from $wgResourceLoaderLESSVars are added. Can be used to add context-based variables.
2306 &$lessVars: array of variables already added
2308 'ResourceLoaderRegisterModules': Right before modules information is required,
2309 such as when responding to a resource
2310 loader request or generating HTML output.
2311 &$resourceLoader: ResourceLoader object
2313 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2314 called after the addition of 'qunit' and MediaWiki testing resources.
2315 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2316 included in core, is fed using tests/qunit/QUnitTestResources.php.
2317 &ResourceLoader object
2319 To add a new qunit module named 'myext.tests':
2320 testModules['qunit']['myext.tests'] = array(
2321 'script' => 'extension/myext/tests.js',
2322 'dependencies' => <any module dependency you might have>
2324 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2325 added to any module.
2327 'RevisionInsertComplete': Called after a revision is inserted into the database.
2328 &$revision: the Revision
2329 $data: the data stored in old_text. The meaning depends on $flags: if external
2330 is set, it's the URL of the revision text in external storage; otherwise,
2331 it's the revision text itself. In either case, if gzip is set, the revision
2333 $flags: a comma-delimited list of strings representing the options used. May
2334 include: utf8 (this will always be set for new revisions); gzip; external.
2336 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2337 the normal operations.
2338 $allSearchTerms : Array of the search terms in all content languages
2339 &$titleResult : Outparam; the value to return. A Title object or null.
2341 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2342 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2344 $term : Search term string
2345 &$title : Outparam; set to $title object and return false for a match
2347 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2348 if nothing was found.
2349 $term : Search term string
2350 &$title : Outparam; set to $title object and return false for a match
2352 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2354 $term : Search term string
2355 &$title : Current Title object that is being returned (null if none found).
2357 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2359 $title : Current Title object being displayed in search results.
2360 &$id: Revision ID (default is false, for latest)
2362 'SearchableNamespaces': An option to modify which namespaces are searchable.
2363 &$arr : Array of namespaces ($nsId => $name) which will be used.
2365 'SelfLinkBegin': Called before a link to the current article is displayed to
2366 allow the display of the link to be customized.
2367 $nt: the Title object
2368 &$html: html to display for the link
2369 &$trail: optional text to display before $html
2370 &$prefix: optional text to display after $html
2371 &$ret: the value to return if your hook returns false
2373 'SetupAfterCache': Called in Setup.php, after cache objects are set
2375 'ShowMissingArticle': Called when generating the output for a non-existent page.
2376 $article: The article object corresponding to the page
2378 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2379 DEPRECATED, use the ContentGetParserOutput hook instead!
2380 $text: Text being shown
2381 $title: Title of the custom script/stylesheet page
2382 $output: Current OutputPage object
2384 'ShowSearchHitTitle': Customise display of search hit title/link.
2385 &$title: Title to link to
2386 &$text: Text to use for the link
2387 $result: The search result
2388 $terms: The search terms entered
2389 $page: The SpecialSearch object.
2391 'ShowSearchHit': Customize display of search hit.
2392 $searchPage: The SpecialSearch instance.
2393 $result: The SearchResult to show
2394 $terms: Search terms, for highlighting
2395 &$link: HTML of link to the matching page. May be modified.
2396 &$redirect: HTML of redirect info. May be modified.
2397 &$section: HTML of matching section. May be modified.
2398 &$extract: HTML of content extract. May be modified.
2399 &$score: HTML of score. May be modified.
2400 &$size: HTML of page size. May be modified.
2401 &$date: HTML of of page modification date. May be modified.
2402 &$related: HTML of additional info for the matching page. May be modified.
2403 &$html: May be set to the full HTML that should be used to represent the search
2404 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2405 function returned false.
2407 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2408 allow the normal method of notice selection/rendering to work, or change the
2409 value of $siteNotice and return false to alter it.
2410 &$siteNotice: HTML returned as the sitenotice
2413 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2414 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2415 the sitenotice/anonnotice.
2418 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2420 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2421 the stock bottom scripts.
2423 'SkinAfterContent': Allows extensions to add text after the page content and
2424 article metadata. This hook should work in all skins. Set the &$data variable to
2425 the text you're going to add.
2426 &$data: (string) Text to be printed out directly (without parsing)
2429 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2431 &$bar: Sidebar contents
2432 Modify $bar to add or modify sidebar portlets.
2434 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2436 &$bar: Sidebar content
2437 Modify $bar to add or modify sidebar portlets.
2438 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2440 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2442 $title: displayed page title
2443 $type: 'normal' or 'history' for old/diff views
2444 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2445 message must be in HTML format, not wikitext!
2446 &$link: overridable HTML link to be passed into the message as $1
2447 &$forContent: overridable flag if copyright footer is shown in content language.
2448 This parameter is deprecated.
2450 'SkinEditSectionLinks': Modify the section edit links
2451 $skin: Skin object rendering the UI
2452 $title: Title object for the title being linked to (may not be the same as
2453 the page title, if the section is included from a template)
2454 $section: The designation of the section being pointed to, to be included in
2455 the link, like "§ion=$section"
2456 $tooltip: The default tooltip. Escape before using.
2457 By default, this is wrapped in the 'editsectionhint' message.
2458 &$result: Array containing all link detail arrays. Each link detail array should contain
2460 * targetTitle - Target Title object
2461 * text - String for the text
2462 * attribs - Array of attributes
2463 * query - Array of query parameters to add to the URL
2464 * options - Array of options for Linker::link
2465 $lang: The language code to use for the link in the wfMessage function
2467 'SkinGetPoweredBy': TODO
2468 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2469 the MediaWiki icon but plain text instead.
2472 'SkinPreloadExistence': Supply titles that should be added to link existence
2473 cache before the page is rendered.
2474 &$titles: Array of Title objects
2477 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2478 &$subpages: Subpage links HTML
2480 $out: OutputPage object
2481 If false is returned $subpages will be used instead of the HTML
2482 subPageSubtitle() generates.
2483 If true is returned, $subpages will be ignored and the rest of
2484 subPageSubtitle() will run.
2486 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2488 $sktemplate: SkinTemplate object
2489 $nav_urls: array of tabs
2491 'SkinTemplateGetLanguageLink': After building the data for a language link from
2492 which the actual html is constructed.
2493 &$languageLink: array containing data about the link. The following keys can be
2494 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2495 $languageLinkTitle: Title object belonging to the external language link.
2496 $title: Title object of the page the link belongs to.
2497 $outputPage: The OutputPage object the links are built from.
2499 To alter the structured navigation links in SkinTemplates, there are three
2500 hooks called in different spots:
2502 'SkinTemplateNavigation': Called on content pages after the tabs have been
2503 added, but before variants have been added.
2504 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2505 tab is added but before variants have been added.
2506 'SkinTemplateNavigation::Universal': Called on both content and special pages
2507 after variants have been added.
2508 &$sktemplate: SkinTemplate object
2509 &$links: Structured navigation links. This is used to alter the navigation for
2510 skins which use buildNavigationUrls such as Vector.
2512 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2514 &$sktemplate: SkinTemplate object
2515 &$tpl: QuickTemplate engine object
2517 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2518 $sktemplate: SkinTemplate object
2519 $res: set to true to prevent active tabs
2521 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2522 You can either create your own array, or alter the parameters for
2524 &$sktemplate: The SkinTemplate instance.
2525 $title: Title instance for the page.
2526 $message: Visible label of tab.
2527 $selected: Whether this is a selected tab.
2528 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2529 &$classes: Array of CSS classes to apply.
2530 &$query: Query string to add to link.
2532 &$result: Complete assoc. array if you want to return true.
2534 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2535 been rendered (useful for adding more).
2536 $sk: The QuickTemplate based skin template running the hook.
2537 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2538 extensions that add support for BaseTemplateToolbox should watch for this
2539 dummy parameter with "$dummy=false" in their code and return without echoing
2540 any HTML to avoid creating duplicate toolbox items.
2542 'SoftwareInfo': Called by Special:Version for returning information about the
2544 $software: The array of software in format 'name' => 'version'. See
2545 SpecialVersion::softwareInformation().
2547 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2548 $name: name of the special page
2549 &$form: HTMLForm object
2551 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2552 $sp: SpecialPage object, for context
2553 &$fields: Current HTMLForm fields
2555 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2556 $id: User id number, only provided for backwards-compatibility
2557 $user: User object representing user contributions are being fetched for
2558 $sp: SpecialPage instance, providing context
2560 'SpecialListusersDefaultQuery': Called right before the end of
2561 UsersPager::getDefaultQuery().
2562 $pager: The UsersPager instance
2563 $query: The query array to be returned
2565 'SpecialListusersFormatRow': Called right before the end of
2566 UsersPager::formatRow().
2567 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2568 $row: Database row object
2570 'SpecialListusersHeader': Called before closing the <fieldset> in
2571 UsersPager::getPageHeader().
2572 $pager: The UsersPager instance
2573 $out: The header HTML
2575 'SpecialListusersHeaderForm': Called before adding the submit button in
2576 UsersPager::getPageHeader().
2577 $pager: The UsersPager instance
2578 $out: The header HTML
2580 'SpecialListusersQueryInfo': Called right before the end of.
2581 UsersPager::getQueryInfo()
2582 $pager: The UsersPager instance
2583 $query: The query array to be returned
2585 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2586 $type: String of the log type
2587 $request: WebRequest object for getting the value provided by the current user
2588 &$qc: Array for query conditions to add
2590 'SpecialMovepageAfterMove': Called after moving a page.
2591 $movePage: MovePageForm object
2592 $oldTitle: old title (object)
2593 $newTitle: new title (object)
2595 'SpecialNewpagesConditions': Called when building sql query for
2597 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2598 $opts: FormOptions object containing special page options
2599 &$conds: array of WHERE conditionals for query
2600 &tables: array of tables to be queried
2601 &$fields: array of columns to select
2602 &$join_conds: join conditions for the tables
2604 'SpecialNewPagesFilters': Called after building form options at NewPages.
2605 $special: the special page object
2606 &$filters: associative array of filter definitions. The keys are the HTML
2607 name/URL parameters. Each key maps to an associative array with a 'msg'
2608 (message key) and a 'default' value.
2610 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2611 hook to remove a core special page.
2612 $list: list (array) of core special pages
2614 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2615 $special: the SpecialPage object
2616 $subPage: the subpage string or null if no subpage was specified
2618 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2619 $special: the SpecialPage object
2620 $subPage: the subpage string or null if no subpage was specified
2622 'SpecialPasswordResetOnSubmit': When executing a form submission on
2623 Special:PasswordReset.
2624 $users: array of User objects.
2625 $data: array of data submitted by the user
2626 &$error: string, error code (message key) used to describe to error (out
2627 parameter). The hook needs to return false when setting this, otherwise it
2628 will have no effect.
2630 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2631 use this to change some selection criteria or substitute a different title.
2632 &$randstr: The random number from wfRandom()
2633 &$isRedir: Boolean, whether to select a redirect or non-redirect
2634 &$namespaces: An array of namespace indexes to get the title from
2635 &$extra: An array of extra SQL statements
2636 &$title: If the hook returns false, a Title object to use instead of the
2637 result from the normal query
2639 'SpecialRecentChangesFilters': Called after building form options at
2640 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2641 $special: the special page object
2642 &$filters: associative array of filter definitions. The keys are the HTML
2643 name/URL parameters. Each key maps to an associative array with a 'msg'
2644 (message key) and a 'default' value.
2646 'SpecialRecentChangesPanel': Called when building form options in
2647 SpecialRecentChanges.
2648 &$extraOpts: array of added items, to which can be added
2649 $opts: FormOptions for this request
2651 'SpecialRecentChangesQuery': Called when building SQL query for
2652 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2653 ChangesListSpecialPageQuery instead.
2654 &$conds: array of WHERE conditionals for query
2655 &$tables: array of tables to be queried
2656 &$join_conds: join conditions for the tables
2657 $opts: FormOptions for this request
2658 &$query_options: array of options for the database request
2659 &$select: Array of columns to select
2661 'SpecialResetTokensTokens': Called when building token list for
2663 &$tokens: array of token information arrays in the format of
2664 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2666 'SpecialSearchCreateLink': Called when making the message to create a page or
2667 go to the existing page.
2668 $t: title object searched for
2669 &$params: an array of the default message name and page title (as parameter)
2671 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2672 target doesn't exist.
2673 &$title: title object generated from the text entered by the user
2675 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2676 the advanced form, a.k.a. power search box.
2677 &$showSections: an array to add values with more options to
2678 $term: the search term (not a title object)
2679 $opts: an array of hidden options (containing 'redirs' and 'profile')
2681 'SpecialSearchProfiles': Allows modification of search profiles.
2682 &$profiles: profiles, which can be modified.
2684 'SpecialSearchProfileForm': Allows modification of search profile forms.
2685 $search: special page object
2686 &$form: String: form html
2687 $profile: String: current search profile
2688 $term: String: search term
2689 $opts: Array: key => value of hidden options for inclusion in custom forms
2691 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2692 $search: SpecialSearch special page object
2693 $profile: String: current search profile
2694 $engine: the search engine
2696 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2697 on the search results page. Useful for including an external search
2698 provider. To disable the output of MediaWiki search output, return
2700 $specialSearch: SpecialSearch object ($this)
2702 $term: Search term specified by the user
2704 'SpecialSearchResults': Called before search result display
2705 $term: string of search term
2706 &$titleMatches: empty or SearchResultSet object
2707 &$textMatches: empty or SearchResultSet object
2709 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2710 &$extraStats: Array to save the new stats
2711 ( $extraStats['<name of statistic>'] => <value>; )
2713 'SpecialUploadComplete': Called after successfully uploading a file from
2715 $form: The SpecialUpload object
2717 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2718 $wgVersion: Current $wgVersion for you to use
2719 &$versionUrl: Raw url to link to (eg: release notes)
2721 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2722 Deprecated, use ChangesListSpecialPageFilters instead.
2723 $special: the special page object
2724 &$filters: associative array of filter definitions. The keys are the HTML
2725 name/URL parameters. Each key maps to an associative array with a 'msg'
2726 (message key) and a 'default' value.
2728 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2729 Deprecated, use ChangesListSpecialPageQuery instead.
2730 &$conds: array of WHERE conditionals for query
2731 &$tables: array of tables to be queried
2732 &$join_conds: join conditions for the tables
2733 &$fields: array of query fields
2734 $opts: A FormOptions object with watchlist options for the current request
2736 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2737 SpecialWatchlist. Allows extensions to register custom values they have
2738 inserted to rc_type so they can be returned as part of the watchlist.
2739 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2741 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2742 URL for a title when we have no other parameters on the URL. Gives a chance for
2743 extensions that alter page view behavior radically to abort that redirect or
2745 $request: WebRequest
2746 $title: Title of the currently found title obj
2747 $output: OutputPage object
2749 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2750 rendered (by ThumbnailImage:toHtml method).
2751 $thumbnail: the ThumbnailImage object
2752 &$attribs: image attribute array
2753 &$linkAttribs: image link attribute array
2755 'TitleArrayFromResult': Called when creating an TitleArray object from a
2757 &$titleArray: set this to an object to override the default object returned
2758 $res: database result used to create the object
2760 'TitleExists': Called when determining whether a page exists at a given title.
2761 $title: The title being tested.
2762 &$exists: Whether the title exists.
2764 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2765 or override the quick permissions check.
2766 $title: The Title object being accessed
2767 $user: The User performing the action
2768 $action: Action being performed
2769 &$errors: Array of errors
2770 $doExpensiveQueries: Whether to do expensive DB queries
2771 $short: Whether to return immediately on first error
2773 'TitleGetEditNotices': Allows extensions to add edit notices
2774 $title: The Title object for the page the edit notices are for
2775 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2776 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2778 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2779 that can be applied.
2780 $title: The title in question.
2781 &$types: The types of protection available.
2783 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2784 Called when determining if a page is a CSS or JS page.
2785 $title: Title object that is being checked
2786 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2787 Hooks may change this value to override the return value of
2788 Title::isCssOrJsPage().
2790 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2791 overriding default behavior for determining if a page exists. If $isKnown is
2792 kept as null, regular checks happen. If it's a boolean, this value is returned
2793 by the isKnown method.
2794 $title: Title object that is being checked
2795 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2797 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2798 that this hook is not called for interwiki pages or pages in immovable
2799 namespaces: for these, isMovable() always returns false.
2800 $title: Title object that is being checked
2801 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2802 Hooks may change this value to override the return value of
2805 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2806 Called when determining if a page is a wikitext or should
2807 be handled by separate handler (via ArticleViewCustom).
2808 $title: Title object that is being checked
2809 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2810 Hooks may change this value to override the return value of
2811 Title::isWikitextPage()
2813 'TitleMove': Before moving an article (title).
2816 $user: user who does the move
2818 'TitleMoveComplete': After moving an article (title).
2821 $user: user who did the move
2822 $pageid: database ID of the page that's been moved
2823 $redirid: database ID of the created redirect
2824 $reason: reason for the move
2826 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2827 adding the default error message if nothing allows the user to read the page. If
2828 a handler wants a title to *not* be whitelisted, it should also return false.
2829 $title: Title object being checked against
2830 $user: Current user object
2831 &$whitelisted: Boolean value of whether this title is whitelisted
2833 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2834 $title: Title object to purge
2835 &$urls: An array of URLs to purge from the caches, to be manipulated.
2837 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2838 PageArchive object has been created but before any further processing is done.
2839 &$archive: PageArchive object
2840 $title: Title object of the page that we're viewing
2842 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2843 PageArchive object has been created but before any further processing is done.
2844 &$archive: PageArchive object
2845 $title: Title object of the page that we're viewing
2847 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2848 the site is not in read-only mode, that the Title object is not null and after
2849 a PageArchive object has been constructed but before performing any further
2851 &$archive: PageArchive object
2852 $title: Title object of the page that we're about to undelete
2854 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2855 $title: title object related to the revision
2856 $rev: revision (object) that will be viewed
2858 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2860 $action: action name
2861 $article: article "acted on"
2863 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
2864 Since 1.24: Paths pointing to a directory will be recursively scanned for
2865 test case files matching the suffix "Test.php".
2866 &$paths: list of test cases and directories to search.
2868 'UnwatchArticle': Before a watch is removed from an article.
2869 $user: user watching
2870 $page: WikiPage object to be removed
2871 &$status: Status object to be returned if the hook returns false
2873 'UnwatchArticleComplete': After a watch is removed from an article.
2874 $user: user that watched
2875 $page: WikiPage object that was watched
2877 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2878 $formattedPageStatus: list of valid page states
2880 'UploadForm:initial': Before the upload form is generated. You might set the
2881 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2882 text (HTML) either before or after the editform.
2883 $form: UploadForm object
2885 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2886 poke at member variables like $mUploadDescription before the file is saved. Do
2887 not use this hook to break upload processing. This will return the user to a
2888 blank form with no error message; use UploadVerification and UploadVerifyFile
2890 $form: UploadForm object
2892 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2893 $type: (string) the requested upload type
2894 &$className: the class name of the Upload instance to be created
2896 'UploadComplete': when Upload completes an upload.
2897 &$upload: an UploadBase child instance
2899 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2901 $descriptor: (array) the HTMLForm descriptor
2903 'UploadFormSourceDescriptors': after the standard source inputs have been
2904 added to the descriptor
2905 $descriptor: (array) the HTMLForm descriptor
2907 'UploadVerification': Additional chances to reject an uploaded file. Consider
2908 using UploadVerifyFile instead.
2909 string $saveName: destination file name
2910 string $tempName: filesystem path to the temporary file for checks
2911 string &$error: output: message key for message to show if upload canceled by
2912 returning false. May also be an array, where the first element is the message
2913 key and the remaining elements are used as parameters to the message.
2915 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
2916 in most cases over UploadVerification.
2917 object $upload: an instance of UploadBase, with all info about the upload
2918 string $mime: The uploaded file's MIME type, as detected by MediaWiki. Handlers
2919 will typically only apply for specific MIME types.
2920 object &$error: output: true if the file is valid. Otherwise, an indexed array
2921 representing the problem with the file, where the first element is the message
2922 key and the remaining elements are used as parameters to the message.
2924 'UploadComplete': Upon completion of a file upload.
2925 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2926 $uploadBase->getLocalFile().
2928 'User::mailPasswordInternal': before creation and mailing of a user's new
2930 $user: the user who sent the message out
2931 $ip: IP of the user who sent the message out
2932 $u: the account whose new password will be set
2934 'UserAddGroup': Called when adding a group; return false to override
2935 stock group addition.
2936 $user: the user object that is to have a group added
2937 &$group: the group to add, can be modified
2939 'UserArrayFromResult': Called when creating an UserArray object from a database
2941 &$userArray: set this to an object to override the default object returned
2942 $res: database result used to create the object
2944 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2945 want to display an error message, try getUserPermissionsErrors.
2946 $title: Title object being checked against
2947 $user : Current user object
2948 $action: Action being checked
2949 $result: Pointer to result returned if hook returns false. If null is returned,
2950 userCan checks are continued by internal code.
2952 'UserCanSendEmail': To override User::canSendEmail() permission check.
2953 $user: User (object) whose permission is being checked
2954 &$canSend: bool set on input, can override on output
2956 'UserClearNewTalkNotification': Called when clearing the "You have new
2957 messages!" message, return false to not delete it.
2958 $user: User (object) that will clear the message
2959 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2961 'UserCreateForm': change to manipulate the login form
2962 $template: SimpleTemplate instance for the form
2964 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2965 $user: User to get groups for
2966 &$groups: Current effective groups
2968 'UserGetAllRights': After calculating a list of all available rights.
2969 &$rights: Array of rights, which may be added to.
2971 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2972 before returning the options to the caller. Warning: This hook is called for
2973 every call to User::getDefaultOptions(), which means it's potentially called
2974 dozens or hundreds of times. You may want to cache the results of non-trivial
2975 operations in your hook function for this reason.
2976 &$defaultOptions: Array of preference keys and their default values.
2978 'UserGetEmail': Called when getting an user email address.
2980 &$email: email, change this to override local email
2982 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2983 email authentication.
2985 &$timestamp: timestamp, change this to override local email authentication
2988 'UserGetImplicitGroups': DEPRECATED, called in User::getImplicitGroups().
2989 &$groups: List of implicit (automatically-assigned) groups
2991 'UserGetLanguageObject': Called when getting user's interface language object.
2993 &$code: Language code that will be used to create the object
2994 $context: IContextSource object
2996 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2997 &$reservedUsernames: $wgReservedUsernames
2999 'UserGetRights': Called in User::getRights().
3000 $user: User to get rights for
3001 &$rights: Current rights
3003 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3004 specific block exemptions).
3005 $user: User in question
3006 $title: Title of the page in question
3007 &$blocked: Out-param, whether or not the user is blocked from that page.
3008 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3009 to edit their own user talk pages.
3011 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3013 $ip: User's IP address
3014 &$blocked: Whether the user is blocked, to be modified by the hook
3016 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3017 false if a UserGetRights hook might remove the named right.
3018 $right: The user right being checked
3020 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3021 environmental means; occurs after session is loaded.
3022 $user: user object being loaded
3024 'UserLoadDefaults': Called when loading a default user.
3028 'UserLoadFromDatabase': Called when loading a user from the database.
3030 &$s: database query object
3032 'UserLoadFromSession': Called to authenticate users on external/environmental
3033 means; occurs before session is loaded.
3034 $user: user object being loaded
3035 &$result: set this to a boolean value to abort the normal authentication
3038 'UserLoadOptions': When user options/preferences are being loaded from the
3041 &$options: Options, can be modified.
3043 'UserLoginComplete': After a user has logged in.
3044 $user: the user object that was created on login
3045 $inject_html: Any HTML to inject after the "logged in" message.
3047 'UserLoginForm': change to manipulate the login form
3048 $template: SimpleTemplate instance for the form
3050 'UserLogout': Before a user logs out.
3051 $user: the user object that is about to be logged out
3053 'UserLogoutComplete': After a user has logged out.
3054 $user: the user object _after_ logout (won't have name, ID, etc.)
3055 $inject_html: Any HTML to inject after the "logged out" message.
3056 $oldName: name of the user before logout (string)
3058 'UserRemoveGroup': Called when removing a group; return false to override stock
3060 $user: the user object that is to have a group removed
3061 &$group: the group to be removed, can be modified
3063 'UserRights': After a user's group memberships are changed.
3064 $user : User object that was changed
3065 $add : Array of strings corresponding to groups added
3066 $remove: Array of strings corresponding to groups removed
3068 'UserRequiresHTTPS': Called to determine whether a user needs
3069 to be switched to HTTPS.
3070 $user: User in question.
3071 &$https: Boolean whether $user should be switched to HTTPS.
3073 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3074 have been requested to be reset. This hook can be used to exclude certain
3075 options from being reset even when the user has requested all prefs to be reset,
3076 because certain options might be stored in the user_properties database table
3077 despite not being visible and editable via Special:Preferences.
3078 $user: the User (object) whose preferences are being reset
3079 &$newOptions: array of new (site default) preferences
3080 $options: array of the user's old preferences
3081 $resetKinds: array containing the kinds of preferences to reset
3083 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3085 $user: user retrieving new talks messages
3086 $talks: array of new talks page(s)
3088 'UserSaveSettings': Called when saving user settings.
3091 'UserSaveOptions': Called just before saving user preferences/options.
3093 &$options: Options, modifiable
3095 'UserSetCookies': Called when setting user cookies.
3097 &$session: session array, will be added to $_SESSION
3098 &$cookies: cookies array mapping cookie name to its value
3100 'UserSetEmail': Called when changing user email address.
3102 &$email: new email, change this to override new email address
3104 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3105 email authentication.
3107 &$timestamp: new timestamp, change this to override local email
3108 authentication timestamp
3110 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3111 "Foobar (Talk | Contribs | Block)".
3112 $userId: User id of the current user
3113 $userText: User name of the current user
3114 &$items: Array of user tool links as HTML fragments
3116 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3117 FormatMetadata::getExtendedMeta (return false means cache will be
3118 invalidated and GetExtendedMetadata hook called again).
3119 $timestamp: The timestamp metadata was generated
3120 $file: The file the metadata is for
3122 'UserMailerChangeReturnPath': Called to generate a VERP return address
3123 when UserMailer sends an email, with a bounce handling extension.
3124 $to: Array of MailAddress objects for the recipients
3125 &$returnPath: The return address string
3127 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid error
3128 messages. Allows to add additional error messages (except messages already in
3129 LoginForm::$validErrorMessages).
3130 &$messages Already added messages (inclusive messages from LoginForm::$validErrorMessages)
3132 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3133 used to alter the SQL query which gets the list of wanted pages.
3134 &$wantedPages: WantedPagesPage object
3135 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3137 'WatchArticle': Before a watch is added to an article.
3138 $user: user that will watch
3139 $page: WikiPage object to be watched
3140 &$status: Status object to be returned if the hook returns false
3142 'WatchArticleComplete': After a watch is added to an article.
3143 $user: user that watched
3144 $page: WikiPage object watched
3146 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3147 form, used to manipulate the list of pages or preload data based on that list.
3148 &$watchlistInfo: array of watchlisted pages in
3149 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3151 'WatchlistEditorBuildRemoveLine': when building remove lines in
3152 Special:Watchlist/edit.
3153 &$tools: array of extra links
3154 $title: Title object
3155 $redirect: whether the page is a redirect
3157 &$link: HTML link to title
3159 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3161 $router: The PathRouter instance
3163 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3164 Return false to prevent setting of the cookie.
3165 &$name: Cookie name passed to WebResponse::setcookie()
3166 &$value: Cookie value passed to WebResponse::setcookie()
3167 &$expire: Cookie expiration, as for PHP's setcookie()
3168 $options: Options passed to WebResponse::setcookie()
3170 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3171 $row: The DB row of the entry.
3172 $title: The Title of the page where the link comes FROM
3173 $target: The Title of the page where the link goes TO
3174 &$props: Array of HTML strings to display after the title.
3176 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3177 dumps. One, and only one hook should set this, and return false.
3178 &$tables: Database tables to use in the SELECT query
3179 &$opts: Options to use for the query
3180 &$join: Join conditions
3182 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3183 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3184 specific to a content model should be provided by the respective Content's
3185 getDeletionUpdates() method.
3187 $content: the Content to generate updates for
3188 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3190 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3191 run a MediaWiki cli script.
3192 &$script: MediaWiki cli script path
3193 &$parameters: Array of arguments and options to the script
3194 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3197 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3198 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3199 $qp: The list of QueryPages
3201 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3202 extra metadata to be added.
3203 $obj: The XmlDumpWriter object.
3204 &$out: The output string.
3205 $row: The database row for the page.
3206 $title: The title of the page.
3208 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3210 $obj: The XmlDumpWriter object.
3211 &$out: The text being output.
3212 $row: The database row for the revision.
3213 $text: The revision text.
3215 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3216 to add additional tags to extract.
3217 &$items: Array containing information on which items to extract. See XMPInfo for
3218 details on the format.
3220 'XMPGetResults': Called just before returning the results array of parsing xmp
3221 data. Can be used to post-process the results.
3222 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3223 is an array of metadata tags returned (each tag is either a value, or an array
3226 More hooks might be available but undocumented, you can execute
3227 "php maintenance/findHooks.php" to find hidden ones.