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::attemptSave:after': Called after an article save attempt
1148 $editpage_Obj: the current EditPage object
1149 $status: the resulting Status object
1150 $resultDetails: Result details array
1152 'EditPage::importFormData': allow extensions to read additional data
1154 $editpage: EditPage instance
1155 $request: Webrequest
1156 return value is ignored (should always return true)
1158 'EditPage::showEditForm:fields': allows injection of form field into edit form
1159 $editor: the EditPage instance for reference
1160 $out: an OutputPage instance to write to
1161 return value is ignored (should always return true)
1163 'EditPage::showEditForm:initial': before showing the edit form
1164 $editor: EditPage instance (object)
1165 $out: an OutputPage instance to write to
1167 Return false to halt editing; you'll need to handle error messages, etc.
1168 yourself. Alternatively, modifying $error and returning true will cause the
1169 contents of $error to be echoed at the top of the edit form as wikitext.
1170 Return true without altering $error to allow the edit to proceed.
1172 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1173 but for the read-only 'view source' variant of the edit form.
1174 $editor: EditPage instance (object)
1175 &$out: an OutputPage instance to write to
1176 return value is ignored (should always return true)
1178 'EditPage::showStandardInputs:options': allows injection of form fields into
1179 the editOptions area
1180 $editor: EditPage instance (object)
1181 $out: an OutputPage instance to write to
1182 &$tabindex: HTML tabindex of the last edit check/button
1183 return value is ignored (should always be true)
1185 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1186 when there's an edit conflict. Return false to halt normal diff output; in
1187 this case you're responsible for computing and outputting the entire "conflict"
1188 part, i.e., the "difference between revisions" and "your text" headers and
1190 &$editor: EditPage instance
1191 &$out: OutputPage instance
1193 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1194 textarea in the edit form.
1195 &$editpage: The current EditPage object
1196 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1197 &$tabindex: HTML tabindex of the last edit check/button
1199 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1201 &$editpage: The current EditPage object
1202 &$checks: Array of edit checks like "watch this page"/"minor edit"
1203 &$tabindex: HTML tabindex of the last edit check/button
1205 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1206 textarea in the edit form.
1207 &$toolbar: The toolbar HTMl
1209 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1210 contribution/copyright notice.
1211 $title: title of page being edited
1212 &$msg: localization message name, overridable. Default is either
1213 'copyrightwarning' or 'copyrightwarning2'.
1215 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1216 modifying the wikitext that will be used in "Show changes". Note that it is
1217 preferable to implement diff handling for different data types using the
1218 ContentHandler facility.
1219 $editPage: EditPage object
1220 &$newtext: wikitext that will be used as "your version"
1222 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1223 "Show changes". Note that it is preferable to implement diff handling for
1224 different data types using the ContentHandler facility.
1225 $editPage: EditPage object
1226 &$newtext: wikitext that will be used as "your version"
1228 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1229 Allow modifying the wikitext that will be previewed. Note that it is preferable
1230 to implement previews for different data types using the ContentHandler
1232 $editPage: EditPage object
1233 &$toparse: wikitext that will be parsed
1235 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1236 previewed. Note that it is preferable to implement previews for different data
1237 types using the ContentHandler facility.
1238 $editPage: EditPage object
1239 &$content: Content object to be previewed (may be replaced by hook function)
1241 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1242 &$editpage: The current EditPage object
1243 &$res: the HTML of the error text
1245 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1246 of terms of service summary link that might exist separately from the copyright
1248 $title: title of page being edited
1249 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1251 'EmailConfirmed': When checking that the user's email address is "confirmed".
1252 $user: User being checked
1253 $confirmed: Whether or not the email address is confirmed
1254 This runs before the other checks, such as anonymity and the real check; return
1255 true to allow those checks to occur, and false if checking is done.
1257 'EmailUser': Before sending email from one user to another.
1258 $to: address of receiving user
1259 $from: address of sending user
1260 $subject: subject of the mail
1261 $text: text of the mail
1263 'EmailUserCC': Before sending the copy of the email to the author.
1264 $to: address of receiving user
1265 $from: address of sending user
1266 $subject: subject of the mail
1267 $text: text of the mail
1269 'EmailUserComplete': After sending email from one user to another.
1270 $to: address of receiving user
1271 $from: address of sending user
1272 $subject: subject of the mail
1273 $text: text of the mail
1275 'EmailUserForm': After building the email user form object.
1276 $form: HTMLForm object
1278 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1280 $user: The user who is trying to email another user.
1281 $editToken: The user's edit token.
1282 &$hookErr: Out-param for the error. Passed as the parameters to
1283 OutputPage::showErrorPage.
1285 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1287 $ip: The ip address of the user
1289 'ExtensionTypes': Called when generating the extensions credits, use this to
1290 change the tables headers.
1291 &$extTypes: associative array of extensions types
1293 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1294 thumbnail file name.
1295 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1296 $thumbname: the base name of the thumbnail file
1297 &$params: the currently extracted params (has source name, temp or archived zone)
1299 'FetchChangesList': When fetching the ChangesList derivative for a particular
1301 $user: User the list is being fetched for
1302 &$skin: Skin object to be used with the list
1303 &$list: List object (defaults to NULL, change it to an object instance and
1304 return false override the list derivative used)
1306 'FileDeleteComplete': When a file is deleted.
1307 $file: reference to the deleted file
1308 $oldimage: in case of the deletion of an old image, the name of the old file
1309 $article: in case all revisions of the file are deleted a reference to the
1310 WikiFilePage associated with the file.
1311 $user: user who performed the deletion
1314 'FileTransformed': When a file is transformed and moved into storage.
1315 $file: reference to the File object
1316 $thumb: the MediaTransformOutput object
1317 $tmpThumbPath: The temporary file system path of the transformed file
1318 $thumbPath: The permanent storage path of the transformed file
1320 'FileUpload': When a file upload occurs.
1321 $file : Image object representing the file that was uploaded
1322 $reupload : Boolean indicating if there was a previously another image there or
1324 $hasDescription : Boolean indicating that there was already a description page
1325 and a new one from the comment wasn't created (since 1.17)
1327 'FileUndeleteComplete': When a file is undeleted
1328 $title: title object to the file
1329 $fileVersions: array of undeleted versions. Empty if all versions were restored
1330 $user: user who performed the undeletion
1333 'FormatAutocomments': When an autocomment is formatted by the Linker.
1334 &$comment: Reference to the accumulated comment. Initially null, when set the
1335 default code will be skipped.
1336 $pre: Boolean, true if there is text before this autocomment
1337 $auto: The extracted part of the parsed comment before the call to the hook.
1338 $post: Boolean, true if there is text after this autocomment
1339 $title: An optional title object used to links to sections. Can be null.
1340 $local: Boolean indicating whether section links should refer to local page.
1342 'GalleryGetModes': Get list of classes that can render different modes of a
1344 &$modeArray: An associative array mapping mode names to classes that implement
1345 that mode. It is expected all registered classes are a subclass of
1348 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1350 &$user: user to promote.
1351 &$promote: groups that will be added.
1353 'GetBlockedStatus': after loading blocking status of an user from the database
1354 $user: user (object) being checked
1356 'GetCacheVaryCookies': Get cookies that should vary cache options.
1357 $out: OutputPage object
1358 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1359 that have to vary cache options
1361 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1363 $title: Title object of page
1364 $url: string value as output (out parameter, can modify)
1365 $query: query options passed to Title::getCanonicalURL()
1367 'GetDefaultSortkey': Override the default sortkey for a page.
1368 $title: Title object that we need to get a sortkey for
1369 &$sortkey: Sortkey to use.
1371 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1372 underscore) magic words. Called by MagicWord.
1373 &$doubleUnderscoreIDs: array of strings
1375 'GetExtendedMetadata': Get extended file metadata for the API
1376 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1377 'value' => prop value, 'source' => 'name of hook' ).
1378 $file: File object of file in question
1379 $context: RequestContext (including language to use)
1380 $single: Only extract the current language; if false, the prop value should
1381 be in the metadata multi-language array format:
1382 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1383 &$maxCacheTime: how long the results can be cached
1385 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1386 $title: Title object of page
1387 $url: string value as output (out parameter, can modify)
1388 $query: query options passed to Title::getFullURL()
1390 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1391 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1393 &$output: string for the output timestamp
1394 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1395 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1396 $user: User whose preferences are being used to make timestamp
1397 $lang: Language that will be used to render the timestamp
1399 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1400 $title: Title object of page
1401 $url: string value as output (out parameter, can modify)
1402 $query: query options passed to Title::getInternalURL()
1404 'GetIP': modify the ip of the current user (called only once).
1405 &$ip: string holding the ip as determined so far
1407 'GetLinkColours': modify the CSS class of an array of page links.
1408 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1410 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1412 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1413 working with internal urls (non-interwiki) then it may be preferable to work
1414 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1415 be buggy for internal urls on render if you do not re-implement the horrible
1416 hack that Title::getLocalURL uses in your own extension.
1417 $title: Title object of page
1418 &$url: string value as output (out parameter, can modify)
1419 $query: query options passed to Title::getLocalURL()
1421 'GetLocalURL::Internal': Modify local URLs to internal pages.
1422 $title: Title object of page
1423 &$url: string value as output (out parameter, can modify)
1424 $query: query options passed to Title::getLocalURL()
1426 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1427 without any fancy queries or variants.
1428 $title: Title object of page
1429 &$url: string value as output (out parameter, can modify)
1431 'GetLogTypesOnUser': Add log types where the target is a userpage
1432 &$types: Array of log types
1434 'GetMetadataVersion': Modify the image metadata version currently in use. This
1435 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1436 that need to have versioned metadata should add an element to the end of the
1437 version array of the form 'handler_name=version'. Most media handlers won't need
1438 to do this unless they broke backwards compatibility with a previous version of
1439 the media handler metadata output.
1440 &$version: Array of version strings
1442 'GetNewMessagesAlert': Disable or modify the new messages alert
1443 &$newMessagesAlert: An empty string by default. If the user has new talk page
1444 messages, this should be populated with an alert message to that effect
1445 $newtalks: An empty array if the user has no new messages or an array containing
1446 links and revisions if there are new messages (See User::getNewMessageLinks)
1447 $user: The user object of the user who is loading the page
1448 $out: OutputPage object (to check what type of page the user is on)
1450 'GetPreferences': Modify user preferences.
1451 $user: User whose preferences are being modified.
1452 &$preferences: Preferences description array, to be fed to an HTMLForm object
1454 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1455 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1457 &$output: string for the output timestamp
1458 &$diff: DateInterval representing the difference between the timestamps
1459 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1460 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1461 $user: User whose preferences are being used to make timestamp
1462 $lang: Language that will be used to render the timestamp
1464 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1465 checked for. Use instead of userCan for most cases. Return false if the user
1466 can't do it, and populate $result with the reason in the form of
1467 array( messagename, param1, param2, ... ). For consistency, error messages
1468 should be plain text with no special coloring, bolding, etc. to show that
1469 they're errors; presenting them properly to the user as errors is done by the
1471 $title: Title object being checked against
1472 $user : Current user object
1473 $action: Action being checked
1474 $result: User permissions error to add. If none, return true.
1476 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1477 called only if expensive checks are enabled. Add a permissions error when
1478 permissions errors are checked for. Return false if the user can't do it, and
1479 populate $result with the reason in the form of array( messagename, param1,
1480 param2, ... ). For consistency, error messages should be plain text with no
1481 special coloring, bolding, etc. to show that they're errors; presenting them
1482 properly to the user as errors is done by the caller.
1484 $title: Title object being checked against
1485 $user : Current user object
1486 $action: Action being checked
1487 $result: User permissions error to add. If none, return true.
1489 'GitViewers': Called when generating the list of git viewers for
1490 Special:Version, use this to change the list.
1491 &$extTypes: associative array of repo URLS to viewer URLs.
1493 'HistoryRevisionTools': Override or extend the revision tools available from the
1494 page history view, i.e. undo, rollback, etc.
1495 $rev: Revision object
1496 &$links: Array of HTML links
1498 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1500 $context: An IContextSource object with information about the request being served.
1502 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1503 image insertion. You can skip the default logic entirely by returning false, or
1504 just modify a few things using call-by-reference.
1506 &$title: Title object of the image
1507 &$file: File object, or false if it doesn't exist
1508 &$frameParams: Various parameters with special meanings; see documentation in
1509 includes/Linker.php for Linker::makeImageLink
1510 &$handlerParams: Various parameters with special meanings; see documentation in
1511 includes/Linker.php for Linker::makeImageLink
1512 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1513 &$res: Final HTML output, used if you return false
1516 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1517 the image on an image page.
1518 $imagePage: ImagePage object ($this)
1521 'ImagePageAfterImageLinks': Called after the image links section on an image
1523 $imagePage: ImagePage object ($this)
1524 &$html: HTML for the hook to add
1526 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1528 $line: the HTML of the history line
1529 $css: the line CSS class
1531 'ImagePageFindFile': Called when fetching the file associated with an image
1533 $page: ImagePage object
1535 &$displayFile: displayed File object
1537 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1538 $page: ImagePage object
1539 &$toc: Array of <li> strings
1541 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1543 &$title: the Title object of the file as it would appear for the upload page
1544 &$path: the original file and path name when img_auth was invoked by the web
1546 &$name: the name only component of the file
1547 &$result: The location to pass back results of the hook routine (only used if
1549 $result[0]=The index of the header message
1550 $result[1]=The index of the body text message
1551 $result[2 through n]=Parameters passed to body text message. Please note the
1552 header message cannot receive/use parameters.
1554 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1555 $reader: XMLReader object
1556 $logInfo: Array of information
1557 Return false to stop further processing of the tag
1559 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1560 $reader: XMLReader object
1561 $pageInfo: Array of information
1562 Return false to stop further processing of the tag
1564 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1565 $reader: XMLReader object
1566 $pageInfo: Array of page information
1567 $revisionInfo: Array of revision information
1568 Return false to stop further processing of the tag
1570 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1571 $reader: XMLReader object
1572 Return false to stop further processing of the tag
1574 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1575 $reader: XMLReader object
1576 $revisionInfo: Array of information
1577 Return false to stop further processing of the tag
1579 'InfoAction': When building information to display on the action=info page.
1580 $context: IContextSource object
1581 &$pageInfo: Array of information
1583 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1584 $title: Title object for the current page
1585 $request: WebRequest
1586 $ignoreRedirect: boolean to skip redirect check
1587 $target: Title/string of redirect target
1588 $article: Article object
1590 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1591 Return true without providing an interwiki to continue interwiki search.
1592 $prefix: interwiki prefix we are looking for.
1593 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1594 iw_trans and optionally iw_api and iw_wikiid.
1596 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1597 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1598 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1599 template/parser function execution which respect nowiki and HTML-comments.
1600 &$parser: Parser object
1601 &$text: string containing partially parsed text
1602 &$stripState: Parser's internal StripState object
1604 'InternalParseBeforeLinks': during Parser's internalParse method before links
1605 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1606 &$parser: Parser object
1607 &$text: string containing partially parsed text
1608 &$stripState: Parser's internal StripState object
1610 'InvalidateEmailComplete': Called after a user's email has been invalidated
1612 $user: user (object) whose email is being invalidated
1614 'IRCLineURL': When constructing the URL to use in an IRC notification.
1615 Callee may modify $url and $query, URL will be constructed as $url . $query
1616 &$url: URL to index.php
1617 &$query: Query string
1618 $rc: RecentChange object that triggered url generation
1620 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1621 $article: article (object) being checked
1623 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1625 $result: Change this value to override the result of wfIsTrustedProxy()
1627 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1628 $url: URL used to upload from
1629 &$allowed: Boolean indicating if uploading is allowed for given URL
1631 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1632 instance to return false if the domain name doesn't match your organization.
1633 $addr: The e-mail address entered by the user
1634 &$result: Set this and return false to override the internal checks
1636 'isValidPassword': Override the result of User::isValidPassword()
1637 $password: The password entered by the user
1638 &$result: Set this and return false to override the internal checks
1639 $user: User the password is being validated for
1641 'Language::getMessagesFileName':
1642 $code: The language code or the language we're looking for a messages file for
1643 &$file: The messages file path, you can override this to change the location.
1645 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1646 remove namespaces. Do not use this hook to add namespaces. Use
1647 CanonicalNamespaces for that.
1648 &$namespaces: Array of namespaces indexed by their numbers
1650 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1651 $wgExtensionMessagesFiles instead.
1652 Use this to define synonyms of magic words depending of the language
1653 $magicExtensions: associative array of magic words synonyms
1654 $lang: language code (string)
1656 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1657 listed in $wgExtensionMessagesFiles instead.
1658 Use to define aliases of special pages names depending of the language
1659 $specialPageAliases: associative array of magic words synonyms
1660 $lang: language code (string)
1662 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1663 &$names: array of language code => language name
1664 $code language of the preferred translations
1666 'LanguageLinks': Manipulate a page's language links. This is called
1667 in various places to allow extensions to define the effective language
1669 $title: The page's Title.
1670 &$links: Associative array mapping language codes to prefixed links of the
1671 form "language:title".
1672 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1673 Currently unused, but planned to provide support for marking individual
1674 language links in the UI, e.g. for featured articles.
1676 'LanguageSelector': Hook to change the language selector available on a page.
1677 $out: The output page.
1678 $cssClassName: CSS class name of the language selector.
1680 'LinkBegin': Used when generating internal and interwiki links in
1681 Linker::link(), before processing starts. Return false to skip default
1682 processing and return $ret. See documentation for Linker::link() for details on
1683 the expected meanings of parameters.
1684 $skin: the Skin object
1685 $target: the Title that the link is pointing to
1686 &$html: the contents that the <a> tag should have (raw HTML); null means
1688 &$customAttribs: the HTML attributes that the <a> tag should have, in
1689 associative array form, with keys and values unescaped. Should be merged with
1690 default values, with a value of false meaning to suppress the attribute.
1691 &$query: the query string to add to the generated URL (the bit after the "?"),
1692 in associative array form, with keys and values unescaped.
1693 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1694 &$ret: the value to return if your hook returns false.
1696 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1697 just before the function returns a value. If you return true, an <a> element
1698 with HTML attributes $attribs and contents $html will be returned. If you
1699 return false, $ret will be returned.
1700 $skin: the Skin object
1701 $target: the Title object that the link is pointing to
1702 $options: the options. Will always include either 'known' or 'broken', and may
1703 include 'noclasses'.
1704 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1705 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1706 associative array form.
1707 &$ret: the value to return if your hook returns false.
1709 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1711 &$url: the image url
1712 &$alt: the image's alt text
1713 &$img: the new image HTML (if returning false)
1715 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1718 &$text: the link text
1719 &$link: the new link HTML (if returning false)
1720 &$attribs: the attributes to be applied.
1721 $linkType: The external link type
1723 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1725 $title: the Title object that the link is pointing to
1726 $file: the File object or false if broken link
1727 &$html: the link text
1728 &$attribs: the attributes to be applied
1729 &$ret: the value to return if your hook returns false
1731 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1733 &$linksUpdate: the LinksUpdate object
1735 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1736 each link table insert. For example, pagelinks, imagelinks, externallinks.
1737 $linksUpdate: LinksUpdate object
1738 $table: the table to insert links to
1739 $insertions: an array of links to insert
1741 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1742 including delete and insert, has completed for all link tables
1743 &$linksUpdate: the LinksUpdate object
1745 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1746 &$linksUpdate: the LinksUpdate object
1748 'ListDefinedTags': When trying to find all defined tags.
1749 &$tags: The list of tags.
1751 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1752 &updater: A DatabaseUpdater subclass
1754 'LocalFile::getHistory': Called before file history query performed.
1755 $file: the File object
1757 $fields: select fields
1759 $opts: query options
1760 $join_conds: JOIN conditions
1762 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1763 $file: the File object
1764 $archiveName: name of an old file version or false if it's the current one
1766 'LocalisationCacheRecache': Called when loading the localisation data into
1768 $cache: The LocalisationCache object
1769 $code: language code
1770 &$alldata: The localisation data from core and extensions
1771 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1773 'LocalisationCacheRecacheFallback': Called for each language when merging
1774 fallback data into the cache.
1775 $cache: The LocalisationCache object
1776 $code: language code
1777 &$alldata: The localisation data from core and extensions. Note some keys may
1778 be omitted if they won't be merged into the final result.
1780 'LocalisationChecksBlacklist': When fetching the blacklist of
1781 localisation checks.
1782 &$blacklist: array of checks to blacklist. See the bottom of
1783 maintenance/language/checkLanguage.inc for the format of this variable.
1785 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1786 optional localisation messages
1787 &$ignored Array of ignored message keys
1788 &$optional Array of optional message keys
1790 'LogEventsListGetExtraInputs': When getting extra inputs to display on Special:Log
1791 for a specific log type
1792 $type: String of log type being displayed
1793 $logEventsList: LogEventsList object for context and access to the WebRequest
1794 &$input: string HTML of an input element
1797 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1798 Returning false will prevent the string from being added to the OutputPage.
1799 &$s: html string to show for the log extract
1800 $types: String or Array Log types to show
1801 $page: String or Title The page title to show log entries for
1802 $user: String The user who made the log entries
1803 $param: Associative Array with the following additional options:
1804 - lim Integer Limit of items to show, default is 50
1805 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1806 - showIfEmpty boolean Set to false if you don't want any output in case the
1807 loglist is empty if set to true (default), "No matching items in log" is
1808 displayed if loglist is empty
1809 - msgKey Array If you want a nice box with a message, set this to the key of
1810 the message. First element is the message key, additional optional elements
1811 are parameters for the key that are processed with
1812 wfMessage()->params()->parseAsBlock()
1813 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1815 - wrap String Wrap the message in html (usually something like
1816 "<div ...>$1</div>").
1817 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1819 'LoginAuthenticateAudit': A login attempt for a valid user account either
1820 succeeded or failed. No return data is accepted; this hook is for auditing only.
1821 $user: the User object being authenticated against
1822 $password: the password being submitted and found wanting
1823 $retval: a LoginForm class constant with authenticateUserData() return
1824 value (SUCCESS, WRONG_PASS, etc.).
1826 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1827 Use this hook to change the Message that will be output on Special:ChangePassword.
1828 &$msg: Message object that will be shown to the user
1829 $username: Username of the user who's password was expired.
1831 'LogLine': Processes a single log entry on Special:Log.
1832 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1833 logging.log_type database field.
1834 $log_action: string for the type of log action (e.g. 'delete', 'block',
1835 'create2'). Corresponds to logging.log_action database field.
1836 $title: Title object that corresponds to logging.log_namespace and
1837 logging.log_title database fields.
1838 $paramArray: Array of parameters that corresponds to logging.log_params field.
1839 Note that only $paramArray[0] appears to contain anything.
1840 &$comment: string that corresponds to logging.log_comment database field, and
1841 which is displayed in the UI.
1842 &$revert: string that is displayed in the UI, similar to $comment.
1843 $time: timestamp of the log entry (added in 1.12)
1845 'LonelyPagesQuery': Allow extensions to modify the query used by
1846 Special:LonelyPages.
1847 &$tables: tables to join in the query
1848 &$conds: conditions for the query
1849 &$joinConds: join conditions for the query
1851 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1853 $refreshLinks: RefreshLinks object
1855 'MagicWordwgVariableIDs': When defining new magic words IDs.
1856 $variableIDs: array of strings
1858 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1859 Ideally, this hook should only be used to add variables that depend on
1860 the current page/request; static configuration should be added through
1861 ResourceLoaderGetConfigVars instead.
1862 &$vars: variable (or multiple variables) to be added into the output of
1863 Skin::makeVariablesScript
1864 $out: The OutputPage which called the hook, can be used to get the real title.
1866 'MarkPatrolled': Before an edit is marked patrolled.
1867 $rcid: ID of the revision to be marked patrolled
1868 $user: the user (object) marking the revision as patrolled
1869 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1870 sysop in order to mark an edit patrolled.
1872 'MarkPatrolledComplete': After an edit is marked patrolled.
1873 $rcid: ID of the revision marked as patrolled
1874 $user: user (object) who marked the edit patrolled
1875 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1876 sysop to patrol the edit.
1878 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1879 something completely different, after the basic globals have been set up, but
1880 before ordinary actions take place.
1882 $article: Article on which the action will be performed
1883 $title: Title on which the action will be performed
1885 $request: $wgRequest
1886 $mediaWiki: The $mediawiki object
1888 'MessagesPreLoad': When loading a message from the database.
1889 $title: title of the message (string)
1890 $message: value (string), change it to the message you want to define
1892 'MessageCache::get': When fetching a message. Can be used to override the key
1893 for customisations. Given and returned message key must be in special format:
1894 1) first letter must be in lower case according to the content language.
1895 2) spaces must be replaced with underscores
1896 &$key: message key (string)
1898 'MessageCacheReplace': When a message page is changed. Useful for updating
1900 $title: name of the page changed.
1901 $text: new contents of the page.
1903 'MimeMagicInit': Before processing the list mapping MIME types to media types
1904 and the list mapping MIME types to file extensions.
1905 As an extension author, you are encouraged to submit patches to MediaWiki's
1906 core to add new MIME types to mime.types.
1907 $mimeMagic: Instance of MimeMagic.
1908 Use $mimeMagic->addExtraInfo( $stringOfInfo );
1909 for adding new MIME info to the list.
1910 Use $mimeMagic->addExtraTypes( $stringOfTypes );
1911 for adding new MIME types to the list.
1913 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1914 MIME type detected by considering the file extension.
1915 $mimeMagic: Instance of MimeMagic.
1916 $ext: File extension.
1917 &$mime: MIME type (in/out).
1919 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1920 $mimeMagic: Instance of MimeMagic.
1921 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1922 &$tail: More or equal than last 65558 bytes of the file in a string
1923 (in - Do not alter!).
1925 &$mime: MIME type (out).
1927 'ModifyExportQuery': Modify the query used by the exporter.
1928 $db: The database object to be queried.
1929 &$tables: Tables in the query.
1930 &$conds: Conditions in the query.
1931 &$opts: Options for the query.
1932 &$join_conds: Join conditions for the query.
1934 'MovePageCheckPermissions': Specify whether the user is allowed to move the page.
1935 $oldTitle: Title object of the current (old) location
1936 $newTitle: Title object of the new location
1937 $user: User making the move
1938 $reason: string of the reason provided by the user
1939 $status: Status object to pass error messages to
1941 'MovePageIsValidMove': Specify whether a page can be moved for technical reasons.
1942 $oldTitle: Title object of the current (old) location
1943 $newTitle: Title object of the new location
1944 $status: Status object to pass error messages to
1946 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1947 and returning it for the skin to output. You can add items to the toolbox while
1948 still letting the skin make final decisions on skin-specific markup conventions
1950 &$sk: The BaseTemplate base skin template
1951 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1952 BaseTemplate::makeListItem for details on the format of individual items
1953 inside of this array.
1955 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1957 $index: Integer; the index of the namespace being checked.
1958 $result: Boolean; whether MediaWiki currently thinks that pages in this
1959 namespace are movable. Hooks may change this value to override the return
1960 value of MWNamespace::isMovable().
1962 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1964 $wikiPage: the WikiPage edited
1965 $rev: the new revision
1966 $baseID: the revision ID this was based off, if any
1967 $user: the editing user
1969 'NormalizeMessageKey': Called before the software gets the text of a message
1970 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1972 &$key: the message being looked up. Change this to something else to change
1973 what message gets displayed (string)
1974 &$useDB: whether or not to look up the message in the database (bool)
1975 &$langCode: the language code to get the message for (string) - or -
1976 whether to use the content language (true) or site language (false) (bool)
1977 &$transform: whether or not to expand variables and templates
1978 in the message (bool)
1980 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1981 return false to omit the line from RecentChanges and Watchlist special pages.
1982 &$changeslist: The OldChangesList instance.
1983 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1984 &$rc: The RecentChange object.
1985 &$classes: array of css classes for the <li> element
1987 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1988 can alter or append to the array of URLs for search & suggestion formats.
1989 &$urls: array of associative arrays with Url element attributes
1991 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1992 users and/or IP addresses too.
1993 $otherBlockLink: An array with links to other block logs
1994 $ip: The requested IP address or username
1996 'OutputPageBeforeHTML': A page has been processed by the parser and the
1997 resulting HTML is about to be displayed.
1998 $parserOutput: the parserOutput (object) that corresponds to the page
1999 $text: the text that will be displayed, in HTML (string)
2001 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
2002 body tag to allow for extensions to add attributes to the body of the page they
2003 might need. Or to allow building extensions to add body classes that aren't of
2004 high enough demand to be included in core.
2005 $out: The OutputPage which called the hook, can be used to get the real title
2006 $sk: The Skin that called OutputPage::headElement
2007 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
2009 'OutputPageCheckLastModified': when checking if the page has been modified
2010 since the last visit.
2011 &$modifiedTimes: array of timestamps.
2012 The following keys are set: page, user, epoch
2014 'OutputPageParserOutput': after adding a parserOutput to $wgOut
2015 $out: OutputPage instance (object)
2016 $parserOutput: parserOutput instance being added in $out
2018 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
2019 categories. Implementations should return false if they generate the category
2020 links, so the default link generation is skipped.
2021 $out: OutputPage instance (object)
2022 $categories: associative array, keys are category names, values are category
2023 types ("normal" or "hidden")
2024 $links: array, intended to hold the result. Must be an associative array with
2025 category types as keys and arrays of HTML links as values.
2027 'PageContentInsertComplete': After a new article is created.
2028 $wikiPage: WikiPage created
2029 $user: User creating the article
2030 $content: New content as a Content object
2031 $summary: Edit summary/comment
2032 $isMinor: Whether or not the edit was marked as minor
2033 $isWatch: (No longer used)
2034 $section: (No longer used)
2035 $flags: Flags passed to WikiPage::doEditContent()
2036 $revision: New Revision of the article
2038 'PageContentLanguage': Allows changing the language in which the content of a
2039 page is written. Defaults to the wiki content language ($wgContLang).
2040 $title: Title object
2041 &$pageLang: the page content language (either an object or a language code)
2042 $wgLang: the user language
2044 'PageContentSave': Before an article is saved.
2045 $wikiPage: the WikiPage (object) being saved
2046 $user: the user (object) saving the article
2047 $content: the new article content, as a Content object
2048 $summary: the article summary (comment)
2049 $isminor: minor flag
2050 $iswatch: watch flag
2053 'PageContentSaveComplete': After an article has been updated.
2054 $wikiPage: WikiPage modified
2055 $user: User performing the modification
2056 $content: New content, as a Content object
2057 $summary: Edit summary/comment
2058 $isMinor: Whether or not the edit was marked as minor
2059 $isWatch: (No longer used)
2060 $section: (No longer used)
2061 $flags: Flags passed to WikiPage::doEditContent()
2062 $revision: New Revision of the article (can be null for edits that change nothing)
2063 $status: Status object about to be returned by doEditContent()
2064 $baseRevId: the rev ID (or false) this edit was based on
2066 'PageHistoryBeforeList': When a history page list is about to be constructed.
2067 $article: the article that the history is loading for
2068 $context: RequestContext object
2070 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
2071 $row: the revision row for this line
2072 $s: the string representing this parsed line
2073 $classes: array containing the <li> element classes
2075 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
2078 $queryInfo: the query parameters
2080 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2081 which depends on user options should install this hook and append its values to
2083 &$confstr: reference to a hash key string which can be modified
2084 $user: User (object) requesting the page
2086 'ParserAfterParse': Called from Parser::parse() just after the call to
2087 Parser::internalParse() returns.
2088 $parser: parser object
2089 $text: text being parsed
2090 $stripState: stripState used (object)
2092 'ParserAfterStrip': Called at end of parsing time.
2093 TODO: No more strip, deprecated ?
2094 $parser: parser object
2095 $text: text being parsed
2096 $stripState: stripState used (object)
2098 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2099 $parser: Parser object being used
2100 $text: text that will be returned
2102 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2103 $parser: Parser object
2104 $text: text to parse
2105 $stripState: StripState instance being used
2107 'ParserBeforeStrip': Called at start of parsing time.
2108 TODO: No more strip, deprecated ?
2109 $parser: parser object
2110 $text: text being parsed
2111 $stripState: stripState used (object)
2113 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2114 $parser: Parser object being used
2117 'ParserClearState': Called at the end of Parser::clearState().
2118 $parser: Parser object being cleared
2120 'ParserCloned': Called when the parser is cloned.
2121 $parser: Newly-cloned Parser object
2123 'ParserFirstCallInit': Called when the parser initialises for the first time.
2124 &$parser: Parser object being cleared
2126 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2128 $parser: Parser object
2129 $varCache: array to store the value in case of multiples calls of the
2131 $index: index (string) of the magic
2132 $ret: value of the magic word (the hook should set it)
2133 $frame: PPFrame object to use for expanding any template variables
2135 'ParserGetVariableValueTs': Use this to change the value of the time for the
2136 {{LOCAL...}} magic word.
2137 $parser: Parser object
2138 $time: actual time (timestamp)
2140 'ParserGetVariableValueVarCache': use this to change the value of the variable
2141 cache or return false to not use it.
2142 $parser: Parser object
2143 $varCache: variable cache (array)
2145 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
2146 ParserLimitReportFormat instead.
2147 Called at the end of Parser:parse() when the parser will
2148 include comments about size of the text parsed.
2149 $parser: Parser object
2150 &$limitReport: text that will be included (without comment tags)
2152 'ParserLimitReportFormat': Called for each row in the parser limit report that
2153 needs formatting. If nothing handles this hook, the default is to use "$key" to
2154 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2156 $key: Key for the limit report item (string)
2157 &$value: Value of the limit report item
2158 &$report: String onto which to append the data
2159 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2160 text intended for display in a monospaced font.
2161 $localize: If false, $report should be output in English.
2163 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2164 include comments about size of the text parsed. Hooks should use
2165 $output->setLimitReportData() to populate data. Functions for this hook should
2166 not use $wgLang; do that in ParserLimitReportFormat instead.
2167 $parser: Parser object
2168 $output: ParserOutput object
2170 'ParserMakeImageParams': Called before the parser make an image link, use this
2171 to modify the parameters of the image.
2172 $title: title object representing the file
2173 $file: file object that will be used to create the image
2174 &$params: 2-D array of parameters
2175 $parser: Parser object that called the hook
2177 'ParserSectionCreate': Called each time the parser creates a document section
2178 from wikitext. Use this to apply per-section modifications to HTML (like
2179 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2180 can begin in one section and end in another. Make sure your code can handle
2181 that case gracefully. See the EditSectionClearerLink extension for an example.
2182 $parser: the calling Parser instance
2183 $section: the section number, zero-based, but section 0 is usually empty
2184 &$sectionContent: ref to the content of the section. modify this.
2185 $showEditLinks: boolean describing whether this section has an edit link
2187 'ParserTestParser': Called when creating a new instance of Parser in
2188 tests/parser/parserTest.inc.
2189 $parser: Parser object created
2191 'ParserTestGlobals': Allows to define globals for parser tests.
2192 &$globals: Array with all the globals which should be set for parser tests.
2193 The arrays keys serve as the globals names, its values are the globals values.
2195 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2196 run. Use when page save hooks require the presence of custom tables to ensure
2197 that tests continue to run properly.
2198 &$tables: array of table names
2200 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2201 my talk page, my contributions" etc).
2202 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2203 &$title: Title object representing the current page
2204 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2206 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2207 &$user : User performing the action
2208 $action : Action being performed
2209 &$result : Whether or not the action should be prevented
2210 Change $result and return false to give a definitive answer, otherwise
2211 the built-in rate limiting checks are used, if enabled.
2212 $incrBy: Amount to increment counter by
2214 'PlaceNewSection': Override placement of new sections. Return false and put the
2215 merged text into $text to override the default behavior.
2216 $wikipage : WikiPage object
2217 $oldtext : the text of the article before editing
2218 $subject : subject of the new section
2219 &$text : text of the new section
2221 'PostLoginRedirect': Modify the post login redirect behavior.
2222 Occurs after signing up or logging in, allows for interception of redirect.
2223 &$returnTo: The page name to return to, as a string
2224 &$returnToQuery: array of url parameters, mapping parameter names to values
2225 &$type: type of login redirect as string;
2226 error: display a return to link ignoring $wgRedirectOnLogin
2227 signup: display a return to link using $wgRedirectOnLogin if needed
2228 success: display a return to link using $wgRedirectOnLogin if needed
2229 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2231 'PreferencesGetLegend': Override the text used for the <legend> of a
2232 preferences section.
2233 $form: the PreferencesForm object. This is a ContextSource as well
2234 $key: the section name
2235 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2237 'PreferencesFormPreSave': Override preferences being saved
2238 $formData: array of user submitted data
2239 $form: PreferencesForm object, also a ContextSource
2240 $user: User object with preferences to be saved set
2241 &$result: boolean indicating success
2243 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2244 AJAX search suggestions. Put results into &$results outparam and return false.
2245 $ns : array of int namespace keys to search in
2246 $search : search term (not guaranteed to be conveniently normalized)
2247 $limit : maximum number of results to return
2248 &$results : out param: array of page names (strings)
2249 $offset : number of results to offset from the beginning
2251 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2252 namespace from the search string so that extensions can attempt it.
2253 $namespaces : array of int namespace keys to search in (change this if you can
2255 $search : search term (replace this with term without the namespace if you can
2258 'PrefsEmailAudit': Called when user changes their email address.
2259 $user: User (object) changing his email address
2260 $oldaddr: old email address (string)
2261 $newaddr: new email address (string)
2263 'PrefsPasswordAudit': Called when user changes his password.
2264 $user: User (object) changing his password
2265 $newPass: new password
2266 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2268 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2270 $article: the title being (un)protected
2271 $output: a string of the form HTML so far
2273 'ProtectionForm::save': Called when a protection form is submitted.
2274 $article: the Page being (un)protected
2275 &$errorMsg: an html message string of an error or an array of message name and
2277 $reasonstr: a string describing the reason page protection level is altered
2279 'ProtectionForm::showLogExtract': Called after the protection log extract is
2281 $article: the page the form is shown for
2282 $out: OutputPage object
2284 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2285 &$obj: RawAction object
2286 &$text: The text that's going to be the output
2288 'RecentChange_save': Called at the end of RecentChange::save().
2289 $recentChange: RecentChange object
2291 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2292 names such as "oldid" that are preserved when using redirecting special pages
2293 such as Special:MyPage and Special:MyTalk.
2294 &$redirectParams: An array of parameters preserved by redirecting special pages.
2296 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2297 instance. Can be used by an extension override what skin is used in certain
2299 IContextSource $context: The RequestContext the skin is being created for.
2300 &$skin: A variable reference you may set a Skin instance or string key on to
2301 override the skin that will be used for the context.
2303 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2304 $user: The user having their password expiration reset
2305 &$newExpire: The new expiration date
2307 'ResetSessionID': Called from wfResetSessionID
2308 $oldSessionID: old session id
2309 $newSessionID: new session id
2311 'ResourceLoaderGetConfigVars': Called at the end of
2312 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2313 configuration variables to JavaScript. Things that depend on the current page
2314 or request state must be added through MakeGlobalVariablesScript instead.
2315 &$vars: array( variable name => value )
2317 'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after variables
2318 from $wgResourceLoaderLESSVars are added. Can be used to add context-based variables.
2319 &$lessVars: array of variables already added
2321 'ResourceLoaderRegisterModules': Right before modules information is required,
2322 such as when responding to a resource
2323 loader request or generating HTML output.
2324 &$resourceLoader: ResourceLoader object
2326 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2327 called after the addition of 'qunit' and MediaWiki testing resources.
2328 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2329 included in core, is fed using tests/qunit/QUnitTestResources.php.
2330 &ResourceLoader object
2332 To add a new qunit module named 'myext.tests':
2333 testModules['qunit']['myext.tests'] = array(
2334 'script' => 'extension/myext/tests.js',
2335 'dependencies' => <any module dependency you might have>
2337 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2338 added to any module.
2340 'RevisionInsertComplete': Called after a revision is inserted into the database.
2341 &$revision: the Revision
2342 $data: the data stored in old_text. The meaning depends on $flags: if external
2343 is set, it's the URL of the revision text in external storage; otherwise,
2344 it's the revision text itself. In either case, if gzip is set, the revision
2346 $flags: a comma-delimited list of strings representing the options used. May
2347 include: utf8 (this will always be set for new revisions); gzip; external.
2349 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2350 the normal operations.
2351 $allSearchTerms : Array of the search terms in all content languages
2352 &$titleResult : Outparam; the value to return. A Title object or null.
2354 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2355 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2357 $term : Search term string
2358 &$title : Outparam; set to $title object and return false for a match
2360 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2361 if nothing was found.
2362 $term : Search term string
2363 &$title : Outparam; set to $title object and return false for a match
2365 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2367 $term : Search term string
2368 &$title : Current Title object that is being returned (null if none found).
2370 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2372 $title : Current Title object being displayed in search results.
2373 &$id: Revision ID (default is false, for latest)
2375 'SearchableNamespaces': An option to modify which namespaces are searchable.
2376 &$arr : Array of namespaces ($nsId => $name) which will be used.
2378 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to
2379 perform when page content is modified. Currently called by
2380 AbstractContent::getSecondaryDataUpdates.
2381 $title: Title of the page that is being edited.
2382 $oldContent: Content object representing the page's content before the edit.
2383 $recursive: bool indicating whether DataUpdates should trigger recursive
2384 updates (relevant mostly for LinksUpdate).
2385 $parserOutput: ParserOutput representing the rendered version of the page
2387 &$updates: a list of DataUpdate objects, to be modified or replaced by
2390 'SelfLinkBegin': Called before a link to the current article is displayed to
2391 allow the display of the link to be customized.
2392 $nt: the Title object
2393 &$html: html to display for the link
2394 &$trail: optional text to display before $html
2395 &$prefix: optional text to display after $html
2396 &$ret: the value to return if your hook returns false
2398 'SetupAfterCache': Called in Setup.php, after cache objects are set
2400 'ShowMissingArticle': Called when generating the output for a non-existent page.
2401 $article: The article object corresponding to the page
2403 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2404 DEPRECATED, use the ContentGetParserOutput hook instead!
2405 $text: Text being shown
2406 $title: Title of the custom script/stylesheet page
2407 $output: Current OutputPage object
2409 'ShowSearchHitTitle': Customise display of search hit title/link.
2410 &$title: Title to link to
2411 &$text: Text to use for the link
2412 $result: The search result
2413 $terms: The search terms entered
2414 $page: The SpecialSearch object.
2416 'ShowSearchHit': Customize display of search hit.
2417 $searchPage: The SpecialSearch instance.
2418 $result: The SearchResult to show
2419 $terms: Search terms, for highlighting
2420 &$link: HTML of link to the matching page. May be modified.
2421 &$redirect: HTML of redirect info. May be modified.
2422 &$section: HTML of matching section. May be modified.
2423 &$extract: HTML of content extract. May be modified.
2424 &$score: HTML of score. May be modified.
2425 &$size: HTML of page size. May be modified.
2426 &$date: HTML of of page modification date. May be modified.
2427 &$related: HTML of additional info for the matching page. May be modified.
2428 &$html: May be set to the full HTML that should be used to represent the search
2429 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2430 function returned false.
2432 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2433 allow the normal method of notice selection/rendering to work, or change the
2434 value of $siteNotice and return false to alter it.
2435 &$siteNotice: HTML returned as the sitenotice
2438 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2439 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2440 the sitenotice/anonnotice.
2443 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2445 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2446 the stock bottom scripts.
2448 'SkinAfterContent': Allows extensions to add text after the page content and
2449 article metadata. This hook should work in all skins. Set the &$data variable to
2450 the text you're going to add.
2451 &$data: (string) Text to be printed out directly (without parsing)
2454 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2456 &$bar: Sidebar contents
2457 Modify $bar to add or modify sidebar portlets.
2459 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2461 &$bar: Sidebar content
2462 Modify $bar to add or modify sidebar portlets.
2463 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2465 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2467 $title: displayed page title
2468 $type: 'normal' or 'history' for old/diff views
2469 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2470 message must be in HTML format, not wikitext!
2471 &$link: overridable HTML link to be passed into the message as $1
2472 &$forContent: overridable flag if copyright footer is shown in content language.
2473 This parameter is deprecated.
2475 'SkinEditSectionLinks': Modify the section edit links
2476 $skin: Skin object rendering the UI
2477 $title: Title object for the title being linked to (may not be the same as
2478 the page title, if the section is included from a template)
2479 $section: The designation of the section being pointed to, to be included in
2480 the link, like "§ion=$section"
2481 $tooltip: The default tooltip. Escape before using.
2482 By default, this is wrapped in the 'editsectionhint' message.
2483 &$result: Array containing all link detail arrays. Each link detail array should contain
2485 * targetTitle - Target Title object
2486 * text - String for the text
2487 * attribs - Array of attributes
2488 * query - Array of query parameters to add to the URL
2489 * options - Array of options for Linker::link
2490 $lang: The language code to use for the link in the wfMessage function
2492 'SkinGetPoweredBy': TODO
2493 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2494 the MediaWiki icon but plain text instead.
2497 'SkinPreloadExistence': Supply titles that should be added to link existence
2498 cache before the page is rendered.
2499 &$titles: Array of Title objects
2502 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2503 &$subpages: Subpage links HTML
2505 $out: OutputPage object
2506 If false is returned $subpages will be used instead of the HTML
2507 subPageSubtitle() generates.
2508 If true is returned, $subpages will be ignored and the rest of
2509 subPageSubtitle() will run.
2511 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2513 $sktemplate: SkinTemplate object
2514 $nav_urls: array of tabs
2516 'SkinTemplateGetLanguageLink': After building the data for a language link from
2517 which the actual html is constructed.
2518 &$languageLink: array containing data about the link. The following keys can be
2519 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2520 $languageLinkTitle: Title object belonging to the external language link.
2521 $title: Title object of the page the link belongs to.
2522 $outputPage: The OutputPage object the links are built from.
2524 To alter the structured navigation links in SkinTemplates, there are three
2525 hooks called in different spots:
2527 'SkinTemplateNavigation': Called on content pages after the tabs have been
2528 added, but before variants have been added.
2529 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2530 tab is added but before variants have been added.
2531 'SkinTemplateNavigation::Universal': Called on both content and special pages
2532 after variants have been added.
2533 &$sktemplate: SkinTemplate object
2534 &$links: Structured navigation links. This is used to alter the navigation for
2535 skins which use buildNavigationUrls such as Vector.
2537 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2539 &$sktemplate: SkinTemplate object
2540 &$tpl: QuickTemplate engine object
2542 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2543 $sktemplate: SkinTemplate object
2544 $res: set to true to prevent active tabs
2546 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2547 You can either create your own array, or alter the parameters for
2549 &$sktemplate: The SkinTemplate instance.
2550 $title: Title instance for the page.
2551 $message: Visible label of tab.
2552 $selected: Whether this is a selected tab.
2553 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2554 &$classes: Array of CSS classes to apply.
2555 &$query: Query string to add to link.
2557 &$result: Complete assoc. array if you want to return true.
2559 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2560 been rendered (useful for adding more).
2561 $sk: The QuickTemplate based skin template running the hook.
2562 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2563 extensions that add support for BaseTemplateToolbox should watch for this
2564 dummy parameter with "$dummy=false" in their code and return without echoing
2565 any HTML to avoid creating duplicate toolbox items.
2567 'SoftwareInfo': Called by Special:Version for returning information about the
2569 $software: The array of software in format 'name' => 'version'. See
2570 SpecialVersion::softwareInformation().
2572 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2573 $name: name of the special page
2574 &$form: HTMLForm object
2576 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2577 $sp: SpecialPage object, for context
2578 &$fields: Current HTMLForm fields
2580 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2581 $id: User id number, only provided for backwards-compatibility
2582 $user: User object representing user contributions are being fetched for
2583 $sp: SpecialPage instance, providing context
2585 'SpecialListusersDefaultQuery': Called right before the end of
2586 UsersPager::getDefaultQuery().
2587 $pager: The UsersPager instance
2588 $query: The query array to be returned
2590 'SpecialListusersFormatRow': Called right before the end of
2591 UsersPager::formatRow().
2592 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2593 $row: Database row object
2595 'SpecialListusersHeader': Called before closing the <fieldset> in
2596 UsersPager::getPageHeader().
2597 $pager: The UsersPager instance
2598 $out: The header HTML
2600 'SpecialListusersHeaderForm': Called before adding the submit button in
2601 UsersPager::getPageHeader().
2602 $pager: The UsersPager instance
2603 $out: The header HTML
2605 'SpecialListusersQueryInfo': Called right before the end of.
2606 UsersPager::getQueryInfo()
2607 $pager: The UsersPager instance
2608 $query: The query array to be returned
2610 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2611 $type: String of the log type
2612 $request: WebRequest object for getting the value provided by the current user
2613 &$qc: Array for query conditions to add
2615 'SpecialMovepageAfterMove': Called after moving a page.
2616 $movePage: MovePageForm object
2617 $oldTitle: old title (object)
2618 $newTitle: new title (object)
2620 'SpecialNewpagesConditions': Called when building sql query for
2622 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2623 $opts: FormOptions object containing special page options
2624 &$conds: array of WHERE conditionals for query
2625 &tables: array of tables to be queried
2626 &$fields: array of columns to select
2627 &$join_conds: join conditions for the tables
2629 'SpecialNewPagesFilters': Called after building form options at NewPages.
2630 $special: the special page object
2631 &$filters: associative array of filter definitions. The keys are the HTML
2632 name/URL parameters. Each key maps to an associative array with a 'msg'
2633 (message key) and a 'default' value.
2635 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2636 hook to remove a core special page.
2637 $list: list (array) of core special pages
2639 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2640 $special: the SpecialPage object
2641 $subPage: the subpage string or null if no subpage was specified
2643 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2644 $special: the SpecialPage object
2645 $subPage: the subpage string or null if no subpage was specified
2647 'SpecialPasswordResetOnSubmit': When executing a form submission on
2648 Special:PasswordReset.
2649 $users: array of User objects.
2650 $data: array of data submitted by the user
2651 &$error: string, error code (message key) used to describe to error (out
2652 parameter). The hook needs to return false when setting this, otherwise it
2653 will have no effect.
2655 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2656 use this to change some selection criteria or substitute a different title.
2657 &$randstr: The random number from wfRandom()
2658 &$isRedir: Boolean, whether to select a redirect or non-redirect
2659 &$namespaces: An array of namespace indexes to get the title from
2660 &$extra: An array of extra SQL statements
2661 &$title: If the hook returns false, a Title object to use instead of the
2662 result from the normal query
2664 'SpecialRecentChangesFilters': Called after building form options at
2665 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2666 $special: the special page object
2667 &$filters: associative array of filter definitions. The keys are the HTML
2668 name/URL parameters. Each key maps to an associative array with a 'msg'
2669 (message key) and a 'default' value.
2671 'SpecialRecentChangesPanel': Called when building form options in
2672 SpecialRecentChanges.
2673 &$extraOpts: array of added items, to which can be added
2674 $opts: FormOptions for this request
2676 'SpecialRecentChangesQuery': Called when building SQL query for
2677 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2678 ChangesListSpecialPageQuery instead.
2679 &$conds: array of WHERE conditionals for query
2680 &$tables: array of tables to be queried
2681 &$join_conds: join conditions for the tables
2682 $opts: FormOptions for this request
2683 &$query_options: array of options for the database request
2684 &$select: Array of columns to select
2686 'SpecialResetTokensTokens': Called when building token list for
2688 &$tokens: array of token information arrays in the format of
2689 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2691 'SpecialSearchCreateLink': Called when making the message to create a page or
2692 go to the existing page.
2693 $t: title object searched for
2694 &$params: an array of the default message name and page title (as parameter)
2696 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2697 target doesn't exist.
2698 &$title: title object generated from the text entered by the user
2700 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2701 the advanced form, a.k.a. power search box.
2702 &$showSections: an array to add values with more options to
2703 $term: the search term (not a title object)
2704 $opts: an array of hidden options (containing 'redirs' and 'profile')
2706 'SpecialSearchProfiles': Allows modification of search profiles.
2707 &$profiles: profiles, which can be modified.
2709 'SpecialSearchProfileForm': Allows modification of search profile forms.
2710 $search: special page object
2711 &$form: String: form html
2712 $profile: String: current search profile
2713 $term: String: search term
2714 $opts: Array: key => value of hidden options for inclusion in custom forms
2716 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2717 $search: SpecialSearch special page object
2718 $profile: String: current search profile
2719 $engine: the search engine
2721 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2722 on the search results page. Useful for including an external search
2723 provider. To disable the output of MediaWiki search output, return
2725 $specialSearch: SpecialSearch object ($this)
2727 $term: Search term specified by the user
2729 'SpecialSearchResults': Called before search result display
2730 $term: string of search term
2731 &$titleMatches: empty or SearchResultSet object
2732 &$textMatches: empty or SearchResultSet object
2734 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2735 &$extraStats: Array to save the new stats
2736 ( $extraStats['<name of statistic>'] => <value>; )
2738 'SpecialUploadComplete': Called after successfully uploading a file from
2740 $form: The SpecialUpload object
2742 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2743 $wgVersion: Current $wgVersion for you to use
2744 &$versionUrl: Raw url to link to (eg: release notes)
2746 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2747 Deprecated, use ChangesListSpecialPageFilters instead.
2748 $special: the special page object
2749 &$filters: associative array of filter definitions. The keys are the HTML
2750 name/URL parameters. Each key maps to an associative array with a 'msg'
2751 (message key) and a 'default' value.
2753 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2754 Deprecated, use ChangesListSpecialPageQuery instead.
2755 &$conds: array of WHERE conditionals for query
2756 &$tables: array of tables to be queried
2757 &$join_conds: join conditions for the tables
2758 &$fields: array of query fields
2759 $opts: A FormOptions object with watchlist options for the current request
2761 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2762 SpecialWatchlist. Allows extensions to register custom values they have
2763 inserted to rc_type so they can be returned as part of the watchlist.
2764 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2766 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2767 URL for a title when we have no other parameters on the URL. Gives a chance for
2768 extensions that alter page view behavior radically to abort that redirect or
2770 $request: WebRequest
2771 $title: Title of the currently found title obj
2772 $output: OutputPage object
2774 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2775 rendered (by ThumbnailImage:toHtml method).
2776 $thumbnail: the ThumbnailImage object
2777 &$attribs: image attribute array
2778 &$linkAttribs: image link attribute array
2780 'TitleArrayFromResult': Called when creating an TitleArray object from a
2782 &$titleArray: set this to an object to override the default object returned
2783 $res: database result used to create the object
2785 'TitleExists': Called when determining whether a page exists at a given title.
2786 $title: The title being tested.
2787 &$exists: Whether the title exists.
2789 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2790 or override the quick permissions check.
2791 $title: The Title object being accessed
2792 $user: The User performing the action
2793 $action: Action being performed
2794 &$errors: Array of errors
2795 $doExpensiveQueries: Whether to do expensive DB queries
2796 $short: Whether to return immediately on first error
2798 'TitleGetEditNotices': Allows extensions to add edit notices
2799 $title: The Title object for the page the edit notices are for
2800 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2801 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2803 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2804 that can be applied.
2805 $title: The title in question.
2806 &$types: The types of protection available.
2808 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2809 Called when determining if a page is a CSS or JS page.
2810 $title: Title object that is being checked
2811 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2812 Hooks may change this value to override the return value of
2813 Title::isCssOrJsPage().
2815 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2816 overriding default behavior for determining if a page exists. If $isKnown is
2817 kept as null, regular checks happen. If it's a boolean, this value is returned
2818 by the isKnown method.
2819 $title: Title object that is being checked
2820 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2822 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2823 that this hook is not called for interwiki pages or pages in immovable
2824 namespaces: for these, isMovable() always returns false.
2825 $title: Title object that is being checked
2826 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2827 Hooks may change this value to override the return value of
2830 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2831 Called when determining if a page is a wikitext or should
2832 be handled by separate handler (via ArticleViewCustom).
2833 $title: Title object that is being checked
2834 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2835 Hooks may change this value to override the return value of
2836 Title::isWikitextPage()
2838 'TitleMove': Before moving an article (title).
2841 $user: user who does the move
2843 'TitleMoveComplete': After moving an article (title).
2846 $user: user who did the move
2847 $pageid: database ID of the page that's been moved
2848 $redirid: database ID of the created redirect
2849 $reason: reason for the move
2851 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2852 adding the default error message if nothing allows the user to read the page. If
2853 a handler wants a title to *not* be whitelisted, it should also return false.
2854 $title: Title object being checked against
2855 $user: Current user object
2856 &$whitelisted: Boolean value of whether this title is whitelisted
2858 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2859 $title: Title object to purge
2860 &$urls: An array of URLs to purge from the caches, to be manipulated.
2862 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2863 PageArchive object has been created but before any further processing is done.
2864 &$archive: PageArchive object
2865 $title: Title object of the page that we're viewing
2867 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2868 PageArchive object has been created but before any further processing is done.
2869 &$archive: PageArchive object
2870 $title: Title object of the page that we're viewing
2872 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2873 the site is not in read-only mode, that the Title object is not null and after
2874 a PageArchive object has been constructed but before performing any further
2876 &$archive: PageArchive object
2877 $title: Title object of the page that we're about to undelete
2879 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2880 $title: title object related to the revision
2881 $rev: revision (object) that will be viewed
2883 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2885 $action: action name
2886 $article: article "acted on"
2888 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
2889 Since 1.24: Paths pointing to a directory will be recursively scanned for
2890 test case files matching the suffix "Test.php".
2891 &$paths: list of test cases and directories to search.
2893 'UnwatchArticle': Before a watch is removed from an article.
2894 $user: user watching
2895 $page: WikiPage object to be removed
2896 &$status: Status object to be returned if the hook returns false
2898 'UnwatchArticleComplete': After a watch is removed from an article.
2899 $user: user that watched
2900 $page: WikiPage object that was watched
2902 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2903 $formattedPageStatus: list of valid page states
2905 'UploadForm:initial': Before the upload form is generated. You might set the
2906 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2907 text (HTML) either before or after the editform.
2908 $form: UploadForm object
2910 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2911 poke at member variables like $mUploadDescription before the file is saved. Do
2912 not use this hook to break upload processing. This will return the user to a
2913 blank form with no error message; use UploadVerification and UploadVerifyFile
2915 $form: UploadForm object
2917 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2918 $type: (string) the requested upload type
2919 &$className: the class name of the Upload instance to be created
2921 'UploadComplete': when Upload completes an upload.
2922 &$upload: an UploadBase child instance
2924 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2926 $descriptor: (array) the HTMLForm descriptor
2928 'UploadFormSourceDescriptors': after the standard source inputs have been
2929 added to the descriptor
2930 $descriptor: (array) the HTMLForm descriptor
2932 'UploadVerification': Additional chances to reject an uploaded file. Consider
2933 using UploadVerifyFile instead.
2934 string $saveName: destination file name
2935 string $tempName: filesystem path to the temporary file for checks
2936 string &$error: output: message key for message to show if upload canceled by
2937 returning false. May also be an array, where the first element is the message
2938 key and the remaining elements are used as parameters to the message.
2940 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
2941 in most cases over UploadVerification.
2942 object $upload: an instance of UploadBase, with all info about the upload
2943 string $mime: The uploaded file's MIME type, as detected by MediaWiki. Handlers
2944 will typically only apply for specific MIME types.
2945 object &$error: output: true if the file is valid. Otherwise, an indexed array
2946 representing the problem with the file, where the first element is the message
2947 key and the remaining elements are used as parameters to the message.
2949 'UploadComplete': Upon completion of a file upload.
2950 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2951 $uploadBase->getLocalFile().
2953 'User::mailPasswordInternal': before creation and mailing of a user's new
2955 $user: the user who sent the message out
2956 $ip: IP of the user who sent the message out
2957 $u: the account whose new password will be set
2959 'UserAddGroup': Called when adding a group; return false to override
2960 stock group addition.
2961 $user: the user object that is to have a group added
2962 &$group: the group to add, can be modified
2964 'UserArrayFromResult': Called when creating an UserArray object from a database
2966 &$userArray: set this to an object to override the default object returned
2967 $res: database result used to create the object
2969 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2970 want to display an error message, try getUserPermissionsErrors.
2971 $title: Title object being checked against
2972 $user : Current user object
2973 $action: Action being checked
2974 $result: Pointer to result returned if hook returns false. If null is returned,
2975 userCan checks are continued by internal code.
2977 'UserCanSendEmail': To override User::canSendEmail() permission check.
2978 $user: User (object) whose permission is being checked
2979 &$canSend: bool set on input, can override on output
2981 'UserClearNewTalkNotification': Called when clearing the "You have new
2982 messages!" message, return false to not delete it.
2983 $user: User (object) that will clear the message
2984 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2986 'UserCreateForm': change to manipulate the login form
2987 $template: SimpleTemplate instance for the form
2989 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2990 $user: User to get groups for
2991 &$groups: Current effective groups
2993 'UserGetAllRights': After calculating a list of all available rights.
2994 &$rights: Array of rights, which may be added to.
2996 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2997 before returning the options to the caller. Warning: This hook is called for
2998 every call to User::getDefaultOptions(), which means it's potentially called
2999 dozens or hundreds of times. You may want to cache the results of non-trivial
3000 operations in your hook function for this reason.
3001 &$defaultOptions: Array of preference keys and their default values.
3003 'UserGetEmail': Called when getting an user email address.
3005 &$email: email, change this to override local email
3007 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
3008 email authentication.
3010 &$timestamp: timestamp, change this to override local email authentication
3013 'UserGetImplicitGroups': DEPRECATED, called in User::getImplicitGroups().
3014 &$groups: List of implicit (automatically-assigned) groups
3016 'UserGetLanguageObject': Called when getting user's interface language object.
3018 &$code: Language code that will be used to create the object
3019 $context: IContextSource object
3021 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
3022 &$reservedUsernames: $wgReservedUsernames
3024 'UserGetRights': Called in User::getRights().
3025 $user: User to get rights for
3026 &$rights: Current rights
3028 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
3029 specific block exemptions).
3030 $user: User in question
3031 $title: Title of the page in question
3032 &$blocked: Out-param, whether or not the user is blocked from that page.
3033 &$allowUsertalk: If the user is blocked, whether or not the block allows users
3034 to edit their own user talk pages.
3036 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
3038 $ip: User's IP address
3039 &$blocked: Whether the user is blocked, to be modified by the hook
3041 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
3042 false if a UserGetRights hook might remove the named right.
3043 $right: The user right being checked
3045 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
3046 environmental means; occurs after session is loaded.
3047 $user: user object being loaded
3049 'UserLoadDefaults': Called when loading a default user.
3053 'UserLoadFromDatabase': Called when loading a user from the database.
3055 &$s: database query object
3057 'UserLoadFromSession': Called to authenticate users on external/environmental
3058 means; occurs before session is loaded.
3059 $user: user object being loaded
3060 &$result: set this to a boolean value to abort the normal authentication
3063 'UserLoadOptions': When user options/preferences are being loaded from the
3066 &$options: Options, can be modified.
3068 'UserLoginComplete': After a user has logged in.
3069 $user: the user object that was created on login
3070 $inject_html: Any HTML to inject after the "logged in" message.
3072 'UserLoginForm': change to manipulate the login form
3073 $template: SimpleTemplate instance for the form
3075 'UserLogout': Before a user logs out.
3076 $user: the user object that is about to be logged out
3078 'UserLogoutComplete': After a user has logged out.
3079 $user: the user object _after_ logout (won't have name, ID, etc.)
3080 $inject_html: Any HTML to inject after the "logged out" message.
3081 $oldName: name of the user before logout (string)
3083 'UserRemoveGroup': Called when removing a group; return false to override stock
3085 $user: the user object that is to have a group removed
3086 &$group: the group to be removed, can be modified
3088 'UserRights': After a user's group memberships are changed.
3089 $user : User object that was changed
3090 $add : Array of strings corresponding to groups added
3091 $remove: Array of strings corresponding to groups removed
3093 'UserRequiresHTTPS': Called to determine whether a user needs
3094 to be switched to HTTPS.
3095 $user: User in question.
3096 &$https: Boolean whether $user should be switched to HTTPS.
3098 'UserResetAllOptions': Called in User::resetOptions() when user preferences
3099 have been requested to be reset. This hook can be used to exclude certain
3100 options from being reset even when the user has requested all prefs to be reset,
3101 because certain options might be stored in the user_properties database table
3102 despite not being visible and editable via Special:Preferences.
3103 $user: the User (object) whose preferences are being reset
3104 &$newOptions: array of new (site default) preferences
3105 $options: array of the user's old preferences
3106 $resetKinds: array containing the kinds of preferences to reset
3108 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
3110 $user: user retrieving new talks messages
3111 $talks: array of new talks page(s)
3113 'UserSaveSettings': Called when saving user settings.
3116 'UserSaveOptions': Called just before saving user preferences/options.
3118 &$options: Options, modifiable
3120 'UserSetCookies': Called when setting user cookies.
3122 &$session: session array, will be added to $_SESSION
3123 &$cookies: cookies array mapping cookie name to its value
3125 'UserSetEmail': Called when changing user email address.
3127 &$email: new email, change this to override new email address
3129 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3130 email authentication.
3132 &$timestamp: new timestamp, change this to override local email
3133 authentication timestamp
3135 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3136 "Foobar (Talk | Contribs | Block)".
3137 $userId: User id of the current user
3138 $userText: User name of the current user
3139 &$items: Array of user tool links as HTML fragments
3141 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3142 FormatMetadata::getExtendedMeta (return false means cache will be
3143 invalidated and GetExtendedMetadata hook called again).
3144 $timestamp: The timestamp metadata was generated
3145 $file: The file the metadata is for
3147 'UserMailerChangeReturnPath': Called to generate a VERP return address
3148 when UserMailer sends an email, with a bounce handling extension.
3149 $to: Array of MailAddress objects for the recipients
3150 &$returnPath: The return address string
3152 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid error
3153 messages. Allows to add additional error messages (except messages already in
3154 LoginForm::$validErrorMessages).
3155 &$messages Already added messages (inclusive messages from LoginForm::$validErrorMessages)
3157 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3158 used to alter the SQL query which gets the list of wanted pages.
3159 &$wantedPages: WantedPagesPage object
3160 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3162 'WatchArticle': Before a watch is added to an article.
3163 $user: user that will watch
3164 $page: WikiPage object to be watched
3165 &$status: Status object to be returned if the hook returns false
3167 'WatchArticleComplete': After a watch is added to an article.
3168 $user: user that watched
3169 $page: WikiPage object watched
3171 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3172 form, used to manipulate the list of pages or preload data based on that list.
3173 &$watchlistInfo: array of watchlisted pages in
3174 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3176 'WatchlistEditorBuildRemoveLine': when building remove lines in
3177 Special:Watchlist/edit.
3178 &$tools: array of extra links
3179 $title: Title object
3180 $redirect: whether the page is a redirect
3182 &$link: HTML link to title
3184 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3186 $router: The PathRouter instance
3188 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3189 Return false to prevent setting of the cookie.
3190 &$name: Cookie name passed to WebResponse::setcookie()
3191 &$value: Cookie value passed to WebResponse::setcookie()
3192 &$expire: Cookie expiration, as for PHP's setcookie()
3193 $options: Options passed to WebResponse::setcookie()
3195 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3196 $row: The DB row of the entry.
3197 $title: The Title of the page where the link comes FROM
3198 $target: The Title of the page where the link goes TO
3199 &$props: Array of HTML strings to display after the title.
3201 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3202 dumps. One, and only one hook should set this, and return false.
3203 &$tables: Database tables to use in the SELECT query
3204 &$opts: Options to use for the query
3205 &$join: Join conditions
3207 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3208 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3209 specific to a content model should be provided by the respective Content's
3210 getDeletionUpdates() method.
3212 $content: the Content to generate updates for
3213 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3215 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3216 run a MediaWiki cli script.
3217 &$script: MediaWiki cli script path
3218 &$parameters: Array of arguments and options to the script
3219 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3222 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3223 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3224 $qp: The list of QueryPages
3226 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3227 extra metadata to be added.
3228 $obj: The XmlDumpWriter object.
3229 &$out: The output string.
3230 $row: The database row for the page.
3231 $title: The title of the page.
3233 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3235 $obj: The XmlDumpWriter object.
3236 &$out: The text being output.
3237 $row: The database row for the revision.
3238 $text: The revision text.
3240 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3241 to add additional tags to extract.
3242 &$items: Array containing information on which items to extract. See XMPInfo for
3243 details on the format.
3245 'XMPGetResults': Called just before returning the results array of parsing xmp
3246 data. Can be used to post-process the results.
3247 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3248 is an array of metadata tags returned (each tag is either a value, or an array
3251 More hooks might be available but undocumented, you can execute
3252 "php maintenance/findHooks.php" to find hidden ones.