3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article);
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once 'extensions/ReverseTitle.php';
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoAccount': Return false to cancel automated local account creation,
238 where normally authentication against an external auth plugin would be creating
240 $user: the User object about to be created (read-only, incomplete)
241 &$abortMsg: out parameter: name of error message to be displayed to user
243 'AbortAutoblock': Return false to cancel an autoblock.
244 $autoblockip: The IP going to be autoblocked.
245 $block: The block from which the autoblock is coming.
247 'AbortDiffCache': Can be used to cancel the caching of a diff.
248 &$diffEngine: DifferenceEngine object
250 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
251 $editor: The User who made the change.
252 $title: The Title of the page that was edited.
253 $rc: The current RecentChange object.
255 'AbortLogin': Return false to cancel account login.
256 $user: the User object being authenticated against
257 $password: the password being submitted, not yet checked for validity
258 &$retval: a LoginForm class constant to return from authenticateUserData();
259 default is LoginForm::ABORTED. Note that the client may be using
260 a machine API rather than the HTML user interface.
261 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: HTML to display on abort
266 &$status: out parameter: Status object to return, replaces the older $msg param (added in 1.23)
267 Create the object with Status::newFatal() to ensure proper API error messages
268 are returned when creating account through API clients.
270 'AbortTalkPageEmailNotification': Return false to cancel talk page email notification
271 $targetUser: the user whom to send talk page email notification
272 $title: the page title
274 'SendWatchlistEmailNotification': Return true to send watchlist email notification
275 $targetUser: the user whom to send watchlist email notification
276 $title: the page title
277 $enotif: EmailNotification object
279 'AbortChangePassword': Return false to cancel password change.
280 $user: the User object to which the password change is occuring
281 $mOldpass: the old password provided by the user
282 $newpass: the new password provided by the user
283 &$abortMsg: the message identifier for abort reason
285 'ActionBeforeFormDisplay': Before executing the HTMLForm object.
286 $name: name of the action
287 &$form: HTMLForm object
288 $article: Article object
290 'ActionModifyFormFields': Before creating an HTMLForm object for a page action;
291 Allows to change the fields on the form that will be generated.
292 $name: name of the action
293 &$fields: HTMLForm descriptor array
294 $article: Article object
296 'AddNewAccount': After a user account is created.
297 $user: the User object that was created. (Parameter added in 1.7)
298 $byEmail: true when account was created "by email" (added in 1.12)
300 'AddNewAccountApiForm': Allow modifying internal login form when creating an account via API.
301 $apiModule: the ApiCreateAccount module calling
302 $loginForm: the LoginForm used
304 'AddNewAccountApiResult': Modify API output when creating a new account via API.
305 $apiModule: the ApiCreateAccount module calling
306 $loginForm: the LoginForm used
307 &$result: associative array for API result data
309 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
310 before OutputPage::sendCacheControl() and final ob_end_flush() which
311 will send the buffered output to the client. This allows for last-minute
312 modification of the output within the buffer by using ob_get_clean().
313 $output: The OutputPage object where output() was called
315 'AfterImportPage': When a page import is completed.
316 $title: Title under which the revisions were imported
317 $origTitle: Title provided by the XML file
318 $revCount: Number of revisions in the XML file
319 $sRevCount: Number of successfully imported revisions
320 $pageInfo: associative array of page information
322 'AfterParserFetchFileAndTitle': After an image gallery is formed by Parser,
323 just before adding its HTML to parser output.
324 $parser: Parser object that called the hook
325 $ig: Gallery, an object of one of the gallery classes (inheriting from
327 $html: HTML generated by the gallery
329 'AlternateEdit': Before checking if a user can edit a page and before showing
330 the edit form ( EditPage::edit() ). This is triggered on &action=edit.
331 $editPage: the EditPage object
333 'AlternateEditPreview': Before generating the preview of the page when editing
334 ( EditPage::getPreviewText() ).
335 $editPage: the EditPage object
336 &$content: the Content object for the text field from the edit page
337 &$previewHTML: Text to be placed into the page for the preview
338 &$parserOutput: the ParserOutput object for the preview
339 return false and set $previewHTML and $parserOutput to output custom page
342 'AlternateUserMailer': Called before mail is sent so that mail could be logged
343 (or something else) instead of using PEAR or PHP's mail(). Return false to skip
344 the regular method of sending mail. Return a string to return a php-mail-error
345 message containing the error. Returning true will continue with sending email
347 $headers: Associative array of headers for the email
348 $to: MailAddress object or array
350 $subject: Subject of the email
351 $body: Body of the message
353 'APIAfterExecute': After calling the execute() method of an API module. Use
354 this to extend core API modules.
355 &$module: Module object
357 'ApiBeforeMain': Before calling ApiMain's execute() method in api.php.
358 &$main: ApiMain object
360 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to further
361 authenticate and authorize API clients before executing the module. Return
362 false and set a message to cancel the request.
363 $module: Module object
365 &$message: API usage message to die with, as a message key or array
366 as accepted by ApiBase::dieUsageMsg.
368 'APIEditBeforeSave': Before saving a page with api.php?action=edit, after
369 processing request parameters. Return false to let the request fail, returning
370 an error message or an <edit result="Failure"> tag if $resultArr was filled.
371 $editPage : the EditPage object
372 $text : the new text of the article (has yet to be saved)
373 &$resultArr : data in this array will be added to the API result
375 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When
376 highlighting, add output to $context->getOutput() and return false.
377 $context: An IContextSource.
378 $text: Text to be highlighted.
379 $mime: MIME type of $text.
380 $format: API format code for $text.
382 'APIGetAllowedParams': Use this hook to modify a module's parameters.
383 &$module: ApiBase Module object
384 &$params: Array of parameters
385 $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
387 'APIGetDescription': DEPRECATED! Use APIGetDescriptionMessages instead.
388 Use this hook to modify a module's description.
389 &$module: ApiBase Module object
390 &$desc: String description, or array of description strings
392 'APIGetDescriptionMessages': Use this hook to modify a module's help message.
393 $module: ApiBase Module object
394 &$msg: Array of Message objects
396 'APIGetParamDescription': DEPRECATED! Use APIGetParamDescriptionMessages instead.
397 Use this hook to modify a module's parameter descriptions.
398 &$module: ApiBase Module object
399 &$desc: Array of parameter descriptions
401 'APIGetParamDescriptionMessages': Use this hook to modify a module's parameter descriptions.
402 $module: ApiBase Module object
403 &$msg: Array of arrays of Message objects
405 'APIHelpModifyOutput': Use this hook to modify an API module's help output.
406 $module: ApiBase Module object
407 &$help: Array of HTML strings to be joined for the output.
408 $options: Array Options passed to ApiHelp::getHelp
410 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks
411 can alter or append to the array.
412 &$results: array with integer keys to associative arrays. Keys in associative
414 - title: Title object.
415 - redirect from: Title or null.
416 - extract: Description for this result.
417 - extract trimmed: If truthy, the extract will not be trimmed to
418 $wgOpenSearchDescriptionLength.
419 - image: Thumbnail for this result. Value is an array with subkeys 'source'
420 (url), 'width', 'height', 'alt', 'align'.
421 - url: Url for the given title.
423 'APIQueryAfterExecute': After calling the execute() method of an
424 action=query submodule. Use this to extend core API modules.
425 &$module: Module object
427 'APIQueryGeneratorAfterExecute': After calling the executeGenerator() method of
428 an action=query submodule. Use this to extend core API modules.
429 &$module: Module object
430 &$resultPageSet: ApiPageSet object
432 'APIQueryInfoTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
433 Use this hook to add custom tokens to prop=info. Every token has an action,
434 which will be used in the intoken parameter and in the output
435 (actiontoken="..."), and a callback function which should return the token, or
436 false if the user isn't allowed to obtain it. The prototype of the callback
437 function is func($pageid, $title), where $pageid is the page ID of the page the
438 token is requested for and $title is the associated Title object. In the hook,
439 just add your callback to the $tokenFunctions array and return true (returning
440 false makes no sense).
441 $tokenFunctions: array(action => callback)
443 'APIQueryRevisionsTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
444 Use this hook to add custom tokens to prop=revisions. Every token has an
445 action, which will be used in the rvtoken parameter and in the output
446 (actiontoken="..."), and a callback function which should return the token, or
447 false if the user isn't allowed to obtain it. The prototype of the callback
448 function is func($pageid, $title, $rev), where $pageid is the page ID of the
449 page associated to the revision the token is requested for, $title the
450 associated Title object and $rev the associated Revision object. In the hook,
451 just add your callback to the $tokenFunctions array and return true (returning
452 false makes no sense).
453 $tokenFunctions: array(action => callback)
455 'APIQueryRecentChangesTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
456 Use this hook to add custom tokens to list=recentchanges. Every token has an
457 action, which will be used in the rctoken parameter and in the output
458 (actiontoken="..."), and a callback function which should return the token, or
459 false if the user isn't allowed to obtain it. The prototype of the callback
460 function is func($pageid, $title, $rc), where $pageid is the page ID of the
461 page associated to the revision the token is requested for, $title the
462 associated Title object and $rc the associated RecentChange object. In the
463 hook, just add your callback to the $tokenFunctions array and return true
464 (returning false makes no sense).
465 $tokenFunctions: array(action => callback)
467 'APIQuerySiteInfoGeneralInfo': Use this hook to add extra information to the
468 sites general information.
469 $module: the current ApiQuerySiteInfo module
470 &$results: array of results, add things here
472 'APIQuerySiteInfoStatisticsInfo': Use this hook to add extra information to the
473 sites statistics information.
474 &$results: array of results, add things here
476 'ApiQueryTokensRegisterTypes': Use this hook to add additional token types to
477 action=query&meta=tokens. Note that most modules will probably be able to use
478 the 'csrf' token instead of creating their own token types.
479 &$salts: array( type => salt to pass to User::getEditToken() )
481 'APIQueryUsersTokens': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
482 Use this hook to add custom token to list=users. Every token has an action,
483 which will be used in the ustoken parameter and in the output
484 (actiontoken="..."), and a callback function which should return the token, or
485 false if the user isn't allowed to obtain it. The prototype of the callback
486 function is func($user) where $user is the User object. In the hook, just add
487 your callback to the $tokenFunctions array and return true (returning false
489 $tokenFunctions: array(action => callback)
491 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling() when
492 an exception is thrown during API action execution.
493 $apiMain: Calling ApiMain instance.
494 $e: Exception object.
496 'ApiRsdServiceApis': Add or remove APIs from the RSD services list. Each service
497 should have its own entry in the $apis array and have a unique name, passed as
498 key for the array that represents the service data. In this data array, the
499 key-value-pair identified by the apiLink key is required.
500 &$apis: array of services
502 'ApiTokensGetTokenTypes': DEPRECATED! Use ApiQueryTokensRegisterTypes instead.
503 Use this hook to extend action=tokens with new token types.
504 &$tokenTypes: supported token types in format 'type' => callback function
505 used to retrieve this type of tokens.
507 'Article::MissingArticleConditions': Before fetching deletion & move log entries
508 to display a message of a non-existing page being deleted/moved, give extensions
509 a chance to hide their (unrelated) log entries.
510 &$conds: Array of query conditions (all of which have to be met; conditions will
511 AND in the final query)
512 $logTypes: Array of log types being queried
514 'ArticleAfterFetchContent': After fetching content of an article from the
515 database. DEPRECATED, use ArticleAfterFetchContentObject instead.
516 $article: the article (object) being loaded from the database
517 &$content: the content (string) of the article
519 'ArticleAfterFetchContentObject': After fetching content of an article from the
521 $article: the article (object) being loaded from the database
522 &$content: the content of the article, as a Content object
524 'ArticleConfirmDelete': Before writing the confirmation form for article
526 $article: the article (object) being deleted
527 $output: the OutputPage object
528 &$reason: the reason (string) the article is being deleted
530 'ArticleContentOnDiff': Before showing the article content below a diff. Use
531 this to change the content in this area or how it is loaded.
532 $diffEngine: the DifferenceEngine
533 $output: the OutputPage object
535 'ArticleDelete': Before an article is deleted.
536 $wikiPage: the WikiPage (object) being deleted
537 $user: the user (object) deleting the article
538 $reason: the reason (string) the article is being deleted
539 $error: if the deletion was prohibited, the (raw HTML) error message to display
541 $status: Status object, modify this to throw an error. Overridden by $error
544 'ArticleDeleteAfterSuccess': Output after an article has been deleted.
545 $title: Title of the article that has been deleted.
546 $outputPage: OutputPage that can be used to append the output.
548 'ArticleDeleteComplete': After an article is deleted.
549 $wikiPage: the WikiPage that was deleted
550 $user: the user that deleted the article
551 $reason: the reason the article was deleted
552 $id: id of the article that was deleted
553 $content: the Content of the deleted page
554 $logEntry: the ManualLogEntry used to record the deletion
556 'ArticleEditUpdateNewTalk': Before updating user_newtalk when a user talk page
558 &$wikiPage: WikiPage (object) of the user talk page
559 $recipient: User (object) who's talk page was edited
561 'ArticleEditUpdates': When edit updates (mainly link tracking) are made when an
562 article has been changed.
563 $wikiPage: the WikiPage (object)
564 $editInfo: data holder that includes the parser output ($editInfo->output) for
565 that page after the change
566 $changed: bool for if the page was changed
568 'ArticleEditUpdatesDeleteFromRecentchanges': Before deleting old entries from
569 recentchanges table, return false to not delete old entries.
570 $wikiPage: WikiPage (object) being modified
572 'ArticleFromTitle': when creating an article object from a title object using
573 Wiki::articleFromTitle().
574 $title: Title (object) used to create the article object
575 $article: Article (object) that will be returned
576 $context: IContextSource (object)
578 'ArticleInsertComplete': After a new article is created. DEPRECATED, use
579 PageContentInsertComplete.
580 $wikiPage: WikiPage created
581 $user: User creating the article
583 $summary: Edit summary/comment
584 $isMinor: Whether or not the edit was marked as minor
585 $isWatch: (No longer used)
586 $section: (No longer used)
587 $flags: Flags passed to WikiPage::doEditContent()
588 $revision: New Revision of the article
590 'ArticleMergeComplete': After merging to article using Special:Mergehistory.
591 $targetTitle: target title (object)
592 $destTitle: destination title (object)
594 'ArticlePageDataAfter': After loading data of an article from the database.
595 $wikiPage: WikiPage (object) whose data were loaded
596 $row: row (object) returned from the database server
598 'ArticlePageDataBefore': Before loading data of an article from the database.
599 $wikiPage: WikiPage (object) that data will be loaded
600 $fields: fields (array) to load from the database
602 'ArticlePrepareTextForEdit': Called when preparing text to be saved.
603 $wikiPage: the WikiPage being saved
604 $popts: parser options to be used for pre-save transformation
606 'ArticleProtect': Before an article is protected.
607 $wikiPage: the WikiPage being protected
608 $user: the user doing the protection
609 $protect: boolean whether this is a protect or an unprotect
610 $reason: Reason for protect
611 $moveonly: boolean whether this is for move only or not
613 'ArticleProtectComplete': After an article is protected.
614 $wikiPage: the WikiPage that was protected
615 $user: the user who did the protection
616 $protect: boolean whether it was a protect or an unprotect
617 $reason: Reason for protect
618 $moveonly: boolean whether it was for move only or not
620 'ArticlePurge': Before executing "&action=purge".
621 $wikiPage: WikiPage (object) to purge
623 'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
624 revisions of an article.
625 &$title: Title object of the article
627 'ArticleRevisionUndeleted': After an article revision is restored.
628 $title: the article title
629 $revision: the revision
630 $oldPageID: the page ID of the revision when archived (may be null)
632 'ArticleRollbackComplete': After an article rollback is completed.
633 $wikiPage: the WikiPage that was edited
634 $user: the user who did the rollback
635 $revision: the revision the page was reverted back to
636 $current: the reverted revision
638 'ArticleSave': Before an article is saved. DEPRECATED, use PageContentSave
640 $wikiPage: the WikiPage (object) being saved
641 $user: the user (object) saving the article
642 $text: the new article text
643 $summary: the article summary (comment)
648 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use
649 PageContentSaveComplete instead.
650 $wikiPage: WikiPage modified
651 $user: User performing the modification
653 $summary: Edit summary/comment
654 $isMinor: Whether or not the edit was marked as minor
655 $isWatch: (No longer used)
656 $section: (No longer used)
657 $flags: Flags passed to WikiPage::doEditContent()
658 $revision: New Revision of the article
659 $status: Status object about to be returned by doEditContent()
660 $baseRevId: the rev ID (or false) this edit was based on
662 'ArticleUndelete': When one or more revisions of an article are restored.
663 $title: Title corresponding to the article restored
664 $create: Whether or not the restoration caused the page to be created (i.e. it
665 didn't exist before).
666 $comment: The comment associated with the undeletion.
667 $oldPageId: ID of page previously deleted (from archive table)
669 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
670 $pageArchive: the PageArchive object
671 &$logEntry: ManualLogEntry object
672 $user: User who is performing the log action
674 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before
675 the user is redirected back to the page.
676 &$article: the article
677 &$sectionanchor: The section anchor link (e.g. "#overview" )
678 &$extraq: Extra query parameters which can be added via hooked functions
680 'ArticleViewFooter': After showing the footer section of an ordinary page view
681 $article: Article object
682 $patrolFooterShown: boolean whether patrol footer is shown
684 'ArticleViewHeader': Before the parser cache is about to be tried for article
686 &$article: the article
687 &$pcache: whether to try the parser cache or not
688 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
689 object to both indicate that the output is done and what parser output was used.
691 'ArticleViewRedirect': Before setting "Redirected from ..." subtitle when a
692 redirect was followed.
693 $article: target article (object)
695 'ArticleViewCustom': Allows to output the text of the article in a different
696 format than wikitext. DEPRECATED, use ArticleContentViewCustom instead. Note
697 that it is preferable to implement proper handing for a custom data type using
698 the ContentHandler facility.
699 $text: text of the page
700 $title: title of the page
701 $output: reference to $wgOut
703 'ArticleContentViewCustom': Allows to output the text of the article in a
704 different format than wikitext. Note that it is preferable to implement proper
705 handing for a custom data type using the ContentHandler facility.
706 $content: content of the page, as a Content object
707 $title: title of the page
708 $output: reference to $wgOut
710 'AuthPluginAutoCreate': Called when creating a local account for an user logged
711 in from an external authentication method.
712 $user: User object created locally
714 'AuthPluginSetup': Update or replace authentication plugin object ($wgAuth).
715 Gives a chance for an extension to set it programmatically to a variable class.
716 &$auth: the $wgAuth object, probably a stub
718 'AutopromoteCondition': Check autopromote condition for user.
719 $type: condition type
722 $result: result of checking autopromote condition
724 'BacklinkCacheGetPrefix': Allows to set prefix for a specific link table.
728 'BacklinkCacheGetConditions': Allows to set conditions for query when links to
729 certain title are fetched.
731 $title: title of the page to which backlinks are sought
732 &$conds: query conditions
734 'BadImage': When checking against the bad image list. Change $bad and return
735 false to override. If an image is "bad", it is not rendered inline in wiki
736 pages or galleries in category pages.
737 $name: Image name being checked
738 &$bad: Whether or not the image is "bad"
740 'BaseTemplateAfterPortlet': After output of portlets, allow injecting
741 custom HTML after the section. Any uses of the hook need to handle escaping.
742 $template BaseTemplate
743 $portlet: string portlet name
746 'BeforeDisplayNoArticleText': Before displaying message key "noarticletext" or
747 "noarticletext-nopermission" at Article::showMissingArticle().
748 $article: article object
750 'BeforeInitialize': Before anything is initialized in
751 MediaWiki::performRequest().
752 &$title: Title being used for request
754 &$output: OutputPage object
756 $request: WebRequest object
757 $mediaWiki: Mediawiki object
759 'BeforePageDisplay': Prior to outputting a page.
760 &$out: OutputPage object
763 'BeforeHttpsRedirect': Prior to forcing HTTP->HTTPS redirect. Gives a chance to
764 override how the redirect is output by modifying, or by returning false, and
765 letting standard HTTP rendering take place.
766 ATTENTION: This hook is likely to be removed soon due to overall design of the system.
767 $context: IContextSource object
768 &$redirect: string URL, modifiable
770 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
771 override how the redirect is output by modifying, or by returning false and
772 taking over the output.
773 $out: OutputPage object
774 &$redirect: URL, modifiable
775 &$code: HTTP code (eg '301' or '302'), modifiable
777 'BeforeParserFetchFileAndTitle': Before an image is rendered by Parser.
778 $parser: Parser object
780 &$options: array of options to RepoGroup::findFile. If it contains 'broken'
781 as a key then the file will appear as a broken thumbnail.
782 &$descQuery: query string to add to thumbnail URL
784 'BeforeParserFetchTemplateAndtitle': Before a template is fetched by Parser.
785 $parser: Parser object
786 $title: title of the template
787 &$skip: skip this template and link it?
788 &$id: the id of the revision being parsed
790 'BeforeParserrenderImageGallery': Before an image gallery is rendered by Parser.
791 &$parser: Parser object
792 &$ig: ImageGallery object
794 'BeforeWelcomeCreation': Before the welcomecreation message is displayed to a
796 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen
797 to a newly created user account.
798 &$injected_html: Any HTML to inject after the "logged in" message of a newly
801 'BitmapHandlerTransform': before a file is transformed, gives extension the
802 possibility to transform it themselves
803 $handler: BitmapHandler
805 &$scalerParams: Array with scaler parameters
806 &$mto: null, set to a MediaTransformOutput
808 'BitmapHandlerCheckImageArea': By BitmapHandler::normaliseParams, after all
809 normalizations have been performed, except for the $wgMaxImageArea check.
811 &$params: Array of parameters
812 &$checkImageAreaHookResult: null, set to true or false to override the
813 $wgMaxImageArea check result.
815 'PerformRetroactiveAutoblock': Called before a retroactive autoblock is applied
817 $block: Block object (which is set to be autoblocking)
818 &$blockIds: Array of block IDs of the autoblock
820 'BlockIp': Before an IP address or user is blocked.
821 $block: the Block object about to be saved
822 $user: the user _doing_ the block (not the one being blocked)
823 &$reason: if the hook is aborted, the error message to be returned in an array
825 'BlockIpComplete': After an IP address or user is blocked.
826 $block: the Block object that was saved
827 $user: the user who did the block (not the one being blocked)
829 'BookInformation': Before information output on Special:Booksources.
830 $isbn: ISBN to show information for
831 $output: OutputPage object in use
833 'CanIPUseHTTPS': Determine whether the client at a given source IP is likely
834 to be able to access the wiki via HTTPS.
835 $ip: The IP address in human-readable form
836 &$canDo: This reference should be set to false if the client may not be able
839 'CanonicalNamespaces': For extensions adding their own namespaces or altering
841 Note that if you need to specify namespace protection or content model for
842 a namespace that is added in a CanonicalNamespaces hook handler, you
843 should do so by altering $wgNamespaceProtection and
844 $wgNamespaceContentModels outside the handler, in top-level scope. The
845 point at which the CanonicalNamespaces hook fires is too late for altering
846 these variables. This applies even if the namespace addition is
847 conditional; it is permissible to declare a content model and protection
848 for a namespace and then decline to actually register it.
849 &$namespaces: Array of namespace numbers with corresponding canonical names
851 'CategoryAfterPageAdded': After a page is added to a category.
852 $category: Category that page was added to
853 $wikiPage: WikiPage that was added
855 'CategoryAfterPageRemoved': After a page is removed from a category.
856 $category: Category that page was removed from
857 $wikiPage: WikiPage that was removed
859 'CategoryPageView': Before viewing a categorypage in CategoryPage::view.
860 $catpage: CategoryPage instance
862 'ChangePasswordForm': For extensions that need to add a field to the
863 ChangePassword form via the Preferences form.
864 &$extraFields: An array of arrays that hold fields like would be passed to the
867 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
868 &$changesList: ChangesList instance.
869 &$articlelink: HTML of link to article (already filled-in).
870 &$s: HTML of row that is being constructed.
871 &$rc: RecentChange instance.
872 $unpatrolled: Whether or not we are showing unpatrolled changes.
873 $watched: Whether or not the change is watched by the user.
875 'ChangesListInitRows': Batch process change list rows prior to rendering.
876 $changesList: ChangesList instance
877 $rows: The data that will be rendered. May be a ResultWrapper instance or
880 'ChangesListSpecialPageFilters': Called after building form options on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
881 $special: ChangesListSpecialPage instance
882 &$filters: associative array of filter definitions. The keys are the HTML
883 name/URL parameters. Each key maps to an associative array with a 'msg'
884 (message key) and a 'default' value.
886 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist).
887 $name: name of the special page, e.g. 'Watchlist'
888 &$tables: array of tables to be queried
889 &$fields: array of columns to select
890 &$conds: array of WHERE conditionals for query
891 &$query_options: array of options for the database request
892 &$join_conds: join conditions for the tables
893 $opts: FormOptions for this request
895 'LoginUserMigrated': Called during login to allow extensions the opportunity to
896 inform a user that their username doesn't exist for a specific reason, instead
897 of letting the login form give the generic error message that the account does
898 not exist. For example, when the account has been renamed or deleted.
899 $user: the User object being authenticated against.
900 &$msg: the message identifier for abort reason, or an array to pass a message
903 'Collation::factory': Called if $wgCategoryCollation is an unknown collation.
904 $collationName: Name of the collation in question
905 &$collationObject: Null. Replace with a subclass of the Collation class that
906 implements the collation given in $collationName.
908 'ConfirmEmailComplete': Called after a user's email has been confirmed
910 $user: user (object) whose email is being confirmed
912 'ContentHandlerDefaultModelFor': Called when the default content model is determined
913 for a given title. May be used to assign a different model for that title.
914 $title: the Title in question
915 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
917 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
918 content model name, but no entry for that model exists in $wgContentHandlers.
919 $modeName: the requested content model name
920 &$handler: set this to a ContentHandler object, if desired.
922 'ContentModelCanBeUsedOn': Called to determine whether that content model can
923 be used on a given page. This is especially useful to prevent some content models
924 to be used in some special location.
925 $contentModel: ID of the content model in question
926 $title: the Title in question.
927 &$ok: Output parameter, whether it is OK to use $contentModel on $title.
928 Handler functions that modify $ok should generally return false to prevent further
929 hooks from further modifying $ok.
931 'ContentGetParserOutput': Customize parser output for a given content object,
932 called by AbstractContent::getParserOutput. May be used to override the normal
933 model-specific rendering of page content.
934 $content: The Content to render
935 $title: Title of the page, as context
936 $revId: The revision ID, as context
937 $options: ParserOptions for rendering. To avoid confusing the parser cache,
938 the output can only depend on parameters provided to this hook function, not on global state.
939 $generateHtml: boolean, indicating whether full HTML should be generated. If false,
940 generation of HTML may be skipped, but other information should still be present in the
942 &$output: ParserOutput, to manipulate or replace
944 'ContentAlterParserOutput': Modify parser output for a given content object.
945 Called by Content::getParserOutput after parsing has finished. Can be used
946 for changes that depend on the result of the parsing but have to be done
947 before LinksUpdate is called (such as adding tracking categories based on
949 $content: The Content to render
950 $title: Title of the page, as context
951 $parserOutput: ParserOutput to manipulate
953 'ConvertContent': Called by AbstractContent::convert when a conversion to another
954 content model is requested.
955 $content: The Content object to be converted.
956 $toModel: The ID of the content model to convert to.
957 $lossy: boolean indicating whether lossy conversion is allowed.
958 &$result: Output parameter, in case the handler function wants to provide a
959 converted Content object. Note that $result->getContentModel() must return $toModel.
960 Handler functions that modify $result should generally return false to further
961 attempts at conversion.
963 'ContribsPager::getQueryInfo': Before the contributions query is about to run
964 &$pager: Pager object for contributions
965 &$queryInfo: The query for the contribs Pager
967 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
968 &$data: an array of results of all contribs queries
969 $pager: The ContribsPager object hooked into
970 $offset: Index offset, inclusive
971 $limit: Exact query limit
972 $descending: Query direction, false for ascending, true for descending
974 'ContributionsLineEnding': Called before a contributions HTML line is finished
975 $page: SpecialPage object for contributions
977 $row: the DB row for this line
978 &$classes: the classes to add to the surrounding <li>
980 'ContributionsToolLinks': Change tool links above Special:Contributions
982 $title: User page title
983 &$tools: Array of tool links
985 'CustomEditor': When invoking the page editor
986 $article: Article being edited
987 $user: User performing the edit
989 Return true to allow the normal editor to be used, or false
990 if implementing a custom editor, e.g. for a special namespace,
993 'DatabaseOraclePostInit': Called after initialising an Oracle database
994 &$db: the DatabaseOracle object
996 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
997 $title: the diff page title (nullable)
998 &$oldId: the actual old Id to use in the diff
999 &$newId: the actual new Id to use in the diff (0 means current)
1000 $old: the ?old= param value from the url
1001 $new: the ?new= param value from the url
1003 'DiffRevisionTools': Override or extend the revision tools available from the
1004 diff view, i.e. undo, etc.
1005 $newRev: Revision object of the "new" revision
1006 &$links: Array of HTML links
1007 $oldRev: Revision object of the "old" revision (may be null)
1009 'DiffViewHeader': Called before diff display
1010 $diff: DifferenceEngine object that's calling
1011 $oldRev: Revision object of the "old" revision (may be null/invalid)
1012 $newRev: Revision object of the "new" revision
1014 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
1016 $article: article (object) being viewed
1017 $oldid: oldid (int) being viewed
1019 'DoEditSectionLink': Override the HTML generated for section edit links
1020 $skin: Skin object rendering the UI
1021 $title: Title object for the title being linked to (may not be the same as
1022 the page title, if the section is included from a template)
1023 $section: The designation of the section being pointed to, to be included in
1024 the link, like "§ion=$section"
1025 $tooltip: The default tooltip. Escape before using.
1026 By default, this is wrapped in the 'editsectionhint' message.
1027 &$result: The HTML to return, prefilled with the default plus whatever other
1028 changes earlier hooks have made
1029 $lang: The language code to use for the link in the wfMessage function
1031 'EditFilter': Perform checks on an edit
1032 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
1033 $text: Contents of the edit box
1034 $section: Section being edited
1035 &$error: Error message to return
1036 $summary: Edit summary for page
1038 'EditFilterMerged': Post-section-merge edit filter.
1039 DEPRECATED, use EditFilterMergedContent instead.
1040 $editor: EditPage instance (object)
1041 $text: content of the edit box
1042 &$error: error message to return
1043 $summary: Edit summary for page
1045 'EditFilterMergedContent': Post-section-merge edit filter.
1046 This may be triggered by the EditPage or any other facility that modifies page content.
1047 Use the $status object to indicate whether the edit should be allowed, and to provide
1048 a reason for disallowing it. Return false to abort the edit, and true to continue.
1049 Returning true if $status->isOK() returns false means "don't save but continue user
1050 interaction", e.g. show the edit form. $status->apiHookResult can be set to an array
1051 to be returned by api.php action=edit. This is used to deliver captchas.
1052 $context: object implementing the IContextSource interface.
1053 $content: content of the edit box, as a Content object.
1054 $status: Status object to represent errors, etc.
1055 $summary: Edit summary for page
1056 $user: the User object representing the user whois performing the edit.
1057 $minoredit: whether the edit was marked as minor by the user.
1059 'EditFormPreloadText': Allows population of the edit form when creating
1061 &$text: Text to preload with
1062 &$title: Title object representing the page being created
1064 'EditFormInitialText': Allows modifying the edit form when editing existing
1066 $editPage: EditPage object
1068 'EditPage::attemptSave': Called before an article is
1069 saved, that is before WikiPage::doEditContent() is called
1070 $editpage_Obj: the current EditPage object
1072 'EditPage::importFormData': allow extensions to read additional data
1074 $editpage: EditPage instance
1075 $request: Webrequest
1076 return value is ignored (should always return true)
1078 'EditPage::showEditForm:fields': allows injection of form field into edit form
1079 $editor: the EditPage instance for reference
1080 $out: an OutputPage instance to write to
1081 return value is ignored (should always return true)
1083 'EditPage::showEditForm:initial': before showing the edit form
1084 $editor: EditPage instance (object)
1085 $out: an OutputPage instance to write to
1087 Return false to halt editing; you'll need to handle error messages, etc.
1088 yourself. Alternatively, modifying $error and returning true will cause the
1089 contents of $error to be echoed at the top of the edit form as wikitext.
1090 Return true without altering $error to allow the edit to proceed.
1092 'EditPage::showReadOnlyForm:initial': similar to EditPage::showEditForm:initial
1093 but for the read-only 'view source' variant of the edit form.
1094 $editor: EditPage instance (object)
1095 &$out: an OutputPage instance to write to
1096 return value is ignored (should always return true)
1098 'EditPage::showStandardInputs:options': allows injection of form fields into
1099 the editOptions area
1100 $editor: EditPage instance (object)
1101 $out: an OutputPage instance to write to
1102 &$tabindex: HTML tabindex of the last edit check/button
1103 return value is ignored (should always be true)
1105 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
1106 when there's an edit conflict. Return false to halt normal diff output; in
1107 this case you're responsible for computing and outputting the entire "conflict"
1108 part, i.e., the "difference between revisions" and "your text" headers and
1110 &$editor: EditPage instance
1111 &$out: OutputPage instance
1113 'EditPageBeforeEditButtons': Allows modifying the edit buttons below the
1114 textarea in the edit form.
1115 &$editpage: The current EditPage object
1116 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
1117 &$tabindex: HTML tabindex of the last edit check/button
1119 'EditPageBeforeEditChecks': Allows modifying the edit checks below the textarea
1121 &$editpage: The current EditPage object
1122 &$checks: Array of edit checks like "watch this page"/"minor edit"
1123 &$tabindex: HTML tabindex of the last edit check/button
1125 'EditPageBeforeEditToolbar': Allows modifying the edit toolbar above the
1126 textarea in the edit form.
1127 &$toolbar: The toolbar HTMl
1129 'EditPageCopyrightWarning': Allow for site and per-namespace customization of
1130 contribution/copyright notice.
1131 $title: title of page being edited
1132 &$msg: localization message name, overridable. Default is either
1133 'copyrightwarning' or 'copyrightwarning2'.
1135 'EditPageGetDiffText': DEPRECATED. Use EditPageGetDiffContent instead. Allow
1136 modifying the wikitext that will be used in "Show changes". Note that it is
1137 preferable to implement diff handling for different data types using the
1138 ContentHandler facility.
1139 $editPage: EditPage object
1140 &$newtext: wikitext that will be used as "your version"
1142 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
1143 "Show changes". Note that it is preferable to implement diff handling for
1144 different data types using the ContentHandler facility.
1145 $editPage: EditPage object
1146 &$newtext: wikitext that will be used as "your version"
1148 'EditPageGetPreviewText': DEPRECATED. Use EditPageGetPreviewContent instead.
1149 Allow modifying the wikitext that will be previewed. Note that it is preferable
1150 to implement previews for different data types using the ContentHandler
1152 $editPage: EditPage object
1153 &$toparse: wikitext that will be parsed
1155 'EditPageGetPreviewContent': Allow modifying the wikitext that will be
1156 previewed. Note that it is preferable to implement previews for different data
1157 types using the ContentHandler facility.
1158 $editPage: EditPage object
1159 &$content: Content object to be previewed (may be replaced by hook function)
1161 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
1162 &$editpage: The current EditPage object
1163 &$res: the HTML of the error text
1165 'EditPageTosSummary': Give a chance for site and per-namespace customizations
1166 of terms of service summary link that might exist separately from the copyright
1168 $title: title of page being edited
1169 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
1171 'EmailConfirmed': When checking that the user's email address is "confirmed".
1172 $user: User being checked
1173 $confirmed: Whether or not the email address is confirmed
1174 This runs before the other checks, such as anonymity and the real check; return
1175 true to allow those checks to occur, and false if checking is done.
1177 'EmailUser': Before sending email from one user to another.
1178 $to: address of receiving user
1179 $from: address of sending user
1180 $subject: subject of the mail
1181 $text: text of the mail
1183 'EmailUserCC': Before sending the copy of the email to the author.
1184 $to: address of receiving user
1185 $from: address of sending user
1186 $subject: subject of the mail
1187 $text: text of the mail
1189 'EmailUserComplete': After sending email from one user to another.
1190 $to: address of receiving user
1191 $from: address of sending user
1192 $subject: subject of the mail
1193 $text: text of the mail
1195 'EmailUserForm': After building the email user form object.
1196 $form: HTMLForm object
1198 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a
1200 $user: The user who is trying to email another user.
1201 $editToken: The user's edit token.
1202 &$hookErr: Out-param for the error. Passed as the parameters to
1203 OutputPage::showErrorPage.
1205 'ExemptFromAccountCreationThrottle': Exemption from the account creation
1207 $ip: The ip address of the user
1209 'ExtensionTypes': Called when generating the extensions credits, use this to
1210 change the tables headers.
1211 &$extTypes: associative array of extensions types
1213 'ExtractThumbParameters': Called when extracting thumbnail parameters from a
1214 thumbnail file name.
1215 DEPRECATED: Media handler should override MediaHandler::parseParamString instead.
1216 $thumbname: the base name of the thumbnail file
1217 &$params: the currently extracted params (has source name, temp or archived zone)
1219 'FetchChangesList': When fetching the ChangesList derivative for a particular
1221 $user: User the list is being fetched for
1222 &$skin: Skin object to be used with the list
1223 &$list: List object (defaults to NULL, change it to an object instance and
1224 return false override the list derivative used)
1226 'FileDeleteComplete': When a file is deleted.
1227 $file: reference to the deleted file
1228 $oldimage: in case of the deletion of an old image, the name of the old file
1229 $article: in case all revisions of the file are deleted a reference to the
1230 WikiFilePage associated with the file.
1231 $user: user who performed the deletion
1234 'FileTransformed': When a file is transformed and moved into storage.
1235 $file: reference to the File object
1236 $thumb: the MediaTransformOutput object
1237 $tmpThumbPath: The temporary file system path of the transformed file
1238 $thumbPath: The permanent storage path of the transformed file
1240 'FileUpload': When a file upload occurs.
1241 $file : Image object representing the file that was uploaded
1242 $reupload : Boolean indicating if there was a previously another image there or
1244 $hasDescription : Boolean indicating that there was already a description page
1245 and a new one from the comment wasn't created (since 1.17)
1247 'FileUndeleteComplete': When a file is undeleted
1248 $title: title object to the file
1249 $fileVersions: array of undeleted versions. Empty if all versions were restored
1250 $user: user who performed the undeletion
1253 'FormatAutocomments': When an autocomment is formatted by the Linker.
1254 &$comment: Reference to the accumulated comment. Initially null, when set the
1255 default code will be skipped.
1256 $pre: Initial part of the parsed comment before the call to the hook.
1257 $auto: The extracted part of the parsed comment before the call to the hook.
1258 $post: The final part of the parsed comment before the call to the hook.
1259 $title: An optional title object used to links to sections. Can be null.
1260 $local: Boolean indicating whether section links should refer to local page.
1262 'GalleryGetModes': Get list of classes that can render different modes of a
1264 &$modeArray: An associative array mapping mode names to classes that implement
1265 that mode. It is expected all registered classes are a subclass of
1268 'GetAutoPromoteGroups': When determining which autopromote groups a user is
1270 &$user: user to promote.
1271 &$promote: groups that will be added.
1273 'GetBlockedStatus': after loading blocking status of an user from the database
1274 $user: user (object) being checked
1276 'GetCacheVaryCookies': Get cookies that should vary cache options.
1277 $out: OutputPage object
1278 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1279 that have to vary cache options
1281 'GetCanonicalURL': Modify fully-qualified URLs used for IRC and e-mail
1283 $title: Title object of page
1284 $url: string value as output (out parameter, can modify)
1285 $query: query options passed to Title::getCanonicalURL()
1287 'GetDefaultSortkey': Override the default sortkey for a page.
1288 $title: Title object that we need to get a sortkey for
1289 &$sortkey: Sortkey to use.
1291 'GetDoubleUnderscoreIDs': Modify the list of behavior switch (double
1292 underscore) magic words. Called by MagicWord.
1293 &$doubleUnderscoreIDs: array of strings
1295 'GetExtendedMetadata': Get extended file metadata for the API
1296 &$combinedMeta: Array of the form: 'MetadataPropName' => array(
1297 'value' => prop value, 'source' => 'name of hook' ).
1298 $file: File object of file in question
1299 $context: RequestContext (including language to use)
1300 $single: Only extract the current language; if false, the prop value should
1301 be in the metadata multi-language array format:
1302 mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
1303 &$maxCacheTime: how long the results can be cached
1305 'GetFullURL': Modify fully-qualified URLs used in redirects/export/offsite data.
1306 $title: Title object of page
1307 $url: string value as output (out parameter, can modify)
1308 $query: query options passed to Title::getFullURL()
1310 'GetHumanTimestamp': Pre-emptively override the human-readable timestamp generated
1311 by MWTimestamp::getHumanTimestamp(). Return false in this hook to use the custom
1313 &$output: string for the output timestamp
1314 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1315 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1316 $user: User whose preferences are being used to make timestamp
1317 $lang: Language that will be used to render the timestamp
1319 'GetInternalURL': Modify fully-qualified URLs used for squid cache purging.
1320 $title: Title object of page
1321 $url: string value as output (out parameter, can modify)
1322 $query: query options passed to Title::getInternalURL()
1324 'GetIP': modify the ip of the current user (called only once).
1325 &$ip: string holding the ip as determined so far
1327 'GetLinkColours': modify the CSS class of an array of page links.
1328 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1330 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1332 'GetLocalURL': Modify local URLs as output into page links. Note that if you are
1333 working with internal urls (non-interwiki) then it may be preferable to work
1334 with the GetLocalURL::Internal or GetLocalURL::Article hooks as GetLocalURL can
1335 be buggy for internal urls on render if you do not re-implement the horrible
1336 hack that Title::getLocalURL uses in your own extension.
1337 $title: Title object of page
1338 &$url: string value as output (out parameter, can modify)
1339 $query: query options passed to Title::getLocalURL()
1341 'GetLocalURL::Internal': Modify local URLs to internal pages.
1342 $title: Title object of page
1343 &$url: string value as output (out parameter, can modify)
1344 $query: query options passed to Title::getLocalURL()
1346 'GetLocalURL::Article': Modify local URLs specifically pointing to article paths
1347 without any fancy queries or variants.
1348 $title: Title object of page
1349 &$url: string value as output (out parameter, can modify)
1351 'GetLogTypesOnUser': Add log types where the target is a userpage
1352 &$types: Array of log types
1354 'GetMetadataVersion': Modify the image metadata version currently in use. This
1355 is used when requesting image metadata from a ForeignApiRepo. Media handlers
1356 that need to have versioned metadata should add an element to the end of the
1357 version array of the form 'handler_name=version'. Most media handlers won't need
1358 to do this unless they broke backwards compatibility with a previous version of
1359 the media handler metadata output.
1360 &$version: Array of version strings
1362 'GetNewMessagesAlert': Disable or modify the new messages alert
1363 &$newMessagesAlert: An empty string by default. If the user has new talk page
1364 messages, this should be populated with an alert message to that effect
1365 $newtalks: An empty array if the user has no new messages or an array containing
1366 links and revisions if there are new messages (See User::getNewMessageLinks)
1367 $user: The user object of the user who is loading the page
1368 $out: OutputPage object (to check what type of page the user is on)
1370 'GetPreferences': Modify user preferences.
1371 $user: User whose preferences are being modified.
1372 &$preferences: Preferences description array, to be fed to an HTMLForm object
1374 'GetRelativeTimestamp': Pre-emptively override the relative timestamp generated
1375 by MWTimestamp::getRelativeTimestamp(). Return false in this hook to use the custom
1377 &$output: string for the output timestamp
1378 &$diff: DateInterval representing the difference between the timestamps
1379 $timestamp: MWTimestamp object of the current (user-adjusted) timestamp
1380 $relativeTo: MWTimestamp object of the relative (user-adjusted) timestamp
1381 $user: User whose preferences are being used to make timestamp
1382 $lang: Language that will be used to render the timestamp
1384 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1385 checked for. Use instead of userCan for most cases. Return false if the user
1386 can't do it, and populate $result with the reason in the form of
1387 array( messagename, param1, param2, ... ). For consistency, error messages
1388 should be plain text with no special coloring, bolding, etc. to show that
1389 they're errors; presenting them properly to the user as errors is done by the
1391 $title: Title object being checked against
1392 $user : Current user object
1393 $action: Action being checked
1394 $result: User permissions error to add. If none, return true.
1396 'getUserPermissionsErrorsExpensive': Equal to getUserPermissionsErrors, but is
1397 called only if expensive checks are enabled. Add a permissions error when
1398 permissions errors are checked for. Return false if the user can't do it, and
1399 populate $result with the reason in the form of array( messagename, param1,
1400 param2, ... ). For consistency, error messages should be plain text with no
1401 special coloring, bolding, etc. to show that they're errors; presenting them
1402 properly to the user as errors is done by the caller.
1404 $title: Title object being checked against
1405 $user : Current user object
1406 $action: Action being checked
1407 $result: User permissions error to add. If none, return true.
1409 'GitViewers': Called when generating the list of git viewers for
1410 Special:Version, use this to change the list.
1411 &$extTypes: associative array of repo URLS to viewer URLs.
1413 'HistoryRevisionTools': Override or extend the revision tools available from the
1414 page history view, i.e. undo, rollback, etc.
1415 $rev: Revision object
1416 &$links: Array of HTML links
1418 'HTMLFileCache::useFileCache': Override whether a page should be cached in file
1420 $context: An IContextSource object with information about the request being served.
1422 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1423 image insertion. You can skip the default logic entirely by returning false, or
1424 just modify a few things using call-by-reference.
1426 &$title: Title object of the image
1427 &$file: File object, or false if it doesn't exist
1428 &$frameParams: Various parameters with special meanings; see documentation in
1429 includes/Linker.php for Linker::makeImageLink
1430 &$handlerParams: Various parameters with special meanings; see documentation in
1431 includes/Linker.php for Linker::makeImageLink
1432 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1433 &$res: Final HTML output, used if you return false
1436 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1437 the image on an image page.
1438 $imagePage: ImagePage object ($this)
1441 'ImagePageAfterImageLinks': Called after the image links section on an image
1443 $imagePage: ImagePage object ($this)
1444 &$html: HTML for the hook to add
1446 'ImagePageFileHistoryLine': Called when a file history line is constructed.
1448 $line: the HTML of the history line
1449 $css: the line CSS class
1451 'ImagePageFindFile': Called when fetching the file associated with an image
1453 $page: ImagePage object
1455 &$displayFile: displayed File object
1457 'ImagePageShowTOC': Called when the file toc on an image page is generated.
1458 $page: ImagePage object
1459 &$toc: Array of <li> strings
1461 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1463 &$title: the Title object of the file as it would appear for the upload page
1464 &$path: the original file and path name when img_auth was invoked by the web
1466 &$name: the name only component of the file
1467 &$result: The location to pass back results of the hook routine (only used if
1469 $result[0]=The index of the header message
1470 $result[1]=The index of the body text message
1471 $result[2 through n]=Parameters passed to body text message. Please note the
1472 header message cannot receive/use parameters.
1474 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item.
1475 $reader: XMLReader object
1476 $logInfo: Array of information
1477 Return false to stop further processing of the tag
1479 'ImportHandlePageXMLTag': When parsing a XML tag in a page.
1480 $reader: XMLReader object
1481 $pageInfo: Array of information
1482 Return false to stop further processing of the tag
1484 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision.
1485 $reader: XMLReader object
1486 $pageInfo: Array of page information
1487 $revisionInfo: Array of revision information
1488 Return false to stop further processing of the tag
1490 'ImportHandleToplevelXMLTag': When parsing a top level XML tag.
1491 $reader: XMLReader object
1492 Return false to stop further processing of the tag
1494 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload.
1495 $reader: XMLReader object
1496 $revisionInfo: Array of information
1497 Return false to stop further processing of the tag
1499 'InfoAction': When building information to display on the action=info page.
1500 $context: IContextSource object
1501 &$pageInfo: Array of information
1503 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect.
1504 $title: Title object for the current page
1505 $request: WebRequest
1506 $ignoreRedirect: boolean to skip redirect check
1507 $target: Title/string of redirect target
1508 $article: Article object
1510 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1511 Return true without providing an interwiki to continue interwiki search.
1512 $prefix: interwiki prefix we are looking for.
1513 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1514 iw_trans and optionally iw_api and iw_wikiid.
1516 'InternalParseBeforeSanitize': during Parser's internalParse method just before
1517 the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/
1518 includeonly/onlyinclude and other processings. Ideal for syntax-extensions after
1519 template/parser function execution which respect nowiki and HTML-comments.
1520 &$parser: Parser object
1521 &$text: string containing partially parsed text
1522 &$stripState: Parser's internal StripState object
1524 'InternalParseBeforeLinks': during Parser's internalParse method before links
1525 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1526 &$parser: Parser object
1527 &$text: string containing partially parsed text
1528 &$stripState: Parser's internal StripState object
1530 'InvalidateEmailComplete': Called after a user's email has been invalidated
1532 $user: user (object) whose email is being invalidated
1534 'IRCLineURL': When constructing the URL to use in an IRC notification.
1535 Callee may modify $url and $query, URL will be constructed as $url . $query
1536 &$url: URL to index.php
1537 &$query: Query string
1538 $rc: RecentChange object that triggered url generation
1540 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1541 $article: article (object) being checked
1543 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1545 $result: Change this value to override the result of wfIsTrustedProxy()
1547 'IsUploadAllowedFromUrl': Override the result of UploadFromUrl::isAllowedUrl()
1548 $url: URL used to upload from
1549 &$allowed: Boolean indicating if uploading is allowed for given URL
1551 'isValidEmailAddr': Override the result of Sanitizer::validateEmail(), for
1552 instance to return false if the domain name doesn't match your organization.
1553 $addr: The e-mail address entered by the user
1554 &$result: Set this and return false to override the internal checks
1556 'isValidPassword': Override the result of User::isValidPassword()
1557 $password: The password entered by the user
1558 &$result: Set this and return false to override the internal checks
1559 $user: User the password is being validated for
1561 'Language::getMessagesFileName':
1562 $code: The language code or the language we're looking for a messages file for
1563 &$file: The messages file path, you can override this to change the location.
1565 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1566 remove namespaces. Do not use this hook to add namespaces. Use
1567 CanonicalNamespaces for that.
1568 &$namespaces: Array of namespaces indexed by their numbers
1570 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1571 $wgExtensionMessagesFiles instead.
1572 Use this to define synonyms of magic words depending of the language
1573 $magicExtensions: associative array of magic words synonyms
1574 $lang: language code (string)
1576 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1577 listed in $wgExtensionMessagesFiles instead.
1578 Use to define aliases of special pages names depending of the language
1579 $specialPageAliases: associative array of magic words synonyms
1580 $lang: language code (string)
1582 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1583 &$names: array of language code => language name
1584 $code language of the preferred translations
1586 'LanguageLinks': Manipulate a page's language links. This is called
1587 in various places to allow extensions to define the effective language
1589 $title: The page's Title.
1590 &$links: Associative array mapping language codes to prefixed links of the
1591 form "language:title".
1592 &$linkFlags: Associative array mapping prefixed links to arrays of flags.
1593 Currently unused, but planned to provide support for marking individual
1594 language links in the UI, e.g. for featured articles.
1596 'LanguageSelector': Hook to change the language selector available on a page.
1597 $out: The output page.
1598 $cssClassName: CSS class name of the language selector.
1600 'LinkBegin': Used when generating internal and interwiki links in
1601 Linker::link(), before processing starts. Return false to skip default
1602 processing and return $ret. See documentation for Linker::link() for details on
1603 the expected meanings of parameters.
1604 $skin: the Skin object
1605 $target: the Title that the link is pointing to
1606 &$html: the contents that the <a> tag should have (raw HTML); null means
1608 &$customAttribs: the HTML attributes that the <a> tag should have, in
1609 associative array form, with keys and values unescaped. Should be merged with
1610 default values, with a value of false meaning to suppress the attribute.
1611 &$query: the query string to add to the generated URL (the bit after the "?"),
1612 in associative array form, with keys and values unescaped.
1613 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1614 &$ret: the value to return if your hook returns false.
1616 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1617 just before the function returns a value. If you return true, an <a> element
1618 with HTML attributes $attribs and contents $html will be returned. If you
1619 return false, $ret will be returned.
1620 $skin: the Skin object
1621 $target: the Title object that the link is pointing to
1622 $options: the options. Will always include either 'known' or 'broken', and may
1623 include 'noclasses'.
1624 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1625 &$attribs: the final HTML attributes of the <a> tag, after processing, in
1626 associative array form.
1627 &$ret: the value to return if your hook returns false.
1629 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1631 &$url: the image url
1632 &$alt: the image's alt text
1633 &$img: the new image HTML (if returning false)
1635 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1638 &$text: the link text
1639 &$link: the new link HTML (if returning false)
1640 &$attribs: the attributes to be applied.
1641 $linkType: The external link type
1643 'LinkerMakeMediaLinkFile': At the end of Linker::makeMediaLinkFile() just
1645 $title: the Title object that the link is pointing to
1646 $file: the File object or false if broken link
1647 &$html: the link text
1648 &$attribs: the attributes to be applied
1649 &$ret: the value to return if your hook returns false
1651 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1653 &$linksUpdate: the LinksUpdate object
1655 'LinksUpdateAfterInsert': At the end of LinksUpdate::incrTableUpdate() after
1656 each link table insert. For example, pagelinks, imagelinks, externallinks.
1657 $linksUpdate: LinksUpdate object
1658 $table: the table to insert links to
1659 $insertions: an array of links to insert
1661 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating,
1662 including delete and insert, has completed for all link tables
1663 &$linksUpdate: the LinksUpdate object
1665 'LinksUpdateConstructed': At the end of LinksUpdate() is construction.
1666 &$linksUpdate: the LinksUpdate object
1668 'ListDefinedTags': When trying to find all defined tags.
1669 &$tags: The list of tags.
1671 'LoadExtensionSchemaUpdates': Called during database installation and updates.
1672 &updater: A DatabaseUpdater subclass
1674 'LocalFile::getHistory': Called before file history query performed.
1675 $file: the File object
1677 $fields: select fields
1679 $opts: query options
1680 $join_conds: JOIN conditions
1682 'LocalFilePurgeThumbnails': Called before thumbnails for a local file a purged.
1683 $file: the File object
1684 $archiveName: name of an old file version or false if it's the current one
1686 'LocalisationCacheRecache': Called when loading the localisation data into
1688 $cache: The LocalisationCache object
1689 $code: language code
1690 &$alldata: The localisation data from core and extensions
1691 &purgeBlobs: whether to purge/update the message blobs via MessageBlobStore::clear()
1693 'LocalisationCacheRecacheFallback': Called for each language when merging
1694 fallback data into the cache.
1695 $cache: The LocalisationCache object
1696 $code: language code
1697 &$alldata: The localisation data from core and extensions. Note some keys may
1698 be omitted if they won't be merged into the final result.
1700 'LocalisationChecksBlacklist': When fetching the blacklist of
1701 localisation checks.
1702 &$blacklist: array of checks to blacklist. See the bottom of
1703 maintenance/language/checkLanguage.inc for the format of this variable.
1705 'LocalisationIgnoredOptionalMessages': When fetching the list of ignored and
1706 optional localisation messages
1707 &$ignored Array of ignored message keys
1708 &$optional Array of optional message keys
1710 'LogEventsListGetExtraInputs': When getting extra inputs to display on Special:Log
1711 for a specific log type
1712 $type: String of log type being displayed
1713 $logEventsList: LogEventsList object for context and access to the WebRequest
1714 &$input: string HTML of an input element
1717 'LogEventsListShowLogExtract': Called before the string is added to OutputPage.
1718 Returning false will prevent the string from being added to the OutputPage.
1719 &$s: html string to show for the log extract
1720 $types: String or Array Log types to show
1721 $page: String or Title The page title to show log entries for
1722 $user: String The user who made the log entries
1723 $param: Associative Array with the following additional options:
1724 - lim Integer Limit of items to show, default is 50
1725 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1726 - showIfEmpty boolean Set to false if you don't want any output in case the
1727 loglist is empty if set to true (default), "No matching items in log" is
1728 displayed if loglist is empty
1729 - msgKey Array If you want a nice box with a message, set this to the key of
1730 the message. First element is the message key, additional optional elements
1731 are parameters for the key that are processed with
1732 wfMessage()->params()->parseAsBlock()
1733 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset
1735 - wrap String Wrap the message in html (usually something like
1736 "<div ...>$1</div>").
1737 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1739 'LoginAuthenticateAudit': A login attempt for a valid user account either
1740 succeeded or failed. No return data is accepted; this hook is for auditing only.
1741 $user: the User object being authenticated against
1742 $password: the password being submitted and found wanting
1743 $retval: a LoginForm class constant with authenticateUserData() return
1744 value (SUCCESS, WRONG_PASS, etc.).
1746 'LoginPasswordResetMessage': User is being requested to reset their password on login.
1747 Use this hook to change the Message that will be output on Special:ChangePassword.
1748 &$msg: Message object that will be shown to the user
1749 $username: Username of the user who's password was expired.
1751 'LogLine': Processes a single log entry on Special:Log.
1752 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1753 logging.log_type database field.
1754 $log_action: string for the type of log action (e.g. 'delete', 'block',
1755 'create2'). Corresponds to logging.log_action database field.
1756 $title: Title object that corresponds to logging.log_namespace and
1757 logging.log_title database fields.
1758 $paramArray: Array of parameters that corresponds to logging.log_params field.
1759 Note that only $paramArray[0] appears to contain anything.
1760 &$comment: string that corresponds to logging.log_comment database field, and
1761 which is displayed in the UI.
1762 &$revert: string that is displayed in the UI, similar to $comment.
1763 $time: timestamp of the log entry (added in 1.12)
1765 'LonelyPagesQuery': Allow extensions to modify the query used by
1766 Special:LonelyPages.
1767 &$tables: tables to join in the query
1768 &$conds: conditions for the query
1769 &$joinConds: join conditions for the query
1771 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance
1773 $refreshLinks: RefreshLinks object
1775 'MagicWordwgVariableIDs': When defining new magic words IDs.
1776 $variableIDs: array of strings
1778 'MakeGlobalVariablesScript': Called at end of OutputPage::getJSVars.
1779 Ideally, this hook should only be used to add variables that depend on
1780 the current page/request; static configuration should be added through
1781 ResourceLoaderGetConfigVars instead.
1782 &$vars: variable (or multiple variables) to be added into the output of
1783 Skin::makeVariablesScript
1784 $out: The OutputPage which called the hook, can be used to get the real title.
1786 'MarkPatrolled': Before an edit is marked patrolled.
1787 $rcid: ID of the revision to be marked patrolled
1788 $user: the user (object) marking the revision as patrolled
1789 $wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
1790 sysop in order to mark an edit patrolled.
1792 'MarkPatrolledComplete': After an edit is marked patrolled.
1793 $rcid: ID of the revision marked as patrolled
1794 $user: user (object) who marked the edit patrolled
1795 $wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
1796 sysop to patrol the edit.
1798 'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
1799 something completely different, after the basic globals have been set up, but
1800 before ordinary actions take place.
1802 $article: Article on which the action will be performed
1803 $title: Title on which the action will be performed
1805 $request: $wgRequest
1806 $mediaWiki: The $mediawiki object
1808 'MessagesPreLoad': When loading a message from the database.
1809 $title: title of the message (string)
1810 $message: value (string), change it to the message you want to define
1812 'MessageCache::get': When fetching a message. Can be used to override the key
1813 for customisations. Given and returned message key must be in special format:
1814 1) first letter must be in lower case according to the content language.
1815 2) spaces must be replaced with underscores
1816 &$key: message key (string)
1818 'MessageCacheReplace': When a message page is changed. Useful for updating
1820 $title: name of the page changed.
1821 $text: new contents of the page.
1823 'MimeMagicInit': Before processing the list mapping MIME types to media types
1824 and the list mapping MIME types to file extensions.
1825 As an extension author, you are encouraged to submit patches to MediaWiki's
1826 core to add new MIME types to mime.types.
1827 $mimeMagic: Instance of MimeMagic.
1828 Use $mimeMagic->addExtraInfo( $stringOfInfo );
1829 for adding new MIME info to the list.
1830 Use $mimeMagic->addExtraTypes( $stringOfTypes );
1831 for adding new MIME types to the list.
1833 'MimeMagicImproveFromExtension': Allows MW extensions to further improve the
1834 MIME type detected by considering the file extension.
1835 $mimeMagic: Instance of MimeMagic.
1836 $ext: File extension.
1837 &$mime: MIME type (in/out).
1839 'MimeMagicGuessFromContent': Allows MW extensions guess the MIME by content.
1840 $mimeMagic: Instance of MimeMagic.
1841 &$head: First 1024 bytes of the file in a string (in - Do not alter!).
1842 &$tail: More or equal than last 65558 bytes of the file in a string
1843 (in - Do not alter!).
1845 &$mime: MIME type (out).
1847 'ModifyExportQuery': Modify the query used by the exporter.
1848 $db: The database object to be queried.
1849 &$tables: Tables in the query.
1850 &$conds: Conditions in the query.
1851 &$opts: Options for the query.
1852 &$join_conds: Join conditions for the query.
1854 'MovePageCheckPermissions': Specify whether the user is allowed to move the page.
1855 $oldTitle: Title object of the current (old) location
1856 $newTitle: Title object of the new location
1857 $user: User making the move
1858 $reason: string of the reason provided by the user
1859 $status: Status object to pass error messages to
1861 'MovePageIsValidMove': Specify whether a page can be moved for technical reasons.
1862 $oldTitle: Title object of the current (old) location
1863 $newTitle: Title object of the new location
1864 $status: Status object to pass error messages to
1866 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1867 and returning it for the skin to output. You can add items to the toolbox while
1868 still letting the skin make final decisions on skin-specific markup conventions
1870 &$sk: The BaseTemplate base skin template
1871 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1872 BaseTemplate::makeListItem for details on the format of individual items
1873 inside of this array.
1875 'NamespaceIsMovable': Called when determining if it is possible to pages in a
1877 $index: Integer; the index of the namespace being checked.
1878 $result: Boolean; whether MediaWiki currently thinks that pages in this
1879 namespace are movable. Hooks may change this value to override the return
1880 value of MWNamespace::isMovable().
1882 'NewRevisionFromEditComplete': Called when a revision was inserted due to an
1884 $wikiPage: the WikiPage edited
1885 $rev: the new revision
1886 $baseID: the revision ID this was based off, if any
1887 $user: the editing user
1889 'NormalizeMessageKey': Called before the software gets the text of a message
1890 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1892 &$key: the message being looked up. Change this to something else to change
1893 what message gets displayed (string)
1894 &$useDB: whether or not to look up the message in the database (bool)
1895 &$langCode: the language code to get the message for (string) - or -
1896 whether to use the content language (true) or site language (false) (bool)
1897 &$transform: whether or not to expand variables and templates
1898 in the message (bool)
1900 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
1901 return false to omit the line from RecentChanges and Watchlist special pages.
1902 &$changeslist: The OldChangesList instance.
1903 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1904 &$rc: The RecentChange object.
1905 &$classes: array of css classes for the <li> element
1907 'OpenSearchUrls': Called when constructing the OpenSearch description XML. Hooks
1908 can alter or append to the array of URLs for search & suggestion formats.
1909 &$urls: array of associative arrays with Url element attributes
1911 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1912 users and/or IP addresses too.
1913 $otherBlockLink: An array with links to other block logs
1914 $ip: The requested IP address or username
1916 'OutputPageBeforeHTML': A page has been processed by the parser and the
1917 resulting HTML is about to be displayed.
1918 $parserOutput: the parserOutput (object) that corresponds to the page
1919 $text: the text that will be displayed, in HTML (string)
1921 'OutputPageBodyAttributes': Called when OutputPage::headElement is creating the
1922 body tag to allow for extensions to add attributes to the body of the page they
1923 might need. Or to allow building extensions to add body classes that aren't of
1924 high enough demand to be included in core.
1925 $out: The OutputPage which called the hook, can be used to get the real title
1926 $sk: The Skin that called OutputPage::headElement
1927 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1929 'OutputPageCheckLastModified': when checking if the page has been modified
1930 since the last visit.
1931 &$modifiedTimes: array of timestamps.
1932 The following keys are set: page, user, epoch
1934 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1935 $out: OutputPage instance (object)
1936 $parserOutput: parserOutput instance being added in $out
1938 'OutputPageMakeCategoryLinks': Links are about to be generated for the page's
1939 categories. Implementations should return false if they generate the category
1940 links, so the default link generation is skipped.
1941 $out: OutputPage instance (object)
1942 $categories: associative array, keys are category names, values are category
1943 types ("normal" or "hidden")
1944 $links: array, intended to hold the result. Must be an associative array with
1945 category types as keys and arrays of HTML links as values.
1947 'PageContentInsertComplete': After a new article is created.
1948 $wikiPage: WikiPage created
1949 $user: User creating the article
1950 $content: New content as a Content object
1951 $summary: Edit summary/comment
1952 $isMinor: Whether or not the edit was marked as minor
1953 $isWatch: (No longer used)
1954 $section: (No longer used)
1955 $flags: Flags passed to WikiPage::doEditContent()
1956 $revision: New Revision of the article
1958 'PageContentLanguage': Allows changing the language in which the content of a
1959 page is written. Defaults to the wiki content language ($wgContLang).
1960 $title: Title object
1961 &$pageLang: the page content language (either an object or a language code)
1962 $wgLang: the user language
1964 'PageContentSave': Before an article is saved.
1965 $wikiPage: the WikiPage (object) being saved
1966 $user: the user (object) saving the article
1967 $content: the new article content, as a Content object
1968 $summary: the article summary (comment)
1969 $isminor: minor flag
1970 $iswatch: watch flag
1973 'PageContentSaveComplete': After an article has been updated.
1974 $wikiPage: WikiPage modified
1975 $user: User performing the modification
1976 $content: New content, as a Content object
1977 $summary: Edit summary/comment
1978 $isMinor: Whether or not the edit was marked as minor
1979 $isWatch: (No longer used)
1980 $section: (No longer used)
1981 $flags: Flags passed to WikiPage::doEditContent()
1982 $revision: New Revision of the article (can be null for edits that change nothing)
1983 $status: Status object about to be returned by doEditContent()
1984 $baseRevId: the rev ID (or false) this edit was based on
1986 'PageHistoryBeforeList': When a history page list is about to be constructed.
1987 $article: the article that the history is loading for
1988 $context: RequestContext object
1990 'PageHistoryLineEnding': Right before the end <li> is added to a history line.
1991 $row: the revision row for this line
1992 $s: the string representing this parsed line
1993 $classes: array containing the <li> element classes
1995 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is
1998 $queryInfo: the query parameters
2000 'PageRenderingHash': Alter the parser cache option hash key. A parser extension
2001 which depends on user options should install this hook and append its values to
2003 &$confstr: reference to a hash key string which can be modified
2004 $user: User (object) requesting the page
2006 'ParserAfterParse': Called from Parser::parse() just after the call to
2007 Parser::internalParse() returns.
2008 $parser: parser object
2009 $text: text being parsed
2010 $stripState: stripState used (object)
2012 'ParserAfterStrip': Called at end of parsing time.
2013 TODO: No more strip, deprecated ?
2014 $parser: parser object
2015 $text: text being parsed
2016 $stripState: stripState used (object)
2018 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
2019 $parser: Parser object being used
2020 $text: text that will be returned
2022 'ParserBeforeInternalParse': Called at the beginning of Parser::internalParse().
2023 $parser: Parser object
2024 $text: text to parse
2025 $stripState: StripState instance being used
2027 'ParserBeforeStrip': Called at start of parsing time.
2028 TODO: No more strip, deprecated ?
2029 $parser: parser object
2030 $text: text being parsed
2031 $stripState: stripState used (object)
2033 'ParserBeforeTidy': Called before tidy and custom tags replacements.
2034 $parser: Parser object being used
2037 'ParserClearState': Called at the end of Parser::clearState().
2038 $parser: Parser object being cleared
2040 'ParserCloned': Called when the parser is cloned.
2041 $parser: Newly-cloned Parser object
2043 'ParserFirstCallInit': Called when the parser initialises for the first time.
2044 &$parser: Parser object being cleared
2046 'ParserGetVariableValueSwitch': Called when the parser need the value of a
2048 $parser: Parser object
2049 $varCache: array to store the value in case of multiples calls of the
2051 $index: index (string) of the magic
2052 $ret: value of the magic word (the hook should set it)
2053 $frame: PPFrame object to use for expanding any template variables
2055 'ParserGetVariableValueTs': Use this to change the value of the time for the
2056 {{LOCAL...}} magic word.
2057 $parser: Parser object
2058 $time: actual time (timestamp)
2060 'ParserGetVariableValueVarCache': use this to change the value of the variable
2061 cache or return false to not use it.
2062 $parser: Parser object
2063 $varCache: variable cache (array)
2065 'ParserLimitReport': DEPRECATED, use ParserLimitReportPrepare and
2066 ParserLimitReportFormat instead.
2067 Called at the end of Parser:parse() when the parser will
2068 include comments about size of the text parsed.
2069 $parser: Parser object
2070 &$limitReport: text that will be included (without comment tags)
2072 'ParserLimitReportFormat': Called for each row in the parser limit report that
2073 needs formatting. If nothing handles this hook, the default is to use "$key" to
2074 get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to
2076 $key: Key for the limit report item (string)
2077 &$value: Value of the limit report item
2078 &$report: String onto which to append the data
2079 $isHTML: If true, $report is an HTML table with two columns; if false, it's
2080 text intended for display in a monospaced font.
2081 $localize: If false, $report should be output in English.
2083 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will
2084 include comments about size of the text parsed. Hooks should use
2085 $output->setLimitReportData() to populate data. Functions for this hook should
2086 not use $wgLang; do that in ParserLimitReportFormat instead.
2087 $parser: Parser object
2088 $output: ParserOutput object
2090 'ParserMakeImageParams': Called before the parser make an image link, use this
2091 to modify the parameters of the image.
2092 $title: title object representing the file
2093 $file: file object that will be used to create the image
2094 &$params: 2-D array of parameters
2095 $parser: Parser object that called the hook
2097 'ParserSectionCreate': Called each time the parser creates a document section
2098 from wikitext. Use this to apply per-section modifications to HTML (like
2099 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
2100 can begin in one section and end in another. Make sure your code can handle
2101 that case gracefully. See the EditSectionClearerLink extension for an example.
2102 $parser: the calling Parser instance
2103 $section: the section number, zero-based, but section 0 is usually empty
2104 &$sectionContent: ref to the content of the section. modify this.
2105 $showEditLinks: boolean describing whether this section has an edit link
2107 'ParserTestParser': Called when creating a new instance of Parser in
2108 tests/parser/parserTest.inc.
2109 $parser: Parser object created
2111 'ParserTestGlobals': Allows to define globals for parser tests.
2112 &$globals: Array with all the globals which should be set for parser tests.
2113 The arrays keys serve as the globals names, its values are the globals values.
2115 'ParserTestTables': Alter the list of tables to duplicate when parser tests are
2116 run. Use when page save hooks require the presence of custom tables to ensure
2117 that tests continue to run properly.
2118 &$tables: array of table names
2120 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
2121 my talk page, my contributions" etc).
2122 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
2123 &$title: Title object representing the current page
2124 $skin: SkinTemplate object providing context (e.g. to check if the user is logged in, etc.)
2126 'PingLimiter': Allows extensions to override the results of User::pingLimiter().
2127 &$user : User performing the action
2128 $action : Action being performed
2129 &$result : Whether or not the action should be prevented
2130 Change $result and return false to give a definitive answer, otherwise
2131 the built-in rate limiting checks are used, if enabled.
2132 $incrBy: Amount to increment counter by
2134 'PlaceNewSection': Override placement of new sections. Return false and put the
2135 merged text into $text to override the default behavior.
2136 $wikipage : WikiPage object
2137 $oldtext : the text of the article before editing
2138 $subject : subject of the new section
2139 &$text : text of the new section
2141 'PostLoginRedirect': Modify the post login redirect behavior.
2142 Occurs after signing up or logging in, allows for interception of redirect.
2143 &$returnTo: The page name to return to, as a string
2144 &$returnToQuery: array of url parameters, mapping parameter names to values
2145 &$type: type of login redirect as string;
2146 error: display a return to link ignoring $wgRedirectOnLogin
2147 signup: display a return to link using $wgRedirectOnLogin if needed
2148 success: display a return to link using $wgRedirectOnLogin if needed
2149 successredirect: send an HTTP redirect using $wgRedirectOnLogin if needed
2151 'PreferencesGetLegend': Override the text used for the <legend> of a
2152 preferences section.
2153 $form: the PreferencesForm object. This is a ContextSource as well
2154 $key: the section name
2155 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
2157 'PreferencesFormPreSave': Override preferences being saved
2158 $formData: array of user submitted data
2159 $form: PreferencesForm object, also a ContextSource
2160 $user: User object with preferences to be saved set
2161 &$result: boolean indicating success
2163 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
2164 AJAX search suggestions. Put results into &$results outparam and return false.
2165 $ns : array of int namespace keys to search in
2166 $search : search term (not guaranteed to be conveniently normalized)
2167 $limit : maximum number of results to return
2168 &$results : out param: array of page names (strings)
2169 $offset : number of results to offset from the beginning
2171 'PrefixSearchExtractNamespace': Called if core was not able to extract a
2172 namespace from the search string so that extensions can attempt it.
2173 $namespaces : array of int namespace keys to search in (change this if you can
2175 $search : search term (replace this with term without the namespace if you can
2178 'PrefsEmailAudit': Called when user changes their email address.
2179 $user: User (object) changing his email address
2180 $oldaddr: old email address (string)
2181 $newaddr: new email address (string)
2183 'PrefsPasswordAudit': Called when user changes his password.
2184 $user: User (object) changing his password
2185 $newPass: new password
2186 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
2188 'ProtectionForm::buildForm': Called after all protection type fieldsets are made
2190 $article: the title being (un)protected
2191 $output: a string of the form HTML so far
2193 'ProtectionForm::save': Called when a protection form is submitted.
2194 $article: the Page being (un)protected
2195 &$errorMsg: an html message string of an error or an array of message name and
2197 $reasonstr: a string describing the reason page protection level is altered
2199 'ProtectionForm::showLogExtract': Called after the protection log extract is
2201 $article: the page the form is shown for
2202 $out: OutputPage object
2204 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw.
2205 &$obj: RawAction object
2206 &$text: The text that's going to be the output
2208 'RecentChange_save': Called at the end of RecentChange::save().
2209 $recentChange: RecentChange object
2211 'RedirectSpecialArticleRedirectParams': Lets you alter the set of parameter
2212 names such as "oldid" that are preserved when using redirecting special pages
2213 such as Special:MyPage and Special:MyTalk.
2214 &$redirectParams: An array of parameters preserved by redirecting special pages.
2216 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin
2217 instance. Can be used by an extension override what skin is used in certain
2219 IContextSource $context: The RequestContext the skin is being created for.
2220 &$skin: A variable reference you may set a Skin instance or string key on to
2221 override the skin that will be used for the context.
2223 'ResetPasswordExpiration': Allow extensions to set a default password expiration
2224 $user: The user having their password expiration reset
2225 &$newExpire: The new expiration date
2227 'ResetSessionID': Called from wfResetSessionID
2228 $oldSessionID: old session id
2229 $newSessionID: new session id
2231 'ResourceLoaderGetConfigVars': Called at the end of
2232 ResourceLoaderStartUpModule::getConfigSettings(). Use this to export static
2233 configuration variables to JavaScript. Things that depend on the current page
2234 or request state must be added through MakeGlobalVariablesScript instead.
2235 &$vars: array( variable name => value )
2237 'ResourceLoaderRegisterModules': Right before modules information is required,
2238 such as when responding to a resource
2239 loader request or generating HTML output.
2240 &$resourceLoader: ResourceLoader object
2242 'ResourceLoaderTestModules': Let you add new JavaScript testing modules. This is
2243 called after the addition of 'qunit' and MediaWiki testing resources.
2244 &testModules: array of JavaScript testing modules. The 'qunit' framework,
2245 included in core, is fed using tests/qunit/QUnitTestResources.php.
2246 &ResourceLoader object
2248 To add a new qunit module named 'myext.tests':
2249 testModules['qunit']['myext.tests'] = array(
2250 'script' => 'extension/myext/tests.js',
2251 'dependencies' => <any module dependency you might have>
2253 For QUnit framework, the mediawiki.tests.qunit.testrunner dependency will be
2254 added to any module.
2256 'RevisionInsertComplete': Called after a revision is inserted into the database.
2257 &$revision: the Revision
2258 $data: the data stored in old_text. The meaning depends on $flags: if external
2259 is set, it's the URL of the revision text in external storage; otherwise,
2260 it's the revision text itself. In either case, if gzip is set, the revision
2262 $flags: a comma-delimited list of strings representing the options used. May
2263 include: utf8 (this will always be set for new revisions); gzip; external.
2265 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before
2266 the normal operations.
2267 $allSearchTerms : Array of the search terms in all content languages
2268 &$titleResult : Outparam; the value to return. A Title object or null.
2270 'SearchAfterNoDirectMatch': If there was no match for the exact result. This
2271 runs before lettercase variants are attempted, whereas 'SearchGetNearMatch'
2273 $term : Search term string
2274 &$title : Outparam; set to $title object and return false for a match
2276 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
2277 if nothing was found.
2278 $term : Search term string
2279 &$title : Outparam; set to $title object and return false for a match
2281 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go"
2283 $term : Search term string
2284 &$title : Current Title object that is being returned (null if none found).
2286 'SearchResultInitFromTitle': Set the revision used when displaying a page in
2288 $title : Current Title object being displayed in search results.
2289 &$id: Revision ID (default is false, for latest)
2291 'SearchableNamespaces': An option to modify which namespaces are searchable.
2292 &$arr : Array of namespaces ($nsId => $name) which will be used.
2294 'SelfLinkBegin': Called before a link to the current article is displayed to
2295 allow the display of the link to be customized.
2296 $nt: the Title object
2297 &$html: html to display for the link
2298 &$trail: optional text to display before $html
2299 &$prefix: optional text to display after $html
2300 &$ret: the value to return if your hook returns false
2302 'SetupAfterCache': Called in Setup.php, after cache objects are set
2304 'ShowMissingArticle': Called when generating the output for a non-existent page.
2305 $article: The article object corresponding to the page
2307 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
2308 DEPRECATED, use the ContentGetParserOutput hook instead!
2309 $text: Text being shown
2310 $title: Title of the custom script/stylesheet page
2311 $output: Current OutputPage object
2313 'ShowSearchHitTitle': Customise display of search hit title/link.
2314 &$title: Title to link to
2315 &$text: Text to use for the link
2316 $result: The search result
2317 $terms: The search terms entered
2318 $page: The SpecialSearch object.
2320 'ShowSearchHit': Customize display of search hit.
2321 $searchPage: The SpecialSearch instance.
2322 $result: The SearchResult to show
2323 $terms: Search terms, for highlighting
2324 &$link: HTML of link to the matching page. May be modified.
2325 &$redirect: HTML of redirect info. May be modified.
2326 &$section: HTML of matching section. May be modified.
2327 &$extract: HTML of content extract. May be modified.
2328 &$score: HTML of score. May be modified.
2329 &$size: HTML of page size. May be modified.
2330 &$date: HTML of of page modification date. May be modified.
2331 &$related: HTML of additional info for the matching page. May be modified.
2332 &$html: May be set to the full HTML that should be used to represent the search
2333 hit. Must include the <li> ... </li> tags. Will only be used if the hook
2334 function returned false.
2336 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed. Return true to
2337 allow the normal method of notice selection/rendering to work, or change the
2338 value of $siteNotice and return false to alter it.
2339 &$siteNotice: HTML returned as the sitenotice
2342 'SiteNoticeAfter': After the sitenotice/anonnotice is composed.
2343 &$siteNotice: HTML sitenotice. Alter the contents of $siteNotice to add to/alter
2344 the sitenotice/anonnotice.
2347 'SkinAfterBottomScripts': At the end of Skin::bottomScripts().
2349 &$text: bottomScripts Text. Append to $text to add additional text/scripts after
2350 the stock bottom scripts.
2352 'SkinAfterContent': Allows extensions to add text after the page content and
2353 article metadata. This hook should work in all skins. Set the &$data variable to
2354 the text you're going to add.
2355 &$data: (string) Text to be printed out directly (without parsing)
2358 'SkinBuildSidebar': At the end of Skin::buildSidebar().
2360 &$bar: Sidebar contents
2361 Modify $bar to add or modify sidebar portlets.
2363 'SidebarBeforeOutput': Allows to edit sidebar just before its output by skins.
2365 &$bar: Sidebar content
2366 Modify $bar to add or modify sidebar portlets.
2367 Warning: This hook is run on each display. You should consider to use 'SkinBuildSidebar' that is aggressively cached.
2369 'SkinCopyrightFooter': Allow for site and per-namespace customization of
2371 $title: displayed page title
2372 $type: 'normal' or 'history' for old/diff views
2373 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This
2374 message must be in HTML format, not wikitext!
2375 &$link: overridable HTML link to be passed into the message as $1
2376 &$forContent: overridable flag if copyright footer is shown in content language.
2377 This parameter is deprecated.
2379 'SkinGetPoweredBy': TODO
2380 &$text: additional 'powered by' icons in HTML. Note: Modern skin does not use
2381 the MediaWiki icon but plain text instead.
2384 'SkinPreloadExistence': Supply titles that should be added to link existence
2385 cache before the page is rendered.
2386 &$titles: Array of Title objects
2389 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle().
2390 &$subpages: Subpage links HTML
2392 $out: OutputPage object
2393 If false is returned $subpages will be used instead of the HTML
2394 subPageSubtitle() generates.
2395 If true is returned, $subpages will be ignored and the rest of
2396 subPageSubtitle() will run.
2398 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
2400 $sktemplate: SkinTemplate object
2401 $nav_urls: array of tabs
2403 'SkinTemplateGetLanguageLink': After building the data for a language link from
2404 which the actual html is constructed.
2405 &$languageLink: array containing data about the link. The following keys can be
2406 modified: href, text, title, class, lang, hreflang. Each of them is a string.
2407 $languageLinkTitle: Title object belonging to the external language link.
2408 $title: Title object of the page the link belongs to.
2409 $outputPage: The OutputPage object the links are built from.
2411 To alter the structured navigation links in SkinTemplates, there are three
2412 hooks called in different spots:
2414 'SkinTemplateNavigation': Called on content pages after the tabs have been
2415 added, but before variants have been added.
2416 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special
2417 tab is added but before variants have been added.
2418 'SkinTemplateNavigation::Universal': Called on both content and special pages
2419 after variants have been added.
2420 &$sktemplate: SkinTemplate object
2421 &$links: Structured navigation links. This is used to alter the navigation for
2422 skins which use buildNavigationUrls such as Vector.
2424 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts
2426 &$sktemplate: SkinTemplate object
2427 &$tpl: QuickTemplate engine object
2429 'SkinTemplatePreventOtherActiveTabs': Use this to prevent showing active tabs.
2430 $sktemplate: SkinTemplate object
2431 $res: set to true to prevent active tabs
2433 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
2434 You can either create your own array, or alter the parameters for
2436 &$sktemplate: The SkinTemplate instance.
2437 $title: Title instance for the page.
2438 $message: Visible label of tab.
2439 $selected: Whether this is a selected tab.
2440 $checkEdit: Whether or not the action=edit query should be added if appropriate.
2441 &$classes: Array of CSS classes to apply.
2442 &$query: Query string to add to link.
2444 &$result: Complete assoc. array if you want to return true.
2446 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
2447 been rendered (useful for adding more).
2448 $sk: The QuickTemplate based skin template running the hook.
2449 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
2450 extensions that add support for BaseTemplateToolbox should watch for this
2451 dummy parameter with "$dummy=false" in their code and return without echoing
2452 any HTML to avoid creating duplicate toolbox items.
2454 'SoftwareInfo': Called by Special:Version for returning information about the
2456 $software: The array of software in format 'name' => 'version'. See
2457 SpecialVersion::softwareInformation().
2459 'SpecialPageBeforeFormDisplay': Before executing the HTMLForm object.
2460 $name: name of the special page
2461 &$form: HTMLForm object
2463 'SpecialBlockModifyFormFields': Add more fields to Special:Block
2464 $sp: SpecialPage object, for context
2465 &$fields: Current HTMLForm fields
2467 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
2468 $id: User id number, only provided for backwards-compatibility
2469 $user: User object representing user contributions are being fetched for
2470 $sp: SpecialPage instance, providing context
2472 'SpecialListusersDefaultQuery': Called right before the end of
2473 UsersPager::getDefaultQuery().
2474 $pager: The UsersPager instance
2475 $query: The query array to be returned
2477 'SpecialListusersFormatRow': Called right before the end of
2478 UsersPager::formatRow().
2479 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
2480 $row: Database row object
2482 'SpecialListusersHeader': Called before closing the <fieldset> in
2483 UsersPager::getPageHeader().
2484 $pager: The UsersPager instance
2485 $out: The header HTML
2487 'SpecialListusersHeaderForm': Called before adding the submit button in
2488 UsersPager::getPageHeader().
2489 $pager: The UsersPager instance
2490 $out: The header HTML
2492 'SpecialListusersQueryInfo': Called right before the end of.
2493 UsersPager::getQueryInfo()
2494 $pager: The UsersPager instance
2495 $query: The query array to be returned
2497 'SpecialLogAddLogSearchRelations': Add log relations to the current log
2498 $type: String of the log type
2499 $request: WebRequest object for getting the value provided by the current user
2500 &$qc: Array for query conditions to add
2502 'SpecialMovepageAfterMove': Called after moving a page.
2503 $movePage: MovePageForm object
2504 $oldTitle: old title (object)
2505 $newTitle: new title (object)
2507 'SpecialNewpagesConditions': Called when building sql query for
2509 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
2510 $opts: FormOptions object containing special page options
2511 &$conds: array of WHERE conditionals for query
2512 &tables: array of tables to be queried
2513 &$fields: array of columns to select
2514 &$join_conds: join conditions for the tables
2516 'SpecialNewPagesFilters': Called after building form options at NewPages.
2517 $special: the special page object
2518 &$filters: associative array of filter definitions. The keys are the HTML
2519 name/URL parameters. Each key maps to an associative array with a 'msg'
2520 (message key) and a 'default' value.
2522 'SpecialPage_initList': Called when setting up SpecialPageFactory::$list, use this
2523 hook to remove a core special page.
2524 $list: list (array) of core special pages
2526 'SpecialPageAfterExecute': Called after SpecialPage::execute.
2527 $special: the SpecialPage object
2528 $subPage: the subpage string or null if no subpage was specified
2530 'SpecialPageBeforeExecute': Called before SpecialPage::execute.
2531 $special: the SpecialPage object
2532 $subPage: the subpage string or null if no subpage was specified
2534 'SpecialPasswordResetOnSubmit': When executing a form submission on
2535 Special:PasswordReset.
2536 $users: array of User objects.
2537 $data: array of data submitted by the user
2538 &$error: string, error code (message key) used to describe to error (out
2539 parameter). The hook needs to return false when setting this, otherwise it
2540 will have no effect.
2542 'SpecialRandomGetRandomTitle': Called during the execution of Special:Random,
2543 use this to change some selection criteria or substitute a different title.
2544 &$randstr: The random number from wfRandom()
2545 &$isRedir: Boolean, whether to select a redirect or non-redirect
2546 &$namespaces: An array of namespace indexes to get the title from
2547 &$extra: An array of extra SQL statements
2548 &$title: If the hook returns false, a Title object to use instead of the
2549 result from the normal query
2551 'SpecialRecentChangesFilters': Called after building form options at
2552 RecentChanges. Deprecated, use ChangesListSpecialPageFilters instead.
2553 $special: the special page object
2554 &$filters: associative array of filter definitions. The keys are the HTML
2555 name/URL parameters. Each key maps to an associative array with a 'msg'
2556 (message key) and a 'default' value.
2558 'SpecialRecentChangesPanel': Called when building form options in
2559 SpecialRecentChanges.
2560 &$extraOpts: array of added items, to which can be added
2561 $opts: FormOptions for this request
2563 'SpecialRecentChangesQuery': Called when building SQL query for
2564 SpecialRecentChanges and SpecialRecentChangesLinked. Deprecated, use
2565 ChangesListSpecialPageQuery instead.
2566 &$conds: array of WHERE conditionals for query
2567 &$tables: array of tables to be queried
2568 &$join_conds: join conditions for the tables
2569 $opts: FormOptions for this request
2570 &$query_options: array of options for the database request
2571 &$select: Array of columns to select
2573 'SpecialResetTokensTokens': Called when building token list for
2575 &$tokens: array of token information arrays in the format of
2576 array( 'preference' => '<preference-name>', 'label-message' => '<message-key>' )
2578 'SpecialSearchCreateLink': Called when making the message to create a page or
2579 go to the existing page.
2580 $t: title object searched for
2581 &$params: an array of the default message name and page title (as parameter)
2583 'SpecialSearchNogomatch': Called when user clicked the "Go" button but the
2584 target doesn't exist.
2585 &$title: title object generated from the text entered by the user
2587 'SpecialSearchPowerBox': The equivalent of SpecialSearchProfileForm for
2588 the advanced form, a.k.a. power search box.
2589 &$showSections: an array to add values with more options to
2590 $term: the search term (not a title object)
2591 $opts: an array of hidden options (containing 'redirs' and 'profile')
2593 'SpecialSearchProfiles': Allows modification of search profiles.
2594 &$profiles: profiles, which can be modified.
2596 'SpecialSearchProfileForm': Allows modification of search profile forms.
2597 $search: special page object
2598 &$form: String: form html
2599 $profile: String: current search profile
2600 $term: String: search term
2601 $opts: Array: key => value of hidden options for inclusion in custom forms
2603 'SpecialSearchSetupEngine': Allows passing custom data to search engine.
2604 $search: SpecialSearch special page object
2605 $profile: String: current search profile
2606 $engine: the search engine
2608 'SpecialSearchResultsPrepend': Called immediately before returning HTML
2609 on the search results page. Useful for including an external search
2610 provider. To disable the output of MediaWiki search output, return
2612 $specialSearch: SpecialSearch object ($this)
2614 $term: Search term specified by the user
2616 'SpecialSearchResults': Called before search result display
2617 $term: string of search term
2618 &$titleMatches: empty or SearchResultSet object
2619 &$textMatches: empty or SearchResultSet object
2621 'SpecialStatsAddExtra': Add extra statistic at the end of Special:Statistics.
2622 &$extraStats: Array to save the new stats
2623 ( $extraStats['<name of statistic>'] => <value>; )
2625 'SpecialUploadComplete': Called after successfully uploading a file from
2627 $form: The SpecialUpload object
2629 'SpecialVersionVersionUrl': Called when building the URL for Special:Version.
2630 $wgVersion: Current $wgVersion for you to use
2631 &$versionUrl: Raw url to link to (eg: release notes)
2633 'SpecialWatchlistFilters': Called after building form options at Watchlist.
2634 Deprecated, use ChangesListSpecialPageFilters instead.
2635 $special: the special page object
2636 &$filters: associative array of filter definitions. The keys are the HTML
2637 name/URL parameters. Each key maps to an associative array with a 'msg'
2638 (message key) and a 'default' value.
2640 'SpecialWatchlistQuery': Called when building sql query for SpecialWatchlist.
2641 Deprecated, use ChangesListSpecialPageQuery instead.
2642 &$conds: array of WHERE conditionals for query
2643 &$tables: array of tables to be queried
2644 &$join_conds: join conditions for the tables
2645 &$fields: array of query fields
2646 $opts: A FormOptions object with watchlist options for the current request
2648 'SpecialWatchlistGetNonRevisionTypes': Called when building sql query for
2649 SpecialWatchlist. Allows extensions to register custom values they have
2650 inserted to rc_type so they can be returned as part of the watchlist.
2651 &$nonRevisionTypes: array of values in the rc_type field of recentchanges table
2653 'TestCanonicalRedirect': Called when about to force a redirect to a canonical
2654 URL for a title when we have no other parameters on the URL. Gives a chance for
2655 extensions that alter page view behavior radically to abort that redirect or
2657 $request: WebRequest
2658 $title: Title of the currently found title obj
2659 $output: OutputPage object
2661 'ThumbnailBeforeProduceHTML': Called before an image HTML is about to be
2662 rendered (by ThumbnailImage:toHtml method).
2663 $thumbnail: the ThumbnailImage object
2664 &$attribs: image attribute array
2665 &$linkAttribs: image link attribute array
2667 'TitleArrayFromResult': Called when creating an TitleArray object from a
2669 &$titleArray: set this to an object to override the default object returned
2670 $res: database result used to create the object
2672 'TitleExists': Called when determining whether a page exists at a given title.
2673 $title: The title being tested.
2674 &$exists: Whether the title exists.
2676 'TitleQuickPermissions': Called from Title::checkQuickPermissions to add to
2677 or override the quick permissions check.
2678 $title: The Title object being accessed
2679 $user: The User performing the action
2680 $action: Action being performed
2681 &$errors: Array of errors
2682 $doExpensiveQueries: Whether to do expensive DB queries
2683 $short: Whether to return immediately on first error
2685 'TitleGetEditNotices': Allows extensions to add edit notices
2686 $title: The Title object for the page the edit notices are for
2687 $oldid: Revision ID that the edit notices are for (or 0 for latest)
2688 &$notices: Array of notices. Keys are i18n message keys, values are parseAsBlock()ed messages.
2690 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2691 that can be applied.
2692 $title: The title in question.
2693 &$types: The types of protection available.
2695 'TitleIsCssOrJsPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2696 Called when determining if a page is a CSS or JS page.
2697 $title: Title object that is being checked
2698 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page.
2699 Hooks may change this value to override the return value of
2700 Title::isCssOrJsPage().
2702 'TitleIsAlwaysKnown': Called when determining if a page exists. Allows
2703 overriding default behavior for determining if a page exists. If $isKnown is
2704 kept as null, regular checks happen. If it's a boolean, this value is returned
2705 by the isKnown method.
2706 $title: Title object that is being checked
2707 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2709 'TitleIsMovable': Called when determining if it is possible to move a page. Note
2710 that this hook is not called for interwiki pages or pages in immovable
2711 namespaces: for these, isMovable() always returns false.
2712 $title: Title object that is being checked
2713 $result: Boolean; whether MediaWiki currently thinks this page is movable.
2714 Hooks may change this value to override the return value of
2717 'TitleIsWikitextPage': DEPRECATED! Use ContentHandlerDefaultModelFor instead.
2718 Called when determining if a page is a wikitext or should
2719 be handled by separate handler (via ArticleViewCustom).
2720 $title: Title object that is being checked
2721 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page.
2722 Hooks may change this value to override the return value of
2723 Title::isWikitextPage()
2725 'TitleMove': Before moving an article (title).
2728 $user: user who does the move
2730 'TitleMoveComplete': After moving an article (title).
2733 $user: user who did the move
2734 $pageid: database ID of the page that's been moved
2735 $redirid: database ID of the created redirect
2736 $reason: reason for the move
2738 'TitleReadWhitelist': Called at the end of read permissions checks, just before
2739 adding the default error message if nothing allows the user to read the page. If
2740 a handler wants a title to *not* be whitelisted, it should also return false.
2741 $title: Title object being checked against
2742 $user: Current user object
2743 &$whitelisted: Boolean value of whether this title is whitelisted
2745 'TitleSquidURLs': Called to determine which URLs to purge from HTTP caches.
2746 $title: Title object to purge
2747 &$urls: An array of URLs to purge from the caches, to be manipulated.
2749 'UndeleteForm::showHistory': Called in UndeleteForm::showHistory, after a
2750 PageArchive object has been created but before any further processing is done.
2751 &$archive: PageArchive object
2752 $title: Title object of the page that we're viewing
2754 'UndeleteForm::showRevision': Called in UndeleteForm::showRevision, after a
2755 PageArchive object has been created but before any further processing is done.
2756 &$archive: PageArchive object
2757 $title: Title object of the page that we're viewing
2759 'UndeleteForm::undelete': Called un UndeleteForm::undelete, after checking that
2760 the site is not in read-only mode, that the Title object is not null and after
2761 a PageArchive object has been constructed but before performing any further
2763 &$archive: PageArchive object
2764 $title: Title object of the page that we're about to undelete
2766 'UndeleteShowRevision': Called when showing a revision in Special:Undelete.
2767 $title: title object related to the revision
2768 $rev: revision (object) that will be viewed
2770 'UnknownAction': An unknown "action" has occurred (useful for defining your own
2772 $action: action name
2773 $article: article "acted on"
2775 'UnitTestsList': Called when building a list of paths containing PHPUnit tests.
2776 Since 1.24: Paths pointing to a directory will be recursively scanned for
2777 test case files matching the suffix "Test.php".
2778 &$paths: list of test cases and directories to search.
2780 'UnwatchArticle': Before a watch is removed from an article.
2781 $user: user watching
2782 $page: WikiPage object to be removed
2783 &$status: Status object to be returned if the hook returns false
2785 'UnwatchArticleComplete': After a watch is removed from an article.
2786 $user: user that watched
2787 $page: WikiPage object that was watched
2789 'UpdateUserMailerFormattedPageStatus': Before notification email gets sent.
2790 $formattedPageStatus: list of valid page states
2792 'UploadForm:initial': Before the upload form is generated. You might set the
2793 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
2794 text (HTML) either before or after the editform.
2795 $form: UploadForm object
2797 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
2798 poke at member variables like $mUploadDescription before the file is saved. Do
2799 not use this hook to break upload processing. This will return the user to a
2800 blank form with no error message; use UploadVerification and UploadVerifyFile
2802 $form: UploadForm object
2804 'UploadCreateFromRequest': When UploadBase::createFromRequest has been called.
2805 $type: (string) the requested upload type
2806 &$className: the class name of the Upload instance to be created
2808 'UploadComplete': when Upload completes an upload.
2809 &$upload: an UploadBase child instance
2811 'UploadFormInitDescriptor': After the descriptor for the upload form as been
2813 $descriptor: (array) the HTMLForm descriptor
2815 'UploadFormSourceDescriptors': after the standard source inputs have been
2816 added to the descriptor
2817 $descriptor: (array) the HTMLForm descriptor
2819 'UploadVerification': Additional chances to reject an uploaded file. Consider
2820 using UploadVerifyFile instead.
2821 string $saveName: destination file name
2822 string $tempName: filesystem path to the temporary file for checks
2823 string &$error: output: message key for message to show if upload canceled by
2824 returning false. May also be an array, where the first element is the message
2825 key and the remaining elements are used as parameters to the message.
2827 'UploadVerifyFile': extra file verification, based on MIME type, etc. Preferred
2828 in most cases over UploadVerification.
2829 object $upload: an instance of UploadBase, with all info about the upload
2830 string $mime: The uploaded file's MIME type, as detected by MediaWiki. Handlers
2831 will typically only apply for specific MIME types.
2832 object &$error: output: true if the file is valid. Otherwise, an indexed array
2833 representing the problem with the file, where the first element is the message
2834 key and the remaining elements are used as parameters to the message.
2836 'UploadComplete': Upon completion of a file upload.
2837 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2838 $uploadBase->getLocalFile().
2840 'User::mailPasswordInternal': before creation and mailing of a user's new
2842 $user: the user who sent the message out
2843 $ip: IP of the user who sent the message out
2844 $u: the account whose new password will be set
2846 'UserAddGroup': Called when adding a group; return false to override
2847 stock group addition.
2848 $user: the user object that is to have a group added
2849 &$group: the group to add, can be modified
2851 'UserArrayFromResult': Called when creating an UserArray object from a database
2853 &$userArray: set this to an object to override the default object returned
2854 $res: database result used to create the object
2856 'userCan': To interrupt/advise the "user can do X to Y article" check. If you
2857 want to display an error message, try getUserPermissionsErrors.
2858 $title: Title object being checked against
2859 $user : Current user object
2860 $action: Action being checked
2861 $result: Pointer to result returned if hook returns false. If null is returned,
2862 userCan checks are continued by internal code.
2864 'UserCanSendEmail': To override User::canSendEmail() permission check.
2865 $user: User (object) whose permission is being checked
2866 &$canSend: bool set on input, can override on output
2868 'UserClearNewTalkNotification': Called when clearing the "You have new
2869 messages!" message, return false to not delete it.
2870 $user: User (object) that will clear the message
2871 $oldid: ID of the talk page revision being viewed (0 means the most recent one)
2873 'UserCreateForm': change to manipulate the login form
2874 $template: SimpleTemplate instance for the form
2876 'UserEffectiveGroups': Called in User::getEffectiveGroups().
2877 $user: User to get groups for
2878 &$groups: Current effective groups
2880 'UserGetAllRights': After calculating a list of all available rights.
2881 &$rights: Array of rights, which may be added to.
2883 'UserGetDefaultOptions': After fetching the core default, this hook is run right
2884 before returning the options to the caller. Warning: This hook is called for
2885 every call to User::getDefaultOptions(), which means it's potentially called
2886 dozens or hundreds of times. You may want to cache the results of non-trivial
2887 operations in your hook function for this reason.
2888 &$defaultOptions: Array of preference keys and their default values.
2890 'UserGetEmail': Called when getting an user email address.
2892 &$email: email, change this to override local email
2894 'UserGetEmailAuthenticationTimestamp': Called when getting the timestamp of
2895 email authentication.
2897 &$timestamp: timestamp, change this to override local email authentication
2900 'UserGetImplicitGroups': DEPRECATED, called in User::getImplicitGroups().
2901 &$groups: List of implicit (automatically-assigned) groups
2903 'UserGetLanguageObject': Called when getting user's interface language object.
2905 &$code: Language code that will be used to create the object
2906 $context: IContextSource object
2908 'UserGetReservedNames': Allows to modify $wgReservedUsernames at run time.
2909 &$reservedUsernames: $wgReservedUsernames
2911 'UserGetRights': Called in User::getRights().
2912 $user: User to get rights for
2913 &$rights: Current rights
2915 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
2916 specific block exemptions).
2917 $user: User in question
2918 $title: Title of the page in question
2919 &$blocked: Out-param, whether or not the user is blocked from that page.
2920 &$allowUsertalk: If the user is blocked, whether or not the block allows users
2921 to edit their own user talk pages.
2923 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2925 $ip: User's IP address
2926 &$blocked: Whether the user is blocked, to be modified by the hook
2928 'UserIsEveryoneAllowed': Check if all users are allowed some user right; return
2929 false if a UserGetRights hook might remove the named right.
2930 $right: The user right being checked
2932 'UserLoadAfterLoadFromSession': Called to authenticate users on external or
2933 environmental means; occurs after session is loaded.
2934 $user: user object being loaded
2936 'UserLoadDefaults': Called when loading a default user.
2940 'UserLoadFromDatabase': Called when loading a user from the database.
2942 &$s: database query object
2944 'UserLoadFromSession': Called to authenticate users on external/environmental
2945 means; occurs before session is loaded.
2946 $user: user object being loaded
2947 &$result: set this to a boolean value to abort the normal authentication
2950 'UserLoadOptions': When user options/preferences are being loaded from the
2953 &$options: Options, can be modified.
2955 'UserLoginComplete': After a user has logged in.
2956 $user: the user object that was created on login
2957 $inject_html: Any HTML to inject after the "logged in" message.
2959 'UserLoginForm': change to manipulate the login form
2960 $template: SimpleTemplate instance for the form
2962 'UserLogout': Before a user logs out.
2963 $user: the user object that is about to be logged out
2965 'UserLogoutComplete': After a user has logged out.
2966 $user: the user object _after_ logout (won't have name, ID, etc.)
2967 $inject_html: Any HTML to inject after the "logged out" message.
2968 $oldName: name of the user before logout (string)
2970 'UserRemoveGroup': Called when removing a group; return false to override stock
2972 $user: the user object that is to have a group removed
2973 &$group: the group to be removed, can be modified
2975 'UserRights': After a user's group memberships are changed.
2976 $user : User object that was changed
2977 $add : Array of strings corresponding to groups added
2978 $remove: Array of strings corresponding to groups removed
2980 'UserRequiresHTTPS': Called to determine whether a user needs
2981 to be switched to HTTPS.
2982 $user: User in question.
2983 &$https: Boolean whether $user should be switched to HTTPS.
2985 'UserResetAllOptions': Called in User::resetOptions() when user preferences
2986 have been requested to be reset. This hook can be used to exclude certain
2987 options from being reset even when the user has requested all prefs to be reset,
2988 because certain options might be stored in the user_properties database table
2989 despite not being visible and editable via Special:Preferences.
2990 $user: the User (object) whose preferences are being reset
2991 &$newOptions: array of new (site default) preferences
2992 $options: array of the user's old preferences
2993 $resetKinds: array containing the kinds of preferences to reset
2995 'UserRetrieveNewTalks': Called when retrieving "You have new messages!"
2997 $user: user retrieving new talks messages
2998 $talks: array of new talks page(s)
3000 'UserSaveSettings': Called when saving user settings.
3003 'UserSaveOptions': Called just before saving user preferences/options.
3005 &$options: Options, modifiable
3007 'UserSetCookies': Called when setting user cookies.
3009 &$session: session array, will be added to $_SESSION
3010 &$cookies: cookies array mapping cookie name to its value
3012 'UserSetEmail': Called when changing user email address.
3014 &$email: new email, change this to override new email address
3016 'UserSetEmailAuthenticationTimestamp': Called when setting the timestamp of
3017 email authentication.
3019 &$timestamp: new timestamp, change this to override local email
3020 authentication timestamp
3022 'UserToolLinksEdit': Called when generating a list of user tool links, e.g.
3023 "Foobar (Talk | Contribs | Block)".
3024 $userId: User id of the current user
3025 $userText: User name of the current user
3026 &$items: Array of user tool links as HTML fragments
3028 'ValidateExtendedMetadataCache': Called to validate the cached metadata in
3029 FormatMetadata::getExtendedMeta (return false means cache will be
3030 invalidated and GetExtendedMetadata hook called again).
3031 $timestamp: The timestamp metadata was generated
3032 $file: The file the metadata is for
3034 'UserMailerChangeReturnPath': Called to generate a VERP return address
3035 when UserMailer sends an email, with a bounce handling extension.
3036 $to: Array of MailAddress objects for the recipients
3037 &$returnPath: The return address string
3039 'LoginFormValidErrorMessages': Called in LoginForm when a function gets valid error
3040 messages. Allows to add additional error messages (except messages already in
3041 LoginForm::$validErrorMessages).
3042 &$messages Already added messages (inclusive messages from LoginForm::$validErrorMessages)
3044 'WantedPages::getQueryInfo': Called in WantedPagesPage::getQueryInfo(), can be
3045 used to alter the SQL query which gets the list of wanted pages.
3046 &$wantedPages: WantedPagesPage object
3047 &$query: query array, see QueryPage::getQueryInfo() for format documentation
3049 'WatchArticle': Before a watch is added to an article.
3050 $user: user that will watch
3051 $page: WikiPage object to be watched
3052 &$status: Status object to be returned if the hook returns false
3054 'WatchArticleComplete': After a watch is added to an article.
3055 $user: user that watched
3056 $page: WikiPage object watched
3058 'WatchlistEditorBeforeFormRender': Before building the Special:EditWatchlist
3059 form, used to manipulate the list of pages or preload data based on that list.
3060 &$watchlistInfo: array of watchlisted pages in
3061 [namespaceId => ['title1' => 1, 'title2' => 1]] format
3063 'WatchlistEditorBuildRemoveLine': when building remove lines in
3064 Special:Watchlist/edit.
3065 &$tools: array of extra links
3066 $title: Title object
3067 $redirect: whether the page is a redirect
3069 &$link: HTML link to title
3071 'WebRequestPathInfoRouter': While building the PathRouter to parse the
3073 $router: The PathRouter instance
3075 'WebResponseSetCookie': when setting a cookie in WebResponse::setcookie().
3076 Return false to prevent setting of the cookie.
3077 &$name: Cookie name passed to WebResponse::setcookie()
3078 &$value: Cookie value passed to WebResponse::setcookie()
3079 &$expire: Cookie expiration, as for PHP's setcookie()
3080 $options: Options passed to WebResponse::setcookie()
3082 'WhatLinksHereProps': Allows annotations to be added to WhatLinksHere
3083 $row: The DB row of the entry.
3084 $title: The Title of the page where the link comes FROM
3085 $target: The Title of the page where the link goes TO
3086 &$props: Array of HTML strings to display after the title.
3088 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
3089 dumps. One, and only one hook should set this, and return false.
3090 &$tables: Database tables to use in the SELECT query
3091 &$opts: Options to use for the query
3092 &$join: Join conditions
3094 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
3095 a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates
3096 specific to a content model should be provided by the respective Content's
3097 getDeletionUpdates() method.
3099 $content: the Content to generate updates for
3100 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
3102 'wfShellWikiCmd': Called when generating a shell-escaped command line string to
3103 run a MediaWiki cli script.
3104 &$script: MediaWiki cli script path
3105 &$parameters: Array of arguments and options to the script
3106 &$options: Associative array of options, may contain the 'php' and 'wrapper'
3109 'wgQueryPages': Called when initialising list of QueryPage subclasses, use this
3110 to add new query pages to be updated with maintenance/updateSpecialPages.php.
3111 $qp: The list of QueryPages
3113 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow
3114 extra metadata to be added.
3115 $obj: The XmlDumpWriter object.
3116 &$out: The output string.
3117 $row: The database row for the page.
3118 $title: The title of the page.
3120 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to
3122 $obj: The XmlDumpWriter object.
3123 &$out: The text being output.
3124 $row: The database row for the revision.
3125 $text: The revision text.
3127 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used
3128 to add additional tags to extract.
3129 &$items: Array containing information on which items to extract. See XMPInfo for
3130 details on the format.
3132 'XMPGetResults': Called just before returning the results array of parsing xmp
3133 data. Can be used to post-process the results.
3134 &$data: Array of metadata sections (such as $data['xmp-general']) each section
3135 is an array of metadata tags returned (each tag is either a value, or an array
3138 More hooks might be available but undocumented, you can execute
3139 "php maintenance/findHooks.php" to find hidden ones.