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, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252 default is LoginForm::ABORTED. Note that the client may be using
253 a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
256 'AbortMove': allows to abort moving an article (title)
259 $user: user who is doing the move
261 $reason: the reason for the move (added in 1.13)
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: name of error message to display on abort
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273 allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
293 'AlternateEdit': before checking if a user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
296 $EditPage: the EditPage object
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or PHP's mail().
300 Return false to skip the regular method of sending mail. Return a
301 string to return a php-mail-error message containing the error.
302 Returning true will continue with sending email in the regular way.
303 $headers: Associative array of headers for the email
304 $to: MailAddress object or array
306 $subject: Subject of the email
307 $body: Body of the message
309 'APIAfterExecute': after calling the execute() method of an API module.
310 Use this to extend core API modules.
311 &$module: Module object
313 'APIEditBeforeSave': before saving a page with api.php?action=edit,
314 after processing request parameters. Return false to let the request
315 fail, returning an error message or an <edit result="Failure"> tag
316 if $resultArr was filled.
317 $EditPage : the EditPage object
318 $text : the new text of the article (has yet to be saved)
319 &$resultArr : data in this array will be added to the API result
321 'APIGetAllowedParams': use this hook to modify a module's parameters.
322 &$module: ApiBase Module object
323 &$params: Array of parameters
325 'APIGetDescription': use this hook to modify a module's description
326 &$module: ApiBase Module object
327 &$desc: Array of descriptions
329 'APIGetParamDescription': use this hook to modify a module's parameter
331 &$module: ApiBase Module object
332 &$desc: Array of parameter descriptions
334 'APIGetResultProperties': use this hook to mofify the properties
335 in a module's result.
336 &$module: ApiBase Module object
337 &$properties: Array of properties
339 'APIQueryAfterExecute': after calling the execute() method of an
340 action=query submodule. Use this to extend core API modules.
341 &$module: Module object
343 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
344 method of an action=query submodule. Use this to extend core API modules.
345 &$module: Module object
346 &$resultPageSet: ApiPageSet object
348 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
349 Every token has an action, which will be used in the intoken parameter
350 and in the output (actiontoken="..."), and a callback function which
351 should return the token, or false if the user isn't allowed to obtain
352 it. The prototype of the callback function is func($pageid, $title)
353 where $pageid is the page ID of the page the token is requested for
354 and $title is the associated Title object. In the hook, just add
355 your callback to the $tokenFunctions array and return true (returning
356 false makes no sense)
357 $tokenFunctions: array(action => callback)
359 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
360 Every token has an action, which will be used in the rvtoken parameter
361 and in the output (actiontoken="..."), and a callback function which
362 should return the token, or false if the user isn't allowed to obtain
363 it. The prototype of the callback function is func($pageid, $title, $rev)
364 where $pageid is the page ID of the page associated to the revision the
365 token is requested for, $title the associated Title object and $rev the
366 associated Revision object. In the hook, just add your callback to the
367 $tokenFunctions array and return true (returning false makes no sense)
368 $tokenFunctions: array(action => callback)
370 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
372 Every token has an action, which will be used in the rctoken parameter
373 and in the output (actiontoken="..."), and a callback function which
374 should return the token, or false if the user isn't allowed to obtain
375 it. The prototype of the callback function is func($pageid, $title, $rc)
376 where $pageid is the page ID of the page associated to the revision the
377 token is requested for, $title the associated Title object and $rc the
378 associated RecentChange object. In the hook, just add your callback to the
379 $tokenFunctions array and return true (returning false makes no sense)
380 $tokenFunctions: array(action => callback)
382 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
383 the sites general information.
384 $module: the current ApiQuerySiteInfo module
385 &$results: array of results, add things here
387 'APIQueryUsersTokens': use this hook to add custom token to list=users.
388 Every token has an action, which will be used in the ustoken parameter
389 and in the output (actiontoken="..."), and a callback function which
390 should return the token, or false if the user isn't allowed to obtain
391 it. The prototype of the callback function is func($user) where $user
392 is the User object. In the hook, just add your callback to the
393 $tokenFunctions array and return true (returning false makes no sense)
394 $tokenFunctions: array(action => callback)
396 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
397 Each service should have its own entry in the $apis array and have a
398 unique name, passed as key for the array that represents the service data.
399 In this data array, the key-value-pair identified by the apiLink key is
401 &$apis: array of services
403 'ApiTokensGetTokenTypes': use this hook to extend action=tokens with new
405 &$tokenTypes: supported token types in format 'type' => callback function
406 used to retrieve this type of tokens.
408 'ArticleAfterFetchContent': after fetching content of an article from
410 $article: the article (object) being loaded from the database
411 $content: the content (string) of the article
413 'ArticleConfirmDelete': before writing the confirmation form for article
415 $article: the article (object) being deleted
416 $output: the OutputPage object ($wgOut)
417 &$reason: the reason (string) the article is being deleted
419 'ArticleContentOnDiff': before showing the article content below a diff.
420 Use this to change the content in this area or how it is loaded.
421 $diffEngine: the DifferenceEngine
422 $output: the OutputPage object ($wgOut)
424 'ArticleDelete': before an article is deleted
425 $article: the WikiPage (object) being deleted
426 $user: the user (object) deleting the article
427 $reason: the reason (string) the article is being deleted
428 $error: if the deletion was prohibited, the (raw HTML) error message to display
430 $status: Status object, modify this to throw an error. Overridden by $error
433 'ArticleDeleteComplete': after an article is deleted
434 $article: the WikiPage that was deleted
435 $user: the user that deleted the article
436 $reason: the reason the article was deleted
437 $id: id of the article that was deleted
439 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
441 $article: WikiPage (object) of the user talk page
443 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
444 article has been changed
445 $article: the WikiPage (object)
446 $editInfo: data holder that includes the parser output ($editInfo->output) for
447 that page after the change
448 $changed: bool for if the page was changed
450 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
451 recentchanges table, return false to not delete old entries
452 $article: WikiPage (object) being modified
454 'ArticleFromTitle': when creating an article object from a title object using
455 Wiki::articleFromTitle()
456 $title: title (object) used to create the article object
457 $article: article (object) that will be returned
459 'ArticleInsertComplete': After a new article is created
460 $article: WikiPage created
461 $user: User creating the article
463 $summary: Edit summary/comment
464 $isMinor: Whether or not the edit was marked as minor
465 $isWatch: (No longer used)
466 $section: (No longer used)
467 $flags: Flags passed to Article::doEdit()
468 $revision: New Revision of the article
470 'ArticleMergeComplete': after merging to article using Special:Mergehistory
471 $targetTitle: target title (object)
472 $destTitle: destination title (object)
474 'ArticlePageDataAfter': after loading data of an article from the database
475 $article: WikiPage (object) whose data were loaded
476 $row: row (object) returned from the database server
478 'ArticlePageDataBefore': before loading data of an article from the database
479 $article: WikiPage (object) that data will be loaded
480 $fields: fileds (array) to load from the database
482 'ArticlePrepareTextForEdit': called when preparing text to be saved
483 $article: the WikiPage being saved
484 $popts: parser options to be used for pre-save transformation
486 'ArticleProtect': before an article is protected
487 $article: the WikiPage being protected
488 $user: the user doing the protection
489 $protect: boolean whether this is a protect or an unprotect
490 $reason: Reason for protect
491 $moveonly: boolean whether this is for move only or not
493 'ArticleProtectComplete': after an article is protected
494 $article: the WikiPage that was protected
495 $user: the user who did the protection
496 $protect: boolean whether it was a protect or an unprotect
497 $reason: Reason for protect
498 $moveonly: boolean whether it was for move only or not
500 'ArticlePurge': before executing "&action=purge"
501 $article: WikiPage (object) to purge
503 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
504 revision of an article
505 &$title: title object of the article
507 'ArticleRevisionUndeleted': after an article revision is restored
508 $title: the article title
509 $revision: the revision
510 $oldPageID: the page ID of the revision when archived (may be null)
512 'ArticleRollbackComplete': after an article rollback is completed
513 $article: the WikiPage that was edited
514 $user: the user who did the rollback
515 $revision: the revision the page was reverted back to
516 $current: the reverted revision
518 'ArticleSave': before an article is saved
519 $article: the WikiPage (object) being saved
520 $user: the user (object) saving the article
521 $text: the new article text
522 $summary: the article summary (comment)
527 'ArticleSaveComplete': After an article has been updated
528 $article: WikiPage modified
529 $user: User performing the modification
531 $summary: Edit summary/comment
532 $isMinor: Whether or not the edit was marked as minor
533 $isWatch: (No longer used)
534 $section: (No longer used)
535 $flags: Flags passed to Article::doEdit()
536 $revision: New Revision of the article
537 $status: Status object about to be returned by doEdit()
538 $baseRevId: the rev ID (or false) this edit was based on
540 'ArticleUndelete': When one or more revisions of an article are restored
541 $title: Title corresponding to the article restored
542 $create: Whether or not the restoration caused the page to be created
543 (i.e. it didn't exist before)
544 $comment: The comment associated with the undeletion.
546 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
547 before the user is redirected back to the page
548 &$article: the article
549 &$sectionanchor: The section anchor link (e.g. "#overview" )
550 &$extraq: Extra query parameters which can be added via hooked functions
552 'ArticleViewFooter': After showing the footer section of an ordinary page view
553 $article: Article object
555 'ArticleViewHeader': Before the parser cache is about to be tried for article
557 &$article: the article
558 &$pcache: whether to try the parser cache or not
559 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
560 object to both indicate that the output is done and what parser output was used.
562 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
564 $article: target article (object)
566 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext
567 $text: text of the page
568 $title: title of the page
569 $output: reference to $wgOut
571 'AuthPluginAutoCreate': Called when creating a local account for an user logged
572 in from an external authentication method
573 $user: User object created locally
575 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
576 Gives a chance for an extension to set it programattically to a variable class.
577 &$auth: the $wgAuth object, probably a stub
579 'AutopromoteCondition': check autopromote condition for user.
580 $type: condition type
583 $result: result of checking autopromote condition
585 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
589 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
592 $title: title of the page to which backlinks are sought
593 &$conds: query conditions
595 'BadImage': When checking against the bad image list
596 $name: Image name being checked
597 &$bad: Whether or not the image is "bad"
599 Change $bad and return false to override. If an image is "bad", it is not
600 rendered inline in wiki pages or galleries in category pages.
602 'BeforeDisplayNoArticleText': before displaying noarticletext or noarticletext-nopermission
603 at Article::showMissingArticle()
605 $article: article object
607 'BeforeInitialize': before anything is initialized in MediaWiki::performRequest()
608 &$title: Title being used for request
610 &$output: OutputPage object
612 $request: WebRequest object
613 $mediaWiki: Mediawiki object
615 'BeforePageDisplay': Prior to outputting a page
616 &$out: OutputPage object
619 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
620 override how the redirect is output by modifying, or by returning false and
621 taking over the output.
622 $out: OutputPage object
623 &$redirect: URL, modifiable
624 &$code: HTTP code (eg '301' or '302'), modifiable
626 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
627 $parser: Parser object
629 &$options: array of options to RepoGroup::findFile
630 &$descQuery: query string to add to thumbnail URL
632 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
634 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
635 $parser: Parser object
636 $title: title of the template
637 &$skip: skip this template and link it?
638 &$id: the id of the revision being parsed
640 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
641 &$parser: Parser object
642 &$ig: ImageGallery object
644 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
645 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
646 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
648 'BitmapHandlerTransform': before a file is transformed, gives extension the
649 possibility to transform it themselves
650 $handler: BitmapHandler
652 &$scalerParams: Array with scaler parameters
653 &$mto: null, set to a MediaTransformOutput
655 'BitmapHandlerCheckImageArea': by BitmapHandler::normaliseParams, after all normalizations have been performed, except for the $wgMaxImageArea check
657 &$params: Array of parameters
658 &$checkImageAreaHookResult: null, set to true or false to override the $wgMaxImageArea check result
660 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
661 $block: Block object (which is set to be autoblocking)
662 &$blockIds: Array of block IDs of the autoblock
664 'BlockIp': before an IP address or user is blocked
665 $block: the Block object about to be saved
666 $user: the user _doing_ the block (not the one being blocked)
668 'BlockIpComplete': after an IP address or user is blocked
669 $block: the Block object that was saved
670 $user: the user who did the block (not the one being blocked)
672 'BookInformation': Before information output on Special:Booksources
673 $isbn: ISBN to show information for
674 $output: OutputPage object in use
676 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
677 &$namespaces: Array of namespace numbers with corresponding canonical names
679 'CategoryPageView': before viewing a categorypage in CategoryPage::view
680 $catpage: CategoryPage instance
682 'ChangePasswordForm': For extensions that need to add a field to the ChangePassword form
683 via the Preferences form
684 &$extraFields: An array of arrays that hold fields like would be passed to the pretty function.
686 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
687 &$changesList: ChangesList instance.
688 &$articlelink: HTML of link to article (already filled-in).
689 &$s: HTML of row that is being constructed.
690 &$rc: RecentChange instance.
691 $unpatrolled: Whether or not we are showing unpatrolled changes.
692 $watched: Whether or not the change is watched by the user.
694 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
695 $collationName: Name of the collation in question
696 &$collationObject: Null. Replace with a subclass of the Collation class that implements
697 the collation given in $collationName.
699 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
700 $user: user (object) whose email is being confirmed
702 'ContribsPager::getQueryInfo': Before the contributions query is about to run
703 &$pager: Pager object for contributions
704 &$queryInfo: The query for the contribs Pager
706 'ContributionsLineEnding': Called before a contributions HTML line is finished
707 $page: SpecialPage object for contributions
709 $row: the DB row for this line
711 'ContributionsToolLinks': Change tool links above Special:Contributions
713 $title: User page title
714 &$tools: Array of tool links
716 'CustomEditor': When invoking the page editor
717 $article: Article being edited
718 $user: User performing the edit
720 Return true to allow the normal editor to be used, or false
721 if implementing a custom editor, e.g. for a special namespace,
724 'DatabaseOraclePostInit': Called after initialising an Oracle database
725 &$db: the DatabaseOracle object
727 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
728 $text: plaintext string to be output
729 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
731 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
732 $title: the diff page title (nullable)
733 &$oldId: the actual old Id to use in the diff
734 &$newId: the actual new Id to use in the diff (0 means current)
735 $old: the ?old= param value from the url
736 $new: the ?new= param value from the url
738 'DiffViewHeader': called before diff display
739 $diff: DifferenceEngine object that's calling
740 $oldRev: Revision object of the "old" revision (may be null/invalid)
741 $newRev: Revision object of the "new" revision
743 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
745 $article: article (object) being viewed
746 $oldid: oldid (int) being viewed
748 'DoEditSectionLink': Override the HTML generated for section edit links
749 $skin: Skin object rendering the UI
750 $title: Title object for the title being linked to (may not be the same as
751 $wgTitle, if the section is included from a template)
752 $section: The designation of the section being pointed to, to be included in
753 the link, like "§ion=$section"
754 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
755 By default, this is wrapped in the 'editsectionhint' message.
756 &$result: The HTML to return, prefilled with the default plus whatever other
757 changes earlier hooks have made
758 $lang: The language code to use for the link in the wfMsg* functions
760 'EditFilter': Perform checks on an edit
761 $editor: Edit form (see includes/EditPage.php)
762 $text: Contents of the edit box
763 $section: Section being edited
764 &$error: Error message to return
765 $summary: Edit summary for page
767 'EditFilterMerged': Post-section-merge edit filter
768 $editor: EditPage instance (object)
769 $text: content of the edit box
770 &$error: error message to return
771 $summary: Edit summary for page
773 'EditFormPreloadText': Allows population of the edit form when creating
775 &$text: Text to preload with
776 &$title: Title object representing the page being created
778 'EditFormInitialText': Allows modifying the edit form when editing existing
780 $editPage: EditPage object
782 'EditPage::attemptSave': called before an article is
783 saved, that is before Article::doEdit() is called
784 $editpage_Obj: the current EditPage object
786 'EditPage::importFormData': allow extensions to read additional data
788 $editpage: EditPage instance
790 return value is ignored (should always return true)
792 'EditPage::showEditForm:fields': allows injection of form field into edit form
793 $editor: the EditPage instance for reference
794 $out: an OutputPage instance to write to
795 return value is ignored (should always return true)
797 'EditPage::showEditForm:initial': before showing the edit form
798 $editor: EditPage instance (object)
799 $out: an OutputPage instance to write to
801 Return false to halt editing; you'll need to handle error messages, etc.
802 yourself. Alternatively, modifying $error and returning true will cause the
803 contents of $error to be echoed at the top of the edit form as wikitext.
804 Return true without altering $error to allow the edit to proceed.
806 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
807 when there's an edit conflict. Return false to halt normal diff output; in
808 this case you're responsible for computing and outputting the entire "conflict"
809 part, i.e., the "difference between revisions" and "your text" headers and
811 &$editor: EditPage instance
812 &$out: OutputPage instance
814 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
815 textarea in the edit form
816 &$editpage: The current EditPage object
817 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
818 &$tabindex: HTML tabindex of the last edit check/button
820 'EditPageBeforeEditChecks': allows modifying the edit checks below the
821 textarea in the edit form
822 &$editpage: The current EditPage object
823 &$checks: Array of edit checks like "watch this page"/"minor edit"
824 &$tabindex: HTML tabindex of the last edit check/button
826 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
827 textarea in the edit form
828 &$toolbar: The toolbar HTMl
830 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
831 $title: title of page being edited
832 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
834 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
836 $editPage: EditPage object
837 &$newtext: wikitext that will be used as "your version"
839 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
840 $editPage: EditPage object
841 &$toparse: wikitext that will be parsed
843 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
844 &$editpage: The current EditPage object
845 &$res: the HTML of the error text
847 'EditPageTosSummary': Give a chance for site and per-namespace customizations
848 of terms of service summary link that might exist separately from the copyright
850 $title: title of page being edited
851 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
853 'EditSectionLink': Do not use, use DoEditSectionLink instead.
854 $skin: Skin rendering the UI
855 $title: Title being linked to
856 $section: Section to link to
858 &$result: Result (alter this to override the generated links)
859 $lang: The language code to use for the link in the wfMsg* functions
861 'EmailConfirmed': When checking that the user's email address is "confirmed"
862 $user: User being checked
863 $confirmed: Whether or not the email address is confirmed
864 This runs before the other checks, such as anonymity and the real check; return
865 true to allow those checks to occur, and false if checking is done.
867 'EmailUser': before sending email from one user to another
868 $to: address of receiving user
869 $from: address of sending user
870 $subject: subject of the mail
871 $text: text of the mail
873 'EmailUserCC': before sending the copy of the email to the author
874 $to: address of receiving user
875 $from: address of sending user
876 $subject: subject of the mail
877 $text: text of the mail
879 'EmailUserComplete': after sending email from one user to another
880 $to: address of receiving user
881 $from: address of sending user
882 $subject: subject of the mail
883 $text: text of the mail
885 'EmailUserForm': after building the email user form object
886 $form: HTMLForm object
888 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
889 $user: The user who is trying to email another user.
890 $editToken: The user's edit token.
891 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
893 'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle
894 $ip: The ip address of the user
896 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
897 &$extTypes: associative array of extensions types
899 'ExtractThumbParameters': called when extracting thumbnail parameters from a thumbnail file name
900 $thumbname: the base name of the thumbnail file
901 &$params: the currently extracted params (has source name, temp or archived zone)
903 'FetchChangesList': When fetching the ChangesList derivative for
905 $user: User the list is being fetched for
906 &$skin: Skin object to be used with the list
907 &$list: List object (defaults to NULL, change it to an object
908 instance and return false override the list derivative used)
910 'FileDeleteComplete': When a file is deleted
911 $file: reference to the deleted file
912 $oldimage: in case of the deletion of an old image, the name of the old file
913 $article: in case all revisions of the file are deleted a reference to the
914 WikiFilePage associated with the file.
915 $user: user who performed the deletion
918 'FileTransformed': When a file is transformed and moved into storage
919 $file: reference to the File object
920 $thumb: the MediaTransformOutput object
921 $tmpThumbPath: The temporary file system path of the transformed file
922 $thumbPath: The permanent storage path of the transformed file
924 'FileUpload': When a file upload occurs
925 $file : Image object representing the file that was uploaded
926 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
927 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
929 'FileUndeleteComplete': When a file is undeleted
930 $title: title object to the file
931 $fileVersions: array of undeleted versions. Empty if all versions were restored
932 $user: user who performed the undeletion
935 'FormatAutocomments': When an autocomment is formatted by the Linker
936 &$comment: Reference to the accumulated comment. Initially null, when set the default code will be skipped.
937 $pre: Initial part of the parsed comment before the call to the hook.
938 $auto: The extracted part of the parsed comment before the call to the hook.
939 $post: The final part of the parsed comment before the call to the hook.
940 $title: An optional title object used to links to sections. Can be null.
941 $local: Boolean indicating whether section links should refer to local page.
943 'GetAutoPromoteGroups': When determining which autopromote groups a user
944 is entitled to be in.
945 &$user: user to promote.
946 &$promote: groups that will be added.
948 'GetBlockedStatus': after loading blocking status of an user from the database
949 $user: user (object) being checked
951 'GetCacheVaryCookies': get cookies that should vary cache options
952 $out: OutputPage object
953 &$cookies: array of cookies name, add a value to it if you want to add a cookie
954 that have to vary cache options
956 'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
957 $title: Title object of page
958 $url: string value as output (out parameter, can modify)
959 $query: query options passed to Title::getCanonicalURL()
961 'GetDefaultSortkey': Override the default sortkey for a page.
962 $title: Title object that we need to get a sortkey for
963 &$sortkey: Sortkey to use.
965 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
966 $title: Title object of page
967 $url: string value as output (out parameter, can modify)
968 $query: query options passed to Title::getFullURL()
970 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
971 $title: Title object of page
972 $url: string value as output (out parameter, can modify)
973 $query: query options passed to Title::getInternalURL()
975 'GetIP': modify the ip of the current user (called only once)
976 &$ip: string holding the ip as determined so far
978 'GetLinkColours': modify the CSS class of an array of page links
979 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
981 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
983 'GetLocalURL': modify local URLs as output into page links. Note that if you
984 are working with internal urls (non-interwiki) then it may be preferable
985 to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
986 GetLocalURL can be buggy for internal urls on render if you do not
987 re-implement the horrible hack that Title::getLocalURL uses
988 in your own extension.
989 $title: Title object of page
990 &$url: string value as output (out parameter, can modify)
991 $query: query options passed to Title::getLocalURL()
993 'GetLocalURL::Internal': modify local URLs to internal pages.
994 $title: Title object of page
995 &$url: string value as output (out parameter, can modify)
996 $query: query options passed to Title::getLocalURL()
998 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
999 without any fancy queries or variants.
1000 $title: Title object of page
1001 &$url: string value as output (out parameter, can modify)
1003 'GetMetadataVersion': modify the image metadata version currently in use. This is
1004 used when requesting image metadata from a ForiegnApiRepo. Media handlers
1005 that need to have versioned metadata should add an element to the end of
1006 the version array of the form 'handler_name=version'. Most media handlers
1007 won't need to do this unless they broke backwards compatibility with a
1008 previous version of the media handler metadata output.
1009 &$version: Array of version strings
1011 'GetPreferences': modify user preferences
1012 $user: User whose preferences are being modified.
1013 &$preferences: Preferences description array, to be fed to an HTMLForm object
1015 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1016 checked for. Use instead of userCan for most cases. Return false if the
1017 user can't do it, and populate $result with the reason in the form of
1018 array( messagename, param1, param2, ... ). For consistency, error messages
1019 should be plain text with no special coloring, bolding, etc. to show that
1020 they're errors; presenting them properly to the user as errors is done by
1022 $title: Title object being checked against
1023 $user : Current user object
1024 $action: Action being checked
1025 $result: User permissions error to add. If none, return true.
1027 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
1028 if expensive checks are enabled.
1030 'GitViewers': called when generating the list of git viewers for Special:Version, use
1031 this to change the list.
1032 &$extTypes: associative array of repo URLS to viewer URLs.
1035 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1036 image insertion. You can skip the default logic entirely by returning
1037 false, or just modify a few things using call-by-reference.
1039 &$title: Title object of the image
1040 &$file: File object, or false if it doesn't exist
1041 &$frameParams: Various parameters with special meanings; see documentation in
1042 includes/Linker.php for Linker::makeImageLink2
1043 &$handlerParams: Various parameters with special meanings; see documentation in
1044 includes/Linker.php for Linker::makeImageLink2
1045 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1046 &$res: Final HTML output, used if you return false
1049 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1050 the image on an image page
1051 $imagePage: ImagePage object ($this)
1054 'ImagePageAfterImageLinks': called after the image links section on an image
1056 $imagePage: ImagePage object ($this)
1057 &$html: HTML for the hook to add
1059 'ImagePageFileHistoryLine': called when a file history line is contructed
1061 $line: the HTML of the history line
1062 $css: the line CSS class
1064 'ImagePageFindFile': called when fetching the file associated with an image page
1065 $page: ImagePage object
1067 &$displayFile: displayed File object
1069 'ImagePageShowTOC': called when the file toc on an image page is generated
1070 $page: ImagePage object
1071 &$toc: Array of <li> strings
1073 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1075 &$title: the Title object of the file as it would appear for the upload page
1076 &$path: the original file and path name when img_auth was invoked by the the web
1078 &$name: the name only component of the file
1079 &$result: The location to pass back results of the hook routine (only used if
1081 $result[0]=The index of the header message
1082 $result[1]=The index of the body text message
1083 $result[2 through n]=Parameters passed to body text message. Please note the
1084 header message cannot receive/use parameters.
1086 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1087 $reader: XMLReader object
1088 $logInfo: Array of information
1089 Return false to stop further processing of the tag
1091 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1092 $reader: XMLReader object
1093 $pageInfo: Array of information
1094 Return false to stop further processing of the tag
1096 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1097 $reader: XMLReader object
1098 $pageInfo: Array of page information
1099 $revisionInfo: Array of revision information
1100 Return false to stop further processing of the tag
1102 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1103 $reader: XMLReader object
1104 Return false to stop further processing of the tag
1106 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1107 $reader: XMLReader object
1108 $revisionInfo: Array of information
1109 Return false to stop further processing of the tag
1111 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1112 $title: Title object ($wgTitle)
1113 $request: WebRequest
1114 $ignoreRedirect: boolean to skip redirect check
1115 $target: Title/string of redirect target
1116 $article: Article object
1118 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1119 Return true without providing an interwiki to continue interwiki search.
1120 $prefix: interwiki prefix we are looking for.
1121 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1122 iw_trans and optionally iw_api and iw_wikiid.
1124 'InternalParseBeforeLinks': during Parser's internalParse method before links
1125 but after noinclude/includeonly/onlyinclude and other processing.
1126 &$parser: Parser object
1127 &$text: string containing partially parsed text
1128 &$stripState: Parser's internal StripState object
1130 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1131 $user: user (object) whose email is being invalidated
1133 'IRCLineURL': When constructing the URL to use in an IRC notification.
1134 Callee may modify $url and $query, URL will be constructed as $url . $query
1135 &$url: URL to index.php
1136 &$query: Query string
1138 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1139 $article: article (object) being checked
1141 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1143 $result: Change this value to override the result of wfIsTrustedProxy()
1145 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1146 tance to return false if the domain name doesn't match your organization
1147 $addr: The e-mail address entered by the user
1148 &$result: Set this and return false to override the internal checks
1150 'isValidPassword': Override the result of User::isValidPassword()
1151 $password: The password entered by the user
1152 &$result: Set this and return false to override the internal checks
1153 $user: User the password is being validated for
1155 'Language::getMessagesFileName':
1156 $code: The language code or the language we're looking for a messages file for
1157 &$file: The messages file path, you can override this to change the location.
1159 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1160 remove namespaces. Do not use this hook to add namespaces. Use
1161 CanonicalNamespaces for that.
1162 &$namespaces: Array of namespaces indexed by their numbers
1164 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1165 $wgExtensionMessagesFiles instead.
1166 Use this to define synonyms of magic words depending of the language
1167 $magicExtensions: associative array of magic words synonyms
1168 $lang: laguage code (string)
1170 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1171 listed in $wgExtensionMessagesFiles instead.
1172 Use to define aliases of special pages names depending of the language
1173 $specialPageAliases: associative array of magic words synonyms
1174 $lang: laguage code (string)
1176 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1177 &$names: array of language code => language name
1178 $code language of the preferred translations
1180 'LinkBegin': Used when generating internal and interwiki links in
1181 Linker::link(), before processing starts. Return false to skip default proces-
1182 sing and return $ret. See documentation for Linker::link() for details on the
1183 expected meanings of parameters.
1184 $skin: the Skin object
1185 $target: the Title that the link is pointing to
1186 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1188 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1189 tive array form, with keys and values unescaped. Should be merged with de-
1190 fault values, with a value of false meaning to suppress the attribute.
1191 &$query: the query string to add to the generated URL (the bit after the "?"),
1192 in associative array form, with keys and values unescaped.
1193 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1194 &$ret: the value to return if your hook returns false.
1196 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1197 just before the function returns a value. If you return true, an <a> element
1198 with HTML attributes $attribs and contents $html will be returned. If you re-
1199 turn false, $ret will be returned.
1200 $skin: the Skin object
1201 $target: the Title object that the link is pointing to
1202 $options: the options. Will always include either 'known' or 'broken', and may
1203 include 'noclasses'.
1204 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1205 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1207 &$ret: the value to return if your hook returns false.
1209 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1211 &$url: the image url
1212 &$alt: the image's alt text
1213 &$img: the new image HTML (if returning false)
1215 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1218 &$text: the link text
1219 &$link: the new link HTML (if returning false)
1220 &$attribs: the attributes to be applied.
1221 $linkType: The external link type
1223 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1225 &$linksUpdate: the LinksUpdate object
1227 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1229 &$linksUpdate: the LinksUpdate object
1231 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1232 &$linksUpdate: the LinksUpdate object
1234 'ListDefinedTags': When trying to find all defined tags.
1235 &$tags: The list of tags.
1237 'LoadExtensionSchemaUpdates': called during database installation and updates
1238 &updater: A DatabaseUpdater subclass
1240 'LocalFile::getHistory': called before file history query performed
1241 $file: the File object
1243 $fields: select fields
1245 $opts: query options
1246 $join_conds: JOIN conditions
1248 'LocalFilePurgeThumbnails': called before thumbnails for a local file a purged
1249 $file: the File object
1250 $archiveName: name of an old file version or false if it's the current one
1252 'LocalisationCacheRecache': Called when loading the localisation data into cache
1253 $cache: The LocalisationCache object
1254 $code: language code
1255 &$alldata: The localisation data from core and extensions
1257 'LogEventsListShowLogExtract': called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage
1258 &$s: html string to show for the log extract
1259 $types: String or Array Log types to show
1260 $page: String or Title The page title to show log entries for
1261 $user: String The user who made the log entries
1262 $param: Associative Array with the following additional options:
1263 - lim Integer Limit of items to show, default is 50
1264 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1265 - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
1266 - msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wfMsgExt and option 'parse'
1267 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset
1268 - wrap String Wrap the message in html (usually something like "<div ...>$1</div>").
1269 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1271 'LoggableUserIPData': called when IP data for a user action can be logged by extensions like CheckUser.
1272 This is intended for when users do things that do not already create edits or log entries.
1273 $context: The context the of the action, which includes the user and request
1274 $data: Associative array of data for handlers to record. It must include values for:
1275 - 'namespace' Integer namespace for target title (NS_SPECIAL is allowed)
1276 - 'title' Database key string for target title (empty string if not applicable)
1277 - 'pageid' Integer page ID for target title (zero if not applicable)
1278 - 'action' Wikitext string in the same format as an edit summary
1279 - 'comment' Wikitext string in the same format as an edit summary
1280 - 'timestamp' Timestamp when the action occured
1282 'LoginAuthenticateAudit': a login attempt for a valid user account either
1283 succeeded or failed. No return data is accepted; this hook is for auditing only.
1284 $user: the User object being authenticated against
1285 $password: the password being submitted and found wanting
1286 $retval: a LoginForm class constant with authenticateUserData() return
1287 value (SUCCESS, WRONG_PASS, etc)
1289 'LogLine': Processes a single log entry on Special:Log
1290 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1291 logging.log_type database field.
1292 $log_action: string for the type of log action (e.g. 'delete', 'block',
1293 'create2'). Corresponds to logging.log_action database field.
1294 $title: Title object that corresponds to logging.log_namespace and
1295 logging.log_title database fields.
1296 $paramArray: Array of parameters that corresponds to logging.log_params field.
1297 Note that only $paramArray[0] appears to contain anything.
1298 &$comment: string that corresponds to logging.log_comment database field, and
1299 which is displayed in the UI.
1300 &$revert: string that is displayed in the UI, similar to $comment.
1301 $time: timestamp of the log entry (added in 1.12)
1303 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1304 $refreshLinks: RefreshLinks object
1306 'MagicWordwgVariableIDs': When definig new magic words IDs.
1307 $variableIDs: array of strings
1309 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1310 is executed. Ideally, this hook should only be used to add variables that
1311 depend on the current page/request; static configuration should be added
1312 through ResourceLoaderGetConfigVars instead.
1313 &$vars: variable (or multiple variables) to be added into the output
1314 of Skin::makeVariablesScript
1315 $out: The OutputPage which called the hook,
1316 can be used to get the real title
1318 'MarkPatrolled': before an edit is marked patrolled
1319 $rcid: ID of the revision to be marked patrolled
1320 $user: the user (object) marking the revision as patrolled
1321 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1322 needs to be a sysop in order to mark an edit patrolled
1324 'MarkPatrolledComplete': after an edit is marked patrolled
1325 $rcid: ID of the revision marked as patrolled
1326 $user: user (object) who marked the edit patrolled
1327 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1328 must be a sysop to patrol the edit
1330 'MediaWikiPerformAction': Override MediaWiki::performAction().
1331 Use this to do something completely different, after the basic
1332 globals have been set up, but before ordinary actions take place.
1334 $article: $wgArticle
1337 $request: $wgRequest
1338 $mediaWiki: The $mediawiki object
1340 'MessagesPreLoad': When loading a message from the database
1341 $title: title of the message (string)
1342 $message: value (string), change it to the message you want to define
1344 'MessageCacheReplace': When a message page is changed.
1345 Useful for updating caches.
1346 $title: name of the page changed.
1347 $text: new contents of the page.
1349 'ModifyExportQuery': Modify the query used by the exporter.
1350 $db: The database object to be queried.
1351 &$tables: Tables in the query.
1352 &$conds: Conditions in the query.
1353 &$opts: Options for the query.
1354 &$join_conds: Join conditions for the query.
1356 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1357 been rendered (useful for adding more)
1358 Note: this is only run for the Monobook skin. This hook is deprecated and
1359 may be removed in the future. To add items to the toolbox you should use
1360 the SkinTemplateToolboxEnd hook instead, which works for all
1361 "SkinTemplate"-type skins.
1362 $tools: array of tools
1364 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1365 and returning it for the skin to output. You can add items to the toolbox while
1366 still letting the skin make final decisions on skin-specific markup conventions
1368 &$sk: The BaseTemplate base skin template
1369 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1370 BaseTemplate::makeListItem for details on the format of individual
1371 items inside of this array
1373 'NamespaceIsMovable': Called when determining if it is possible to pages in a namespace.
1374 $index: Integer; the index of the namespace being checked.
1375 $result: Boolean; whether MediaWiki currently thinks that pages in this namespace are movable.
1376 Hooks may change this value to override the return value of MWNamespace::isMovable()
1378 'NewRevisionFromEditComplete': called when a revision was inserted
1380 $article: the WikiPage edited
1381 $rev: the new revision
1382 $baseID: the revision ID this was based off, if any
1383 $user: the editing user
1385 'NormalizeMessageKey': Called before the software gets the text of a message
1386 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1388 &$key: the message being looked up. Change this to something else to change
1389 what message gets displayed (string)
1390 &$useDB: whether or not to look up the message in the database (bool)
1391 &$langCode: the language code to get the message for (string) - or -
1392 whether to use the content language (true) or site language (false) (bool)
1393 &$transform: whether or not to expand variables and templates
1394 in the message (bool)
1396 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1397 &$changeslist: The OldChangesList instance.
1398 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1399 &$rc: The RecentChange object.
1401 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1402 Hooks can alter or append to the array of URLs for search & suggestion formats.
1403 &$urls: array of associative arrays with Url element attributes
1405 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1406 users and/or IP addresses too
1407 $otherBlockLink: An array with links to other block logs
1408 $ip: The requested IP address or username
1410 'OutputPageBeforeHTML': a page has been processed by the parser and
1411 the resulting HTML is about to be displayed.
1412 $parserOutput: the parserOutput (object) that corresponds to the page
1413 $text: the text that will be displayed, in HTML (string)
1415 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1416 tag to allow for extensions to add attributes to the body of the page they might
1417 need. Or to allow building extensions to add body classes that aren't of high
1418 enough demand to be included in core.
1419 $out: The OutputPage which called the hook, can be used to get the real title
1420 $sk: The Skin that called OutputPage::headElement
1421 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1423 'OutputPageCheckLastModified': when checking if the page has been modified
1424 since the last visit
1425 &$modifiedTimes: array of timestamps.
1426 The following keys are set: page, user, epoch
1428 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1429 $out: OutputPage instance (object)
1430 $parserOutput: parserOutput instance being added in $out
1432 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1433 categories. Implementations should return false if they generate the category
1434 links, so the default link generation is skipped.
1435 $out: OutputPage instance (object)
1436 $categories: associative array, keys are category names, values are category
1437 types ("normal" or "hidden")
1438 $links: array, intended to hold the result. Must be an associative array with
1439 category types as keys and arrays of HTML links as values.
1441 'PageContentLanguage': allows changing the language in which the content of
1442 a page is written. Defaults to the wiki content language ($wgContLang).
1443 $title: Title object
1444 &$pageLang: the page content language (either an object or a language code)
1445 $wgLang: the user language
1447 'PageHistoryBeforeList': When a history page list is about to be constructed.
1448 $article: the article that the history is loading for
1450 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1451 $row: the revision row for this line
1452 $s: the string representing this parsed line
1453 $classes: array containing the <li> element classes
1455 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1458 $queryInfo: the query parameters
1460 'PageRenderingHash': alter the parser cache option hash key
1461 A parser extension which depends on user options should install
1462 this hook and append its values to the key.
1463 $hash: reference to a hash key string which can be modified
1465 'ParserAfterStrip': Same as ParserBeforeStrip
1467 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1468 $parser: Parser object being used
1469 $text: text that'll be returned
1471 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1472 $parser: Parser object
1473 $text: text to parse
1474 $stripState: StripState instance being used
1476 'ParserBeforeStrip': Called at start of parsing time
1477 (no more strip, deprecated ?)
1478 $parser: parser object
1479 $text: text being parsed
1480 $stripState: stripState used (object)
1482 'ParserBeforeTidy': called before tidy and custom tags replacements
1483 $parser: Parser object being used
1486 'ParserClearState': called at the end of Parser::clearState()
1487 $parser: Parser object being cleared
1489 'ParserFirstCallInit': called when the parser initialises for the first time
1490 &$parser: Parser object being cleared
1492 'ParserGetVariableValueSwitch': called when the parser need the value of a
1494 $parser: Parser object
1495 $varCache: array to store the value in case of multiples calls of the
1497 $index: index (string) of the magic
1498 $ret: value of the magic word (the hook should set it)
1499 $frame: PPFrame object to use for expanding any template variables
1501 'ParserGetVariableValueTs': use this to change the value of the time for the
1502 {{LOCAL...}} magic word
1503 $parser: Parser object
1504 $time: actual time (timestamp)
1506 'ParserGetVariableValueVarCache': use this to change the value of the
1507 variable cache or return false to not use it
1508 $parser: Parser object
1509 $varCache: varaiable cache (array)
1511 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1512 include comments about size of the text parsed
1513 $parser: Parser object
1514 $limitReport: text that will be included (without comment tags)
1516 'ParserMakeImageParams': Called before the parser make an image link, use this
1517 to modify the parameters of the image.
1518 $title: title object representing the file
1519 $file: file object that will be used to create the image
1520 &$params: 2-D array of parameters
1521 $parser: Parser object that called the hook
1523 'ParserSectionCreate': Called each time the parser creates a document section
1524 from wikitext. Use this to apply per-section modifications to HTML (like
1525 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1526 can begin in one section and end in another. Make sure your code can handle
1527 that case gracefully. See the EditSectionClearerLink extension for an
1529 $parser: the calling Parser instance
1530 $section: the section number, zero-based, but section 0 is usually empty
1531 &$sectionContent: ref to the content of the section. modify this.
1532 $showEditLinks: boolean describing whether this section has an edit link
1534 'ParserTestParser': called when creating a new instance of Parser in
1535 maintenance/parserTests.inc
1536 $parser: Parser object created
1538 'ParserTestTables': alter the list of tables to duplicate when parser tests
1539 are run. Use when page save hooks require the presence of custom tables
1540 to ensure that tests continue to run properly.
1541 &$tables: array of table names
1543 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1544 my talk page, my contributions" etc).
1545 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1546 &$title: Title object representing the current page
1548 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1549 &$user : User performing the action
1550 $action : Action being performed
1551 &$result : Whether or not the action should be prevented
1552 Change $result and return false to give a definitive answer, otherwise
1553 the built-in rate limiting checks are used, if enabled.
1555 'PlaceNewSection': Override placement of new sections.
1556 $wikipage : WikiPage object
1557 $oldtext : the text of the article before editing
1558 $subject : subject of the new section
1559 &$text : text of the new section
1560 Return false and put the merged text into $text to override the default behavior.
1562 'PreferencesGetLegend': Override the text used for the <legend> of a preferences section
1563 $form: the PreferencesForm object. This is a ContextSource as well
1564 $key: the section name
1565 &$legend: the legend text. Defaults to wfMsg( "prefs-$key" ) but may be overridden
1567 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1568 AJAX search suggestions. Put results into &$results outparam and return false.
1569 $ns : array of int namespace keys to search in
1570 $search : search term (not guaranteed to be conveniently normalized)
1571 $limit : maximum number of results to return
1572 &$results : out param: array of page names (strings)
1574 'PrefsEmailAudit': called when user changes his email address
1575 $user: User (object) changing his email address
1576 $oldaddr: old email address (string)
1577 $newaddr: new email address (string)
1579 'PrefsPasswordAudit': called when user changes his password
1580 $user: User (object) changing his passoword
1581 $newPass: new password
1582 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1584 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1585 $article: the title being (un)protected
1586 $output: a string of the form HTML so far
1588 'ProtectionForm::save': called when a protection form is submitted
1589 $article: the title being (un)protected
1590 $errorMsg: an html message string of an error or an array of message name and its parameters
1592 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1593 $article: the page the form is shown for
1594 $out: OutputPage object
1596 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1597 &$obj: RawPage object
1598 &$text: The text that's going to be the output
1600 'RecentChange_save': called at the end of RecentChange::save()
1601 $recentChange: RecentChange object
1603 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin instance.
1604 Can be used by an extension override what skin is used in certain contexts.
1605 IContextSource $context: The RequestContext the skin is being created for.
1606 &$skin: A variable reference you may set a Skin instance or string key on to override the skin that will be used for the context.
1608 'ResourceLoaderGetConfigVars': called at the end of
1609 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1610 configuration variables to JavaScript. Things that depend on the current
1611 page/request state must be added through MakeGlobalVariablesScript instead.
1612 &$vars: array( variable name => value )
1614 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1615 to add modules to the startup module. This hook should be used sparingly since any module added here
1616 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1619 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1620 loader request or generating HTML output.
1621 &$resourceLoader: ResourceLoader object
1623 'ResourceLoaderTestModules': let you add new JavaScript testing modules. This is called after the addition of 'qunit' and MediaWiki testing resources.
1624 &testModules: array of JavaScript testing modules. The 'qunit' framework, included in core, is fed using tests/qunit/QUnitTestResources.php.
1625 &ResourceLoader object
1626 To add a new qunit module named 'myext.tests':
1627 testModules['qunit']['myext.tests'] = array(
1628 'script' => 'extension/myext/tests.js',
1629 'dependencies' => <any module dependency you might have>
1631 For qunit framework, the mediawiki.tests.qunit.testrunner dependency will be added to any module.
1633 'RevisionInsertComplete': called after a revision is inserted into the DB
1634 &$revision: the Revision
1635 $data: the data stored in old_text. The meaning depends on $flags: if external
1636 is set, it's the URL of the revision text in external storage; otherwise,
1637 it's the revision text itself. In either case, if gzip is set, the revision
1639 $flags: a comma-delimited list of strings representing the options used. May
1640 include: utf8 (this will always be set for new revisions); gzip; external.
1642 'SearchUpdate': Prior to search update completion
1644 $namespace : Page namespace
1646 $text : Current text being indexed
1648 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1649 $allSearchTerms : Array of the search terms in all content languages
1650 &$titleResult : Outparam; the value to return. A Title object or null.
1652 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1653 $term : Search term string
1654 &$title : Outparam; set to $title object and return false for a match
1656 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1657 $term : Search term string
1658 &$title : Current Title object that is being returned (null if none found).
1660 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1661 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1662 in the $searchEngine->namespaces array.
1663 $query : Original query.
1664 &$parsed : Resultant query with the prefixes stripped.
1666 'SearchableNamespaces': An option to modify which namespaces are searchable.
1667 &$arr : Array of namespaces ($nsId => $name) which will be used.
1669 'SetupAfterCache': Called in Setup.php, after cache objects are set
1671 'ShowMissingArticle': Called when generating the output for a non-existent page
1672 $article: The article object corresponding to the page
1674 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1675 $text: Text being shown
1676 $title: Title of the custom script/stylesheet page
1677 $output: Current OutputPage object
1679 'ShowSearchHitTitle': Customise display of search hit title/link.
1680 &$title: Title to link to
1681 &$text: Text to use for the link
1682 $result: The search result
1683 $terms: The search terms entered
1684 $page: The SpecialSearch object.
1686 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1687 &$siteNotice: HTML returned as the sitenotice
1689 Return true to allow the normal method of notice selection/rendering to work,
1690 or change the value of $siteNotice and return false to alter it.
1692 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1693 &$siteNotice: HTML sitenotice
1695 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1697 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1699 &$text: bottomScripts Text
1700 Append to $text to add additional text/scripts after the stock bottom scripts.
1702 'SkinAfterContent': Allows extensions to add text after the page content and
1704 &$data: (string) Text to be printed out directly (without parsing)
1706 This hook should work in all skins. Just set the &$data variable to the text
1707 you're going to add.
1709 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1711 &$bar: Sidebar contents
1712 Modify $bar to add or modify sidebar portlets.
1714 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1715 $title: displayed page title
1716 $type: 'normal' or 'history' for old/diff views
1717 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1718 &$link: overridable HTML link to be passed into the message as $1
1719 &$forContent: overridable flag if copyright footer is shown in content language.
1722 &$text: additional 'powered by' icons in HTML.
1723 Note: Modern skin does not use the MediaWiki icon but plain text instead
1726 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1727 &$subpages: Subpage links HTML
1729 $out: OutputPage object
1730 If false is returned $subpages will be used instead of the HTML
1731 subPageSubtitle() generates.
1732 If true is returned, $subpages will be ignored and the rest of
1733 subPageSubtitle() will run.
1735 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1736 "permanent link" tab
1737 $sktemplate: SkinTemplate object
1738 $nav_urls: array of tabs
1740 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1741 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1742 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1743 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1744 &$sktemplate: SkinTemplate object
1745 &$links: Structured navigation links
1746 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1748 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1750 &$sktemplate: SkinTemplate object
1751 &$tpl: Template engine object
1753 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1754 $sktemplate: SkinTemplate object
1755 $res: set to true to prevent active tabs
1757 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1758 You can either create your own array, or alter the parameters for
1760 &$sktemplate: The SkinTemplate instance.
1761 $title: Title instance for the page.
1762 $message: Visible label of tab.
1763 $selected: Whether this is a selected tab.
1764 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1765 &$classes: Array of CSS classes to apply.
1766 &$query: Query string to add to link.
1768 &$result: Complete assoc. array if you want to return true.
1770 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1771 been rendered (useful for adding more)
1772 $sk: The QuickTemplate based skin template running the hook.
1773 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
1774 extensions that add support for BaseTemplateToolbox should watch for this dummy
1775 parameter with "$dummy=false" in their code and return without echoing any html
1776 to avoid creating duplicate toolbox items.
1778 'SoftwareInfo': Called by Special:Version for returning information about
1780 $software: The array of software in format 'name' => 'version'.
1781 See SpecialVersion::softwareInformation()
1783 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1784 $id: User identifier
1786 'SpecialListusersDefaultQuery': called right before the end of
1787 UsersPager::getDefaultQuery()
1788 $pager: The UsersPager instance
1789 $query: The query array to be returned
1791 'SpecialListusersFormatRow': called right before the end of
1792 UsersPager::formatRow()
1793 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1794 $row: Database row object
1796 'SpecialListusersHeader': called before closing the <fieldset> in
1797 UsersPager::getPageHeader()
1798 $pager: The UsersPager instance
1799 $out: The header HTML
1801 'SpecialListusersHeaderForm': called before adding the submit button in
1802 UsersPager::getPageHeader()
1803 $pager: The UsersPager instance
1804 $out: The header HTML
1806 'SpecialListusersQueryInfo': called right before the end of
1807 UsersPager::getQueryInfo()
1808 $pager: The UsersPager instance
1809 $query: The query array to be returned
1811 'SpecialMovepageAfterMove': called after moving a page
1812 $movePage: MovePageForm object
1813 $oldTitle: old title (object)
1814 $newTitle: new title (object)
1816 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1817 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1818 $opts: FormOptions object containing special page options
1819 &$conds: array of WHERE conditionals for query
1820 &tables: array of tables to be queried
1821 &$fields: array of columns to select
1822 &$join_conds: join conditions for the tables
1824 'SpecialNewPagesFilters': called after building form options at NewPages
1825 $special: the special page object
1826 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1827 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1829 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1830 hook to remove a core special page
1831 $list: list (array) of core special pages
1833 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1834 $users: array of User objects
1835 $data: array of data submitted by the user
1836 &$error: string, error code (message name) used to describe to error (out paramater).
1837 The hook needs to return false when setting this, otherwise it will have no effect.
1839 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1840 use this to change some selection criteria or substitute a different title
1841 &$randstr: The random number from wfRandom()
1842 &$isRedir: Boolean, whether to select a redirect or non-redirect
1843 &$namespaces: An array of namespace indexes to get the title from
1844 &$extra: An array of extra SQL statements
1845 &$title: If the hook returns false, a Title object to use instead of the
1846 result from the normal query
1848 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1849 $special: the special page object
1850 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1851 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1853 'SpecialRecentChangesPanel': called when building form options in
1854 SpecialRecentChanges
1855 &$extraOpts: array of added items, to which can be added
1856 $opts: FormOptions for this request
1858 'SpecialRecentChangesQuery': called when building sql query for
1859 SpecialRecentChanges and SpecialRecentChangesLinked
1860 &$conds: array of WHERE conditionals for query
1861 &$tables: array of tables to be queried
1862 &$join_conds: join conditions for the tables
1863 $opts: FormOptions for this request
1864 &$query_options: array of options for the database request
1865 &$select: Array of columns to select
1867 'SpecialSearchCreateLink': called when making the message to create a page or
1868 go to the existing page
1869 $t: title object searched for
1870 &$params: an array of the default message name and page title (as parameter)
1872 'SpecialSearchGo': called when user clicked the "Go"
1873 &$title: title object generated from the text entered by the user
1874 &$term: the search term entered by the user
1876 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1877 target doesn't exist
1878 &$title: title object generated from the text entered by the user
1880 'SpecialSearchPowerBox': the equivalent of SpecialSearchProfileForm for
1881 the advanced form, a.k.a. power search box
1882 &$showSections: an array to add values with more options to
1883 $term: the search term (not a title object)
1884 $opts: an array of hidden options (containing 'redirs' and 'profile')
1886 'SpecialSearchProfiles': allows modification of search profiles
1887 &$profiles: profiles, which can be modified.
1889 'SpecialSearchProfileForm': allows modification of search profile forms
1890 $search: special page object
1891 &$form: String: form html
1892 $profile: String: current search profile
1893 $term: String: search term
1894 $opts: Array: key => value of hidden options for inclusion in custom forms
1896 'SpecialSearchSetupEngine': allows passing custom data to search engine
1897 $search: special page object
1898 $profile: String: current search profile
1899 $engine: the search engine
1901 'SpecialSearchResults': called before search result display when there
1903 $term: string of search term
1904 &$titleMatches: empty or SearchResultSet object
1905 &$textMatches: empty or SearchResultSet object
1907 'SpecialSearchNoResults': called before search result display when there are
1909 $term: string of search term
1911 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1912 &$extraStats: Array to save the new stats
1913 ( $extraStats['<name of statistic>'] => <value>; )
1915 'SpecialUploadComplete': Called after successfully uploading a file from
1917 $form: The SpecialUpload object
1919 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1920 use this to change the tables headers
1921 $extTypes: associative array of extensions types
1923 'SpecialWatchlistFilters': called after building form options at Watchlist
1924 $special: the special page object
1925 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1926 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1928 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1929 &$conds: array of WHERE conditionals for query
1930 &$tables: array of tables to be queried
1931 &$join_conds: join conditions for the tables
1932 &$fields: array of query fields
1934 'TestCanonicalRedirect': called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. Gives a chance for extensions that alter page view behavior radically to abort that redirect or handle it manually.
1935 $request: WebRequest
1936 $title: Title of the currently found title obj
1937 $output: OutputPage object
1939 'TitleArrayFromResult': called when creating an TitleArray object from a
1941 &$titleArray: set this to an object to override the default object returned
1942 $res: database result used to create the object
1944 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1945 that can be applied.
1946 $title: The title in question.
1947 &$types: The types of protection available.
1949 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1950 $title: Title object that is being checked
1951 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
1953 'TitleIsAlwaysKnown': Called when determining if a page exists.
1954 Allows overriding default behaviour for determining if a page exists.
1955 If $isKnown is kept as null, regular checks happen. If it's a boolean, this value is returned by the isKnown method.
1956 $title: Title object that is being checked
1957 $result: Boolean|null; whether MediaWiki currently thinks this page is known
1959 'TitleIsMovable': Called when determining if it is possible to move a page.
1960 Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
1961 $title: Title object that is being checked
1962 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
1964 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
1965 be handled by seperate handler (via ArticleViewCustom)
1966 $title: Title object that is being checked
1967 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
1969 'TitleMoveComplete': after moving an article (title)
1972 $user: user who did the move
1973 $pageid: database ID of the page that's been moved
1974 $redirid: database ID of the created redirect
1976 'TitleReadWhitelist': called at the end of read permissions checks, just before
1977 adding the default error message if nothing allows the user to read the page.
1978 If a handler wants a title to *not* be whitelisted, it should also return false.
1979 $title: Title object being checked against
1980 $user: Current user object
1981 &$whitelisted: Boolean value of whether this title is whitelisted
1983 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1984 PageArchive object has been created but before any further processing is done.
1985 &$archive: PageArchive object
1986 $title: Title object of the page that we're viewing
1988 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1989 PageArchive object has been created but before any further processing is done.
1990 &$archive: PageArchive object
1991 $title: Title object of the page that we're viewing
1993 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1994 the site is not in read-only mode, that the Title object is not null and after
1995 a PageArchive object has been constructed but before performing any further
1997 &$archive: PageArchive object
1998 $title: Title object of the page that we're about to undelete
2000 'UndeleteShowRevision': called when showing a revision in Special:Undelete
2001 $title: title object related to the revision
2002 $rev: revision (object) that will be viewed
2004 'UnknownAction': An unknown "action" has occured (useful for defining
2006 $action: action name
2007 $article: article "acted on"
2009 'UnitTestsList': Called when building a list of files with PHPUnit tests
2010 &$files: list of files
2012 'UnwatchArticle': before a watch is removed from an article
2013 $user: user watching
2014 $page: WikiPage object to be removed
2016 'UnwatchArticleComplete': after a watch is removed from an article
2017 $user: user that watched
2018 $page: WikiPage object that was watched
2020 'UploadForm:initial': before the upload form is generated
2021 $form: UploadForm object
2022 You might set the member-variables $uploadFormTextTop and
2023 $uploadFormTextAfterSummary to inject text (HTML) either before
2024 or after the editform.
2026 'UploadForm:BeforeProcessing': at the beginning of processUpload()
2027 $form: UploadForm object
2028 Lets you poke at member variables like $mUploadDescription before the
2030 Do not use this hook to break upload processing. This will return the user to
2031 a blank form with no error message; use UploadVerification and
2032 UploadVerifyFile instead
2034 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
2035 $type: (string) the requested upload type
2036 &$className: the class name of the Upload instance to be created
2038 'UploadComplete': when Upload completes an upload
2039 &$upload: an UploadBase child instance
2041 'UploadFormInitDescriptor': after the descriptor for the upload form as been
2043 $descriptor: (array) the HTMLForm descriptor
2045 'UploadFormSourceDescriptors': after the standard source inputs have been
2046 added to the descriptor
2047 $descriptor: (array) the HTMLForm descriptor
2049 'UploadVerification': additional chances to reject an uploaded file. Consider
2050 using UploadVerifyFile instead.
2051 string $saveName: destination file name
2052 string $tempName: filesystem path to the temporary file for checks
2053 string &$error: output: message key for message to show if upload canceled
2054 by returning false. May also be an array, where the first element
2055 is the message key and the remaining elements are used as parameters to
2058 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2059 in most cases over UploadVerification.
2060 object $upload: an instance of UploadBase, with all info about the upload
2061 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
2062 will typically only apply for specific mime types.
2063 object &$error: output: true if the file is valid. Otherwise, an indexed array
2064 representing the problem with the file, where the first element
2065 is the message key and the remaining elements are used as parameters to
2068 'UploadComplete': Upon completion of a file upload
2069 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2070 $uploadBase->getLocalFile().
2072 'User::mailPasswordInternal': before creation and mailing of a user's new
2074 $user: the user who sent the message out
2075 $ip: IP of the user who sent the message out
2076 $u: the account whose new password will be set
2078 'UserAddGroup': called when adding a group; return false to override
2079 stock group addition.
2080 $user: the user object that is to have a group added
2081 &$group: the group to add, can be modified
2083 'UserArrayFromResult': called when creating an UserArray object from a
2085 &$userArray: set this to an object to override the default object returned
2086 $res: database result used to create the object
2088 'userCan': To interrupt/advise the "user can do X to Y article" check.
2089 If you want to display an error message, try getUserPermissionsErrors.
2090 $title: Title object being checked against
2091 $user : Current user object
2092 $action: Action being checked
2093 $result: Pointer to result returned if hook returns false. If null is returned,
2094 userCan checks are continued by internal code.
2096 'UserCanSendEmail': To override User::canSendEmail() permission check
2097 $user: User (object) whose permission is being checked
2098 &$canSend: bool set on input, can override on output
2100 'UserClearNewTalkNotification': called when clearing the
2101 "You have new messages!" message, return false to not delete it
2102 $user: User (object) that'll clear the message
2104 'UserComparePasswords': called when checking passwords, return false to
2105 override the default password checks
2106 &$hash: String of the password hash (from the database)
2107 &$password: String of the plaintext password the user entered
2108 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2110 &$result: If the hook returns false, this Boolean value will be checked to
2111 determine if the password was valid
2113 'UserCreateForm': change to manipulate the login form
2114 $template: SimpleTemplate instance for the form
2116 'UserCryptPassword': called when hashing a password, return false to implement
2117 your own hashing method
2118 &$password: String of the plaintext password to encrypt
2119 &$salt: String of the password salt or Boolean false if no salt is provided
2120 &$wgPasswordSalt: Boolean of whether the salt is used in the default
2122 &$hash: If the hook returns false, this String will be used as the hash
2124 'UserEffectiveGroups': Called in User::getEffectiveGroups()
2125 $user: User to get groups for
2126 &$groups: Current effective groups
2128 'UserGetAllRights': after calculating a list of all available rights
2129 &$rights: Array of rights, which may be added to.
2131 'UserGetDefaultOptions': after fetching the core default, this hook is ran
2132 right before returning the options to the caller. WARNING: this hook is
2133 called for every call to User::getDefaultOptions(), which means it's
2134 potentially called dozens or hundreds of times. You may want to cache
2135 the results of non-trivial operations in your hook function for this reason.
2136 &$defaultOptions: Array of preference keys and their default values.
2138 'UserGetEmail': called when getting an user email address
2140 &$email: email, change this to override local email
2142 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
2143 email authentification
2145 &$timestamp: timestamp, change this to override local email authentification
2148 'UserGetImplicitGroups': Called in User::getImplicitGroups()
2149 &$groups: List of implicit (automatically-assigned) groups
2151 'UserGetLanguageObject': Called when getting user's interface language object
2153 &$code: Langauge code that will be used to create the object
2155 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2156 &$reservedUsernames: $wgReservedUsernames
2158 'UserGetRights': Called in User::getRights()
2159 $user: User to get rights for
2160 &$rights: Current rights
2162 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
2164 $user: User in question
2165 $title: Title of the page in question
2166 &$blocked: Out-param, whether or not the user is blocked from that page.
2167 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2168 own user talk pages.
2170 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2172 $ip: User's IP address
2173 &$blocked: Whether the user is blocked, to be modified by the hook
2175 'UserLoadAfterLoadFromSession': called to authenticate users on
2176 external/environmental means; occurs after session is loaded
2177 $user: user object being loaded
2179 'UserLoadDefaults': called when loading a default user
2183 'UserLoadFromDatabase': called when loading a user from the database
2185 &$s: database query object
2187 'UserLoadFromSession': called to authenticate users on external/environmental
2188 means; occurs before session is loaded
2189 $user: user object being loaded
2190 &$result: set this to a boolean value to abort the normal authentification
2193 'UserLoadOptions': when user options/preferences are being loaded from
2196 &$options: Options, can be modified.
2198 'UserLoginComplete': after a user has logged in
2199 $user: the user object that was created on login
2200 $inject_html: Any HTML to inject after the "logged in" message.
2202 'UserLoginForm': change to manipulate the login form
2203 $template: SimpleTemplate instance for the form
2205 'UserLogout': before a user logs out
2206 $user: the user object that is about to be logged out
2208 'UserLogoutComplete': after a user has logged out
2209 $user: the user object _after_ logout (won't have name, ID, etc.)
2210 $inject_html: Any HTML to inject after the "logged out" message.
2211 $oldName: name of the user before logout (string)
2213 'UserRemoveGroup': called when removing a group; return false to override
2214 stock group removal.
2215 $user: the user object that is to have a group removed
2216 &$group: the group to be removed, can be modified
2218 'UserRights': After a user's group memberships are changed
2219 $user : User object that was changed
2220 $add : Array of strings corresponding to groups added
2221 $remove: Array of strings corresponding to groups removed
2223 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2225 $user: user retrieving new talks messages
2226 $talks: array of new talks page(s)
2228 'UserSaveSettings': called when saving user settings
2231 'UserSaveOptions': Called just before saving user preferences/options.
2233 &$options: Options, modifiable
2235 'UserSetCookies': called when setting user cookies
2237 &$session: session array, will be added to $_SESSION
2238 &$cookies: cookies array mapping cookie name to its value
2240 'UserSetEmail': called when changing user email address
2242 &$email: new email, change this to override new email address
2244 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2245 of email authentification
2247 &$timestamp: new timestamp, change this to override local email
2248 authentification timestamp
2250 'UserToolLinksEdit': Called when generating a list of user tool links, eg "Foobar (Talk | Contribs | Block)"
2251 $userId: User id of the current user
2252 $userText: User name of the current user
2253 &$items: Array of user tool links as HTML fragments
2255 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2256 used to alter the SQL query which gets the list of wanted pages
2257 &$wantedPages: WantedPagesPage object
2258 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2260 'WatchArticle': before a watch is added to an article
2261 $user: user that will watch
2262 $page: WikiPage object to be watched
2264 'WatchArticleComplete': after a watch is added to an article
2265 $user: user that watched
2266 $page: WikiPage object watched
2268 'WatchlistEditorBuildRemoveLine': when building remove lines in
2269 Special:Watchlist/edit
2270 &$tools: array of extra links
2271 $title: Title object
2272 $redirect: whether the page is a redirect
2275 'WebRequestPathInfoRouter': While building the PathRouter to parse the REQUEST_URI.
2276 $router: The PathRouter instance
2278 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2280 One, and only one hook should set this, and return false.
2281 &$tables: Database tables to use in the SELECT query
2282 &$opts: Options to use for the query
2283 &$join: Join conditions
2285 'wfShellWikiCmd': Called when generating a shell-escaped command line
2286 string to run a MediaWiki cli script.
2287 &$script: MediaWiki cli script path
2288 &$parameters: Array of arguments and options to the script
2289 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2292 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2293 query pages to be updated with maintenance/updateSpecialPages.php
2294 $query: $wgQueryPages itself
2296 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2297 metadata to be added.
2298 $obj: The XmlDumpWriter object.
2299 &$out: The output string.
2300 $row: The database row for the page.
2301 $title: The title of the page.
2303 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2305 $obj: The XmlDumpWriter object.
2306 &$out: The text being output.
2307 $row: The database row for the revision.
2308 $text: The revision text.
2310 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2311 additional tags to extract.
2312 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2314 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2315 used to post-process the results.
2316 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2317 metadata tags returned (each tag is either a value, or an array of values).
2319 More hooks might be available but undocumented, you can execute
2320 ./maintenance/findhooks.php to find hidden one.