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 'ApiMain::moduleManager': Called when ApiMain has finished initializing its
422 module manager. Can be used to conditionally register API modules.
423 $moduleManager: ApiModuleManager Module manager instance
425 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
426 can alter or append to the array.
427 &$results: array with integer keys to associative arrays. Keys in associative
429 - title: Title object.
430 - redirect from: Title or null.
431 - extract: Description for this result.
432 - extract trimmed: If truthy, the extract will not be trimmed to
433 $wgOpenSearchDescriptionLength.
434 - image: Thumbnail for this result. Value is an array with subkeys 'source'
435 (url), 'width', 'height', 'alt', 'align'.
436 - url: Url for the given title.
438 'ApiQuery::moduleManager': Called when ApiQuery has finished initializing its
439 module manager. Can be used to conditionally register API query modules.
440 $moduleManager: ApiModuleManager Module manager instance
442 'APIQueryAfterExecute': After calling the execute() method of an
443 action=query submodule. Use this to extend core API modules.
444 &$module: Module object
446 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
447 an action=query submodule. Use this to extend core API modules.
448 &$module: Module object
449 &$resultPageSet: ApiPageSet object
451 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
452 Use this hook to add custom tokens to prop=info. Every token has an action,
453 which will be used in the intoken parameter and in the output
454 (actiontoken="..."), and a callback function which should return the token, or
455 false if the user isn't allowed to obtain it. The prototype of the callback
456 function is func($pageid, $title), where $pageid is the page ID of the page the
457 token is requested for and $title is the associated Title object. In the hook,
458 just add your callback to the $tokenFunctions array and return true (returning
459 false makes no sense).
460 $tokenFunctions: array(action => callback)
462 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
463 Use this hook to add custom tokens to prop=revisions. Every token has an
464 action, which will be used in the rvtoken parameter and in the output
465 (actiontoken="..."), and a callback function which should return the token, or
466 false if the user isn't allowed to obtain it. The prototype of the callback
467 function is func($pageid, $title, $rev), where $pageid is the page ID of the
468 page associated to the revision the token is requested for, $title the
469 associated Title object and $rev the associated Revision object. In the hook,
470 just add your callback to the $tokenFunctions array and return true (returning
471 false makes no sense).
472 $tokenFunctions: array(action => callback)
474 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
475 Use this hook to add custom tokens to list=recentchanges. Every token has an
476 action, which will be used in the rctoken parameter and in the output
477 (actiontoken="..."), and a callback function which should return the token, or
478 false if the user isn't allowed to obtain it. The prototype of the callback
479 function is func($pageid, $title, $rc), where $pageid is the page ID of the
480 page associated to the revision the token is requested for, $title the
481 associated Title object and $rc the associated RecentChange object. In the
482 hook, just add your callback to the $tokenFunctions array and return true
483 (returning false makes no sense).
484 $tokenFunctions: array(action => callback)
486 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
487 sites general information.
488 $module: the current ApiQuerySiteInfo module
489 &$results: array of results, add things here
491 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
492 sites statistics information.
493 &$results: array of results, add things here
495 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
496 action=query&meta=tokens. Note that most modules will probably be able to use
497 the 'csrf' token instead of creating their own token types.
498 &$salts: array( type => salt to pass to User::getEditToken() )
500 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
501 Use this hook to add custom token to list=users. Every token has an action,
502 which will be used in the ustoken parameter and in the output
503 (actiontoken="..."), and a callback function which should return the token, or
504 false if the user isn't allowed to obtain it. The prototype of the callback
505 function is func($user) where $user is the User object. In the hook, just add
506 your callback to the $tokenFunctions array and return true (returning false
508 $tokenFunctions: array(action => callback)
510 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
511 an exception is thrown during API action execution.
512 $apiMain: Calling ApiMain instance.
513 $e: Exception object.
515 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
516 should have its own entry in the $apis array and have a unique name, passed as
517 key for the array that represents the service data. In this data array, the
518 key-value-pair identified by the apiLink key is required.
519 &$apis: array of services
521 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
522 Use this hook to extend action=tokens with new token types.
523 &$tokenTypes: supported token types in format 'type' => callback function
524 used to retrieve this type of tokens.
526 'Article::MissingArticleConditions': Before fetching deletion & move log entries
527 to display a message of a non-existing page being deleted/moved, give extensions
528 a chance to hide their (unrelated) log entries.
529 &$conds: Array of query conditions (all of which have to be met; conditions will
530 AND in the final query)
531 $logTypes: Array of log types being queried
533 'ArticleAfterFetchContent': After fetching content of an article from the
534 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
535 $article: the article (object) being loaded from the database
536 &$content: the content (string) of the article
538 'ArticleAfterFetchContentObject': After fetching content of an article from the
540 $article: the article (object) being loaded from the database
541 &$content: the content of the article, as a Content object
543 'ArticleConfirmDelete': Before writing the confirmation form for article
545 $article: the article (object) being deleted
546 $output: the OutputPage object
547 &$reason: the reason (string) the article is being deleted
549 'ArticleContentOnDiff': Before showing the article content below a diff. Use
550 this to change the content in this area or how it is loaded.
551 $diffEngine: the DifferenceEngine
552 $output: the OutputPage object
554 'ArticleDelete': Before an article is deleted.
555 $wikiPage: the WikiPage (object) being deleted
556 $user: the user (object) deleting the article
557 $reason: the reason (string) the article is being deleted
558 $error: if the deletion was prohibited, the (raw HTML) error message to display
560 $status: Status object, modify this to throw an error. Overridden by $error
563 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
564 $title: Title of the article that has been deleted.
565 $outputPage: OutputPage that can be used to append the output.
567 'ArticleDeleteComplete': After an article is deleted.
568 $wikiPage: the WikiPage that was deleted
569 $user: the user that deleted the article
570 $reason: the reason the article was deleted
571 $id: id of the article that was deleted
572 $content: the Content of the deleted page
573 $logEntry: the ManualLogEntry used to record the deletion
575 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
577 &$wikiPage: WikiPage (object) of the user talk page
578 $recipient: User (object) who's talk page was edited
580 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
581 article has been changed.
582 $wikiPage: the WikiPage (object)
583 $editInfo: data holder that includes the parser output ($editInfo->output) for
584 that page after the change
585 $changed: bool for if the page was changed
587 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
588 recentchanges table, return false to not delete old entries.
589 $wikiPage: WikiPage (object) being modified
591 'ArticleFromTitle': when creating an article object from a title object using
592 Wiki::articleFromTitle().
593 $title: Title (object) used to create the article object
594 $article: Article (object) that will be returned
595 $context: IContextSource (object)
597 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
598 PageContentInsertComplete.
599 $wikiPage: WikiPage created
600 $user: User creating the article
602 $summary: Edit summary/comment
603 $isMinor: Whether or not the edit was marked as minor
604 $isWatch: (No longer used)
605 $section: (No longer used)
606 $flags: Flags passed to WikiPage::doEditContent()
607 $revision: New Revision of the article
609 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
610 $targetTitle: target title (object)
611 $destTitle: destination title (object)
613 'ArticlePageDataAfter': After loading data of an article from the database.
614 $wikiPage: WikiPage (object) whose data were loaded
615 $row: row (object) returned from the database server
617 'ArticlePageDataBefore': Before loading data of an article from the database.
618 $wikiPage: WikiPage (object) that data will be loaded
619 $fields: fields (array) to load from the database
621 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
622 $wikiPage: the WikiPage being saved
623 $popts: parser options to be used for pre-save transformation
625 'ArticleProtect': Before an article is protected.
626 $wikiPage: the WikiPage being protected
627 $user: the user doing the protection
628 $protect: boolean whether this is a protect or an unprotect
629 $reason: Reason for protect
630 $moveonly: boolean whether this is for move only or not
632 'ArticleProtectComplete': After an article is protected.
633 $wikiPage: the WikiPage that was protected
634 $user: the user who did the protection
635 $protect: boolean whether it was a protect or an unprotect
636 $reason: Reason for protect
637 $moveonly: boolean whether it was for move only or not
639 'ArticlePurge': Before executing "&action=purge".
640 $wikiPage: WikiPage (object) to purge
642 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
643 revisions of an article.
644 &$title: Title object of the article
646 'ArticleRevisionUndeleted': After an article revision is restored.
647 $title: the article title
648 $revision: the revision
649 $oldPageID: the page ID of the revision when archived (may be null)
651 'ArticleRollbackComplete': After an article rollback is completed.
652 $wikiPage: the WikiPage that was edited
653 $user: the user who did the rollback
654 $revision: the revision the page was reverted back to
655 $current: the reverted revision
657 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
659 $wikiPage: the WikiPage (object) being saved
660 $user: the user (object) saving the article
661 $text: the new article text
662 $summary: the article summary (comment)
667 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
668 PageContentSaveComplete instead.
669 $wikiPage: WikiPage modified
670 $user: User performing the modification
672 $summary: Edit summary/comment
673 $isMinor: Whether or not the edit was marked as minor
674 $isWatch: (No longer used)
675 $section: (No longer used)
676 $flags: Flags passed to WikiPage::doEditContent()
677 $revision: New Revision of the article
678 $status: Status object about to be returned by doEditContent()
679 $baseRevId: the rev ID (or false) this edit was based on
681 'ArticleUndelete': When one or more revisions of an article are restored.
682 $title: Title corresponding to the article restored
683 $create: Whether or not the restoration caused the page to be created (i.e. it
684 didn't exist before).
685 $comment: The comment associated with the undeletion.
686 $oldPageId: ID of page previously deleted (from archive table)
688 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
689 $pageArchive: the PageArchive object
690 &$logEntry: ManualLogEntry object
691 $user: User who is performing the log action
693 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
694 the user is redirected back to the page.
695 &$article: the article
696 &$sectionanchor: The section anchor link (e.g. "#overview" )
697 &$extraq: Extra query parameters which can be added via hooked functions
699 'ArticleViewFooter': After showing the footer section of an ordinary page view
700 $article: Article object
701 $patrolFooterShown: boolean whether patrol footer is shown
703 'ArticleViewHeader': Before the parser cache is about to be tried for article
705 &$article: the article
706 &$pcache: whether to try the parser cache or not
707 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
708 object to both indicate that the output is done and what parser output was used.
710 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
711 redirect was followed.
712 $article: target article (object)
714 'ArticleViewCustom': Allows to output the text of the article in a different
715 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
716 that it is preferable to implement proper handing for a custom data type using
717 the ContentHandler facility.
718 $text: text of the page
719 $title: title of the page
720 $output: reference to $wgOut
722 'ArticleContentViewCustom': Allows to output the text of the article in a
723 different format than wikitext. Note that it is preferable to implement proper
724 handing for a custom data type using the ContentHandler facility.
725 $content: content of the page, as a Content object
726 $title: title of the page
727 $output: reference to $wgOut
729 'AuthPluginAutoCreate': Called when creating a local account for an user logged
730 in from an external authentication method.
731 $user: User object created locally
733 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
734 Gives a chance for an extension to set it programmatically to a variable class.
735 &$auth: the $wgAuth object, probably a stub
737 'AutopromoteCondition': Check autopromote condition for user.
738 $type: condition type
741 $result: result of checking autopromote condition
743 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
747 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
748 certain title are fetched.
750 $title: title of the page to which backlinks are sought
751 &$conds: query conditions
753 'BadImage': When checking against the bad image list. Change $bad and return
754 false to override. If an image is "bad", it is not rendered inline in wiki
755 pages or galleries in category pages.
756 $name: Image name being checked
757 &$bad: Whether or not the image is "bad"
759 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
760 custom HTML after the section. Any uses of the hook need to handle escaping.
761 $template BaseTemplate
762 $portlet: string portlet name
765 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
766 "noarticletext-nopermission" at Article::showMissingArticle().
767 $article: article object
769 'BeforeInitialize': Before anything is initialized in
770 MediaWiki::performRequest().
771 &$title: Title being used for request
773 &$output: OutputPage object
775 $request: WebRequest object
776 $mediaWiki: Mediawiki object
778 'BeforePageDisplay': Prior to outputting a page.
779 &$out: OutputPage object
782 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
783 override how the redirect is output by modifying, or by returning false, and
784 letting standard HTTP rendering take place.
785 ATTENTION: This hook is likely to be removed soon due to overall design of the system.
786 $context: IContextSource object
787 &$redirect: string URL, modifiable
789 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
790 override how the redirect is output by modifying, or by returning false and
791 taking over the output.
792 $out: OutputPage object
793 &$redirect: URL, modifiable
794 &$code: HTTP code (eg '301' or '302'), modifiable
796 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
797 $parser: Parser object
799 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
800 as a key then the file will appear as a broken thumbnail.
801 &$descQuery: query string to add to thumbnail URL
803 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
804 $parser: Parser object
805 $title: title of the template
806 &$skip: skip this template and link it?
807 &$id: the id of the revision being parsed
809 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
810 &$parser: Parser object
811 &$ig: ImageGallery object
813 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
815 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
816 to a newly created user account.
817 &$injected_html: Any HTML to inject after the "logged in" message of a newly
820 'BitmapHandlerTransform': before a file is transformed, gives extension the
821 possibility to transform it themselves
822 $handler: BitmapHandler
824 &$scalerParams: Array with scaler parameters
825 &$mto: null, set to a MediaTransformOutput
827 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
828 normalizations have been performed, except for the $wgMaxImageArea check.
830 &$params: Array of parameters
831 &$checkImageAreaHookResult: null, set to true or false to override the
832 $wgMaxImageArea check result.
834 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
836 $block: Block object (which is set to be autoblocking)
837 &$blockIds: Array of block IDs of the autoblock
839 'BlockIp': Before an IP address or user is blocked.
840 $block: the Block object about to be saved
841 $user: the user _doing_ the block (not the one being blocked)
842 &$reason: if the hook is aborted, the error message to be returned in an array
844 'BlockIpComplete': After an IP address or user is blocked.
845 $block: the Block object that was saved
846 $user: the user who did the block (not the one being blocked)
848 'BookInformation': Before information output on Special:Booksources.
849 $isbn: ISBN to show information for
850 $output: OutputPage object in use
852 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
853 to be able to access the wiki via HTTPS.
854 $ip: The IP address in human-readable form
855 &$canDo: This reference should be set to false if the client may not be able
858 'CanonicalNamespaces': For extensions adding their own namespaces or altering
860 Note that if you need to specify namespace protection or content model for
861 a namespace that is added in a CanonicalNamespaces hook handler, you
862 should do so by altering $wgNamespaceProtection and
863 $wgNamespaceContentModels outside the handler, in top-level scope. The
864 point at which the CanonicalNamespaces hook fires is too late for altering
865 these variables. This applies even if the namespace addition is
866 conditional; it is permissible to declare a content model and protection
867 for a namespace and then decline to actually register it.
868 &$namespaces: Array of namespace numbers with corresponding canonical names
870 'CategoryAfterPageAdded': After a page is added to a category.
871 $category: Category that page was added to
872 $wikiPage: WikiPage that was added
874 'CategoryAfterPageRemoved': After a page is removed from a category.
875 $category: Category that page was removed from
876 $wikiPage: WikiPage that was removed
878 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
879 $catpage: CategoryPage instance
881 'CategoryViewer::doCategoryQuery': After querying for pages to be displayed
882 in a Category page. Gives extensions the opportunity to batch load any
883 related data about the pages.
884 $type: The category type. Either 'page', 'file' or 'subcat'
885 $res: Query result from DatabaseBase::select()
887 'CategoryViewer::generateLink': Before generating an output link allow
888 extensions opportunity to generate a more specific or relevant link.
889 $type: The category type. Either 'page', 'img' or 'subcat'
890 $title: Title object for the categorized page
891 $html: Requested html content of anchor
892 &$link: Returned value. When set to a non-null value by a hook subscriber
893 this value will be used as the anchor instead of Linker::link
895 'ChangePasswordForm': For extensions that need to add a field to the
896 ChangePassword form via the Preferences form.
897 &$extraFields: An array of arrays that hold fields like would be passed to the
900 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
901 &$changesList: ChangesList instance.
902 &$articlelink: HTML of link to article (already filled-in).
903 &$s: HTML of row that is being constructed.
904 &$rc: RecentChange instance.
905 $unpatrolled: Whether or not we are showing unpatrolled changes.
906 $watched: Whether or not the change is watched by the user.
908 'ChangesListInitRows': Batch process change list rows prior to rendering.
909 $changesList: ChangesList instance
910 $rows: The data that will be rendered. May be a ResultWrapper instance or
913 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
914 $special: ChangesListSpecialPage instance
915 &$filters: associative array of filter definitions. The keys are the HTML
916 name/URL parameters. Each key maps to an associative array with a 'msg'
917 (message key) and a 'default' value.
919 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
920 $name: name of the special page, e.g. 'Watchlist'
921 &$tables: array of tables to be queried
922 &$fields: array of columns to select
923 &$conds: array of WHERE conditionals for query
924 &$query_options: array of options for the database request
925 &$join_conds: join conditions for the tables
926 $opts: FormOptions for this request
928 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is,
929 removed from all revisions and log entries to which it was applied). This gives
930 extensions a chance to take it off their books.
931 $tag: name of the tag
932 &$status: Status object. Add warnings to this as required. There is no point
933 setting errors, as the deletion has already been partly carried out by this
936 'ChangeTagCanCreate': Tell whether a change tag should be able to be created
937 from the UI (Special:Tags) or via the API. You could use this hook if you want
938 to reserve a specific "namespace" of tags, or something similar.
939 $tag: name of the tag
940 $user: user initiating the action
941 &$status: Status object. Add your errors using `$status->fatal()` or warnings
942 using `$status->warning()`. Errors and warnings will be relayed to the user.
943 If you set an error, the user will be unable to create the tag.
945 'ChangeTagCanDelete': Tell whether a change tag should be able to be
946 deleted from the UI (Special:Tags) or via the API. The default is that tags
947 defined using the ListDefinedTags hook are not allowed to be deleted unless
948 specifically allowed. If you wish to allow deletion of the tag, set
949 `$status = Status::newGood()` to allow deletion, and then `return false` from
950 the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry
951 out custom deletion actions.
952 $tag: name of the tag
953 $user: user initiating the action
954 &$status: Status object. See above.
956 'ChangeTagsListActive': Allows you to nominate which of the tags your extension
957 uses are in active use.
958 &$tags: list of all active tags. Append to this array.
960 'LoginUserMigrated': Called during login to allow extensions the opportunity to
961 inform a user that their username doesn't exist for a specific reason, instead
962 of letting the login form give the generic error message that the account does
963 not exist. For example, when the account has been renamed or deleted.
964 $user: the User object being authenticated against.
965 &$msg: the message identifier for abort reason, or an array to pass a message
968 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
969 $collationName: Name of the collation in question
970 &$collationObject: Null. Replace with a subclass of the Collation class that
971 implements the collation given in $collationName.
973 'ConfirmEmailComplete': Called after a user's email has been confirmed
975 $user: user (object) whose email is being confirmed
977 'ContentHandlerDefaultModelFor': Called when the default content model is determined
978 for a given title. May be used to assign a different model for that title.
979 $title: the Title in question
980 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
982 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
983 content model name, but no entry for that model exists in $wgContentHandlers.
984 $modeName: the requested content model name
985 &$handler: set this to a ContentHandler object, if desired.
987 'ContentModelCanBeUsedOn': Called to determine whether that content model can
988 be used on a given page. This is especially useful to prevent some content models
989 to be used in some special location.
990 $contentModel: ID of the content model in question
991 $title: the Title in question.
992 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
993 Handler functions that modify $ok should generally return false to prevent further
994 hooks from further modifying $ok.
996 'ContentGetParserOutput': Customize parser output for a given content object,
997 called by AbstractContent::getParserOutput. May be used to override the normal
998 model-specific rendering of page content.
999 $content: The Content to render
1000 $title: Title of the page, as context
1001 $revId: The revision ID, as context
1002 $options: ParserOptions for rendering. To avoid confusing the parser cache,
1003 the output can only depend on parameters provided to this hook function, not on global state.
1004 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
1005 generation of HTML may be skipped, but other information should still be present in the
1006 ParserOutput object.
1007 &$output: ParserOutput, to manipulate or replace
1009 'ContentAlterParserOutput': Modify parser output for a given content object.
1010 Called by Content::getParserOutput after parsing has finished. Can be used
1011 for changes that depend on the result of the parsing but have to be done
1012 before LinksUpdate is called (such as adding tracking categories based on
1014 $content: The Content to render
1015 $title: Title of the page, as context
1016 $parserOutput: ParserOutput to manipulate
1018 'ConvertContent': Called by AbstractContent::convert when a conversion to another
1019 content model is requested.
1020 $content: The Content object to be converted.
1021 $toModel: The ID of the content model to convert to.
1022 $lossy: boolean indicating whether lossy conversion is allowed.
1023 &$result: Output parameter, in case the handler function wants to provide a
1024 converted Content object. Note that $result->getContentModel() must return $toModel.
1025 Handler functions that modify $result should generally return false to further
1026 attempts at conversion.
1028 'ContribsPager::getQueryInfo': Before the contributions query is about to run
1029 &$pager: Pager object for contributions
1030 &$queryInfo: The query for the contribs Pager
1032 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
1033 &$data: an array of results of all contribs queries
1034 $pager: The ContribsPager object hooked into
1035 $offset: Index offset, inclusive
1036 $limit: Exact query limit
1037 $descending: Query direction, false for ascending, true for descending
1039 'ContributionsLineEnding': Called before a contributions HTML line is finished
1040 $page: SpecialPage object for contributions
1041 &$ret: the HTML line
1042 $row: the DB row for this line
1043 &$classes: the classes to add to the surrounding <li>
1045 'ContributionsToolLinks': Change tool links above Special:Contributions
1046 $id: User identifier
1047 $title: User page title
1048 &$tools: Array of tool links
1050 'CustomEditor': When invoking the page editor
1051 $article: Article being edited
1052 $user: User performing the edit
1054 Return true to allow the normal editor to be used, or false
1055 if implementing a custom editor, e.g. for a special namespace,
1058 'DatabaseOraclePostInit': Called after initialising an Oracle database
1059 &$db: the DatabaseOracle object
1061 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
1062 $title: the diff page title (nullable)
1063 &$oldId: the actual old Id to use in the diff
1064 &$newId: the actual new Id to use in the diff (0 means current)
1065 $old: the ?old= param value from the url
1066 $new: the ?new= param value from the url
1068 'GetDifferenceEngine': Called when getting a new difference engine interface object
1069 Return false for valid object in $differenceEngine or true for the default difference engine
1070 $context: IContextSource context to be used for diff
1071 $old: Revision ID to show and diff with
1072 $new: Either a revision ID or one of the strings 'cur', 'prev' or 'next'
1073 $refreshCache: If set, refreshes the diff cache
1074 $unhide: If set, allow viewing deleted revs
1075 &$differenceEngine: output parameter, difference engine object to be used for diff
1077 'DiffRevisionTools': Override or extend the revision tools available from the
1078 diff view, i.e. undo, etc.
1079 $newRev: Revision object of the "new" revision
1080 &$links: Array of HTML links
1081 $oldRev: Revision object of the "old" revision (may be null)
1083 'DiffViewHeader': Called before diff display
1084 $diff: DifferenceEngine object that's calling
1085 $oldRev: Revision object of the "old" revision (may be null/invalid)
1086 $newRev: Revision object of the "new" revision
1088 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1090 $article: article (object) being viewed
1091 $oldid: oldid (int) being viewed
1093 'DoEditSectionLink': Override the HTML generated for section edit links
1094 * Deprecated in favour of SkinEditSectionLinks hook *
1095 $skin: Skin object rendering the UI
1096 $title: Title object for the title being linked to (may not be the same as
1097 the page title, if the section is included from a template)
1098 $section: The designation of the section being pointed to, to be included in
1099 the link, like "§ion=$section"
1100 $tooltip: The default tooltip. Escape before using.
1101 By default, this is wrapped in the 'editsectionhint' message.
1102 &$result: The HTML to return, prefilled with the default plus whatever other
1103 changes earlier hooks have made
1104 $lang: The language code to use for the link in the wfMessage function
1106 'EditFilter': Perform checks on an edit
1107 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1108 $text: Contents of the edit box
1109 $section: Section being edited
1110 &$error: Error message to return
1111 $summary: Edit summary for page
1113 'EditFilterMerged': Post-section-merge edit filter.
1114 DEPRECATED, use EditFilterMergedContent instead.
1115 $editor: EditPage instance (object)
1116 $text: content of the edit box
1117 &$error: error message to return
1118 $summary: Edit summary for page
1120 'EditFilterMergedContent': Post-section-merge edit filter.
1121 This may be triggered by the EditPage or any other facility that modifies page content.
1122 Use the $status object to indicate whether the edit should be allowed, and to provide
1123 a reason for disallowing it. Return false to abort the edit, and true to continue.
1124 Returning true if $status->isOK() returns false means "don't save but continue user
1125 interaction", e.g. show the edit form. $status->apiHookResult can be set to an array
1126 to be returned by api.php action=edit. This is used to deliver captchas.
1127 $context: object implementing the IContextSource interface.
1128 $content: content of the edit box, as a Content object.
1129 $status: Status object to represent errors, etc.
1130 $summary: Edit summary for page
1131 $user: the User object representing the user whois performing the edit.
1132 $minoredit: whether the edit was marked as minor by the user.
1134 'EditFormPreloadText': Allows population of the edit form when creating
1136 &$text: Text to preload with
1137 &$title: Title object representing the page being created
1139 'EditFormInitialText': Allows modifying the edit form when editing existing
1141 $editPage: EditPage object
1143 'EditPage::attemptSave': Called before an article is
1144 saved, that is before WikiPage::doEditContent() is called
1145 $editpage_Obj: the current EditPage object
1147 'EditPage::importFormData': allow extensions to read additional data
1149 $editpage: EditPage instance
1150 $request: Webrequest
1151 return value is ignored (should always return true)
1153 'EditPage::showEditForm:fields': allows injection of form field into edit form
1154 $editor: the EditPage instance for reference
1155 $out: an OutputPage instance to write to
1156 return value is ignored (should always return true)
1158 'EditPage::showEditForm:initial': before showing the edit form
1159 $editor: EditPage instance (object)
1160 $out: an OutputPage instance to write to
1162 Return false to halt editing; you'll need to handle error messages, etc.
1163 yourself. Alternatively, modifying $error and returning true will cause the
1164 contents of $error to be echoed at the top of the edit form as wikitext.
1165 Return true without altering $error to allow the edit to proceed.
1167 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1168 but for the read-only 'view source' variant of the edit form.
1169 $editor: EditPage instance (object)
1170 &$out: an OutputPage instance to write to
1171 return value is ignored (should always return true)
1173 'EditPage::showStandardInputs:options': allows injection of form fields into
1174 the editOptions area
1175 $editor: EditPage instance (object)
1176 $out: an OutputPage instance to write to
1177 &$tabindex: HTML tabindex of the last edit check/button
1178 return value is ignored (should always be true)
1180 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1181 when there's an edit conflict. Return false to halt normal diff output; in
1182 this case you're responsible for computing and outputting the entire "conflict"
1183 part, i.e., the "difference between revisions" and "your text" headers and
1185 &$editor: EditPage instance
1186 &$out: OutputPage instance
1188 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1189 textarea in the edit form.
1190 &$editpage: The current EditPage object
1191 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1192 &$tabindex: HTML tabindex of the last edit check/button
1194 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1196 &$editpage: The current EditPage object
1197 &$checks: Array of edit checks like "watch this page"/"minor edit"
1198 &$tabindex: HTML tabindex of the last edit check/button
1200 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1201 textarea in the edit form.
1202 &$toolbar: The toolbar HTMl
1204 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1205 contribution/copyright notice.
1206 $title: title of page being edited
1207 &$msg: localization message name, overridable. Default is either
1208 'copyrightwarning' or 'copyrightwarning2'.
1210 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1211 modifying the wikitext that will be used in "Show changes". Note that it is
1212 preferable to implement diff handling for different data types using the
1213 ContentHandler facility.
1214 $editPage: EditPage object
1215 &$newtext: wikitext that will be used as "your version"
1217 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1218 "Show changes". Note that it is preferable to implement diff handling for
1219 different data types using the ContentHandler facility.
1220 $editPage: EditPage object
1221 &$newtext: wikitext that will be used as "your version"
1223 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1224 Allow modifying the wikitext that will be previewed. Note that it is preferable
1225 to implement previews for different data types using the ContentHandler
1227 $editPage: EditPage object
1228 &$toparse: wikitext that will be parsed
1230 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1231 previewed. Note that it is preferable to implement previews for different data
1232 types using the ContentHandler facility.
1233 $editPage: EditPage object
1234 &$content: Content object to be previewed (may be replaced by hook function)
1236 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1237 &$editpage: The current EditPage object
1238 &$res: the HTML of the error text
1240 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1241 of terms of service summary link that might exist separately from the copyright
1243 $title: title of page being edited
1244 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1246 'EmailConfirmed': When checking that the user's email address is "confirmed".
1247 $user: User being checked
1248 $confirmed: Whether or not the email address is confirmed
1249 This runs before the other checks, such as anonymity and the real check; return
1250 true to allow those checks to occur, and false if checking is done.
1252 'EmailUser': Before sending email from one user to another.
1253 $to: address of receiving user
1254 $from: address of sending user
1255 $subject: subject of the mail
1256 $text: text of the mail
1258 'EmailUserCC': Before sending the copy of the email to the author.
1259 $to: address of receiving user
1260 $from: address of sending user
1261 $subject: subject of the mail
1262 $text: text of the mail
1264 'EmailUserComplete': After sending email from one user to another.
1265 $to: address of receiving user
1266 $from: address of sending user
1267 $subject: subject of the mail
1268 $text: text of the mail
1270 'EmailUserForm': After building the email user form object.
1271 $form: HTMLForm object
1273 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1275 $user: The user who is trying to email another user.
1276 $editToken: The user's edit token.
1277 &$hookErr: Out-param for the error. Passed as the parameters to
1278 OutputPage::showErrorPage.
1280 'EnhancedChangesList::getLogText': to alter, remove or add to the links of a
1281 group of changes in EnhancedChangesList.
1282 $changesList: EnhancedChangesList object
1283 &$links: The links that were generated by EnhancedChangesList
1284 $block: The RecentChanges objects in that block
1286 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1288 $ip: The ip address of the user
1290 'ExtensionTypes': Called when generating the extensions credits, use this to
1291 change the tables headers.
1292 &$extTypes: associative array of extensions types
1294 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1295 thumbnail file name.
1296 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1297 $thumbname: the base name of the thumbnail file
1298 &$params: the currently extracted params (has source name, temp or archived zone)
1300 'FetchChangesList': When fetching the ChangesList derivative for a particular
1302 $user: User the list is being fetched for
1303 &$skin: Skin object to be used with the list
1304 &$list: List object (defaults to NULL, change it to an object instance and
1305 return false override the list derivative used)
1307 'FileDeleteComplete': When a file is deleted.
1308 $file: reference to the deleted file
1309 $oldimage: in case of the deletion of an old image, the name of the old file
1310 $article: in case all revisions of the file are deleted a reference to the
1311 WikiFilePage associated with the file.
1312 $user: user who performed the deletion
1315 'FileTransformed': When a file is transformed and moved into storage.
1316 $file: reference to the File object
1317 $thumb: the MediaTransformOutput object
1318 $tmpThumbPath: The temporary file system path of the transformed file
1319 $thumbPath: The permanent storage path of the transformed file
1321 'FileUpload': When a file upload occurs.
1322 $file : Image object representing the file that was uploaded
1323 $reupload : Boolean indicating if there was a previously another image there or
1325 $hasDescription : Boolean indicating that there was already a description page
1326 and a new one from the comment wasn't created (since 1.17)
1328 'FileUndeleteComplete': When a file is undeleted
1329 $title: title object to the file
1330 $fileVersions: array of undeleted versions. Empty if all versions were restored
1331 $user: user who performed the undeletion
1334 'FormatAutocomments': When an autocomment is formatted by the Linker.
1335 &$comment: Reference to the accumulated comment. Initially null, when set the
1336 default code will be skipped.
1337 $pre: Boolean, true if there is text before this autocomment
1338 $auto: The extracted part of the parsed comment before the call to the hook.
1339 $post: Boolean, true if there is text after this autocomment
1340 $title: An optional title object used to links to sections. Can be null.
1341 $local: Boolean indicating whether section links should refer to local page.
1343 'GalleryGetModes': Get list of classes that can render different modes of a
1345 &$modeArray: An associative array mapping mode names to classes that implement
1346 that mode. It is expected all registered classes are a subclass of
1349 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1351 &$user: user to promote.
1352 &$promote: groups that will be added.
1354 'GetBlockedStatus': after loading blocking status of an user from the database
1355 $user: user (object) being checked
1357 'GetCacheVaryCookies': Get cookies that should vary cache options.
1358 $out: OutputPage object
1359 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1360 that have to vary cache options
1362 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1364 $title: Title object of page
1365 $url: string value as output (out parameter, can modify)
1366 $query: query options passed to Title::getCanonicalURL()
1368 'GetDefaultSortkey': Override the default sortkey for a page.
1369 $title: Title object that we need to get a sortkey for
1370 &$sortkey: Sortkey to use.
1372 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1373 underscore) magic words. Called by MagicWord.
1374 &$doubleUnderscoreIDs: array of strings
1376 'GetExtendedMetadata': Get extended file metadata for the API
1377 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1378 'value' => prop value, 'source' => 'name of hook' ).
1379 $file: File object of file in question
1380 $context: RequestContext (including language to use)
1381 $single: Only extract the current language; if false, the prop value should
1382 be in the metadata multi-language array format:
1383 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1384 &$maxCacheTime: how long the results can be cached
1386 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1387 $title: Title object of page
1388 $url: string value as output (out parameter, can modify)
1389 $query: query options passed to Title::getFullURL()
1391 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1392 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1394 &$output: string for the output timestamp
1395 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1396 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1397 $user: User whose preferences are being used to make timestamp
1398 $lang: Language that will be used to render the timestamp
1400 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1401 $title: Title object of page
1402 $url: string value as output (out parameter, can modify)
1403 $query: query options passed to Title::getInternalURL()
1405 'GetIP': modify the ip of the current user (called only once).
1406 &$ip: string holding the ip as determined so far
1408 'GetLinkColours': modify the CSS class of an array of page links.
1409 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1411 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1413 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1414 working with internal urls (non-interwiki) then it may be preferable to work
1415 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1416 be buggy for internal urls on render if you do not re-implement the horrible
1417 hack that Title::getLocalURL uses in your own extension.
1418 $title: Title object of page
1419 &$url: string value as output (out parameter, can modify)
1420 $query: query options passed to Title::getLocalURL()
1422 'GetLocalURL::Internal': Modify local URLs to internal pages.
1423 $title: Title object of page
1424 &$url: string value as output (out parameter, can modify)
1425 $query: query options passed to Title::getLocalURL()
1427 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1428 without any fancy queries or variants.
1429 $title: Title object of page
1430 &$url: string value as output (out parameter, can modify)
1432 'GetLogTypesOnUser': Add log types where the target is a userpage
1433 &$types: Array of log types
1435 'GetMetadataVersion': Modify the image metadata version currently in use. This
1436 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1437 that need to have versioned metadata should add an element to the end of the
1438 version array of the form 'handler_name=version'. Most media handlers won't need
1439 to do this unless they broke backwards compatibility with a previous version of
1440 the media handler metadata output.
1441 &$version: Array of version strings
1443 'GetNewMessagesAlert': Disable or modify the new messages alert
1444 &$newMessagesAlert: An empty string by default. If the user has new talk page
1445 messages, this should be populated with an alert message to that effect
1446 $newtalks: An empty array if the user has no new messages or an array containing
1447 links and revisions if there are new messages (See User::getNewMessageLinks)
1448 $user: The user object of the user who is loading the page
1449 $out: OutputPage object (to check what type of page the user is on)
1451 'GetPreferences': Modify user preferences.
1452 $user: User whose preferences are being modified.
1453 &$preferences: Preferences description array, to be fed to an HTMLForm object
1455 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1456 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1458 &$output: string for the output timestamp
1459 &$diff: DateInterval representing the difference between the timestamps
1460 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1461 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1462 $user: User whose preferences are being used to make timestamp
1463 $lang: Language that will be used to render the timestamp
1465 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1466 checked for. Use instead of userCan for most cases. Return false if the user
1467 can't do it, and populate $result with the reason in the form of
1468 array( messagename, param1, param2, ... ). For consistency, error messages
1469 should be plain text with no special coloring, bolding, etc. to show that
1470 they're errors; presenting them properly to the user as errors is done by the
1472 $title: Title object being checked against
1473 $user : Current user object
1474 $action: Action being checked
1475 $result: User permissions error to add. If none, return true.
1477 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1478 called only if expensive checks are enabled. Add a permissions error when
1479 permissions errors are checked for. Return false if the user can't do it, and
1480 populate $result with the reason in the form of array( messagename, param1,
1481 param2, ... ). For consistency, error messages should be plain text with no
1482 special coloring, bolding, etc. to show that they're errors; presenting them
1483 properly to the user as errors is done by the caller.
1485 $title: Title object being checked against
1486 $user : Current user object
1487 $action: Action being checked
1488 $result: User permissions error to add. If none, return true.
1490 'GitViewers': Called when generating the list of git viewers for
1491 Special:Version, use this to change the list.
1492 &$extTypes: associative array of repo URLS to viewer URLs.
1494 'HistoryRevisionTools': Override or extend the revision tools available from the
1495 page history view, i.e. undo, rollback, etc.
1496 $rev: Revision object
1497 &$links: Array of HTML links
1499 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1501 $context: An IContextSource object with information about the request being served.
1503 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1504 image insertion. You can skip the default logic entirely by returning false, or
1505 just modify a few things using call-by-reference.
1507 &$title: Title object of the image
1508 &$file: File object, or false if it doesn't exist
1509 &$frameParams: Various parameters with special meanings; see documentation in
1510 includes/Linker.php for Linker::makeImageLink
1511 &$handlerParams: Various parameters with special meanings; see documentation in
1512 includes/Linker.php for Linker::makeImageLink
1513 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1514 &$res: Final HTML output, used if you return false
1517 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1518 the image on an image page.
1519 $imagePage: ImagePage object ($this)
1522 'ImagePageAfterImageLinks': Called after the image links section on an image
1524 $imagePage: ImagePage object ($this)
1525 &$html: HTML for the hook to add
1527 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1529 $line: the HTML of the history line
1530 $css: the line CSS class
1532 'ImagePageFindFile': Called when fetching the file associated with an image
1534 $page: ImagePage object
1536 &$displayFile: displayed File object
1538 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1539 $page: ImagePage object
1540 &$toc: Array of <li> strings
1542 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1544 &$title: the Title object of the file as it would appear for the upload page
1545 &$path: the original file and path name when img_auth was invoked by the web
1547 &$name: the name only component of the file
1548 &$result: The location to pass back results of the hook routine (only used if
1550 $result[0]=The index of the header message
1551 $result[1]=The index of the body text message
1552 $result[2 through n]=Parameters passed to body text message. Please note the
1553 header message cannot receive/use parameters.
1555 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1556 $reader: XMLReader object
1557 $logInfo: Array of information
1558 Return false to stop further processing of the tag
1560 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1561 $reader: XMLReader object
1562 $pageInfo: Array of information
1563 Return false to stop further processing of the tag
1565 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1566 $reader: XMLReader object
1567 $pageInfo: Array of page information
1568 $revisionInfo: Array of revision information
1569 Return false to stop further processing of the tag
1571 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1572 $reader: XMLReader object
1573 Return false to stop further processing of the tag
1575 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1576 $reader: XMLReader object
1577 $revisionInfo: Array of information
1578 Return false to stop further processing of the tag
1580 'InfoAction': When building information to display on the action=info page.
1581 $context: IContextSource object
1582 &$pageInfo: Array of information
1584 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1585 $title: Title object for the current page
1586 $request: WebRequest
1587 $ignoreRedirect: boolean to skip redirect check
1588 $target: Title/string of redirect target
1589 $article: Article object
1591 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1592 Return true without providing an interwiki to continue interwiki search.
1593 $prefix: interwiki prefix we are looking for.
1594 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1595 iw_trans and optionally iw_api and iw_wikiid.
1597 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1598 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1599 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1600 template/parser function execution which respect nowiki and HTML-comments.
1601 &$parser: Parser object
1602 &$text: string containing partially parsed text
1603 &$stripState: Parser's internal StripState object
1605 'InternalParseBeforeLinks': during Parser's internalParse method before links
1606 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1607 &$parser: Parser object
1608 &$text: string containing partially parsed text
1609 &$stripState: Parser's internal StripState object
1611 'InvalidateEmailComplete': Called after a user's email has been invalidated
1613 $user: user (object) whose email is being invalidated
1615 'IRCLineURL': When constructing the URL to use in an IRC notification.
1616 Callee may modify $url and $query, URL will be constructed as $url . $query
1617 &$url: URL to index.php
1618 &$query: Query string
1619 $rc: RecentChange object that triggered url generation
1621 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1622 $article: article (object) being checked
1624 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1626 $result: Change this value to override the result of wfIsTrustedProxy()
1628 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1629 $url: URL used to upload from
1630 &$allowed: Boolean indicating if uploading is allowed for given URL
1632 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1633 instance to return false if the domain name doesn't match your organization.
1634 $addr: The e-mail address entered by the user
1635 &$result: Set this and return false to override the internal checks
1637 'isValidPassword': Override the result of User::isValidPassword()
1638 $password: The password entered by the user
1639 &$result: Set this and return false to override the internal checks
1640 $user: User the password is being validated for
1642 'Language::getMessagesFileName':
1643 $code: The language code or the language we're looking for a messages file for
1644 &$file: The messages file path, you can override this to change the location.
1646 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1647 remove namespaces. Do not use this hook to add namespaces. Use
1648 CanonicalNamespaces for that.
1649 &$namespaces: Array of namespaces indexed by their numbers
1651 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1652 $wgExtensionMessagesFiles instead.
1653 Use this to define synonyms of magic words depending of the language
1654 $magicExtensions: associative array of magic words synonyms
1655 $lang: language code (string)
1657 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1658 listed in $wgExtensionMessagesFiles instead.
1659 Use to define aliases of special pages names depending of the language
1660 $specialPageAliases: associative array of magic words synonyms
1661 $lang: language code (string)
1663 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1664 &$names: array of language code => language name
1665 $code language of the preferred translations
1667 'LanguageLinks': Manipulate a page's language links. This is called
1668 in various places to allow extensions to define the effective language
1670 $title: The page's Title.
1671 &$links: Associative array mapping language codes to prefixed links of the
1672 form "language:title".
1673 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1674 Currently unused, but planned to provide support for marking individual
1675 language links in the UI, e.g. for featured articles.
1677 'LanguageSelector': Hook to change the language selector available on a page.
1678 $out: The output page.
1679 $cssClassName: CSS class name of the language selector.
1681 'LinkBegin': Used when generating internal and interwiki links in
1682 Linker::link(), before processing starts. Return false to skip default
1683 processing and return $ret. See documentation for Linker::link() for details on
1684 the expected meanings of parameters.
1685 $skin: the Skin object
1686 $target: the Title that the link is pointing to
1687 &$html: the contents that the <a> tag should have (raw HTML); null means
1689 &$customAttribs: the HTML attributes that the <a> tag should have, in
1690 associative array form, with keys and values unescaped. Should be merged with
1691 default values, with a value of false meaning to suppress the attribute.
1692 &$query: the query string to add to the generated URL (the bit after the "?"),
1693 in associative array form, with keys and values unescaped.
1694 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1695 &$ret: the value to return if your hook returns false.
1697 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1698 just before the function returns a value. If you return true, an <a> element
1699 with HTML attributes $attribs and contents $html will be returned. If you
1700 return false, $ret will be returned.
1701 $skin: the Skin object
1702 $target: the Title object that the link is pointing to
1703 $options: the options. Will always include either 'known' or 'broken', and may
1704 include 'noclasses'.
1705 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1706 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1707 associative array form.
1708 &$ret: the value to return if your hook returns false.
1710 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1712 &$url: the image url
1713 &$alt: the image's alt text
1714 &$img: the new image HTML (if returning false)
1716 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1719 &$text: the link text
1720 &$link: the new link HTML (if returning false)
1721 &$attribs: the attributes to be applied.
1722 $linkType: The external link type
1724 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1726 $title: the Title object that the link is pointing to
1727 $file: the File object or false if broken link
1728 &$html: the link text
1729 &$attribs: the attributes to be applied
1730 &$ret: the value to return if your hook returns false
1732 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1734 &$linksUpdate: the LinksUpdate object
1736 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1737 each link table insert. For example, pagelinks, imagelinks, externallinks.
1738 $linksUpdate: LinksUpdate object
1739 $table: the table to insert links to
1740 $insertions: an array of links to insert
1742 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1743 including delete and insert, has completed for all link tables
1744 &$linksUpdate: the LinksUpdate object
1746 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1747 &$linksUpdate: the LinksUpdate object
1749 'ListDefinedTags': When trying to find all defined tags.
1750 &$tags: The list of tags.
1752 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1753 &updater: A DatabaseUpdater subclass
1755 'LocalFile::getHistory': Called before file history query performed.
1756 $file: the File object
1758 $fields: select fields
1760 $opts: query options
1761 $join_conds: JOIN conditions
1763 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1764 $file: the File object
1765 $archiveName: name of an old file version or false if it's the current one
1767 'LocalisationCacheRecache': Called when loading the localisation data into
1769 $cache: The LocalisationCache object
1770 $code: language code
1771 &$alldata: The localisation data from core and extensions
1772 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1774 'LocalisationCacheRecacheFallback': Called for each language when merging
1775 fallback data into the cache.
1776 $cache: The LocalisationCache object
1777 $code: language code
1778 &$alldata: The localisation data from core and extensions. Note some keys may
1779 be omitted if they won't be merged into the final result.
1781 'LocalisationChecksBlacklist': When fetching the blacklist of
1782 localisation checks.
1783 &$blacklist: array of checks to blacklist. See the bottom of
1784 maintenance/language/checkLanguage.inc for the format of this variable.
1786 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1787 optional localisation messages
1788 &$ignored Array of ignored message keys
1789 &$optional Array of optional message keys
1791 'LogEventsListGetExtraInputs': When getting extra inputs to display on Special:Log
1792 for a specific log type
1793 $type: String of log type being displayed
1794 $logEventsList: LogEventsList object for context and access to the WebRequest
1795 &$input: string HTML of an input element
1798 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1799 Returning false will prevent the string from being added to the OutputPage.
1800 &$s: html string to show for the log extract
1801 $types: String or Array Log types to show
1802 $page: String or Title The page title to show log entries for
1803 $user: String The user who made the log entries
1804 $param: Associative Array with the following additional options:
1805 - lim Integer Limit of items to show, default is 50
1806 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1807 - showIfEmpty boolean Set to false if you don't want any output in case the
1808 loglist is empty if set to true (default), "No matching items in log" is
1809 displayed if loglist is empty
1810 - msgKey Array If you want a nice box with a message, set this to the key of
1811 the message. First element is the message key, additional optional elements
1812 are parameters for the key that are processed with
1813 wfMessage()->params()->parseAsBlock()
1814 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1816 - wrap String Wrap the message in html (usually something like
1817 "<div ...>$1</div>").
1818 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1820 'LoginAuthenticateAudit': A login attempt for a valid user account either
1821 succeeded or failed. No return data is accepted; this hook is for auditing only.
1822 $user: the User object being authenticated against
1823 $password: the password being submitted and found wanting
1824 $retval: a LoginForm class constant with authenticateUserData() return
1825 value (SUCCESS, WRONG_PASS, etc.).
1827 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1828 Use this hook to change the Message that will be output on Special:ChangePassword.
1829 &$msg: Message object that will be shown to the user
1830 $username: Username of the user who's password was expired.
1832 'LogLine': Processes a single log entry on Special:Log.
1833 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1834 logging.log_type database field.
1835 $log_action: string for the type of log action (e.g. 'delete', 'block',
1836 'create2'). Corresponds to logging.log_action database field.
1837 $title: Title object that corresponds to logging.log_namespace and
1838 logging.log_title database fields.
1839 $paramArray: Array of parameters that corresponds to logging.log_params field.
1840 Note that only $paramArray[0] appears to contain anything.
1841 &$comment: string that corresponds to logging.log_comment database field, and
1842 which is displayed in the UI.
1843 &$revert: string that is displayed in the UI, similar to $comment.
1844 $time: timestamp of the log entry (added in 1.12)
1846 'LonelyPagesQuery': Allow extensions to modify the query used by
1847 Special:LonelyPages.
1848 &$tables: tables to join in the query
1849 &$conds: conditions for the query
1850 &$joinConds: join conditions for the query
1852 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1854 $refreshLinks: RefreshLinks object
1856 'MagicWordwgVariableIDs': When defining new magic words IDs.
1857 $variableIDs: array of strings
1859 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1860 Ideally, this hook should only be used to add variables that depend on
1861 the current page/request; static configuration should be added through
1862 ResourceLoaderGetConfigVars instead.
1863 &$vars: variable (or multiple variables) to be added into the output of
1864 Skin::makeVariablesScript
1865 $out: The OutputPage which called the hook, can be used to get the real title.
1867 'MarkPatrolled': Before an edit is marked patrolled.
1868 $rcid: ID of the revision to be marked patrolled
1869 $user: the user (object) marking the revision as patrolled
1870 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1871 sysop in order to mark an edit patrolled.
1873 'MarkPatrolledComplete': After an edit is marked patrolled.
1874 $rcid: ID of the revision marked as patrolled
1875 $user: user (object) who marked the edit patrolled
1876 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1877 sysop to patrol the edit.
1879 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1880 something completely different, after the basic globals have been set up, but
1881 before ordinary actions take place.
1883 $article: Article on which the action will be performed
1884 $title: Title on which the action will be performed
1886 $request: $wgRequest
1887 $mediaWiki: The $mediawiki object
1889 'MessagesPreLoad': When loading a message from the database.
1890 $title: title of the message (string)
1891 $message: value (string), change it to the message you want to define
1893 'MessageCache::get': When fetching a message. Can be used to override the key
1894 for customisations. Given and returned message key must be in special format:
1895 1) first letter must be in lower case according to the content language.
1896 2) spaces must be replaced with underscores
1897 &$key: message key (string)
1899 'MessageCacheReplace': When a message page is changed. Useful for updating
1901 $title: name of the page changed.
1902 $text: new contents of the page.
1904 'MimeMagicInit': Before processing the list mapping MIME types to media types
1905 and the list mapping MIME types to file extensions.
1906 As an extension author, you are encouraged to submit patches to MediaWiki's
1907 core to add new MIME types to mime.types.
1908 $mimeMagic: Instance of MimeMagic.
1909 Use $mimeMagic->addExtraInfo( $stringOfInfo );
1910 for adding new MIME info to the list.
1911 Use $mimeMagic->addExtraTypes( $stringOfTypes );
1912 for adding new MIME types to the list.
1914 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1915 MIME type detected by considering the file extension.
1916 $mimeMagic: Instance of MimeMagic.
1917 $ext: File extension.
1918 &$mime: MIME type (in/out).
1920 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1921 $mimeMagic: Instance of MimeMagic.
1922 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1923 &$tail: More or equal than last 65558 bytes of the file in a string
1924 (in - Do not alter!).
1926 &$mime: MIME type (out).
1928 'ModifyExportQuery': Modify the query used by the exporter.
1929 $db: The database object to be queried.
1930 &$tables: Tables in the query.
1931 &$conds: Conditions in the query.
1932 &$opts: Options for the query.
1933 &$join_conds: Join conditions for the query.
1935 'MovePageCheckPermissions': Specify whether the user is allowed to move the page.
1936 $oldTitle: Title object of the current (old) location
1937 $newTitle: Title object of the new location
1938 $user: User making the move
1939 $reason: string of the reason provided by the user
1940 $status: Status object to pass error messages to
1942 'MovePageIsValidMove': Specify whether a page can be moved for technical reasons.
1943 $oldTitle: Title object of the current (old) location
1944 $newTitle: Title object of the new location
1945 $status: Status object to pass error messages to
1947 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1948 and returning it for the skin to output. You can add items to the toolbox while
1949 still letting the skin make final decisions on skin-specific markup conventions
1951 &$sk: The BaseTemplate base skin template
1952 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1953 BaseTemplate::makeListItem for details on the format of individual items
1954 inside of this array.
1956 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1958 $index: Integer; the index of the namespace being checked.
1959 $result: Boolean; whether MediaWiki currently thinks that pages in this
1960 namespace are movable. Hooks may change this value to override the return
1961 value of MWNamespace::isMovable().
1963 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1965 $wikiPage: the WikiPage edited
1966 $rev: the new revision
1967 $baseID: the revision ID this was based off, if any
1968 $user: the editing user
1970 'NormalizeMessageKey': Called before the software gets the text of a message
1971 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1973 &$key: the message being looked up. Change this to something else to change
1974 what message gets displayed (string)
1975 &$useDB: whether or not to look up the message in the database (bool)
1976 &$langCode: the language code to get the message for (string) - or -
1977 whether to use the content language (true) or site language (false) (bool)
1978 &$transform: whether or not to expand variables and templates
1979 in the message (bool)
1981 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1982 return false to omit the line from RecentChanges and Watchlist special pages.
1983 &$changeslist: The OldChangesList instance.
1984 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1985 &$rc: The RecentChange object.
1986 &$classes: array of css classes for the <li> element
1988 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1989 can alter or append to the array of URLs for search & suggestion formats.
1990 &$urls: array of associative arrays with Url element attributes
1992 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1993 users and/or IP addresses too.
1994 $otherBlockLink: An array with links to other block logs
1995 $ip: The requested IP address or username
1997 'OutputPageBeforeHTML': A page has been processed by the parser and the
1998 resulting HTML is about to be displayed.
1999 $parserOutput: the parserOutput (object) that corresponds to the page
2000 $text: the text that will be displayed, in HTML (string)
2002 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2003 body tag to allow for extensions to add attributes to the body of the page they
2004 might need. Or to allow building extensions to add body classes that aren't of
2005 high enough demand to be included in core.
2006 $out: The OutputPage which called the hook, can be used to get the real title
2007 $sk: The Skin that called OutputPage::headElement
2008 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2010 'OutputPageCheckLastModified': when checking if the page has been modified
2011 since the last visit.
2012 &$modifiedTimes: array of timestamps.
2013 The following keys are set: page, user, epoch
2015 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2016 $out: OutputPage instance (object)
2017 $parserOutput: parserOutput instance being added in $out
2019 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2020 categories. Implementations should return false if they generate the category
2021 links, so the default link generation is skipped.
2022 $out: OutputPage instance (object)
2023 $categories: associative array, keys are category names, values are category
2024 types ("normal" or "hidden")
2025 $links: array, intended to hold the result. Must be an associative array with
2026 category types as keys and arrays of HTML links as values.
2028 'PageContentInsertComplete': After a new article is created.
2029 $wikiPage: WikiPage created
2030 $user: User creating the article
2031 $content: New content as a Content object
2032 $summary: Edit summary/comment
2033 $isMinor: Whether or not the edit was marked as minor
2034 $isWatch: (No longer used)
2035 $section: (No longer used)
2036 $flags: Flags passed to WikiPage::doEditContent()
2037 $revision: New Revision of the article
2039 'PageContentLanguage': Allows changing the language in which the content of a
2040 page is written. Defaults to the wiki content language ($wgContLang).
2041 $title: Title object
2042 &$pageLang: the page content language (either an object or a language code)
2043 $wgLang: the user language
2045 'PageContentSave': Before an article is saved.
2046 $wikiPage: the WikiPage (object) being saved
2047 $user: the user (object) saving the article
2048 $content: the new article content, as a Content object
2049 $summary: the article summary (comment)
2050 $isminor: minor flag
2051 $iswatch: watch flag
2054 'PageContentSaveComplete': After an article has been updated.
2055 $wikiPage: WikiPage modified
2056 $user: User performing the modification
2057 $content: New content, as a Content object
2058 $summary: Edit summary/comment
2059 $isMinor: Whether or not the edit was marked as minor
2060 $isWatch: (No longer used)
2061 $section: (No longer used)
2062 $flags: Flags passed to WikiPage::doEditContent()
2063 $revision: New Revision of the article (can be null for edits that change nothing)
2064 $status: Status object about to be returned by doEditContent()
2065 $baseRevId: the rev ID (or false) this edit was based on
2067 'PageHistoryBeforeList': When a history page list is about to be constructed.
2068 $article: the article that the history is loading for
2069 $context: RequestContext object
2071 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2072 $row: the revision row for this line
2073 $s: the string representing this parsed line
2074 $classes: array containing the <li> element classes
2076 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2079 $queryInfo: the query parameters
2081 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2082 which depends on user options should install this hook and append its values to
2084 &$confstr: reference to a hash key string which can be modified
2085 $user: User (object) requesting the page
2087 'ParserAfterParse': Called from Parser::parse() just after the call to
2088 Parser::internalParse() returns.
2089 $parser: parser object
2090 $text: text being parsed
2091 $stripState: stripState used (object)
2093 'ParserAfterStrip': Called at end of parsing time.
2094 TODO: No more strip, deprecated ?
2095 $parser: parser object
2096 $text: text being parsed
2097 $stripState: stripState used (object)
2099 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2100 $parser: Parser object being used
2101 $text: text that will be returned
2103 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2104 $parser: Parser object
2105 $text: text to parse
2106 $stripState: StripState instance being used
2108 'ParserBeforeStrip': Called at start of parsing time.
2109 TODO: No more strip, deprecated ?
2110 $parser: parser object
2111 $text: text being parsed
2112 $stripState: stripState used (object)
2114 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2115 $parser: Parser object being used
2118 'ParserClearState': Called at the end of Parser::clearState().
2119 $parser: Parser object being cleared
2121 'ParserCloned': Called when the parser is cloned.
2122 $parser: Newly-cloned Parser object
2124 'ParserFirstCallInit': Called when the parser initialises for the first time.
2125 &$parser: Parser object being cleared
2127 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2129 $parser: Parser object
2130 $varCache: array to store the value in case of multiples calls of the
2132 $index: index (string) of the magic
2133 $ret: value of the magic word (the hook should set it)
2134 $frame: PPFrame object to use for expanding any template variables
2136 'ParserGetVariableValueTs': Use this to change the value of the time for the
2137 {{LOCAL...}} magic word.
2138 $parser: Parser object
2139 $time: actual time (timestamp)
2141 'ParserGetVariableValueVarCache': use this to change the value of the variable
2142 cache or return false to not use it.
2143 $parser: Parser object
2144 $varCache: variable cache (array)
2146 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
2147 ParserLimitReportFormat instead.
2148 Called at the end of Parser:parse() when the parser will
2149 include comments about size of the text parsed.
2150 $parser: Parser object
2151 &$limitReport: text that will be included (without comment tags)
2153 'ParserLimitReportFormat': Called for each row in the parser limit report that
2154 needs formatting. If nothing handles this hook, the default is to use "$key" to
2155 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2157 $key: Key for the limit report item (string)
2158 &$value: Value of the limit report item
2159 &$report: String onto which to append the data
2160 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2161 text intended for display in a monospaced font.
2162 $localize: If false, $report should be output in English.
2164 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2165 include comments about size of the text parsed. Hooks should use
2166 $output->setLimitReportData() to populate data. Functions for this hook should
2167 not use $wgLang; do that in ParserLimitReportFormat instead.
2168 $parser: Parser object
2169 $output: ParserOutput object
2171 'ParserMakeImageParams': Called before the parser make an image link, use this
2172 to modify the parameters of the image.
2173 $title: title object representing the file
2174 $file: file object that will be used to create the image
2175 &$params: 2-D array of parameters
2176 $parser: Parser object that called the hook
2178 'ParserSectionCreate': Called each time the parser creates a document section
2179 from wikitext. Use this to apply per-section modifications to HTML (like
2180 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2181 can begin in one section and end in another. Make sure your code can handle
2182 that case gracefully. See the EditSectionClearerLink extension for an example.
2183 $parser: the calling Parser instance
2184 $section: the section number, zero-based, but section 0 is usually empty
2185 &$sectionContent: ref to the content of the section. modify this.
2186 $showEditLinks: boolean describing whether this section has an edit link
2188 'ParserTestParser': Called when creating a new instance of Parser in
2189 tests/parser/parserTest.inc.
2190 $parser: Parser object created
2192 'ParserTestGlobals': Allows to define globals for parser tests.
2193 &$globals: Array with all the globals which should be set for parser tests.
2194 The arrays keys serve as the globals names, its values are the globals values.
2196 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2197 run. Use when page save hooks require the presence of custom tables to ensure
2198 that tests continue to run properly.
2199 &$tables: array of table names
2201 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2202 my talk page, my contributions" etc).
2203 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2204 &$title: Title object representing the current page
2205 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2207 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2208 &$user : User performing the action
2209 $action : Action being performed
2210 &$result : Whether or not the action should be prevented
2211 Change $result and return false to give a definitive answer, otherwise
2212 the built-in rate limiting checks are used, if enabled.
2213 $incrBy: Amount to increment counter by
2215 'PlaceNewSection': Override placement of new sections. Return false and put the
2216 merged text into $text to override the default behavior.
2217 $wikipage : WikiPage object
2218 $oldtext : the text of the article before editing
2219 $subject : subject of the new section
2220 &$text : text of the new section
2222 'PostLoginRedirect': Modify the post login redirect behavior.
2223 Occurs after signing up or logging in, allows for interception of redirect.
2224 &$returnTo: The page name to return to, as a string
2225 &$returnToQuery: array of url parameters, mapping parameter names to values
2226 &$type: type of login redirect as string;
2227 error: display a return to link ignoring $wgRedirectOnLogin
2228 signup: display a return to link using $wgRedirectOnLogin if needed
2229 success: display a return to link using $wgRedirectOnLogin if needed
2230 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2232 'PreferencesGetLegend': Override the text used for the <legend> of a
2233 preferences section.
2234 $form: the PreferencesForm object. This is a ContextSource as well
2235 $key: the section name
2236 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2238 'PreferencesFormPreSave': Override preferences being saved
2239 $formData: array of user submitted data
2240 $form: PreferencesForm object, also a ContextSource
2241 $user: User object with preferences to be saved set
2242 &$result: boolean indicating success
2244 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2245 AJAX search suggestions. Put results into &$results outparam and return false.
2246 $ns : array of int namespace keys to search in
2247 $search : search term (not guaranteed to be conveniently normalized)
2248 $limit : maximum number of results to return
2249 &$results : out param: array of page names (strings)
2250 $offset : number of results to offset from the beginning
2252 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2253 namespace from the search string so that extensions can attempt it.
2254 $namespaces : array of int namespace keys to search in (change this if you can
2256 $search : search term (replace this with term without the namespace if you can
2259 'PrefsEmailAudit': Called when user changes their email address.
2260 $user: User (object) changing his email address
2261 $oldaddr: old email address (string)
2262 $newaddr: new email address (string)
2264 'PrefsPasswordAudit': Called when user changes his password.
2265 $user: User (object) changing his password
2266 $newPass: new password
2267 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2269 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2271 $article: the title being (un)protected
2272 $output: a string of the form HTML so far
2274 'ProtectionForm::save': Called when a protection form is submitted.
2275 $article: the Page being (un)protected
2276 &$errorMsg: an html message string of an error or an array of message name and
2278 $reasonstr: a string describing the reason page protection level is altered
2280 'ProtectionForm::showLogExtract': Called after the protection log extract is
2282 $article: the page the form is shown for
2283 $out: OutputPage object
2285 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2286 &$obj: RawAction object
2287 &$text: The text that's going to be the output
2289 'RecentChange_save': Called at the end of RecentChange::save().
2290 $recentChange: RecentChange object
2292 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2293 names such as "oldid" that are preserved when using redirecting special pages
2294 such as Special:MyPage and Special:MyTalk.
2295 &$redirectParams: An array of parameters preserved by redirecting special pages.
2297 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2298 instance. Can be used by an extension override what skin is used in certain
2300 IContextSource $context: The RequestContext the skin is being created for.
2301 &$skin: A variable reference you may set a Skin instance or string key on to
2302 override the skin that will be used for the context.
2304 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2305 $user: The user having their password expiration reset
2306 &$newExpire: The new expiration date
2308 'ResetSessionID': Called from wfResetSessionID
2309 $oldSessionID: old session id
2310 $newSessionID: new session id
2312 'ResourceLoaderGetConfigVars': Called at the end of
2313 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2314 configuration variables to JavaScript. Things that depend on the current page
2315 or request state must be added through MakeGlobalVariablesScript instead.
2316 &$vars: array( variable name => value )
2318 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after variables
2319 from $wgResourceLoaderLESSVars are added. Can be used to add context-based variables.
2320 &$lessVars: array of variables already added
2322 'ResourceLoaderRegisterModules': Right before modules information is required,
2323 such as when responding to a resource
2324 loader request or generating HTML output.
2325 &$resourceLoader: ResourceLoader object
2327 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2328 called after the addition of 'qunit' and MediaWiki testing resources.
2329 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2330 included in core, is fed using tests/qunit/QUnitTestResources.php.
2331 &ResourceLoader object
2333 To add a new qunit module named 'myext.tests':
2334 testModules['qunit']['myext.tests'] = array(
2335 'script' => 'extension/myext/tests.js',
2336 'dependencies' => <any module dependency you might have>
2338 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2339 added to any module.
2341 'RevisionInsertComplete': Called after a revision is inserted into the database.
2342 &$revision: the Revision
2343 $data: the data stored in old_text. The meaning depends on $flags: if external
2344 is set, it's the URL of the revision text in external storage; otherwise,
2345 it's the revision text itself. In either case, if gzip is set, the revision
2347 $flags: a comma-delimited list of strings representing the options used. May
2348 include: utf8 (this will always be set for new revisions); gzip; external.
2350 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2351 the normal operations.
2352 $allSearchTerms : Array of the search terms in all content languages
2353 &$titleResult : Outparam; the value to return. A Title object or null.
2355 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2356 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2358 $term : Search term string
2359 &$title : Outparam; set to $title object and return false for a match
2361 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2362 if nothing was found.
2363 $term : Search term string
2364 &$title : Outparam; set to $title object and return false for a match
2366 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2368 $term : Search term string
2369 &$title : Current Title object that is being returned (null if none found).
2371 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2373 $title : Current Title object being displayed in search results.
2374 &$id: Revision ID (default is false, for latest)
2376 'SearchableNamespaces': An option to modify which namespaces are searchable.
2377 &$arr : Array of namespaces ($nsId => $name) which will be used.
2379 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2380 perform when page content is modified. Currently called by
2381 AbstractContent::getSecondaryDataUpdates.
2382 $title: Title of the page that is being edited.
2383 $oldContent: Content object representing the page's content before the edit.
2384 $recursive: bool indicating whether DataUpdates should trigger recursive
2385 updates (relevant mostly for LinksUpdate).
2386 $parserOutput: ParserOutput representing the rendered version of the page
2388 &$updates: a list of DataUpdate objects, to be modified or replaced by
2391 'SelfLinkBegin': Called before a link to the current article is displayed to
2392 allow the display of the link to be customized.
2393 $nt: the Title object
2394 &$html: html to display for the link
2395 &$trail: optional text to display before $html
2396 &$prefix: optional text to display after $html
2397 &$ret: the value to return if your hook returns false
2399 'SetupAfterCache': Called in Setup.php, after cache objects are set
2401 'ShowMissingArticle': Called when generating the output for a non-existent page.
2402 $article: The article object corresponding to the page
2404 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2405 DEPRECATED, use the ContentGetParserOutput hook instead!
2406 $text: Text being shown
2407 $title: Title of the custom script/stylesheet page
2408 $output: Current OutputPage object
2410 'ShowSearchHitTitle': Customise display of search hit title/link.
2411 &$title: Title to link to
2412 &$text: Text to use for the link
2413 $result: The search result
2414 $terms: The search terms entered
2415 $page: The SpecialSearch object.
2417 'ShowSearchHit': Customize display of search hit.
2418 $searchPage: The SpecialSearch instance.
2419 $result: The SearchResult to show
2420 $terms: Search terms, for highlighting
2421 &$link: HTML of link to the matching page. May be modified.
2422 &$redirect: HTML of redirect info. May be modified.
2423 &$section: HTML of matching section. May be modified.
2424 &$extract: HTML of content extract. May be modified.
2425 &$score: HTML of score. May be modified.
2426 &$size: HTML of page size. May be modified.
2427 &$date: HTML of of page modification date. May be modified.
2428 &$related: HTML of additional info for the matching page. May be modified.
2429 &$html: May be set to the full HTML that should be used to represent the search
2430 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2431 function returned false.
2433 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2434 allow the normal method of notice selection/rendering to work, or change the
2435 value of $siteNotice and return false to alter it.
2436 &$siteNotice: HTML returned as the sitenotice
2439 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2440 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2441 the sitenotice/anonnotice.
2444 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2446 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2447 the stock bottom scripts.
2449 'SkinAfterContent': Allows extensions to add text after the page content and
2450 article metadata. This hook should work in all skins. Set the &$data variable to
2451 the text you're going to add.
2452 &$data: (string) Text to be printed out directly (without parsing)
2455 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2457 &$bar: Sidebar contents
2458 Modify $bar to add or modify sidebar portlets.
2460 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2462 &$bar: Sidebar content
2463 Modify $bar to add or modify sidebar portlets.
2464 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2466 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2468 $title: displayed page title
2469 $type: 'normal' or 'history' for old/diff views
2470 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2471 message must be in HTML format, not wikitext!
2472 &$link: overridable HTML link to be passed into the message as $1
2473 &$forContent: overridable flag if copyright footer is shown in content language.
2474 This parameter is deprecated.
2476 'SkinEditSectionLinks': Modify the section edit links
2477 $skin: Skin object rendering the UI
2478 $title: Title object for the title being linked to (may not be the same as
2479 the page title, if the section is included from a template)
2480 $section: The designation of the section being pointed to, to be included in
2481 the link, like "§ion=$section"
2482 $tooltip: The default tooltip. Escape before using.
2483 By default, this is wrapped in the 'editsectionhint' message.
2484 &$result: Array containing all link detail arrays. Each link detail array should contain
2486 * targetTitle - Target Title object
2487 * text - String for the text
2488 * attribs - Array of attributes
2489 * query - Array of query parameters to add to the URL
2490 * options - Array of options for Linker::link
2491 $lang: The language code to use for the link in the wfMessage function
2493 'SkinGetPoweredBy': TODO
2494 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2495 the MediaWiki icon but plain text instead.
2498 'SkinPreloadExistence': Supply titles that should be added to link existence
2499 cache before the page is rendered.
2500 &$titles: Array of Title objects
2503 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2504 &$subpages: Subpage links HTML
2506 $out: OutputPage object
2507 If false is returned $subpages will be used instead of the HTML
2508 subPageSubtitle() generates.
2509 If true is returned, $subpages will be ignored and the rest of
2510 subPageSubtitle() will run.
2512 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2514 $sktemplate: SkinTemplate object
2515 $nav_urls: array of tabs
2517 'SkinTemplateGetLanguageLink': After building the data for a language link from
2518 which the actual html is constructed.
2519 &$languageLink: array containing data about the link. The following keys can be
2520 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2521 $languageLinkTitle: Title object belonging to the external language link.
2522 $title: Title object of the page the link belongs to.
2523 $outputPage: The OutputPage object the links are built from.
2525 To alter the structured navigation links in SkinTemplates, there are three
2526 hooks called in different spots:
2528 'SkinTemplateNavigation': Called on content pages after the tabs have been
2529 added, but before variants have been added.
2530 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2531 tab is added but before variants have been added.
2532 'SkinTemplateNavigation::Universal': Called on both content and special pages
2533 after variants have been added.
2534 &$sktemplate: SkinTemplate object
2535 &$links: Structured navigation links. This is used to alter the navigation for
2536 skins which use buildNavigationUrls such as Vector.
2538 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2540 &$sktemplate: SkinTemplate object
2541 &$tpl: QuickTemplate engine object
2543 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2544 $sktemplate: SkinTemplate object
2545 $res: set to true to prevent active tabs
2547 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2548 You can either create your own array, or alter the parameters for
2550 &$sktemplate: The SkinTemplate instance.
2551 $title: Title instance for the page.
2552 $message: Visible label of tab.
2553 $selected: Whether this is a selected tab.
2554 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2555 &$classes: Array of CSS classes to apply.
2556 &$query: Query string to add to link.
2558 &$result: Complete assoc. array if you want to return true.
2560 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2561 been rendered (useful for adding more).
2562 $sk: The QuickTemplate based skin template running the hook.
2563 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2564 extensions that add support for BaseTemplateToolbox should watch for this
2565 dummy parameter with "$dummy=false" in their code and return without echoing
2566 any HTML to avoid creating duplicate toolbox items.
2568 'SoftwareInfo': Called by Special:Version for returning information about the
2570 $software: The array of software in format 'name' => 'version'. See
2571 SpecialVersion::softwareInformation().
2573 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2574 $name: name of the special page
2575 &$form: HTMLForm object
2577 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2578 $sp: SpecialPage object, for context
2579 &$fields: Current HTMLForm fields
2581 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2582 $id: User id number, only provided for backwards-compatibility
2583 $user: User object representing user contributions are being fetched for
2584 $sp: SpecialPage instance, providing context
2586 'SpecialListusersDefaultQuery': Called right before the end of
2587 UsersPager::getDefaultQuery().
2588 $pager: The UsersPager instance
2589 $query: The query array to be returned
2591 'SpecialListusersFormatRow': Called right before the end of
2592 UsersPager::formatRow().
2593 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2594 $row: Database row object
2596 'SpecialListusersHeader': Called before closing the <fieldset> in
2597 UsersPager::getPageHeader().
2598 $pager: The UsersPager instance
2599 $out: The header HTML
2601 'SpecialListusersHeaderForm': Called before adding the submit button in
2602 UsersPager::getPageHeader().
2603 $pager: The UsersPager instance
2604 $out: The header HTML
2606 'SpecialListusersQueryInfo': Called right before the end of.
2607 UsersPager::getQueryInfo()
2608 $pager: The UsersPager instance
2609 $query: The query array to be returned
2611 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2612 $type: String of the log type
2613 $request: WebRequest object for getting the value provided by the current user
2614 &$qc: Array for query conditions to add
2616 'SpecialMovepageAfterMove': Called after moving a page.
2617 $movePage: MovePageForm object
2618 $oldTitle: old title (object)
2619 $newTitle: new title (object)
2621 'SpecialNewpagesConditions': Called when building sql query for
2623 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2624 $opts: FormOptions object containing special page options
2625 &$conds: array of WHERE conditionals for query
2626 &tables: array of tables to be queried
2627 &$fields: array of columns to select
2628 &$join_conds: join conditions for the tables
2630 'SpecialNewPagesFilters': Called after building form options at NewPages.
2631 $special: the special page object
2632 &$filters: associative array of filter definitions. The keys are the HTML
2633 name/URL parameters. Each key maps to an associative array with a 'msg'
2634 (message key) and a 'default' value.
2636 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2637 hook to remove a core special page.
2638 $list: list (array) of core special pages
2640 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2641 $special: the SpecialPage object
2642 $subPage: the subpage string or null if no subpage was specified
2644 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2645 $special: the SpecialPage object
2646 $subPage: the subpage string or null if no subpage was specified
2648 'SpecialPasswordResetOnSubmit': When executing a form submission on
2649 Special:PasswordReset.
2650 $users: array of User objects.
2651 $data: array of data submitted by the user
2652 &$error: string, error code (message key) used to describe to error (out
2653 parameter). The hook needs to return false when setting this, otherwise it
2654 will have no effect.
2656 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2657 use this to change some selection criteria or substitute a different title.
2658 &$randstr: The random number from wfRandom()
2659 &$isRedir: Boolean, whether to select a redirect or non-redirect
2660 &$namespaces: An array of namespace indexes to get the title from
2661 &$extra: An array of extra SQL statements
2662 &$title: If the hook returns false, a Title object to use instead of the
2663 result from the normal query
2665 'SpecialRecentChangesFilters': Called after building form options at
2666 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2667 $special: the special page object
2668 &$filters: associative array of filter definitions. The keys are the HTML
2669 name/URL parameters. Each key maps to an associative array with a 'msg'
2670 (message key) and a 'default' value.
2672 'SpecialRecentChangesPanel': Called when building form options in
2673 SpecialRecentChanges.
2674 &$extraOpts: array of added items, to which can be added
2675 $opts: FormOptions for this request
2677 'SpecialRecentChangesQuery': Called when building SQL query for
2678 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2679 ChangesListSpecialPageQuery instead.
2680 &$conds: array of WHERE conditionals for query
2681 &$tables: array of tables to be queried
2682 &$join_conds: join conditions for the tables
2683 $opts: FormOptions for this request
2684 &$query_options: array of options for the database request
2685 &$select: Array of columns to select
2687 'SpecialResetTokensTokens': Called when building token list for
2689 &$tokens: array of token information arrays in the format of
2690 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2692 'SpecialSearchCreateLink': Called when making the message to create a page or
2693 go to the existing page.
2694 $t: title object searched for
2695 &$params: an array of the default message name and page title (as parameter)
2697 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2698 target doesn't exist.
2699 &$title: title object generated from the text entered by the user
2701 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2702 the advanced form, a.k.a. power search box.
2703 &$showSections: an array to add values with more options to
2704 $term: the search term (not a title object)
2705 $opts: an array of hidden options (containing 'redirs' and 'profile')
2707 'SpecialSearchProfiles': Allows modification of search profiles.
2708 &$profiles: profiles, which can be modified.
2710 'SpecialSearchProfileForm': Allows modification of search profile forms.
2711 $search: special page object
2712 &$form: String: form html
2713 $profile: String: current search profile
2714 $term: String: search term
2715 $opts: Array: key => value of hidden options for inclusion in custom forms
2717 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2718 $search: SpecialSearch special page object
2719 $profile: String: current search profile
2720 $engine: the search engine
2722 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2723 on the search results page. Useful for including an external search
2724 provider. To disable the output of MediaWiki search output, return
2726 $specialSearch: SpecialSearch object ($this)
2728 $term: Search term specified by the user
2730 'SpecialSearchResults': Called before search result display
2731 $term: string of search term
2732 &$titleMatches: empty or SearchResultSet object
2733 &$textMatches: empty or SearchResultSet object
2735 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2736 &$extraStats: Array to save the new stats
2737 ( $extraStats['<name of statistic>'] => <value>; )
2739 'SpecialUploadComplete': Called after successfully uploading a file from
2741 $form: The SpecialUpload object
2743 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2744 $wgVersion: Current $wgVersion for you to use
2745 &$versionUrl: Raw url to link to (eg: release notes)
2747 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2748 Deprecated, use ChangesListSpecialPageFilters instead.
2749 $special: the special page object
2750 &$filters: associative array of filter definitions. The keys are the HTML
2751 name/URL parameters. Each key maps to an associative array with a 'msg'
2752 (message key) and a 'default' value.
2754 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2755 Deprecated, use ChangesListSpecialPageQuery instead.
2756 &$conds: array of WHERE conditionals for query
2757 &$tables: array of tables to be queried
2758 &$join_conds: join conditions for the tables
2759 &$fields: array of query fields
2760 $opts: A FormOptions object with watchlist options for the current request
2762 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2763 SpecialWatchlist. Allows extensions to register custom values they have
2764 inserted to rc_type so they can be returned as part of the watchlist.
2765 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2767 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2768 URL for a title when we have no other parameters on the URL. Gives a chance for
2769 extensions that alter page view behavior radically to abort that redirect or
2771 $request: WebRequest
2772 $title: Title of the currently found title obj
2773 $output: OutputPage object
2775 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2776 rendered (by ThumbnailImage:toHtml method).
2777 $thumbnail: the ThumbnailImage object
2778 &$attribs: image attribute array
2779 &$linkAttribs: image link attribute array
2781 'TitleArrayFromResult': Called when creating an TitleArray object from a
2783 &$titleArray: set this to an object to override the default object returned
2784 $res: database result used to create the object
2786 'TitleExists': Called when determining whether a page exists at a given title.
2787 $title: The title being tested.
2788 &$exists: Whether the title exists.
2790 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2791 or override the quick permissions check.
2792 $title: The Title object being accessed
2793 $user: The User performing the action
2794 $action: Action being performed
2795 &$errors: Array of errors
2796 $doExpensiveQueries: Whether to do expensive DB queries
2797 $short: Whether to return immediately on first error
2799 'TitleGetEditNotices': Allows extensions to add edit notices
2800 $title: The Title object for the page the edit notices are for
2801 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2802 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2804 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2805 that can be applied.
2806 $title: The title in question.
2807 &$types: The types of protection available.
2809 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2810 Called when determining if a page is a CSS or JS page.
2811 $title: Title object that is being checked
2812 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2813 Hooks may change this value to override the return value of
2814 Title::isCssOrJsPage().
2816 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2817 overriding default behavior for determining if a page exists. If $isKnown is
2818 kept as null, regular checks happen. If it's a boolean, this value is returned
2819 by the isKnown method.
2820 $title: Title object that is being checked
2821 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2823 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2824 that this hook is not called for interwiki pages or pages in immovable
2825 namespaces: for these, isMovable() always returns false.
2826 $title: Title object that is being checked
2827 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2828 Hooks may change this value to override the return value of
2831 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2832 Called when determining if a page is a wikitext or should
2833 be handled by separate handler (via ArticleViewCustom).
2834 $title: Title object that is being checked
2835 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2836 Hooks may change this value to override the return value of
2837 Title::isWikitextPage()
2839 'TitleMove': Before moving an article (title).
2842 $user: user who does the move
2844 'TitleMoveComplete': After moving an article (title).
2847 $user: user who did the move
2848 $pageid: database ID of the page that's been moved
2849 $redirid: database ID of the created redirect
2850 $reason: reason for the move
2852 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2853 adding the default error message if nothing allows the user to read the page. If
2854 a handler wants a title to *not* be whitelisted, it should also return false.
2855 $title: Title object being checked against
2856 $user: Current user object
2857 &$whitelisted: Boolean value of whether this title is whitelisted
2859 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2860 $title: Title object to purge
2861 &$urls: An array of URLs to purge from the caches, to be manipulated.
2863 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2864 PageArchive object has been created but before any further processing is done.
2865 &$archive: PageArchive object
2866 $title: Title object of the page that we're viewing
2868 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2869 PageArchive object has been created but before any further processing is done.
2870 &$archive: PageArchive object
2871 $title: Title object of the page that we're viewing
2873 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2874 the site is not in read-only mode, that the Title object is not null and after
2875 a PageArchive object has been constructed but before performing any further
2877 &$archive: PageArchive object
2878 $title: Title object of the page that we're about to undelete
2880 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2881 $title: title object related to the revision
2882 $rev: revision (object) that will be viewed
2884 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2886 $action: action name
2887 $article: article "acted on"
2889 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
2890 Since 1.24: Paths pointing to a directory will be recursively scanned for
2891 test case files matching the suffix "Test.php".
2892 &$paths: list of test cases and directories to search.
2894 'UnwatchArticle': Before a watch is removed from an article.
2895 $user: user watching
2896 $page: WikiPage object to be removed
2897 &$status: Status object to be returned if the hook returns false
2899 'UnwatchArticleComplete': After a watch is removed from an article.
2900 $user: user that watched
2901 $page: WikiPage object that was watched
2903 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2904 $formattedPageStatus: list of valid page states
2906 'UploadForm:initial': Before the upload form is generated. You might set the
2907 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2908 text (HTML) either before or after the editform.
2909 $form: UploadForm object
2911 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2912 poke at member variables like $mUploadDescription before the file is saved. Do
2913 not use this hook to break upload processing. This will return the user to a
2914 blank form with no error message; use UploadVerification and UploadVerifyFile
2916 $form: UploadForm object
2918 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2919 $type: (string) the requested upload type
2920 &$className: the class name of the Upload instance to be created
2922 'UploadComplete': when Upload completes an upload.
2923 &$upload: an UploadBase child instance
2925 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2927 $descriptor: (array) the HTMLForm descriptor
2929 'UploadFormSourceDescriptors': after the standard source inputs have been
2930 added to the descriptor
2931 $descriptor: (array) the HTMLForm descriptor
2933 'UploadVerification': Additional chances to reject an uploaded file. Consider
2934 using UploadVerifyFile instead.
2935 string $saveName: destination file name
2936 string $tempName: filesystem path to the temporary file for checks
2937 string &$error: output: message key for message to show if upload canceled by
2938 returning false. May also be an array, where the first element is the message
2939 key and the remaining elements are used as parameters to the message.
2941 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
2942 in most cases over UploadVerification.
2943 object $upload: an instance of UploadBase, with all info about the upload
2944 string $mime: The uploaded file's MIME type, as detected by MediaWiki. Handlers
2945 will typically only apply for specific MIME types.
2946 object &$error: output: true if the file is valid. Otherwise, an indexed array
2947 representing the problem with the file, where the first element is the message
2948 key and the remaining elements are used as parameters to the message.
2950 'UploadComplete': Upon completion of a file upload.
2951 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2952 $uploadBase->getLocalFile().
2954 'User::mailPasswordInternal': before creation and mailing of a user's new
2956 $user: the user who sent the message out
2957 $ip: IP of the user who sent the message out
2958 $u: the account whose new password will be set
2960 'UserAddGroup': Called when adding a group; return false to override
2961 stock group addition.
2962 $user: the user object that is to have a group added
2963 &$group: the group to add, can be modified
2965 'UserArrayFromResult': Called when creating an UserArray object from a database
2967 &$userArray: set this to an object to override the default object returned
2968 $res: database result used to create the object
2970 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2971 want to display an error message, try getUserPermissionsErrors.
2972 $title: Title object being checked against
2973 $user : Current user object
2974 $action: Action being checked
2975 $result: Pointer to result returned if hook returns false. If null is returned,
2976 userCan checks are continued by internal code.
2978 'UserCanSendEmail': To override User::canSendEmail() permission check.
2979 $user: User (object) whose permission is being checked
2980 &$canSend: bool set on input, can override on output
2982 'UserClearNewTalkNotification': Called when clearing the "You have new
2983 messages!" message, return false to not delete it.
2984 $user: User (object) that will clear the message
2985 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2987 'UserCreateForm': change to manipulate the login form
2988 $template: SimpleTemplate instance for the form
2990 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2991 $user: User to get groups for
2992 &$groups: Current effective groups
2994 'UserGetAllRights': After calculating a list of all available rights.
2995 &$rights: Array of rights, which may be added to.
2997 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2998 before returning the options to the caller. Warning: This hook is called for
2999 every call to User::getDefaultOptions(), which means it's potentially called
3000 dozens or hundreds of times. You may want to cache the results of non-trivial
3001 operations in your hook function for this reason.
3002 &$defaultOptions: Array of preference keys and their default values.
3004 'UserGetEmail': Called when getting an user email address.
3006 &$email: email, change this to override local email
3008 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3009 email authentication.
3011 &$timestamp: timestamp, change this to override local email authentication
3014 'UserGetImplicitGroups': DEPRECATED, called in User::getImplicitGroups().
3015 &$groups: List of implicit (automatically-assigned) groups
3017 'UserGetLanguageObject': Called when getting user's interface language object.
3019 &$code: Language code that will be used to create the object
3020 $context: IContextSource object
3022 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3023 &$reservedUsernames: $wgReservedUsernames
3025 'UserGetRights': Called in User::getRights().
3026 $user: User to get rights for
3027 &$rights: Current rights
3029 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3030 specific block exemptions).
3031 $user: User in question
3032 $title: Title of the page in question
3033 &$blocked: Out-param, whether or not the user is blocked from that page.
3034 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3035 to edit their own user talk pages.
3037 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3039 $ip: User's IP address
3040 &$blocked: Whether the user is blocked, to be modified by the hook
3042 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3043 false if a UserGetRights hook might remove the named right.
3044 $right: The user right being checked
3046 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3047 environmental means; occurs after session is loaded.
3048 $user: user object being loaded
3050 'UserLoadDefaults': Called when loading a default user.
3054 'UserLoadFromDatabase': Called when loading a user from the database.
3056 &$s: database query object
3058 'UserLoadFromSession': Called to authenticate users on external/environmental
3059 means; occurs before session is loaded.
3060 $user: user object being loaded
3061 &$result: set this to a boolean value to abort the normal authentication
3064 'UserLoadOptions': When user options/preferences are being loaded from the
3067 &$options: Options, can be modified.
3069 'UserLoginComplete': After a user has logged in.
3070 $user: the user object that was created on login
3071 $inject_html: Any HTML to inject after the "logged in" message.
3073 'UserLoginForm': change to manipulate the login form
3074 $template: SimpleTemplate instance for the form
3076 'UserLogout': Before a user logs out.
3077 $user: the user object that is about to be logged out
3079 'UserLogoutComplete': After a user has logged out.
3080 $user: the user object _after_ logout (won't have name, ID, etc.)
3081 $inject_html: Any HTML to inject after the "logged out" message.
3082 $oldName: name of the user before logout (string)
3084 'UserRemoveGroup': Called when removing a group; return false to override stock
3086 $user: the user object that is to have a group removed
3087 &$group: the group to be removed, can be modified
3089 'UserRights': After a user's group memberships are changed.
3090 $user : User object that was changed
3091 $add : Array of strings corresponding to groups added
3092 $remove: Array of strings corresponding to groups removed
3094 'UserRequiresHTTPS': Called to determine whether a user needs
3095 to be switched to HTTPS.
3096 $user: User in question.
3097 &$https: Boolean whether $user should be switched to HTTPS.
3099 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3100 have been requested to be reset. This hook can be used to exclude certain
3101 options from being reset even when the user has requested all prefs to be reset,
3102 because certain options might be stored in the user_properties database table
3103 despite not being visible and editable via Special:Preferences.
3104 $user: the User (object) whose preferences are being reset
3105 &$newOptions: array of new (site default) preferences
3106 $options: array of the user's old preferences
3107 $resetKinds: array containing the kinds of preferences to reset
3109 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3111 $user: user retrieving new talks messages
3112 $talks: array of new talks page(s)
3114 'UserSaveSettings': Called when saving user settings.
3117 'UserSaveOptions': Called just before saving user preferences/options.
3119 &$options: Options, modifiable
3121 'UserSetCookies': Called when setting user cookies.
3123 &$session: session array, will be added to $_SESSION
3124 &$cookies: cookies array mapping cookie name to its value
3126 'UserSetEmail': Called when changing user email address.
3128 &$email: new email, change this to override new email address
3130 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3131 email authentication.
3133 &$timestamp: new timestamp, change this to override local email
3134 authentication timestamp
3136 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3137 "Foobar (Talk | Contribs | Block)".
3138 $userId: User id of the current user
3139 $userText: User name of the current user
3140 &$items: Array of user tool links as HTML fragments
3142 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3143 FormatMetadata::getExtendedMeta (return false means cache will be
3144 invalidated and GetExtendedMetadata hook called again).
3145 $timestamp: The timestamp metadata was generated
3146 $file: The file the metadata is for
3148 'UserMailerChangeReturnPath': Called to generate a VERP return address
3149 when UserMailer sends an email, with a bounce handling extension.
3150 $to: Array of MailAddress objects for the recipients
3151 &$returnPath: The return address string
3153 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid error
3154 messages. Allows to add additional error messages (except messages already in
3155 LoginForm::$validErrorMessages).
3156 &$messages Already added messages (inclusive messages from LoginForm::$validErrorMessages)
3158 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3159 used to alter the SQL query which gets the list of wanted pages.
3160 &$wantedPages: WantedPagesPage object
3161 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3163 'WatchArticle': Before a watch is added to an article.
3164 $user: user that will watch
3165 $page: WikiPage object to be watched
3166 &$status: Status object to be returned if the hook returns false
3168 'WatchArticleComplete': After a watch is added to an article.
3169 $user: user that watched
3170 $page: WikiPage object watched
3172 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3173 form, used to manipulate the list of pages or preload data based on that list.
3174 &$watchlistInfo: array of watchlisted pages in
3175 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3177 'WatchlistEditorBuildRemoveLine': when building remove lines in
3178 Special:Watchlist/edit.
3179 &$tools: array of extra links
3180 $title: Title object
3181 $redirect: whether the page is a redirect
3183 &$link: HTML link to title
3185 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3187 $router: The PathRouter instance
3189 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3190 Return false to prevent setting of the cookie.
3191 &$name: Cookie name passed to WebResponse::setcookie()
3192 &$value: Cookie value passed to WebResponse::setcookie()
3193 &$expire: Cookie expiration, as for PHP's setcookie()
3194 $options: Options passed to WebResponse::setcookie()
3196 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3197 $row: The DB row of the entry.
3198 $title: The Title of the page where the link comes FROM
3199 $target: The Title of the page where the link goes TO
3200 &$props: Array of HTML strings to display after the title.
3202 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3203 dumps. One, and only one hook should set this, and return false.
3204 &$tables: Database tables to use in the SELECT query
3205 &$opts: Options to use for the query
3206 &$join: Join conditions
3208 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3209 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3210 specific to a content model should be provided by the respective Content's
3211 getDeletionUpdates() method.
3213 $content: the Content to generate updates for
3214 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3216 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3217 run a MediaWiki cli script.
3218 &$script: MediaWiki cli script path
3219 &$parameters: Array of arguments and options to the script
3220 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3223 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3224 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3225 $qp: The list of QueryPages
3227 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3228 extra metadata to be added.
3229 $obj: The XmlDumpWriter object.
3230 &$out: The output string.
3231 $row: The database row for the page.
3232 $title: The title of the page.
3234 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3236 $obj: The XmlDumpWriter object.
3237 &$out: The text being output.
3238 $row: The database row for the revision.
3239 $text: The revision text.
3241 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3242 to add additional tags to extract.
3243 &$items: Array containing information on which items to extract. See XMPInfo for
3244 details on the format.
3246 'XMPGetResults': Called just before returning the results array of parsing xmp
3247 data. Can be used to post-process the results.
3248 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3249 is an array of metadata tags returned (each tag is either a value, or an array
3252 More hooks might be available but undocumented, you can execute
3253 "php maintenance/findHooks.php" to find hidden ones.