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 'AbortMove': Allows to abort moving an article (title).
266 $user: user who is doing the move
268 $reason: the reason for the move (added in 1.13)
270 'AbortNewAccount': Return false to cancel explicit account creation.
271 $user: the User object about to be created (read-only, incomplete)
272 &$msg: out parameter: HTML to display on abort
273 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
274 Create the object with Status::newFatal() to ensure proper API error messages
275 are returned when creating account through API clients.
277 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
278 $targetUser: the user whom to send talk page email notification
279 $title: the page title
281 'SendWatchlistEmailNotification': Return true to send watchlist email notification
282 $targetUser: the user whom to send watchlist email notification
283 $title: the page title
284 $enotif: EmailNotification object
286 'AbortChangePassword': Return false to cancel password change.
287 $user: the User object to which the password change is occuring
288 $mOldpass: the old password provided by the user
289 $newpass: the new password provided by the user
290 &$abortMsg: the message identifier for abort reason
292 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
293 $name: name of the action
294 &$form: HTMLForm object
295 $article: Article object
297 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
298 Allows to change the fields on the form that will be generated.
299 $name: name of the action
300 &$fields: HTMLForm descriptor array
301 $article: Article object
303 'AddNewAccount': After a user account is created.
304 $user: the User object that was created. (Parameter added in 1.7)
305 $byEmail: true when account was created "by email" (added in 1.12)
307 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
308 $apiModule: the ApiCreateAccount module calling
309 $loginForm: the LoginForm used
311 'AddNewAccountApiResult': Modify API output when creating a new account via API.
312 $apiModule: the ApiCreateAccount module calling
313 $loginForm: the LoginForm used
314 &$result: associative array for API result data
316 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
317 before OutputPage::sendCacheControl() and final ob_end_flush() which
318 will send the buffered output to the client. This allows for last-minute
319 modification of the output within the buffer by using ob_get_clean().
320 $output: The OutputPage object where output() was called
322 'AfterImportPage': When a page import is completed.
323 $title: Title under which the revisions were imported
324 $origTitle: Title provided by the XML file
325 $revCount: Number of revisions in the XML file
326 $sRevCount: Number of successfully imported revisions
327 $pageInfo: associative array of page information
329 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
330 just before adding its HTML to parser output.
331 $parser: Parser object that called the hook
332 $ig: Gallery, an object of one of the gallery classes (inheriting from
334 $html: HTML generated by the gallery
336 'AjaxAddScript': Called in output page just before the initialisation
337 of the javascript ajax engine. The hook is only called when ajax
338 is enabled ( $wgUseAjax = true; ).
339 &$output: OutputPage object
341 'AlternateEdit': Before checking if a user can edit a page and before showing
342 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
343 $editPage: the EditPage object
345 'AlternateEditPreview': Before generating the preview of the page when editing
346 ( EditPage::getPreviewText() ).
347 $editPage: the EditPage object
348 &$content: the Content object for the text field from the edit page
349 &$previewHTML: Text to be placed into the page for the preview
350 &$parserOutput: the ParserOutput object for the preview
351 return false and set $previewHTML and $parserOutput to output custom page
354 'AlternateUserMailer': Called before mail is sent so that mail could be logged
355 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
356 the regular method of sending mail. Return a string to return a php-mail-error
357 message containing the error. Returning true will continue with sending email
359 $headers: Associative array of headers for the email
360 $to: MailAddress object or array
362 $subject: Subject of the email
363 $body: Body of the message
365 'APIAfterExecute': After calling the execute() method of an API module. Use
366 this to extend core API modules.
367 &$module: Module object
369 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
370 &$main: ApiMain object
372 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
373 authenticate and authorize API clients before executing the module. Return
374 false and set a message to cancel the request.
375 $module: Module object
377 &$message: API usage message to die with, as a message key or array
378 as accepted by ApiBase::dieUsageMsg.
380 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
381 processing request parameters. Return false to let the request fail, returning
382 an error message or an <edit result="Failure"> tag if $resultArr was filled.
383 $editPage : the EditPage object
384 $text : the new text of the article (has yet to be saved)
385 &$resultArr : data in this array will be added to the API result
387 'APIGetAllowedParams': Use this hook to modify a module's parameters.
388 &$module: ApiBase Module object
389 &$params: Array of parameters
390 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
392 'APIGetDescription': Use this hook to modify a module's description.
393 &$module: ApiBase Module object
394 &$desc: Array of descriptions
396 'APIGetParamDescription': Use this hook to modify a module's parameter
398 &$module: ApiBase Module object
399 &$desc: Array of parameter descriptions
401 'APIGetResultProperties': Use this hook to modify the properties in a module's
403 &$module: ApiBase Module object
404 &$properties: Array of properties
406 'APIGetPossibleErrors': Use this hook to modify the module's list of possible
408 $module: ApiBase Module object
409 &$possibleErrors: Array of possible errors
411 'APIQueryAfterExecute': After calling the execute() method of an
412 action=query submodule. Use this to extend core API modules.
413 &$module: Module object
415 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
416 an action=query submodule. Use this to extend core API modules.
417 &$module: Module object
418 &$resultPageSet: ApiPageSet object
420 'APIQueryInfoTokens': Use this hook to add custom tokens to prop=info. Every
421 token has an action, which will be used in the intoken parameter and in the
422 output (actiontoken="..."), and a callback function which should return the
423 token, or false if the user isn't allowed to obtain it. The prototype of the
424 callback function is func($pageid, $title), where $pageid is the page ID of the
425 page the token is requested for and $title is the associated Title object. In
426 the hook, just add your callback to the $tokenFunctions array and return true
427 (returning false makes no sense).
428 $tokenFunctions: array(action => callback)
430 'APIQueryRevisionsTokens': Use this hook to add custom tokens to prop=revisions.
431 Every token has an action, which will be used in the rvtoken parameter and in
432 the output (actiontoken="..."), and a callback function which should return the
433 token, or false if the user isn't allowed to obtain it. The prototype of the
434 callback function is func($pageid, $title, $rev), where $pageid is the page ID
435 of the page associated to the revision the token is requested for, $title the
436 associated Title object and $rev the associated Revision object. In the hook,
437 just add your callback to the $tokenFunctions array and return true (returning
438 false makes no sense).
439 $tokenFunctions: array(action => callback)
441 'APIQueryRecentChangesTokens': Use this hook to add custom tokens to
442 list=recentchanges. Every token has an action, which will be used in the rctoken
443 parameter and in the output (actiontoken="..."), and a callback function which
444 should return the token, or false if the user isn't allowed to obtain it. The
445 prototype of the callback function is func($pageid, $title, $rc), where $pageid
446 is the page ID of the page associated to the revision the token is requested
447 for, $title the associated Title object and $rc the associated RecentChange
448 object. In the hook, just add your callback to the $tokenFunctions array and
449 return true (returning false makes no sense).
450 $tokenFunctions: array(action => callback)
452 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
453 sites general information.
454 $module: the current ApiQuerySiteInfo module
455 &$results: array of results, add things here
457 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
458 sites statistics information.
459 &$results: array of results, add things here
461 'APIQueryUsersTokens': Use this hook to add custom token to list=users. Every
462 token has an action, which will be used in the ustoken parameter and in the
463 output (actiontoken="..."), and a callback function which should return the
464 token, or false if the user isn't allowed to obtain it. The prototype of the
465 callback function is func($user) where $user is the User object. In the hook,
466 just add your callback to the $tokenFunctions array and return true (returning
467 false makes no sense).
468 $tokenFunctions: array(action => callback)
470 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
471 an exception is thrown during API action execution.
472 $apiMain: Calling ApiMain instance.
473 $e: Exception object.
475 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
476 should have its own entry in the $apis array and have a unique name, passed as
477 key for the array that represents the service data. In this data array, the
478 key-value-pair identified by the apiLink key is required.
479 &$apis: array of services
481 'ApiTokensGetTokenTypes': Use this hook to extend action=tokens with new token
483 &$tokenTypes: supported token types in format 'type' => callback function
484 used to retrieve this type of tokens.
486 'Article::MissingArticleConditions': Before fetching deletion & move log entries
487 to display a message of a non-existing page being deleted/moved, give extensions
488 a chance to hide their (unrelated) log entries.
489 &$conds: Array of query conditions (all of which have to be met; conditions will
490 AND in the final query)
491 $logTypes: Array of log types being queried
493 'ArticleAfterFetchContent': After fetching content of an article from the
494 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
495 $article: the article (object) being loaded from the database
496 &$content: the content (string) of the article
498 'ArticleAfterFetchContentObject': After fetching content of an article from the
500 $article: the article (object) being loaded from the database
501 &$content: the content of the article, as a Content object
503 'ArticleConfirmDelete': Before writing the confirmation form for article
505 $article: the article (object) being deleted
506 $output: the OutputPage object
507 &$reason: the reason (string) the article is being deleted
509 'ArticleContentOnDiff': Before showing the article content below a diff. Use
510 this to change the content in this area or how it is loaded.
511 $diffEngine: the DifferenceEngine
512 $output: the OutputPage object
514 'ArticleDelete': Before an article is deleted.
515 $wikiPage: the WikiPage (object) being deleted
516 $user: the user (object) deleting the article
517 $reason: the reason (string) the article is being deleted
518 $error: if the deletion was prohibited, the (raw HTML) error message to display
520 $status: Status object, modify this to throw an error. Overridden by $error
523 'ArticleDeleteComplete': After an article is deleted.
524 $wikiPage: the WikiPage that was deleted
525 $user: the user that deleted the article
526 $reason: the reason the article was deleted
527 $id: id of the article that was deleted
528 $content: the Content of the deleted page
529 $logEntry: the ManualLogEntry used to record the deletion
531 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
533 &$wikiPage: WikiPage (object) of the user talk page
534 $recipient: User (object) who's talk page was edited
536 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
537 article has been changed.
538 $wikiPage: the WikiPage (object)
539 $editInfo: data holder that includes the parser output ($editInfo->output) for
540 that page after the change
541 $changed: bool for if the page was changed
543 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
544 recentchanges table, return false to not delete old entries.
545 $wikiPage: WikiPage (object) being modified
547 'ArticleFromTitle': when creating an article object from a title object using
548 Wiki::articleFromTitle().
549 $title: Title (object) used to create the article object
550 $article: Article (object) that will be returned
551 $context: IContextSource (object)
553 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
554 PageContentInsertComplete.
555 $wikiPage: WikiPage created
556 $user: User creating the article
558 $summary: Edit summary/comment
559 $isMinor: Whether or not the edit was marked as minor
560 $isWatch: (No longer used)
561 $section: (No longer used)
562 $flags: Flags passed to WikiPage::doEditContent()
563 $revision: New Revision of the article
565 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
566 $targetTitle: target title (object)
567 $destTitle: destination title (object)
569 'ArticlePageDataAfter': After loading data of an article from the database.
570 $wikiPage: WikiPage (object) whose data were loaded
571 $row: row (object) returned from the database server
573 'ArticlePageDataBefore': Before loading data of an article from the database.
574 $wikiPage: WikiPage (object) that data will be loaded
575 $fields: fields (array) to load from the database
577 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
578 $wikiPage: the WikiPage being saved
579 $popts: parser options to be used for pre-save transformation
581 'ArticleProtect': Before an article is protected.
582 $wikiPage: the WikiPage being protected
583 $user: the user doing the protection
584 $protect: boolean whether this is a protect or an unprotect
585 $reason: Reason for protect
586 $moveonly: boolean whether this is for move only or not
588 'ArticleProtectComplete': After an article is protected.
589 $wikiPage: the WikiPage that was protected
590 $user: the user who did the protection
591 $protect: boolean whether it was a protect or an unprotect
592 $reason: Reason for protect
593 $moveonly: boolean whether it was for move only or not
595 'ArticlePurge': Before executing "&action=purge".
596 $wikiPage: WikiPage (object) to purge
598 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
599 revisions of an article.
600 &$title: Title object of the article
602 'ArticleRevisionUndeleted': After an article revision is restored.
603 $title: the article title
604 $revision: the revision
605 $oldPageID: the page ID of the revision when archived (may be null)
607 'ArticleRollbackComplete': After an article rollback is completed.
608 $wikiPage: the WikiPage that was edited
609 $user: the user who did the rollback
610 $revision: the revision the page was reverted back to
611 $current: the reverted revision
613 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
615 $wikiPage: the WikiPage (object) being saved
616 $user: the user (object) saving the article
617 $text: the new article text
618 $summary: the article summary (comment)
623 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
624 PageContentSaveComplete instead.
625 $wikiPage: WikiPage modified
626 $user: User performing the modification
628 $summary: Edit summary/comment
629 $isMinor: Whether or not the edit was marked as minor
630 $isWatch: (No longer used)
631 $section: (No longer used)
632 $flags: Flags passed to WikiPage::doEditContent()
633 $revision: New Revision of the article
634 $status: Status object about to be returned by doEditContent()
635 $baseRevId: the rev ID (or false) this edit was based on
637 'ArticleUndelete': When one or more revisions of an article are restored.
638 $title: Title corresponding to the article restored
639 $create: Whether or not the restoration caused the page to be created (i.e. it
640 didn't exist before).
641 $comment: The comment associated with the undeletion.
642 $oldPageId: ID of page previously deleted (from archive table)
644 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
645 $pageArchive: the PageArchive object
646 &$logEntry: ManualLogEntry object
647 $user: User who is performing the log action
649 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
650 the user is redirected back to the page.
651 &$article: the article
652 &$sectionanchor: The section anchor link (e.g. "#overview" )
653 &$extraq: Extra query parameters which can be added via hooked functions
655 'ArticleViewFooter': After showing the footer section of an ordinary page view
656 $article: Article object
657 $patrolFooterShown: boolean whether patrol footer is shown
659 'ArticleViewHeader': Before the parser cache is about to be tried for article
661 &$article: the article
662 &$pcache: whether to try the parser cache or not
663 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
664 object to both indicate that the output is done and what parser output was used.
666 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
667 redirect was followed.
668 $article: target article (object)
670 'ArticleViewCustom': Allows to output the text of the article in a different
671 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
672 that it is preferable to implement proper handing for a custom data type using
673 the ContentHandler facility.
674 $text: text of the page
675 $title: title of the page
676 $output: reference to $wgOut
678 'ArticleContentViewCustom': Allows to output the text of the article in a
679 different format than wikitext. Note that it is preferable to implement proper
680 handing for a custom data type using the ContentHandler facility.
681 $content: content of the page, as a Content object
682 $title: title of the page
683 $output: reference to $wgOut
685 'AuthPluginAutoCreate': Called when creating a local account for an user logged
686 in from an external authentication method.
687 $user: User object created locally
689 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
690 Gives a chance for an extension to set it programmatically to a variable class.
691 &$auth: the $wgAuth object, probably a stub
693 'AutopromoteCondition': Check autopromote condition for user.
694 $type: condition type
697 $result: result of checking autopromote condition
699 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
703 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
704 certain title are fetched.
706 $title: title of the page to which backlinks are sought
707 &$conds: query conditions
709 'BadImage': When checking against the bad image list. Change $bad and return
710 false to override. If an image is "bad", it is not rendered inline in wiki
711 pages or galleries in category pages.
712 $name: Image name being checked
713 &$bad: Whether or not the image is "bad"
715 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
716 custom HTML after the section. Any uses of the hook need to handle escaping.
717 $template BaseTemplate
718 $portlet: string portlet name
721 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
722 "noarticletext-nopermission" at Article::showMissingArticle().
723 $article: article object
725 'BeforeInitialize': Before anything is initialized in
726 MediaWiki::performRequest().
727 &$title: Title being used for request
729 &$output: OutputPage object
731 $request: WebRequest object
732 $mediaWiki: Mediawiki object
734 'BeforePageDisplay': Prior to outputting a page.
735 &$out: OutputPage object
738 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
739 override how the redirect is output by modifying, or by returning false, and
740 letting standard HTTP rendering take place.
741 ATTENTION: This hook is likely to be removed soon due to overall design of the system.
742 $context: IContextSource object
743 &$redirect: string URL, modifiable
745 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
746 override how the redirect is output by modifying, or by returning false and
747 taking over the output.
748 $out: OutputPage object
749 &$redirect: URL, modifiable
750 &$code: HTTP code (eg '301' or '302'), modifiable
752 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
753 $parser: Parser object
755 &$options: array of options to RepoGroup::findFile
756 &$descQuery: query string to add to thumbnail URL
758 FIXME: Where does the below sentence fit in?
759 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
761 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
762 $parser: Parser object
763 $title: title of the template
764 &$skip: skip this template and link it?
765 &$id: the id of the revision being parsed
767 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
768 &$parser: Parser object
769 &$ig: ImageGallery object
771 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
773 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
774 to a newly created user account.
775 &$injected_html: Any HTML to inject after the "logged in" message of a newly
778 'BitmapHandlerTransform': before a file is transformed, gives extension the
779 possibility to transform it themselves
780 $handler: BitmapHandler
782 &$scalerParams: Array with scaler parameters
783 &$mto: null, set to a MediaTransformOutput
785 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
786 normalizations have been performed, except for the $wgMaxImageArea check.
788 &$params: Array of parameters
789 &$checkImageAreaHookResult: null, set to true or false to override the
790 $wgMaxImageArea check result.
792 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
794 $block: Block object (which is set to be autoblocking)
795 &$blockIds: Array of block IDs of the autoblock
797 'BlockIp': Before an IP address or user is blocked.
798 $block: the Block object about to be saved
799 $user: the user _doing_ the block (not the one being blocked)
800 &$reason: if the hook is aborted, the error message to be returned in an array
802 'BlockIpComplete': After an IP address or user is blocked.
803 $block: the Block object that was saved
804 $user: the user who did the block (not the one being blocked)
806 'BookInformation': Before information output on Special:Booksources.
807 $isbn: ISBN to show information for
808 $output: OutputPage object in use
810 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
811 to be able to access the wiki via HTTPS.
812 $ip: The IP address in human-readable form
813 &$canDo: This reference should be set to false if the client may not be able
816 'CanonicalNamespaces': For extensions adding their own namespaces or altering
818 Note that if you need to specify namespace protection or content model for
819 a namespace that is added in a CanonicalNamespaces hook handler, you
820 should do so by altering $wgNamespaceProtection and
821 $wgNamespaceContentModels outside the handler, in top-level scope. The
822 point at which the CanonicalNamespaces hook fires is too late for altering
823 these variables. This applies even if the namespace addition is
824 conditional; it is permissible to declare a content model and protection
825 for a namespace and then decline to actually register it.
826 &$namespaces: Array of namespace numbers with corresponding canonical names
828 'CategoryAfterPageAdded': After a page is added to a category.
829 $category: Category that page was added to
830 $wikiPage: WikiPage that was added
832 'CategoryAfterPageRemoved': After a page is removed from a category.
833 $category: Category that page was removed from
834 $wikiPage: WikiPage that was removed
836 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
837 $catpage: CategoryPage instance
839 'ChangePasswordForm': For extensions that need to add a field to the
840 ChangePassword form via the Preferences form.
841 &$extraFields: An array of arrays that hold fields like would be passed to the
844 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
845 &$changesList: ChangesList instance.
846 &$articlelink: HTML of link to article (already filled-in).
847 &$s: HTML of row that is being constructed.
848 &$rc: RecentChange instance.
849 $unpatrolled: Whether or not we are showing unpatrolled changes.
850 $watched: Whether or not the change is watched by the user.
852 'ChangesListInitRows': Batch process change list rows prior to rendering.
853 $changesList: ChangesList instance
854 $rows: The data that will be rendered. May be a ResultWrapper instance or
857 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
858 $special: ChangesListSpecialPage instance
859 &$filters: associative array of filter definitions. The keys are the HTML
860 name/URL parameters. Each key maps to an associative array with a 'msg'
861 (message key) and a 'default' value.
863 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
864 $name: name of the special page, e.g. 'Watchlist'
865 &$tables: array of tables to be queried
866 &$fields: array of columns to select
867 &$conds: array of WHERE conditionals for query
868 &$query_options: array of options for the database request
869 &$join_conds: join conditions for the tables
870 $opts: FormOptions for this request
872 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
873 $collationName: Name of the collation in question
874 &$collationObject: Null. Replace with a subclass of the Collation class that
875 implements the collation given in $collationName.
877 'ConfirmEmailComplete': Called after a user's email has been confirmed
879 $user: user (object) whose email is being confirmed
881 'ContentHandlerDefaultModelFor': Called when the default content model is determined
882 for a given title. May be used to assign a different model for that title.
883 $title: the Title in question
884 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
886 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
887 content model name, but no entry for that model exists in $wgContentHandlers.
888 $modeName: the requested content model name
889 &$handler: set this to a ContentHandler object, if desired.
891 'ContentModelCanBeUsedOn': Called to determine whether that content model can
892 be used on a given page. This is especially useful to prevent some content models
893 to be used in some special location.
894 $contentModel: ID of the content model in question
895 $title: the Title in question.
896 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
897 Handler functions that modify $ok should generally return false to prevent further
898 hooks from further modifying $ok.
900 'ContentGetParserOutput': Customize parser output for a given content object,
901 called by AbstractContent::getParserOutput. May be used to override the normal
902 model-specific rendering of page content.
903 $content: The Content to render
904 $title: Title of the page, as context
905 $revId: The revision ID, as context
906 $options: ParserOptions for rendering. To avoid confusing the parser cache,
907 the output can only depend on parameters provided to this hook function, not on global state.
908 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
909 generation of HTML may be skipped, but other information should still be present in the
911 &$output: ParserOutput, to manipulate or replace
913 'ConvertContent': Called by AbstractContent::convert when a conversion to another
914 content model is requested.
915 $content: The Content object to be converted.
916 $toModel: The ID of the content model to convert to.
917 $lossy: boolean indicating whether lossy conversion is allowed.
918 &$result: Output parameter, in case the handler function wants to provide a
919 converted Content object. Note that $result->getContentModel() must return $toModel.
920 Handler functions that modify $result should generally return false to further
921 attempts at conversion.
923 'ContribsPager::getQueryInfo': Before the contributions query is about to run
924 &$pager: Pager object for contributions
925 &$queryInfo: The query for the contribs Pager
927 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
928 &$data: an array of results of all contribs queries
929 $pager: The ContribsPager object hooked into
930 $offset: Index offset, inclusive
931 $limit: Exact query limit
932 $descending: Query direction, false for ascending, true for descending
934 'ContributionsLineEnding': Called before a contributions HTML line is finished
935 $page: SpecialPage object for contributions
937 $row: the DB row for this line
938 &$classes: the classes to add to the surrounding <li>
940 'ContributionsToolLinks': Change tool links above Special:Contributions
942 $title: User page title
943 &$tools: Array of tool links
945 'CustomEditor': When invoking the page editor
946 $article: Article being edited
947 $user: User performing the edit
949 Return true to allow the normal editor to be used, or false
950 if implementing a custom editor, e.g. for a special namespace,
953 'DatabaseOraclePostInit': Called after initialising an Oracle database
954 &$db: the DatabaseOracle object
956 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
957 $title: the diff page title (nullable)
958 &$oldId: the actual old Id to use in the diff
959 &$newId: the actual new Id to use in the diff (0 means current)
960 $old: the ?old= param value from the url
961 $new: the ?new= param value from the url
963 'DiffRevisionTools': Override or extend the revision tools available from the
964 diff view, i.e. undo, etc.
965 $newRev: Revision object of the "new" revision
966 &$links: Array of HTML links
967 $oldRev: Revision object of the "old" revision (may be null)
969 'DiffViewHeader': Called before diff display
970 $diff: DifferenceEngine object that's calling
971 $oldRev: Revision object of the "old" revision (may be null/invalid)
972 $newRev: Revision object of the "new" revision
974 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
976 $article: article (object) being viewed
977 $oldid: oldid (int) being viewed
979 'DoEditSectionLink': Override the HTML generated for section edit links
980 $skin: Skin object rendering the UI
981 $title: Title object for the title being linked to (may not be the same as
982 the page title, if the section is included from a template)
983 $section: The designation of the section being pointed to, to be included in
984 the link, like "§ion=$section"
985 $tooltip: The default tooltip. Escape before using.
986 By default, this is wrapped in the 'editsectionhint' message.
987 &$result: The HTML to return, prefilled with the default plus whatever other
988 changes earlier hooks have made
989 $lang: The language code to use for the link in the wfMessage function
991 'EditFilter': Perform checks on an edit
992 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
993 $text: Contents of the edit box
994 $section: Section being edited
995 &$error: Error message to return
996 $summary: Edit summary for page
998 'EditFilterMerged': Post-section-merge edit filter.
999 DEPRECATED, use EditFilterMergedContent instead.
1000 $editor: EditPage instance (object)
1001 $text: content of the edit box
1002 &$error: error message to return
1003 $summary: Edit summary for page
1005 'EditFilterMergedContent': Post-section-merge edit filter.
1006 This may be triggered by the EditPage or any other facility that modifies page content.
1007 Use the $status object to indicate whether the edit should be allowed, and to provide
1008 a reason for disallowing it. Return false to abort the edit, and true to continue.
1009 Returning true if $status->isOK() returns false means "don't save but continue user
1010 interaction", e.g. show the edit form.
1011 $context: object implementing the IContextSource interface.
1012 $content: content of the edit box, as a Content object.
1013 $status: Status object to represent errors, etc.
1014 $summary: Edit summary for page
1015 $user: the User object representing the user whois performing the edit.
1016 $minoredit: whether the edit was marked as minor by the user.
1018 'EditFormPreloadText': Allows population of the edit form when creating
1020 &$text: Text to preload with
1021 &$title: Title object representing the page being created
1023 'EditFormInitialText': Allows modifying the edit form when editing existing
1025 $editPage: EditPage object
1027 'EditPage::attemptSave': Called before an article is
1028 saved, that is before WikiPage::doEditContent() is called
1029 $editpage_Obj: the current EditPage object
1031 'EditPage::importFormData': allow extensions to read additional data
1033 $editpage: EditPage instance
1034 $request: Webrequest
1035 return value is ignored (should always return true)
1037 'EditPage::showEditForm:fields': allows injection of form field into edit form
1038 $editor: the EditPage instance for reference
1039 $out: an OutputPage instance to write to
1040 return value is ignored (should always return true)
1042 'EditPage::showEditForm:initial': before showing the edit form
1043 $editor: EditPage instance (object)
1044 $out: an OutputPage instance to write to
1046 Return false to halt editing; you'll need to handle error messages, etc.
1047 yourself. Alternatively, modifying $error and returning true will cause the
1048 contents of $error to be echoed at the top of the edit form as wikitext.
1049 Return true without altering $error to allow the edit to proceed.
1051 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1052 but for the read-only 'view source' variant of the edit form.
1053 $editor: EditPage instance (object)
1054 &$out: an OutputPage instance to write to
1055 return value is ignored (should always return true)
1057 'EditPage::showStandardInputs:options': allows injection of form fields into
1058 the editOptions area
1059 $editor: EditPage instance (object)
1060 $out: an OutputPage instance to write to
1061 &$tabindex: HTML tabindex of the last edit check/button
1062 return value is ignored (should always be true)
1064 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1065 when there's an edit conflict. Return false to halt normal diff output; in
1066 this case you're responsible for computing and outputting the entire "conflict"
1067 part, i.e., the "difference between revisions" and "your text" headers and
1069 &$editor: EditPage instance
1070 &$out: OutputPage instance
1072 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1073 textarea in the edit form.
1074 &$editpage: The current EditPage object
1075 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1076 &$tabindex: HTML tabindex of the last edit check/button
1078 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1080 &$editpage: The current EditPage object
1081 &$checks: Array of edit checks like "watch this page"/"minor edit"
1082 &$tabindex: HTML tabindex of the last edit check/button
1084 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1085 textarea in the edit form.
1086 &$toolbar: The toolbar HTMl
1088 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1089 contribution/copyright notice.
1090 $title: title of page being edited
1091 &$msg: localization message name, overridable. Default is either
1092 'copyrightwarning' or 'copyrightwarning2'.
1094 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1095 modifying the wikitext that will be used in "Show changes". Note that it is
1096 preferable to implement diff handling for different data types using the
1097 ContentHandler facility.
1098 $editPage: EditPage object
1099 &$newtext: wikitext that will be used as "your version"
1101 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1102 "Show changes". Note that it is preferable to implement diff handling for
1103 different data types using the ContentHandler facility.
1104 $editPage: EditPage object
1105 &$newtext: wikitext that will be used as "your version"
1107 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1108 Allow modifying the wikitext that will be previewed. Note that it is preferable
1109 to implement previews for different data types using the ContentHandler
1111 $editPage: EditPage object
1112 &$toparse: wikitext that will be parsed
1114 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1115 previewed. Note that it is preferable to implement previews for different data
1116 types using the ContentHandler facility.
1117 $editPage: EditPage object
1118 &$content: Content object to be previewed (may be replaced by hook function)
1120 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1121 &$editpage: The current EditPage object
1122 &$res: the HTML of the error text
1124 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1125 of terms of service summary link that might exist separately from the copyright
1127 $title: title of page being edited
1128 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1130 'EmailConfirmed': When checking that the user's email address is "confirmed".
1131 $user: User being checked
1132 $confirmed: Whether or not the email address is confirmed
1133 This runs before the other checks, such as anonymity and the real check; return
1134 true to allow those checks to occur, and false if checking is done.
1136 'EmailUser': Before sending email from one user to another.
1137 $to: address of receiving user
1138 $from: address of sending user
1139 $subject: subject of the mail
1140 $text: text of the mail
1142 'EmailUserCC': Before sending the copy of the email to the author.
1143 $to: address of receiving user
1144 $from: address of sending user
1145 $subject: subject of the mail
1146 $text: text of the mail
1148 'EmailUserComplete': After sending email from one user to another.
1149 $to: address of receiving user
1150 $from: address of sending user
1151 $subject: subject of the mail
1152 $text: text of the mail
1154 'EmailUserForm': After building the email user form object.
1155 $form: HTMLForm object
1157 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1159 $user: The user who is trying to email another user.
1160 $editToken: The user's edit token.
1161 &$hookErr: Out-param for the error. Passed as the parameters to
1162 OutputPage::showErrorPage.
1164 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1166 $ip: The ip address of the user
1168 'ExtensionTypes': Called when generating the extensions credits, use this to
1169 change the tables headers.
1170 &$extTypes: associative array of extensions types
1172 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1173 thumbnail file name.
1174 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1175 $thumbname: the base name of the thumbnail file
1176 &$params: the currently extracted params (has source name, temp or archived zone)
1178 'FetchChangesList': When fetching the ChangesList derivative for a particular
1180 $user: User the list is being fetched for
1181 &$skin: Skin object to be used with the list
1182 &$list: List object (defaults to NULL, change it to an object instance and
1183 return false override the list derivative used)
1185 'FileDeleteComplete': When a file is deleted.
1186 $file: reference to the deleted file
1187 $oldimage: in case of the deletion of an old image, the name of the old file
1188 $article: in case all revisions of the file are deleted a reference to the
1189 WikiFilePage associated with the file.
1190 $user: user who performed the deletion
1193 'FileTransformed': When a file is transformed and moved into storage.
1194 $file: reference to the File object
1195 $thumb: the MediaTransformOutput object
1196 $tmpThumbPath: The temporary file system path of the transformed file
1197 $thumbPath: The permanent storage path of the transformed file
1199 'FileUpload': When a file upload occurs.
1200 $file : Image object representing the file that was uploaded
1201 $reupload : Boolean indicating if there was a previously another image there or
1203 $hasDescription : Boolean indicating that there was already a description page
1204 and a new one from the comment wasn't created (since 1.17)
1206 'FileUndeleteComplete': When a file is undeleted
1207 $title: title object to the file
1208 $fileVersions: array of undeleted versions. Empty if all versions were restored
1209 $user: user who performed the undeletion
1212 'FormatAutocomments': When an autocomment is formatted by the Linker.
1213 &$comment: Reference to the accumulated comment. Initially null, when set the
1214 default code will be skipped.
1215 $pre: Initial part of the parsed comment before the call to the hook.
1216 $auto: The extracted part of the parsed comment before the call to the hook.
1217 $post: The final part of the parsed comment before the call to the hook.
1218 $title: An optional title object used to links to sections. Can be null.
1219 $local: Boolean indicating whether section links should refer to local page.
1221 'GalleryGetModes': Get list of classes that can render different modes of a
1223 $modeArray: An associative array mapping mode names to classes that implement
1224 that mode. It is expected all registered classes are a subclass of
1227 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1229 &$user: user to promote.
1230 &$promote: groups that will be added.
1232 'GetBlockedStatus': after loading blocking status of an user from the database
1233 $user: user (object) being checked
1235 'GetCacheVaryCookies': Get cookies that should vary cache options.
1236 $out: OutputPage object
1237 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1238 that have to vary cache options
1240 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1242 $title: Title object of page
1243 $url: string value as output (out parameter, can modify)
1244 $query: query options passed to Title::getCanonicalURL()
1246 'GetDefaultSortkey': Override the default sortkey for a page.
1247 $title: Title object that we need to get a sortkey for
1248 &$sortkey: Sortkey to use.
1250 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1251 underscore) magic words. Called by MagicWord.
1252 &$doubleUnderscoreIDs: array of strings
1254 'GetExtendedMetadata': Get extended file metadata for the API
1255 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1256 'value' => prop value, 'source' => 'name of hook' ).
1257 $file: File object of file in question
1258 $context: RequestContext (including language to use)
1259 $single: Only extract the current language; if false, the prop value should
1260 be in the metadata multi-language array format:
1261 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1262 &$maxCacheTime: how long the results can be cached
1264 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1265 $title: Title object of page
1266 $url: string value as output (out parameter, can modify)
1267 $query: query options passed to Title::getFullURL()
1269 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1270 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1272 &$output: string for the output timestamp
1273 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1274 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1275 $user: User whose preferences are being used to make timestamp
1276 $lang: Language that will be used to render the timestamp
1278 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1279 $title: Title object of page
1280 $url: string value as output (out parameter, can modify)
1281 $query: query options passed to Title::getInternalURL()
1283 'GetIP': modify the ip of the current user (called only once).
1284 &$ip: string holding the ip as determined so far
1286 'GetLinkColours': modify the CSS class of an array of page links.
1287 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1289 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1291 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1292 working with internal urls (non-interwiki) then it may be preferable to work
1293 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1294 be buggy for internal urls on render if you do not re-implement the horrible
1295 hack that Title::getLocalURL uses in your own extension.
1296 $title: Title object of page
1297 &$url: string value as output (out parameter, can modify)
1298 $query: query options passed to Title::getLocalURL()
1300 'GetLocalURL::Internal': Modify local URLs to internal pages.
1301 $title: Title object of page
1302 &$url: string value as output (out parameter, can modify)
1303 $query: query options passed to Title::getLocalURL()
1305 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1306 without any fancy queries or variants.
1307 $title: Title object of page
1308 &$url: string value as output (out parameter, can modify)
1310 'GetLogTypesOnUser': Add log types where the target is a userpage
1311 &$types: Array of log types
1313 'GetMetadataVersion': Modify the image metadata version currently in use. This
1314 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1315 that need to have versioned metadata should add an element to the end of the
1316 version array of the form 'handler_name=version'. Most media handlers won't need
1317 to do this unless they broke backwards compatibility with a previous version of
1318 the media handler metadata output.
1319 &$version: Array of version strings
1321 'GetNewMessagesAlert': Disable or modify the new messages alert
1322 &$newMessagesAlert: An empty string by default. If the user has new talk page
1323 messages, this should be populated with an alert message to that effect
1324 $newtalks: An empty array if the user has no new messages or an array containing
1325 links and revisions if there are new messages (See User::getNewMessageLinks)
1326 $user: The user object of the user who is loading the page
1327 $out: OutputPage object (to check what type of page the user is on)
1329 'GetPreferences': Modify user preferences.
1330 $user: User whose preferences are being modified.
1331 &$preferences: Preferences description array, to be fed to an HTMLForm object
1333 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1334 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1336 &$output: string for the output timestamp
1337 &$diff: DateInterval representing the difference between the timestamps
1338 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1339 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1340 $user: User whose preferences are being used to make timestamp
1341 $lang: Language that will be used to render the timestamp
1343 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1344 checked for. Use instead of userCan for most cases. Return false if the user
1345 can't do it, and populate $result with the reason in the form of
1346 array( messagename, param1, param2, ... ). For consistency, error messages
1347 should be plain text with no special coloring, bolding, etc. to show that
1348 they're errors; presenting them properly to the user as errors is done by the
1350 $title: Title object being checked against
1351 $user : Current user object
1352 $action: Action being checked
1353 $result: User permissions error to add. If none, return true.
1355 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1356 called only if expensive checks are enabled. Add a permissions error when
1357 permissions errors are checked for. Return false if the user can't do it, and
1358 populate $result with the reason in the form of array( messagename, param1,
1359 param2, ... ). For consistency, error messages should be plain text with no
1360 special coloring, bolding, etc. to show that they're errors; presenting them
1361 properly to the user as errors is done by the caller.
1363 $title: Title object being checked against
1364 $user : Current user object
1365 $action: Action being checked
1366 $result: User permissions error to add. If none, return true.
1368 'GitViewers': Called when generating the list of git viewers for
1369 Special:Version, use this to change the list.
1370 &$extTypes: associative array of repo URLS to viewer URLs.
1372 'HistoryRevisionTools': Override or extend the revision tools available from the
1373 page history view, i.e. undo, rollback, etc.
1374 $rev: Revision object
1375 &$links: Array of HTML links
1377 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1378 image insertion. You can skip the default logic entirely by returning false, or
1379 just modify a few things using call-by-reference.
1381 &$title: Title object of the image
1382 &$file: File object, or false if it doesn't exist
1383 &$frameParams: Various parameters with special meanings; see documentation in
1384 includes/Linker.php for Linker::makeImageLink
1385 &$handlerParams: Various parameters with special meanings; see documentation in
1386 includes/Linker.php for Linker::makeImageLink
1387 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1388 &$res: Final HTML output, used if you return false
1391 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1392 the image on an image page.
1393 $imagePage: ImagePage object ($this)
1396 'ImagePageAfterImageLinks': Called after the image links section on an image
1398 $imagePage: ImagePage object ($this)
1399 &$html: HTML for the hook to add
1401 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1403 $line: the HTML of the history line
1404 $css: the line CSS class
1406 'ImagePageFindFile': Called when fetching the file associated with an image
1408 $page: ImagePage object
1410 &$displayFile: displayed File object
1412 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1413 $page: ImagePage object
1414 &$toc: Array of <li> strings
1416 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1418 &$title: the Title object of the file as it would appear for the upload page
1419 &$path: the original file and path name when img_auth was invoked by the the web
1421 &$name: the name only component of the file
1422 &$result: The location to pass back results of the hook routine (only used if
1424 $result[0]=The index of the header message
1425 $result[1]=The index of the body text message
1426 $result[2 through n]=Parameters passed to body text message. Please note the
1427 header message cannot receive/use parameters.
1429 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1430 $reader: XMLReader object
1431 $logInfo: Array of information
1432 Return false to stop further processing of the tag
1434 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1435 $reader: XMLReader object
1436 $pageInfo: Array of information
1437 Return false to stop further processing of the tag
1439 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1440 $reader: XMLReader object
1441 $pageInfo: Array of page information
1442 $revisionInfo: Array of revision information
1443 Return false to stop further processing of the tag
1445 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1446 $reader: XMLReader object
1447 Return false to stop further processing of the tag
1449 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1450 $reader: XMLReader object
1451 $revisionInfo: Array of information
1452 Return false to stop further processing of the tag
1454 'InfoAction': When building information to display on the action=info page.
1455 $context: IContextSource object
1456 &$pageInfo: Array of information
1458 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1459 $title: Title object for the current page
1460 $request: WebRequest
1461 $ignoreRedirect: boolean to skip redirect check
1462 $target: Title/string of redirect target
1463 $article: Article object
1465 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1466 Return true without providing an interwiki to continue interwiki search.
1467 $prefix: interwiki prefix we are looking for.
1468 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1469 iw_trans and optionally iw_api and iw_wikiid.
1471 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1472 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1473 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1474 template/parser function execution which respect nowiki and HTML-comments.
1475 &$parser: Parser object
1476 &$text: string containing partially parsed text
1477 &$stripState: Parser's internal StripState object
1479 'InternalParseBeforeLinks': during Parser's internalParse method before links
1480 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1481 &$parser: Parser object
1482 &$text: string containing partially parsed text
1483 &$stripState: Parser's internal StripState object
1485 'InvalidateEmailComplete': Called after a user's email has been invalidated
1487 $user: user (object) whose email is being invalidated
1489 'IRCLineURL': When constructing the URL to use in an IRC notification.
1490 Callee may modify $url and $query, URL will be constructed as $url . $query
1491 &$url: URL to index.php
1492 &$query: Query string
1493 $rc: RecentChange object that triggered url generation
1495 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1496 $article: article (object) being checked
1498 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1500 $result: Change this value to override the result of wfIsTrustedProxy()
1502 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1503 $url: URL used to upload from
1504 &$allowed: Boolean indicating if uploading is allowed for given URL
1506 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1507 instance to return false if the domain name doesn't match your organization.
1508 $addr: The e-mail address entered by the user
1509 &$result: Set this and return false to override the internal checks
1511 'isValidPassword': Override the result of User::isValidPassword()
1512 $password: The password entered by the user
1513 &$result: Set this and return false to override the internal checks
1514 $user: User the password is being validated for
1516 'Language::getMessagesFileName':
1517 $code: The language code or the language we're looking for a messages file for
1518 &$file: The messages file path, you can override this to change the location.
1520 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1521 remove namespaces. Do not use this hook to add namespaces. Use
1522 CanonicalNamespaces for that.
1523 &$namespaces: Array of namespaces indexed by their numbers
1525 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1526 $wgExtensionMessagesFiles instead.
1527 Use this to define synonyms of magic words depending of the language
1528 $magicExtensions: associative array of magic words synonyms
1529 $lang: language code (string)
1531 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1532 listed in $wgExtensionMessagesFiles instead.
1533 Use to define aliases of special pages names depending of the language
1534 $specialPageAliases: associative array of magic words synonyms
1535 $lang: language code (string)
1537 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1538 &$names: array of language code => language name
1539 $code language of the preferred translations
1541 'LanguageLinks': Manipulate a page's language links. This is called
1542 in various places to allow extensions to define the effective language
1544 $title: The page's Title.
1545 &$links: Associative array mapping language codes to prefixed links of the
1546 form "language:title".
1547 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1548 Currently unused, but planned to provide support for marking individual
1549 language links in the UI, e.g. for featured articles.
1551 'LinkBegin': Used when generating internal and interwiki links in
1552 Linker::link(), before processing starts. Return false to skip default
1553 processing and return $ret. See documentation for Linker::link() for details on
1554 the expected meanings of parameters.
1555 $skin: the Skin object
1556 $target: the Title that the link is pointing to
1557 &$html: the contents that the <a> tag should have (raw HTML); null means
1559 &$customAttribs: the HTML attributes that the <a> tag should have, in
1560 associative array form, with keys and values unescaped. Should be merged with
1561 default values, with a value of false meaning to suppress the attribute.
1562 &$query: the query string to add to the generated URL (the bit after the "?"),
1563 in associative array form, with keys and values unescaped.
1564 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1565 &$ret: the value to return if your hook returns false.
1567 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1568 just before the function returns a value. If you return true, an <a> element
1569 with HTML attributes $attribs and contents $html will be returned. If you
1570 return false, $ret will be returned.
1571 $skin: the Skin object
1572 $target: the Title object that the link is pointing to
1573 $options: the options. Will always include either 'known' or 'broken', and may
1574 include 'noclasses'.
1575 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1576 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1577 associative array form.
1578 &$ret: the value to return if your hook returns false.
1580 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1582 &$url: the image url
1583 &$alt: the image's alt text
1584 &$img: the new image HTML (if returning false)
1586 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1589 &$text: the link text
1590 &$link: the new link HTML (if returning false)
1591 &$attribs: the attributes to be applied.
1592 $linkType: The external link type
1594 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1596 $title: the Title object that the link is pointing to
1597 $file: the File object or false if broken link
1598 &$html: the link text
1599 &$attribs: the attributes to be applied
1600 &$ret: the value to return if your hook returns false
1602 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1604 &$linksUpdate: the LinksUpdate object
1606 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1607 each link table insert. For example, pagelinks, imagelinks, externallinks.
1608 $linksUpdate: LinksUpdate object
1609 $table: the table to insert links to
1610 $insertions: an array of links to insert
1612 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1613 including delete and insert, has completed for all link tables
1614 &$linksUpdate: the LinksUpdate object
1616 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1617 &$linksUpdate: the LinksUpdate object
1619 'ListDefinedTags': When trying to find all defined tags.
1620 &$tags: The list of tags.
1622 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1623 &updater: A DatabaseUpdater subclass
1625 'LocalFile::getHistory': Called before file history query performed.
1626 $file: the File object
1628 $fields: select fields
1630 $opts: query options
1631 $join_conds: JOIN conditions
1633 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1634 $file: the File object
1635 $archiveName: name of an old file version or false if it's the current one
1637 'LocalisationCacheRecache': Called when loading the localisation data into
1639 $cache: The LocalisationCache object
1640 $code: language code
1641 &$alldata: The localisation data from core and extensions
1642 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1644 'LocalisationChecksBlacklist': When fetching the blacklist of
1645 localisation checks.
1646 &$blacklist: array of checks to blacklist. See the bottom of
1647 maintenance/language/checkLanguage.inc for the format of this variable.
1649 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1650 optional localisation messages
1651 &$ignored Array of ignored message keys
1652 &$optional Array of optional message keys
1654 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1655 Returning false will prevent the string from being added to the OutputPage.
1656 &$s: html string to show for the log extract
1657 $types: String or Array Log types to show
1658 $page: String or Title The page title to show log entries for
1659 $user: String The user who made the log entries
1660 $param: Associative Array with the following additional options:
1661 - lim Integer Limit of items to show, default is 50
1662 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1663 - showIfEmpty boolean Set to false if you don't want any output in case the
1664 loglist is empty if set to true (default), "No matching items in log" is
1665 displayed if loglist is empty
1666 - msgKey Array If you want a nice box with a message, set this to the key of
1667 the message. First element is the message key, additional optional elements
1668 are parameters for the key that are processed with
1669 wfMessage()->params()->parseAsBlock()
1670 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1672 - wrap String Wrap the message in html (usually something like
1673 "<div ...>$1</div>").
1674 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1676 'LoginAuthenticateAudit': A login attempt for a valid user account either
1677 succeeded or failed. No return data is accepted; this hook is for auditing only.
1678 $user: the User object being authenticated against
1679 $password: the password being submitted and found wanting
1680 $retval: a LoginForm class constant with authenticateUserData() return
1681 value (SUCCESS, WRONG_PASS, etc.).
1683 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1684 Use this hook to change the Message that will be output on Special:ChangePassword.
1685 &$msg: Message object that will be shown to the user
1686 $username: Username of the user who's password was expired.
1688 'LogLine': Processes a single log entry on Special:Log.
1689 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1690 logging.log_type database field.
1691 $log_action: string for the type of log action (e.g. 'delete', 'block',
1692 'create2'). Corresponds to logging.log_action database field.
1693 $title: Title object that corresponds to logging.log_namespace and
1694 logging.log_title database fields.
1695 $paramArray: Array of parameters that corresponds to logging.log_params field.
1696 Note that only $paramArray[0] appears to contain anything.
1697 &$comment: string that corresponds to logging.log_comment database field, and
1698 which is displayed in the UI.
1699 &$revert: string that is displayed in the UI, similar to $comment.
1700 $time: timestamp of the log entry (added in 1.12)
1702 'LonelyPagesQuery': Allow extensions to modify the query used by
1703 Special:LonelyPages.
1704 &$tables: tables to join in the query
1705 &$conds: conditions for the query
1706 &$joinConds: join conditions for the query
1708 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1710 $refreshLinks: RefreshLinks object
1712 'MagicWordwgVariableIDs': When defining new magic words IDs.
1713 $variableIDs: array of strings
1715 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1716 Ideally, this hook should only be used to add variables that depend on
1717 the current page/request; static configuration should be added through
1718 ResourceLoaderGetConfigVars instead.
1719 &$vars: variable (or multiple variables) to be added into the output of
1720 Skin::makeVariablesScript
1721 $out: The OutputPage which called the hook, can be used to get the real title.
1723 'MarkPatrolled': Before an edit is marked patrolled.
1724 $rcid: ID of the revision to be marked patrolled
1725 $user: the user (object) marking the revision as patrolled
1726 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1727 sysop in order to mark an edit patrolled.
1729 'MarkPatrolledComplete': After an edit is marked patrolled.
1730 $rcid: ID of the revision marked as patrolled
1731 $user: user (object) who marked the edit patrolled
1732 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1733 sysop to patrol the edit.
1735 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1736 something completely different, after the basic globals have been set up, but
1737 before ordinary actions take place.
1739 $article: Article on which the action will be performed
1740 $title: Title on which the action will be performed
1742 $request: $wgRequest
1743 $mediaWiki: The $mediawiki object
1745 'MessagesPreLoad': When loading a message from the database.
1746 $title: title of the message (string)
1747 $message: value (string), change it to the message you want to define
1749 'MessageCache::get': When fetching a message. Can be used to override the key
1750 for customisations. Given and returned message key must be in special format:
1751 1) first letter must be in lower case according to the content language.
1752 2) spaces must be replaced with underscores
1753 &$key: message key (string)
1755 'MessageCacheReplace': When a message page is changed. Useful for updating
1757 $title: name of the page changed.
1758 $text: new contents of the page.
1760 'MimeMagicInit': Before processing the list mapping MIME types to media types
1761 and the list mapping MIME types to file extensions.
1762 As an extension author, you are encouraged to submit patches to MediaWiki's
1763 core to add new MIME types to mime.types.
1764 $mimeMagic: Instance of MimeMagic.
1765 Use $mimeMagic->addExtraInfo( $stringOfInfo );
1766 for adding new MIME info to the list.
1767 Use $mimeMagic->addExtraTypes( $stringOfTypes );
1768 for adding new MIME types to the list.
1770 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1771 MIME type detected by considering the file extension.
1772 $mimeMagic: Instance of MimeMagic.
1773 $ext: File extension.
1774 &$mime: MIME type (in/out).
1776 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1777 $mimeMagic: Instance of MimeMagic.
1778 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1779 &$tail: More or equal than last 65558 bytes of the file in a string
1780 (in - Do not alter!).
1782 &$mime: MIME type (out).
1784 'ModifyExportQuery': Modify the query used by the exporter.
1785 $db: The database object to be queried.
1786 &$tables: Tables in the query.
1787 &$conds: Conditions in the query.
1788 &$opts: Options for the query.
1789 &$join_conds: Join conditions for the query.
1791 'MonoBookTemplateToolboxEnd': DEPRECATED. Called by Monobook skin after toolbox
1792 links have been rendered (useful for adding more). Note: this is only run for
1793 the Monobook skin. To add items to the toolbox you should use the
1794 SkinTemplateToolboxEnd hook instead, which works for all "SkinTemplate"-type
1796 $tools: array of tools
1798 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1799 and returning it for the skin to output. You can add items to the toolbox while
1800 still letting the skin make final decisions on skin-specific markup conventions
1802 &$sk: The BaseTemplate base skin template
1803 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1804 BaseTemplate::makeListItem for details on the format of individual items
1805 inside of this array.
1807 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1809 $index: Integer; the index of the namespace being checked.
1810 $result: Boolean; whether MediaWiki currently thinks that pages in this
1811 namespace are movable. Hooks may change this value to override the return
1812 value of MWNamespace::isMovable().
1814 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1816 $wikiPage: the WikiPage edited
1817 $rev: the new revision
1818 $baseID: the revision ID this was based off, if any
1819 $user: the editing user
1821 'NormalizeMessageKey': Called before the software gets the text of a message
1822 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1824 &$key: the message being looked up. Change this to something else to change
1825 what message gets displayed (string)
1826 &$useDB: whether or not to look up the message in the database (bool)
1827 &$langCode: the language code to get the message for (string) - or -
1828 whether to use the content language (true) or site language (false) (bool)
1829 &$transform: whether or not to expand variables and templates
1830 in the message (bool)
1832 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1833 return false to omit the line from RecentChanges and Watchlist special pages.
1834 &$changeslist: The OldChangesList instance.
1835 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1836 &$rc: The RecentChange object.
1837 &$classes: array of css classes for the <li> element
1839 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1840 can alter or append to the array of URLs for search & suggestion formats.
1841 &$urls: array of associative arrays with Url element attributes
1843 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1844 users and/or IP addresses too.
1845 $otherBlockLink: An array with links to other block logs
1846 $ip: The requested IP address or username
1848 'OutputPageBeforeHTML': A page has been processed by the parser and the
1849 resulting HTML is about to be displayed.
1850 $parserOutput: the parserOutput (object) that corresponds to the page
1851 $text: the text that will be displayed, in HTML (string)
1853 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1854 body tag to allow for extensions to add attributes to the body of the page they
1855 might need. Or to allow building extensions to add body classes that aren't of
1856 high enough demand to be included in core.
1857 $out: The OutputPage which called the hook, can be used to get the real title
1858 $sk: The Skin that called OutputPage::headElement
1859 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1861 'OutputPageCheckLastModified': when checking if the page has been modified
1862 since the last visit.
1863 &$modifiedTimes: array of timestamps.
1864 The following keys are set: page, user, epoch
1866 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1867 $out: OutputPage instance (object)
1868 $parserOutput: parserOutput instance being added in $out
1870 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1871 categories. Implementations should return false if they generate the category
1872 links, so the default link generation is skipped.
1873 $out: OutputPage instance (object)
1874 $categories: associative array, keys are category names, values are category
1875 types ("normal" or "hidden")
1876 $links: array, intended to hold the result. Must be an associative array with
1877 category types as keys and arrays of HTML links as values.
1879 'PageContentInsertComplete': After a new article is created.
1880 $wikiPage: WikiPage created
1881 $user: User creating the article
1882 $content: New content as a Content object
1883 $summary: Edit summary/comment
1884 $isMinor: Whether or not the edit was marked as minor
1885 $isWatch: (No longer used)
1886 $section: (No longer used)
1887 $flags: Flags passed to WikiPage::doEditContent()
1888 $revision: New Revision of the article
1890 'PageContentLanguage': Allows changing the language in which the content of a
1891 page is written. Defaults to the wiki content language ($wgContLang).
1892 $title: Title object
1893 &$pageLang: the page content language (either an object or a language code)
1894 $wgLang: the user language
1896 'PageContentSave': Before an article is saved.
1897 $wikiPage: the WikiPage (object) being saved
1898 $user: the user (object) saving the article
1899 $content: the new article content, as a Content object
1900 $summary: the article summary (comment)
1901 $isminor: minor flag
1902 $iswatch: watch flag
1905 'PageContentSaveComplete': After an article has been updated.
1906 $wikiPage: WikiPage modified
1907 $user: User performing the modification
1908 $content: New content, as a Content object
1909 $summary: Edit summary/comment
1910 $isMinor: Whether or not the edit was marked as minor
1911 $isWatch: (No longer used)
1912 $section: (No longer used)
1913 $flags: Flags passed to WikiPage::doEditContent()
1914 $revision: New Revision of the article (can be null for edits that change nothing)
1915 $status: Status object about to be returned by doEditContent()
1916 $baseRevId: the rev ID (or false) this edit was based on
1918 'PageHistoryBeforeList': When a history page list is about to be constructed.
1919 $article: the article that the history is loading for
1920 $context: RequestContext object
1922 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1923 $row: the revision row for this line
1924 $s: the string representing this parsed line
1925 $classes: array containing the <li> element classes
1927 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1930 $queryInfo: the query parameters
1932 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
1933 which depends on user options should install this hook and append its values to
1935 &$confstr: reference to a hash key string which can be modified
1936 $user: User (object) requesting the page
1938 'ParserAfterParse': Called from Parser::parse() just after the call to
1939 Parser::internalParse() returns.
1940 $parser: parser object
1941 $text: text being parsed
1942 $stripState: stripState used (object)
1944 'ParserAfterStrip': Called at end of parsing time.
1945 TODO: No more strip, deprecated ?
1946 $parser: parser object
1947 $text: text being parsed
1948 $stripState: stripState used (object)
1950 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1951 $parser: Parser object being used
1952 $text: text that will be returned
1954 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
1955 $parser: Parser object
1956 $text: text to parse
1957 $stripState: StripState instance being used
1959 'ParserBeforeStrip': Called at start of parsing time.
1960 TODO: No more strip, deprecated ?
1961 $parser: parser object
1962 $text: text being parsed
1963 $stripState: stripState used (object)
1965 'ParserBeforeTidy': Called before tidy and custom tags replacements.
1966 $parser: Parser object being used
1969 'ParserClearState': Called at the end of Parser::clearState().
1970 $parser: Parser object being cleared
1972 'ParserCloned': Called when the parser is cloned.
1973 $parser: Newly-cloned Parser object
1975 'ParserFirstCallInit': Called when the parser initialises for the first time.
1976 &$parser: Parser object being cleared
1978 'ParserGetVariableValueSwitch': Called when the parser need the value of a
1980 $parser: Parser object
1981 $varCache: array to store the value in case of multiples calls of the
1983 $index: index (string) of the magic
1984 $ret: value of the magic word (the hook should set it)
1985 $frame: PPFrame object to use for expanding any template variables
1987 'ParserGetVariableValueTs': Use this to change the value of the time for the
1988 {{LOCAL...}} magic word.
1989 $parser: Parser object
1990 $time: actual time (timestamp)
1992 'ParserGetVariableValueVarCache': use this to change the value of the variable
1993 cache or return false to not use it.
1994 $parser: Parser object
1995 $varCache: variable cache (array)
1997 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
1998 ParserLimitReportFormat instead.
1999 Called at the end of Parser:parse() when the parser will
2000 include comments about size of the text parsed.
2001 $parser: Parser object
2002 &$limitReport: text that will be included (without comment tags)
2004 'ParserLimitReportFormat': Called for each row in the parser limit report that
2005 needs formatting. If nothing handles this hook, the default is to use "$key" to
2006 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2008 $key: Key for the limit report item (string)
2009 &$value: Value of the limit report item
2010 &$report: String onto which to append the data
2011 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2012 text intended for display in a monospaced font.
2013 $localize: If false, $report should be output in English.
2015 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2016 include comments about size of the text parsed. Hooks should use
2017 $output->setLimitReportData() to populate data. Functions for this hook should
2018 not use $wgLang; do that in ParserLimitReportFormat instead.
2019 $parser: Parser object
2020 $output: ParserOutput object
2022 'ParserMakeImageParams': Called before the parser make an image link, use this
2023 to modify the parameters of the image.
2024 $title: title object representing the file
2025 $file: file object that will be used to create the image
2026 &$params: 2-D array of parameters
2027 $parser: Parser object that called the hook
2029 'ParserSectionCreate': Called each time the parser creates a document section
2030 from wikitext. Use this to apply per-section modifications to HTML (like
2031 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2032 can begin in one section and end in another. Make sure your code can handle
2033 that case gracefully. See the EditSectionClearerLink extension for an example.
2034 $parser: the calling Parser instance
2035 $section: the section number, zero-based, but section 0 is usually empty
2036 &$sectionContent: ref to the content of the section. modify this.
2037 $showEditLinks: boolean describing whether this section has an edit link
2039 'ParserTestParser': Called when creating a new instance of Parser in
2040 tests/parser/parserTest.inc.
2041 $parser: Parser object created
2043 'ParserTestGlobals': Allows to define globals for parser tests.
2044 &$globals: Array with all the globals which should be set for parser tests.
2045 The arrays keys serve as the globals names, its values are the globals values.
2047 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2048 run. Use when page save hooks require the presence of custom tables to ensure
2049 that tests continue to run properly.
2050 &$tables: array of table names
2052 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2053 my talk page, my contributions" etc).
2054 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2055 &$title: Title object representing the current page
2056 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2058 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2059 &$user : User performing the action
2060 $action : Action being performed
2061 &$result : Whether or not the action should be prevented
2062 Change $result and return false to give a definitive answer, otherwise
2063 the built-in rate limiting checks are used, if enabled.
2064 $incrBy: Amount to increment counter by
2066 'PlaceNewSection': Override placement of new sections. Return false and put the
2067 merged text into $text to override the default behavior.
2068 $wikipage : WikiPage object
2069 $oldtext : the text of the article before editing
2070 $subject : subject of the new section
2071 &$text : text of the new section
2073 'PostLoginRedirect': Modify the post login redirect behavior.
2074 Occurs after signing up or logging in, allows for interception of redirect.
2075 &$returnTo: The page name to return to, as a string
2076 &$returnToQuery: array of url parameters, mapping parameter names to values
2077 &$type: type of login redirect as string;
2078 error: display a return to link ignoring $wgRedirectOnLogin
2079 signup: display a return to link using $wgRedirectOnLogin if needed
2080 success: display a return to link using $wgRedirectOnLogin if needed
2081 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2083 'PreferencesGetLegend': Override the text used for the <legend> of a
2084 preferences section.
2085 $form: the PreferencesForm object. This is a ContextSource as well
2086 $key: the section name
2087 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2089 'PreferencesFormPreSave': Override preferences being saved
2090 $formData: array of user submitted data
2091 $form: PreferencesForm object, also a ContextSource
2092 $user: User object with preferences to be saved set
2093 &$result: boolean indicating success
2095 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2096 AJAX search suggestions. Put results into &$results outparam and return false.
2097 $ns : array of int namespace keys to search in
2098 $search : search term (not guaranteed to be conveniently normalized)
2099 $limit : maximum number of results to return
2100 &$results : out param: array of page names (strings)
2102 'PrefsEmailAudit': Called when user changes their email address.
2103 $user: User (object) changing his email address
2104 $oldaddr: old email address (string)
2105 $newaddr: new email address (string)
2107 'PrefsPasswordAudit': Called when user changes his password.
2108 $user: User (object) changing his password
2109 $newPass: new password
2110 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2112 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2114 $article: the title being (un)protected
2115 $output: a string of the form HTML so far
2117 'ProtectionForm::save': Called when a protection form is submitted.
2118 $article: the Page being (un)protected
2119 &$errorMsg: an html message string of an error or an array of message name and
2121 $reasonstr: a string describing the reason page protection level is altered
2123 'ProtectionForm::showLogExtract': Called after the protection log extract is
2125 $article: the page the form is shown for
2126 $out: OutputPage object
2128 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2129 &$obj: RawAction object
2130 &$text: The text that's going to be the output
2132 'RecentChange_save': Called at the end of RecentChange::save().
2133 $recentChange: RecentChange object
2135 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2136 names such as "oldid" that are preserved when using redirecting special pages
2137 such as Special:MyPage and Special:MyTalk.
2138 &$redirectParams: An array of parameters preserved by redirecting special pages.
2140 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2141 instance. Can be used by an extension override what skin is used in certain
2143 IContextSource $context: The RequestContext the skin is being created for.
2144 &$skin: A variable reference you may set a Skin instance or string key on to
2145 override the skin that will be used for the context.
2147 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2148 $user: The user having their password expiration reset
2149 &$newExpire: The new expiration date
2151 'ResetSessionID': Called from wfResetSessionID
2152 $oldSessionID: old session id
2153 $newSessionID: new session id
2155 'ResourceLoaderGetConfigVars': Called at the end of
2156 ResourceLoaderStartUpModule::getConfig(). Use this to export static
2157 configuration variables to JavaScript. Things that depend on the current page
2158 or request state must be added through MakeGlobalVariablesScript instead.
2159 &$vars: array( variable name => value )
2161 'ResourceLoaderRegisterModules': Right before modules information is required,
2162 such as when responding to a resource
2163 loader request or generating HTML output.
2164 &$resourceLoader: ResourceLoader object
2166 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2167 called after the addition of 'qunit' and MediaWiki testing resources.
2168 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2169 included in core, is fed using tests/qunit/QUnitTestResources.php.
2170 &ResourceLoader object
2172 To add a new qunit module named 'myext.tests':
2173 testModules['qunit']['myext.tests'] = array(
2174 'script' => 'extension/myext/tests.js',
2175 'dependencies' => <any module dependency you might have>
2177 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2178 added to any module.
2180 'RevisionInsertComplete': Called after a revision is inserted into the database.
2181 &$revision: the Revision
2182 $data: the data stored in old_text. The meaning depends on $flags: if external
2183 is set, it's the URL of the revision text in external storage; otherwise,
2184 it's the revision text itself. In either case, if gzip is set, the revision
2186 $flags: a comma-delimited list of strings representing the options used. May
2187 include: utf8 (this will always be set for new revisions); gzip; external.
2189 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2190 the normal operations.
2191 $allSearchTerms : Array of the search terms in all content languages
2192 &$titleResult : Outparam; the value to return. A Title object or null.
2194 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2195 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2197 $term : Search term string
2198 &$title : Outparam; set to $title object and return false for a match
2200 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2201 if nothing was found.
2202 $term : Search term string
2203 &$title : Outparam; set to $title object and return false for a match
2205 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2207 $term : Search term string
2208 &$title : Current Title object that is being returned (null if none found).
2210 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2212 $title : Current Title object being displayed in search results.
2213 &$id: Revision ID (default is false, for latest)
2215 'SearchableNamespaces': An option to modify which namespaces are searchable.
2216 &$arr : Array of namespaces ($nsId => $name) which will be used.
2218 'SelfLinkBegin': Called before a link to the current article is displayed to
2219 allow the display of the link to be customized.
2220 $nt: the Title object
2221 &$html: html to display for the link
2222 &$trail: optional text to display before $html
2223 &$prefix: optional text to display after $html
2224 &$ret: the value to return if your hook returns false
2226 'SetupAfterCache': Called in Setup.php, after cache objects are set
2228 'ShowMissingArticle': Called when generating the output for a non-existent page.
2229 $article: The article object corresponding to the page
2231 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2232 DEPRECATED, use the ContentGetParserOutput hook instead!
2233 $text: Text being shown
2234 $title: Title of the custom script/stylesheet page
2235 $output: Current OutputPage object
2237 'ShowSearchHitTitle': Customise display of search hit title/link.
2238 &$title: Title to link to
2239 &$text: Text to use for the link
2240 $result: The search result
2241 $terms: The search terms entered
2242 $page: The SpecialSearch object.
2244 'ShowSearchHit': Customize display of search hit.
2245 $searchPage: The SpecialSearch instance.
2246 $result: The SearchResult to show
2247 $terms: Search terms, for highlighting
2248 &$link: HTML of link to the matching page. May be modified.
2249 &$redirect: HTML of redirect info. May be modified.
2250 &$section: HTML of matching section. May be modified.
2251 &$extract: HTML of content extract. May be modified.
2252 &$score: HTML of score. May be modified.
2253 &$size: HTML of page size. May be modified.
2254 &$date: HTML of of page modification date. May be modified.
2255 &$related: HTML of additional info for the matching page. May be modified.
2256 &$html: May be set to the full HTML that should be used to represent the search
2257 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2258 function returned false.
2260 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2261 allow the normal method of notice selection/rendering to work, or change the
2262 value of $siteNotice and return false to alter it.
2263 &$siteNotice: HTML returned as the sitenotice
2266 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2267 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2268 the sitenotice/anonnotice.
2271 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2273 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2274 the stock bottom scripts.
2276 'SkinAfterContent': Allows extensions to add text after the page content and
2277 article metadata. This hook should work in all skins. Set the &$data variable to
2278 the text you're going to add.
2279 &$data: (string) Text to be printed out directly (without parsing)
2282 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2284 &$bar: Sidebar contents
2285 Modify $bar to add or modify sidebar portlets.
2287 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2289 &$bar: Sidebar content
2290 Modify $bar to add or modify sidebar portlets.
2291 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2293 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2295 $title: displayed page title
2296 $type: 'normal' or 'history' for old/diff views
2297 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2298 message must be in HTML format, not wikitext!
2299 &$link: overridable HTML link to be passed into the message as $1
2300 &$forContent: overridable flag if copyright footer is shown in content language.
2301 This parameter is deprecated.
2303 'SkinGetPoweredBy': TODO
2304 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2305 the MediaWiki icon but plain text instead.
2308 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2309 &$subpages: Subpage links HTML
2311 $out: OutputPage object
2312 If false is returned $subpages will be used instead of the HTML
2313 subPageSubtitle() generates.
2314 If true is returned, $subpages will be ignored and the rest of
2315 subPageSubtitle() will run.
2317 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2319 $sktemplate: SkinTemplate object
2320 $nav_urls: array of tabs
2322 'SkinTemplateGetLanguageLink': After building the data for a language link from
2323 which the actual html is constructed.
2324 &$languageLink: array containing data about the link. The following keys can be
2325 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2326 $languageLinkTitle: Title object belonging to the external language link
2327 $title: Title object of the page the link belongs to
2329 To alter the structured navigation links in SkinTemplates, there are three
2330 hooks called in different spots:
2332 'SkinTemplateNavigation': Called on content pages after the tabs have been
2333 added, but before variants have been added.
2334 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2335 tab is added but before variants have been added.
2336 'SkinTemplateNavigation::Universal': Called on both content and special pages
2337 after variants have been added.
2338 &$sktemplate: SkinTemplate object
2339 &$links: Structured navigation links. This is used to alter the navigation for
2340 skins which use buildNavigationUrls such as Vector.
2342 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2344 &$sktemplate: SkinTemplate object
2345 &$tpl: Template engine object
2347 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2348 $sktemplate: SkinTemplate object
2349 $res: set to true to prevent active tabs
2351 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2352 You can either create your own array, or alter the parameters for
2354 &$sktemplate: The SkinTemplate instance.
2355 $title: Title instance for the page.
2356 $message: Visible label of tab.
2357 $selected: Whether this is a selected tab.
2358 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2359 &$classes: Array of CSS classes to apply.
2360 &$query: Query string to add to link.
2362 &$result: Complete assoc. array if you want to return true.
2364 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2365 been rendered (useful for adding more).
2366 $sk: The QuickTemplate based skin template running the hook.
2367 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2368 extensions that add support for BaseTemplateToolbox should watch for this
2369 dummy parameter with "$dummy=false" in their code and return without echoing
2370 any HTML to avoid creating duplicate toolbox items.
2372 'SkinVectorStyleModules': Called when defining the list of module styles to be
2373 loaded by the Vector skin.
2374 $skin: SkinVector object
2375 &$styles: Array of module names whose style will be loaded for the skin
2377 'SoftwareInfo': Called by Special:Version for returning information about the
2379 $software: The array of software in format 'name' => 'version'. See
2380 SpecialVersion::softwareInformation().
2382 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2383 $name: name of the special page
2384 &$form: HTMLForm object
2386 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2387 $sp: SpecialPage object, for context
2388 &$fields: Current HTMLForm fields
2390 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2391 $id: User id number, only provided for backwards-compatability
2392 $user: User object representing user contributions are being fetched for
2393 $sp: SpecialPage instance, providing context
2395 'SpecialListusersDefaultQuery': Called right before the end of
2396 UsersPager::getDefaultQuery().
2397 $pager: The UsersPager instance
2398 $query: The query array to be returned
2400 'SpecialListusersFormatRow': Called right before the end of
2401 UsersPager::formatRow().
2402 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2403 $row: Database row object
2405 'SpecialListusersHeader': Called before closing the <fieldset> in
2406 UsersPager::getPageHeader().
2407 $pager: The UsersPager instance
2408 $out: The header HTML
2410 'SpecialListusersHeaderForm': Called before adding the submit button in
2411 UsersPager::getPageHeader().
2412 $pager: The UsersPager instance
2413 $out: The header HTML
2415 'SpecialListusersQueryInfo': Called right before the end of.
2416 UsersPager::getQueryInfo()
2417 $pager: The UsersPager instance
2418 $query: The query array to be returned
2420 'SpecialMovepageAfterMove': Called after moving a page.
2421 $movePage: MovePageForm object
2422 $oldTitle: old title (object)
2423 $newTitle: new title (object)
2425 'SpecialNewpagesConditions': Called when building sql query for
2427 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2428 $opts: FormOptions object containing special page options
2429 &$conds: array of WHERE conditionals for query
2430 &tables: array of tables to be queried
2431 &$fields: array of columns to select
2432 &$join_conds: join conditions for the tables
2434 'SpecialNewPagesFilters': Called after building form options at NewPages.
2435 $special: the special page object
2436 &$filters: associative array of filter definitions. The keys are the HTML
2437 name/URL parameters. Each key maps to an associative array with a 'msg'
2438 (message key) and a 'default' value.
2440 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2441 hook to remove a core special page.
2442 $list: list (array) of core special pages
2444 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2445 $special: the SpecialPage object
2446 $subPage: the subpage string or null if no subpage was specified
2448 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2449 $special: the SpecialPage object
2450 $subPage: the subpage string or null if no subpage was specified
2452 'SpecialPasswordResetOnSubmit': When executing a form submission on
2453 Special:PasswordReset.
2454 $users: array of User objects.
2455 $data: array of data submitted by the user
2456 &$error: string, error code (message key) used to describe to error (out
2457 parameter). The hook needs to return false when setting this, otherwise it
2458 will have no effect.
2460 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2461 use this to change some selection criteria or substitute a different title.
2462 &$randstr: The random number from wfRandom()
2463 &$isRedir: Boolean, whether to select a redirect or non-redirect
2464 &$namespaces: An array of namespace indexes to get the title from
2465 &$extra: An array of extra SQL statements
2466 &$title: If the hook returns false, a Title object to use instead of the
2467 result from the normal query
2469 'SpecialRecentChangesFilters': Called after building form options at
2470 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2471 $special: the special page object
2472 &$filters: associative array of filter definitions. The keys are the HTML
2473 name/URL parameters. Each key maps to an associative array with a 'msg'
2474 (message key) and a 'default' value.
2476 'SpecialRecentChangesPanel': Called when building form options in
2477 SpecialRecentChanges.
2478 &$extraOpts: array of added items, to which can be added
2479 $opts: FormOptions for this request
2481 'SpecialRecentChangesQuery': Called when building SQL query for
2482 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2483 ChangesListSpecialPageQuery instead.
2484 &$conds: array of WHERE conditionals for query
2485 &$tables: array of tables to be queried
2486 &$join_conds: join conditions for the tables
2487 $opts: FormOptions for this request
2488 &$query_options: array of options for the database request
2489 &$select: Array of columns to select
2491 'SpecialResetTokensTokens': Called when building token list for
2493 &$tokens: array of token information arrays in the format of
2494 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2496 'SpecialSearchCreateLink': Called when making the message to create a page or
2497 go to the existing page.
2498 $t: title object searched for
2499 &$params: an array of the default message name and page title (as parameter)
2501 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2502 target doesn't exist.
2503 &$title: title object generated from the text entered by the user
2505 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2506 the advanced form, a.k.a. power search box.
2507 &$showSections: an array to add values with more options to
2508 $term: the search term (not a title object)
2509 $opts: an array of hidden options (containing 'redirs' and 'profile')
2511 'SpecialSearchProfiles': Allows modification of search profiles.
2512 &$profiles: profiles, which can be modified.
2514 'SpecialSearchProfileForm': Allows modification of search profile forms.
2515 $search: special page object
2516 &$form: String: form html
2517 $profile: String: current search profile
2518 $term: String: search term
2519 $opts: Array: key => value of hidden options for inclusion in custom forms
2521 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2522 $search: SpecialSearch special page object
2523 $profile: String: current search profile
2524 $engine: the search engine
2526 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2527 on the search results page. Useful for including an external search
2528 provider. To disable the output of MediaWiki search output, return
2530 $specialSearch: SpecialSearch object ($this)
2532 $term: Search term specified by the user
2534 'SpecialSearchResults': Called before search result display when there are
2536 $term: string of search term
2537 &$titleMatches: empty or SearchResultSet object
2538 &$textMatches: empty or SearchResultSet object
2540 'SpecialSearchNoResults': Called before search result display when there are no
2542 $term: string of search term
2544 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2545 &$extraStats: Array to save the new stats
2546 ( $extraStats['<name of statistic>'] => <value>; )
2548 'SpecialUploadComplete': Called after successfully uploading a file from
2550 $form: The SpecialUpload object
2552 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2553 $wgVersion: Current $wgVersion for you to use
2554 &$versionUrl: Raw url to link to (eg: release notes)
2556 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2557 Deprecated, use ChangesListSpecialPageFilters instead.
2558 $special: the special page object
2559 &$filters: associative array of filter definitions. The keys are the HTML
2560 name/URL parameters. Each key maps to an associative array with a 'msg'
2561 (message key) and a 'default' value.
2563 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2564 Deprecated, use ChangesListSpecialPageQuery instead.
2565 &$conds: array of WHERE conditionals for query
2566 &$tables: array of tables to be queried
2567 &$join_conds: join conditions for the tables
2568 &$fields: array of query fields
2569 $opts: A FormOptions object with watchlist options for the current request
2571 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2572 SpecialWatchlist. Allows extensions to register custom values they have
2573 inserted to rc_type so they can be returned as part of the watchlist.
2574 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2576 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2577 URL for a title when we have no other parameters on the URL. Gives a chance for
2578 extensions that alter page view behavior radically to abort that redirect or
2580 $request: WebRequest
2581 $title: Title of the currently found title obj
2582 $output: OutputPage object
2584 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2585 rendered (by ThumbnailImage:toHtml method).
2586 $thumbnail: the ThumbnailImage object
2587 &$attribs: image attribute array
2588 &$linkAttribs: image link attribute array
2590 'TitleArrayFromResult': Called when creating an TitleArray object from a
2592 &$titleArray: set this to an object to override the default object returned
2593 $res: database result used to create the object
2595 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2596 or override the quick permissions check.
2597 $title: The Title object being accessed
2598 $user: The User performing the action
2599 $action: Action being performed
2600 &$errors: Array of errors
2601 $doExpensiveQueries: Whether to do expensive DB queries
2602 $short: Whether to return immediately on first error
2604 'TitleGetEditNotices': Allows extensions to add edit notices
2605 $title: The Title object for the page the edit notices are for
2606 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2607 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2609 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2610 that can be applied.
2611 $title: The title in question.
2612 &$types: The types of protection available.
2614 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page.
2615 $title: Title object that is being checked
2616 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2617 Hooks may change this value to override the return value of
2618 Title::isCssOrJsPage().
2620 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2621 overriding default behavior for determining if a page exists. If $isKnown is
2622 kept as null, regular checks happen. If it's a boolean, this value is returned
2623 by the isKnown method.
2624 $title: Title object that is being checked
2625 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2627 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2628 that this hook is not called for interwiki pages or pages in immovable
2629 namespaces: for these, isMovable() always returns false.
2630 $title: Title object that is being checked
2631 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2632 Hooks may change this value to override the return value of
2635 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2636 be handled by separate handler (via ArticleViewCustom).
2637 $title: Title object that is being checked
2638 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2639 Hooks may change this value to override the return value of
2640 Title::isWikitextPage()
2642 'TitleMove': Before moving an article (title).
2645 $user: user who does the move
2647 'TitleMoveComplete': After moving an article (title).
2650 $user: user who did the move
2651 $pageid: database ID of the page that's been moved
2652 $redirid: database ID of the created redirect
2653 $reason: reason for the move
2655 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2656 adding the default error message if nothing allows the user to read the page. If
2657 a handler wants a title to *not* be whitelisted, it should also return false.
2658 $title: Title object being checked against
2659 $user: Current user object
2660 &$whitelisted: Boolean value of whether this title is whitelisted
2662 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2663 $title: Title object to purge
2664 &$urls: An array of URLs to purge from the caches, to be manipulated.
2666 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2667 PageArchive object has been created but before any further processing is done.
2668 &$archive: PageArchive object
2669 $title: Title object of the page that we're viewing
2671 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2672 PageArchive object has been created but before any further processing is done.
2673 &$archive: PageArchive object
2674 $title: Title object of the page that we're viewing
2676 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2677 the site is not in read-only mode, that the Title object is not null and after
2678 a PageArchive object has been constructed but before performing any further
2680 &$archive: PageArchive object
2681 $title: Title object of the page that we're about to undelete
2683 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2684 $title: title object related to the revision
2685 $rev: revision (object) that will be viewed
2687 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2689 $action: action name
2690 $article: article "acted on"
2692 'UnitTestsList': Called when building a list of files with PHPUnit tests.
2693 &$files: list of files
2695 'UnwatchArticle': Before a watch is removed from an article.
2696 $user: user watching
2697 $page: WikiPage object to be removed
2698 &$status: Status object to be returned if the hook returns false
2700 'UnwatchArticleComplete': After a watch is removed from an article.
2701 $user: user that watched
2702 $page: WikiPage object that was watched
2704 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2705 $formattedPageStatus: list of valid page states
2707 'UploadForm:initial': Before the upload form is generated. You might set the
2708 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2709 text (HTML) either before or after the editform.
2710 $form: UploadForm object
2712 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2713 poke at member variables like $mUploadDescription before the file is saved. Do
2714 not use this hook to break upload processing. This will return the user to a
2715 blank form with no error message; use UploadVerification and UploadVerifyFile
2717 $form: UploadForm object
2719 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2720 $type: (string) the requested upload type
2721 &$className: the class name of the Upload instance to be created
2723 'UploadComplete': when Upload completes an upload.
2724 &$upload: an UploadBase child instance
2726 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2728 $descriptor: (array) the HTMLForm descriptor
2730 'UploadFormSourceDescriptors': after the standard source inputs have been
2731 added to the descriptor
2732 $descriptor: (array) the HTMLForm descriptor
2734 'UploadVerification': Additional chances to reject an uploaded file. Consider
2735 using UploadVerifyFile instead.
2736 string $saveName: destination file name
2737 string $tempName: filesystem path to the temporary file for checks
2738 string &$error: output: message key for message to show if upload canceled by
2739 returning false. May also be an array, where the first element is the message
2740 key and the remaining elements are used as parameters to the message.
2742 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2743 in most cases over UploadVerification.
2744 object $upload: an instance of UploadBase, with all info about the upload
2745 string $mime: The uploaded file's mime type, as detected by MediaWiki. Handlers
2746 will typically only apply for specific mime types.
2747 object &$error: output: true if the file is valid. Otherwise, an indexed array
2748 representing the problem with the file, where the first element is the message
2749 key and the remaining elements are used as parameters to the message.
2751 'UploadComplete': Upon completion of a file upload.
2752 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2753 $uploadBase->getLocalFile().
2755 'User::mailPasswordInternal': before creation and mailing of a user's new
2757 $user: the user who sent the message out
2758 $ip: IP of the user who sent the message out
2759 $u: the account whose new password will be set
2761 'UserAddGroup': Called when adding a group; return false to override
2762 stock group addition.
2763 $user: the user object that is to have a group added
2764 &$group: the group to add, can be modified
2766 'UserArrayFromResult': Called when creating an UserArray object from a database
2768 &$userArray: set this to an object to override the default object returned
2769 $res: database result used to create the object
2771 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2772 want to display an error message, try getUserPermissionsErrors.
2773 $title: Title object being checked against
2774 $user : Current user object
2775 $action: Action being checked
2776 $result: Pointer to result returned if hook returns false. If null is returned,
2777 userCan checks are continued by internal code.
2779 'UserCanSendEmail': To override User::canSendEmail() permission check.
2780 $user: User (object) whose permission is being checked
2781 &$canSend: bool set on input, can override on output
2783 'UserClearNewTalkNotification': Called when clearing the "You have new
2784 messages!" message, return false to not delete it.
2785 $user: User (object) that will clear the message
2786 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2788 'UserComparePasswords': Called when checking passwords, return false to
2789 override the default password checks.
2790 &$hash: String of the password hash (from the database)
2791 &$password: String of the plaintext password the user entered
2792 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2794 &$result: If the hook returns false, this Boolean value will be checked to
2795 determine if the password was valid
2797 'UserCreateForm': change to manipulate the login form
2798 $template: SimpleTemplate instance for the form
2800 'UserCryptPassword': Called when hashing a password, return false to implement
2801 your own hashing method.
2802 &$password: String of the plaintext password to encrypt
2803 &$salt: String of the password salt or Boolean false if no salt is provided
2804 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing
2806 &$hash: If the hook returns false, this String will be used as the hash
2808 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2809 $user: User to get groups for
2810 &$groups: Current effective groups
2812 'UserGetAllRights': After calculating a list of all available rights.
2813 &$rights: Array of rights, which may be added to.
2815 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2816 before returning the options to the caller. Warning: This hook is called for
2817 every call to User::getDefaultOptions(), which means it's potentially called
2818 dozens or hundreds of times. You may want to cache the results of non-trivial
2819 operations in your hook function for this reason.
2820 &$defaultOptions: Array of preference keys and their default values.
2822 'UserGetEmail': Called when getting an user email address.
2824 &$email: email, change this to override local email
2826 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2827 email authentication.
2829 &$timestamp: timestamp, change this to override local email authentication
2832 'UserGetImplicitGroups': Called in User::getImplicitGroups().
2833 &$groups: List of implicit (automatically-assigned) groups
2835 'UserGetLanguageObject': Called when getting user's interface language object.
2837 &$code: Language code that will be used to create the object
2838 $context: RequestContext object
2840 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2841 &$reservedUsernames: $wgReservedUsernames
2843 'UserGetRights': Called in User::getRights().
2844 $user: User to get rights for
2845 &$rights: Current rights
2847 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2848 specific block exemptions).
2849 $user: User in question
2850 $title: Title of the page in question
2851 &$blocked: Out-param, whether or not the user is blocked from that page.
2852 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2853 to edit their own user talk pages.
2855 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2857 $ip: User's IP address
2858 &$blocked: Whether the user is blocked, to be modified by the hook
2860 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2861 false if a UserGetRights hook might remove the named right.
2862 $right: The user right being checked
2864 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2865 environmental means; occurs after session is loaded.
2866 $user: user object being loaded
2868 'UserLoadDefaults': Called when loading a default user.
2872 'UserLoadFromDatabase': Called when loading a user from the database.
2874 &$s: database query object
2876 'UserLoadFromSession': Called to authenticate users on external/environmental
2877 means; occurs before session is loaded.
2878 $user: user object being loaded
2879 &$result: set this to a boolean value to abort the normal authentication
2882 'UserLoadOptions': When user options/preferences are being loaded from the
2885 &$options: Options, can be modified.
2887 'UserLoginComplete': After a user has logged in.
2888 $user: the user object that was created on login
2889 $inject_html: Any HTML to inject after the "logged in" message.
2891 'UserLoginForm': change to manipulate the login form
2892 $template: SimpleTemplate instance for the form
2894 'UserLogout': Before a user logs out.
2895 $user: the user object that is about to be logged out
2897 'UserLogoutComplete': After a user has logged out.
2898 $user: the user object _after_ logout (won't have name, ID, etc.)
2899 $inject_html: Any HTML to inject after the "logged out" message.
2900 $oldName: name of the user before logout (string)
2902 'UserRemoveGroup': Called when removing a group; return false to override stock
2904 $user: the user object that is to have a group removed
2905 &$group: the group to be removed, can be modified
2907 'UserRights': After a user's group memberships are changed.
2908 $user : User object that was changed
2909 $add : Array of strings corresponding to groups added
2910 $remove: Array of strings corresponding to groups removed
2912 'UserRequiresHTTPS': Called to determine whether a user needs
2913 to be switched to HTTPS.
2914 $user: User in question.
2915 &$https: Boolean whether $user should be switched to HTTPS.
2917 'UserResetAllOptions': Called in User::resetOptions() when user preferences
2918 have been requested to be reset. This hook can be used to exclude certain
2919 options from being reset even when the user has requested all prefs to be reset,
2920 because certain options might be stored in the user_properties database table
2921 despite not being visible and editable via Special:Preferences.
2922 $user: the User (object) whose preferences are being reset
2923 &$newOptions: array of new (site default) preferences
2924 $options: array of the user's old preferences
2925 $resetKinds: array containing the kinds of preferences to reset
2927 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2929 $user: user retrieving new talks messages
2930 $talks: array of new talks page(s)
2932 'UserSaveSettings': Called when saving user settings.
2935 'UserSaveOptions': Called just before saving user preferences/options.
2937 &$options: Options, modifiable
2939 'UserSetCookies': Called when setting user cookies.
2941 &$session: session array, will be added to $_SESSION
2942 &$cookies: cookies array mapping cookie name to its value
2944 'UserSetEmail': Called when changing user email address.
2946 &$email: new email, change this to override new email address
2948 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
2949 email authentication.
2951 &$timestamp: new timestamp, change this to override local email
2952 authentication timestamp
2954 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
2955 "Foobar (Talk | Contribs | Block)".
2956 $userId: User id of the current user
2957 $userText: User name of the current user
2958 &$items: Array of user tool links as HTML fragments
2960 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
2961 FormatMetadata::getExtendedMeta (return false means cache will be
2962 invalidated and GetExtendedMetadata hook called again).
2963 $timestamp: The timestamp metadata was generated
2964 $file: The file the metadata is for
2966 'UserMailerChangeReturnPath': Called to generate a VERP return address
2967 when UserMailer sends an email, with a bounce handling extension.
2968 $to: Array of MailAddress objects for the recipients
2969 &$returnPath: The return address string
2971 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
2972 used to alter the SQL query which gets the list of wanted pages.
2973 &$wantedPages: WantedPagesPage object
2974 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2976 'WatchArticle': Before a watch is added to an article.
2977 $user: user that will watch
2978 $page: WikiPage object to be watched
2979 &$status: Status object to be returned if the hook returns false
2981 'WatchArticleComplete': After a watch is added to an article.
2982 $user: user that watched
2983 $page: WikiPage object watched
2985 'WatchlistEditorBuildRemoveLine': when building remove lines in
2986 Special:Watchlist/edit.
2987 &$tools: array of extra links
2988 $title: Title object
2989 $redirect: whether the page is a redirect
2992 'WebRequestPathInfoRouter': While building the PathRouter to parse the
2994 $router: The PathRouter instance
2996 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
2997 Return false to prevent setting of the cookie.
2998 &$name: Cookie name passed to WebResponse::setcookie()
2999 &$value: Cookie value passed to WebResponse::setcookie()
3000 &$expire: Cookie expiration, as for PHP's setcookie()
3001 $options: Options passed to WebResponse::setcookie()
3003 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3004 $row: The DB row of the entry.
3005 $title: The Title of the page where the link comes FROM
3006 $target: The Title of the page where the link goes TO
3007 &$props: Array of HTML strings to display after the title.
3009 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3010 dumps. One, and only one hook should set this, and return false.
3011 &$tables: Database tables to use in the SELECT query
3012 &$opts: Options to use for the query
3013 &$join: Join conditions
3015 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3016 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3017 specific to a content model should be provided by the respective Content's
3018 getDeletionUpdates() method.
3020 $content: the Content to generate updates for
3021 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3023 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3024 run a MediaWiki cli script.
3025 &$script: MediaWiki cli script path
3026 &$parameters: Array of arguments and options to the script
3027 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3030 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3031 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3032 $qp: The list of QueryPages
3034 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3035 extra metadata to be added.
3036 $obj: The XmlDumpWriter object.
3037 &$out: The output string.
3038 $row: The database row for the page.
3039 $title: The title of the page.
3041 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3043 $obj: The XmlDumpWriter object.
3044 &$out: The text being output.
3045 $row: The database row for the revision.
3046 $text: The revision text.
3048 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3049 to add additional tags to extract.
3050 &$items: Array containing information on which items to extract. See XMPInfo for
3051 details on the format.
3053 'XMPGetResults': Called just before returning the results array of parsing xmp
3054 data. Can be used to post-process the results.
3055 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3056 is an array of metadata tags returned (each tag is either a value, or an array
3059 More hooks might be available but undocumented, you can execute
3060 "php maintenance/findHooks.php" to find hidden ones.