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 an user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
296 $EditPage: the EditPage object
298 'APIAfterExecute': after calling the execute() method of an API module.
299 Use this to extend core API modules.
300 &$module: Module object
302 'APIEditBeforeSave': before saving a page with api.php?action=edit,
303 after processing request parameters. Return false to let the request
304 fail, returning an error message or an <edit result="Failure"> tag
305 if $resultArr was filled.
306 $EditPage : the EditPage object
307 $text : the new text of the article (has yet to be saved)
308 &$resultArr : data in this array will be added to the API result
310 'APIGetAllowedParams': use this hook to modify a module's parameters.
311 &$module: Module object
312 &$params: Array of parameters
314 'APIGetParamDescription': use this hook to modify a module's parameter
316 &$module: Module object
317 &$desc: Array of parameter descriptions
319 'APIQueryAfterExecute': after calling the execute() method of an
320 action=query submodule. Use this to extend core API modules.
321 &$module: Module object
323 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
324 method of an action=query submodule. Use this to extend core API modules.
325 &$module: Module object
326 &$resultPageSet: ApiPageSet object
328 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
329 Every token has an action, which will be used in the intoken parameter
330 and in the output (actiontoken="..."), and a callback function which
331 should return the token, or false if the user isn't allowed to obtain
332 it. The prototype of the callback function is func($pageid, $title)
333 where $pageid is the page ID of the page the token is requested for
334 and $title is the associated Title object. In the hook, just add
335 your callback to the $tokenFunctions array and return true (returning
336 false makes no sense)
337 $tokenFunctions: array(action => callback)
339 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
340 Every token has an action, which will be used in the rvtoken parameter
341 and in the output (actiontoken="..."), and a callback function which
342 should return the token, or false if the user isn't allowed to obtain
343 it. The prototype of the callback function is func($pageid, $title, $rev)
344 where $pageid is the page ID of the page associated to the revision the
345 token is requested for, $title the associated Title object and $rev the
346 associated Revision object. In the hook, just add your callback to the
347 $tokenFunctions array and return true (returning false makes no sense)
348 $tokenFunctions: array(action => callback)
350 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
352 Every token has an action, which will be used in the rctoken parameter
353 and in the output (actiontoken="..."), and a callback function which
354 should return the token, or false if the user isn't allowed to obtain
355 it. The prototype of the callback function is func($pageid, $title, $rc)
356 where $pageid is the page ID of the page associated to the revision the
357 token is requested for, $title the associated Title object and $rc the
358 associated RecentChange object. In the hook, just add your callback to the
359 $tokenFunctions array and return true (returning false makes no sense)
360 $tokenFunctions: array(action => callback)
362 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
363 the sites general information.
364 $module: the current ApiQuerySiteInfo module
365 &$results: array of results, add things here
367 'APIQueryUsersTokens': use this hook to add custom token to list=users.
368 Every token has an action, which will be used in the ustoken parameter
369 and in the output (actiontoken="..."), and a callback function which
370 should return the token, or false if the user isn't allowed to obtain
371 it. The prototype of the callback function is func($user) where $user
372 is the User object. In the hook, just add your callback to the
373 $tokenFunctions array and return true (returning false makes no sense)
374 $tokenFunctions: array(action => callback)
376 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
377 Each service should have its own entry in the $apis array and have a
378 unique name, passed as key for the array that represents the service data.
379 In this data array, the key-value-pair identified by the apiLink key is
381 &$apis: array of services
383 'ArticleAfterFetchContent': after fetching content of an article from
385 $article: the article (object) being loaded from the database
386 $content: the content (string) of the article
388 'ArticleConfirmDelete': before writing the confirmation form for article
390 $article: the article (object) being deleted
391 $output: the OutputPage object ($wgOut)
392 &$reason: the reason (string) the article is being deleted
394 'ArticleContentOnDiff': before showing the article content below a diff.
395 Use this to change the content in this area or how it is loaded.
396 $diffEngine: the DifferenceEngine
397 $output: the OutputPage object ($wgOut)
399 'ArticleDelete': before an article is deleted
400 $article: the article (object) being deleted
401 $user: the user (object) deleting the article
402 $reason: the reason (string) the article is being deleted
403 $error: if the deletion was prohibited, the (raw HTML) error message to display
406 'ArticleDeleteComplete': after an article is deleted
407 $article: the article that was deleted
408 $user: the user that deleted the article
409 $reason: the reason the article was deleted
410 $id: id of the article that was deleted
412 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
414 $article: article (object) of the user talk page
416 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
417 article has been changed
418 $article: the article (object)
419 $editInfo: data holder that includes the parser output ($editInfo->output) for
420 that page after the change
421 $changed: bool for if the page was changed
423 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
424 recentchanges table, return false to not delete old entries
425 $article: article (object) being modified
427 'ArticleFromTitle': when creating an article object from a title object using
428 Wiki::articleFromTitle()
429 $title: title (object) used to create the article object
430 $article: article (object) that will be returned
432 'ArticleInsertComplete': After a new article is created
433 $article: Article created
434 $user: User creating the article
436 $summary: Edit summary/comment
437 $isMinor: Whether or not the edit was marked as minor
438 $isWatch: (No longer used)
439 $section: (No longer used)
440 $flags: Flags passed to Article::doEdit()
441 $revision: New Revision of the article
443 'ArticleMergeComplete': after merging to article using Special:Mergehistory
444 $targetTitle: target title (object)
445 $destTitle: destination title (object)
447 'ArticlePageDataAfter': after loading data of an article from the database
448 $article: article (object) whose data were loaded
449 $row: row (object) returned from the database server
451 'ArticlePageDataBefore': before loading data of an article from the database
452 $article: article (object) that data will be loaded
453 $fields: fileds (array) to load from the database
455 'ArticlePrepareTextForEdit': called when preparing text to be saved
456 $article: the article being saved
457 $popts: parser options to be used for pre-save transformation
459 'ArticleProtect': before an article is protected
460 $article: the article being protected
461 $user: the user doing the protection
462 $protect: boolean whether this is a protect or an unprotect
463 $reason: Reason for protect
464 $moveonly: boolean whether this is for move only or not
466 'ArticleProtectComplete': after an article is protected
467 $article: the article that was protected
468 $user: the user who did the protection
469 $protect: boolean whether it was a protect or an unprotect
470 $reason: Reason for protect
471 $moveonly: boolean whether it was for move only or not
473 'ArticlePurge': before executing "&action=purge"
474 $article: article (object) to purge
476 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
477 revision of an article
478 &$title: title object of the article
480 'ArticleRevisionUndeleted': after an article revision is restored
481 $title: the article title
482 $revision: the revision
483 $oldPageID: the page ID of the revision when archived (may be null)
485 'ArticleRollbackComplete': after an article rollback is completed
486 $article: the article that was edited
487 $user: the user who did the rollback
488 $revision: the revision the page was reverted back to
489 $current: the reverted revision
491 'ArticleSave': before an article is saved
492 $article: the article (object) being saved
493 $user: the user (object) saving the article
494 $text: the new article text
495 $summary: the article summary (comment)
500 'ArticleSaveComplete': After an article has been updated
501 $article: Article modified
502 $user: User performing the modification
504 $summary: Edit summary/comment
505 $isMinor: Whether or not the edit was marked as minor
506 $isWatch: (No longer used)
507 $section: (No longer used)
508 $flags: Flags passed to Article::doEdit()
509 $revision: New Revision of the article
510 $baseRevId: the rev ID (or false) this edit was based on
512 'ArticleUndelete': When one or more revisions of an article are restored
513 $title: Title corresponding to the article restored
514 $create: Whether or not the restoration caused the page to be created
515 (i.e. it didn't exist before)
516 $comment: The comment associated with the undeletion.
518 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
519 before the user is redirected back to the page
520 &$article: the article
521 &$sectionanchor: The section anchor link (e.g. "#overview" )
522 &$extraq: Extra query parameters which can be added via hooked functions
524 'ArticleViewFooter': After showing the footer section of an ordinary page view
525 $article: Article object
527 'ArticleViewHeader': Before the parser cache is about to be tried for article
529 &$article: the article
530 &$pcache: whether to try the parser cache or not
531 &$outputDone: whether the output for this page finished or not
533 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
535 $article: target article (object)
537 'AuthPluginAutoCreate': Called when creating a local account for an user logged
538 in from an external authentication method
539 $user: User object created locally
541 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
542 Gives a chance for an extension to set it programattically to a variable class.
543 &$auth: the $wgAuth object, probably a stub
545 'AutopromoteCondition': check autopromote condition for user.
546 $type: condition type
549 $result: result of checking autopromote condition
551 'BadImage': When checking against the bad image list
552 $name: Image name being checked
553 &$bad: Whether or not the image is "bad"
555 Change $bad and return false to override. If an image is "bad", it is not
556 rendered inline in wiki pages or galleries in category pages.
558 'BeforeInitialize': before anything is initialized in performRequestForTitle()
559 &$title: Title being used for request
560 &$article: The associated Article object
561 &$output: OutputPage object
563 $request: WebRequest object
564 $mediaWiki: Mediawiki object
566 'BeforePageDisplay': Prior to outputting a page
567 &$out: OutputPage object
570 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
571 $parser: Parser object
573 &$time: the image timestamp (use '0' to force a broken thumbnail)
574 &$sha1: image base 36 sha1 (used to specify the file, $nt will be ignored if this is set)
575 &$descQuery: query string to add to thumbnail URL
577 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
578 $parser: Parser object
579 $title: title of the template
580 &$skip: skip this template and link it?
581 &$id: the id of the revision being parsed
583 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
584 &$parser: Parser object
585 &$ig: ImageGallery object
587 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
588 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
589 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
591 'BitmapHandlerTransform': before a file is transformed, gives extension the
592 possibility to transform it themselves
593 $handler: BitmapHandler
595 &$scalerParams: Array with scaler parameters
596 &$mto: null, set to a MediaTransformOutput
598 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
599 $block: Block object (which is set to be autoblocking)
600 &$blockIds: Array of block IDs of the autoblock
602 'BlockIp': before an IP address or user is blocked
603 $block: the Block object about to be saved
604 $user: the user _doing_ the block (not the one being blocked)
606 'BlockIpComplete': after an IP address or user is blocked
607 $block: the Block object that was saved
608 $user: the user who did the block (not the one being blocked)
610 'BookInformation': Before information output on Special:Booksources
611 $isbn: ISBN to show information for
612 $output: OutputPage object in use
614 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
615 &$namespaces: Array of namespace numbers with corresponding canonical names
617 'CategoryPageView': before viewing a categorypage in CategoryPage::view
618 $catpage: CategoryPage instance
620 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
621 &$changesList: ChangesList instance.
622 &$articlelink: HTML of link to article (already filled-in).
623 &$s: HTML of row that is being constructed.
624 &$rc: RecentChange instance.
625 $unpatrolled: Whether or not we are showing unpatrolled changes.
626 $watched: Whether or not the change is watched by the user.
628 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
629 $collationName: Name of the collation in question
630 &$collationObject: Null. Replace with a subclass of the Collation class that implements
631 the collation given in $collationName.
633 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
634 $user: user (object) whose email is being confirmed
636 'ContribsPager::getQueryInfo': Before the contributions query is about to run
637 &$pager: Pager object for contributions
638 &queryInfo: The query for the contribs Pager
640 'ContributionsLineEnding': Called before a contributions HTML line is finished
641 $page: SpecialPage object for contributions
643 $row: the DB row for this line
645 'ContributionsToolLinks': Change tool links above Special:Contributions
647 $title: User page title
648 &$tools: Array of tool links
650 'CustomEditor': When invoking the page editor
651 $article: Article being edited
652 $user: User performing the edit
654 Return true to allow the normal editor to be used, or false
655 if implementing a custom editor, e.g. for a special namespace,
658 'DatabaseOraclePostInit': Called after initialising an Oracle database
659 &$db: the DatabaseOracle object
661 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
662 $text: plaintext string to be output
663 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
665 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
666 $title: the diff page title (nullable)
667 &$oldId: the actual old Id to use in the diff
668 &$newId: the actual new Id to use in the diff (0 means current)
669 $old: the ?old= param value from the url
670 $new: the ?new= param value from the url
672 'DiffViewHeader': called before diff display
673 $diff: DifferenceEngine object that's calling
674 $oldRev: Revision object of the "old" revision (may be null/invalid)
675 $newRev: Revision object of the "new" revision
677 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
679 $article: article (object) being viewed
680 $oldid: oldid (int) being viewed
682 'DoEditSectionLink': Override the HTML generated for section edit links
683 $skin: Skin object rendering the UI
684 $title: Title object for the title being linked to (may not be the same as
685 $wgTitle, if the section is included from a template)
686 $section: The designation of the section being pointed to, to be included in
687 the link, like "§ion=$section"
688 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
689 By default, this is wrapped in the 'editsectionhint' message.
690 &$result: The HTML to return, prefilled with the default plus whatever other
691 changes earlier hooks have made
692 $lang: The language code to use for the link in the wfMsg* functions
694 'EditFilter': Perform checks on an edit
695 $editor: Edit form (see includes/EditPage.php)
696 $text: Contents of the edit box
697 $section: Section being edited
698 &$error: Error message to return
699 $summary: Edit summary for page
701 'EditFilterMerged': Post-section-merge edit filter
702 $editor: EditPage instance (object)
703 $text: content of the edit box
704 &$error: error message to return
705 $summary: Edit summary for page
707 'EditFormPreloadText': Allows population of the edit form when creating
709 &$text: Text to preload with
710 &$title: Title object representing the page being created
712 'EditFormInitialText': Allows modifying the edit form when editing existing
714 $editPage: EditPage object
716 'EditPage::attemptSave': called before an article is
717 saved, that is before Article::doEdit() is called
718 $editpage_Obj: the current EditPage object
720 'EditPage::importFormData': allow extensions to read additional data
722 $editpage: EditPage instance
724 return value is ignored (should always return true)
726 'EditPage::showEditForm:fields': allows injection of form field into edit form
727 &$editor: the EditPage instance for reference
728 &$out: an OutputPage instance to write to
729 return value is ignored (should always return true)
731 'EditPage::showEditForm:initial': before showing the edit form
732 $editor: EditPage instance (object)
733 $formCallback: Array for callback of modifying the edit form
735 Return false to halt editing; you'll need to handle error messages, etc.
736 yourself. Alternatively, modifying $error and returning true will cause the
737 contents of $error to be echoed at the top of the edit form as wikitext.
738 Return true without altering $error to allow the edit to proceed.
740 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
741 when there's an edit conflict. Return false to halt normal diff output; in
742 this case you're responsible for computing and outputting the entire "conflict"
743 part, i.e., the "difference between revisions" and "your text" headers and
745 &$editor: EditPage instance
746 &$out: OutputPage instance
748 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
749 textarea in the edit form
750 &$editpage: The current EditPage object
751 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
752 &$tabindex: HTML tabindex of the last edit check/button
754 'EditPageBeforeEditChecks': allows modifying the edit checks below the
755 textarea in the edit form
756 &$editpage: The current EditPage object
757 &$checks: Array of edit checks like "watch this page"/"minor edit"
758 &$tabindex: HTML tabindex of the last edit check/button
760 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
761 textarea in the edit form
762 &$toolbar: The toolbar HTMl
764 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
765 $title: title of page being edited
766 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
768 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
770 $editPage: EditPage object
771 &$newtext: wikitext that will be used as "your version"
773 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
774 $editPage: EditPage object
775 &$toparse: wikitext that will be parsed
777 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
778 &$editpage: The current EditPage object
779 &$res: the HTML of the error text
781 'EditPageTosSummary': Give a chance for site and per-namespace customizations
782 of terms of service summary link that might exist separately from the copyright
784 $title: title of page being edited
785 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
787 'EditSectionLink': Do not use, use DoEditSectionLink instead.
788 $skin: Skin rendering the UI
789 $title: Title being linked to
790 $section: Section to link to
792 &$result: Result (alter this to override the generated links)
793 $lang: The language code to use for the link in the wfMsg* functions
795 'EmailConfirmed': When checking that the user's email address is "confirmed"
796 $user: User being checked
797 $confirmed: Whether or not the email address is confirmed
798 This runs before the other checks, such as anonymity and the real check; return
799 true to allow those checks to occur, and false if checking is done.
801 'EmailUser': before sending email from one user to another
802 $to: address of receiving user
803 $from: address of sending user
804 $subject: subject of the mail
805 $text: text of the mail
807 'EmailUserCC': before sending the copy of the email to the author
808 $to: address of receiving user
809 $from: address of sending user
810 $subject: subject of the mail
811 $text: text of the mail
813 'EmailUserComplete': after sending email from one user to another
814 $to: address of receiving user
815 $from: address of sending user
816 $subject: subject of the mail
817 $text: text of the mail
819 'EmailUserForm': after building the email user form object
820 $form: HTMLForm object
822 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
823 $user: The user who is trying to email another user.
824 $editToken: The user's edit token.
825 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
827 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
828 &$extTypes: associative array of extensions types
830 'FetchChangesList': When fetching the ChangesList derivative for
832 $user: User the list is being fetched for
833 &$skin: Skin object to be used with the list
834 &$list: List object (defaults to NULL, change it to an object
835 instance and return false override the list derivative used)
837 'FileDeleteComplete': When a file is deleted
838 $file: reference to the deleted file
839 $oldimage: in case of the deletion of an old image, the name of the old file
840 $article: in case all revisions of the file are deleted a reference to the
841 article associated with the file.
842 $user: user who performed the deletion
845 'FileUpload': When a file upload occurs
846 $file : Image object representing the file that was uploaded
847 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
848 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
850 'FileUndeleteComplete': When a file is undeleted
851 $title: title object to the file
852 $fileVersions: array of undeleted versions. Empty if all versions were restored
853 $user: user who performed the undeletion
856 'GetAutoPromoteGroups': When determining which autopromote groups a user
857 is entitled to be in.
858 &$user: user to promote.
859 &$promote: groups that will be added.
861 'GetBlockedStatus': after loading blocking status of an user from the database
862 $user: user (object) being checked
864 'GetCacheVaryCookies': get cookies that should vary cache options
865 $out: OutputPage object
866 &$cookies: array of cookies name, add a value to it if you want to add a cookie
867 that have to vary cache options
869 'GetDefaultSortkey': Override the default sortkey for a page.
870 $title: Title object that we need to get a sortkey for
871 &$sortkey: Sortkey to use.
873 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
874 $title: Title object of page
875 $url: string value as output (out parameter, can modify)
876 $query: query options passed to Title::getFullURL()
878 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
879 $title: Title object of page
880 $url: string value as output (out parameter, can modify)
881 $query: query options passed to Title::getInternalURL()
883 'GetIP': modify the ip of the current user (called only once)
884 &$ip: string holding the ip as determined so far
886 'GetLinkColours': modify the CSS class of an array of page links
887 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
889 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
891 'GetLocalURL': modify local URLs as output into page links
892 $title: Title object of page
893 $url: string value as output (out parameter, can modify)
894 $query: query options passed to Title::getLocalURL()
896 'GetMetadataVersion': modify the image metadata version currently in use. This is
897 used when requesting image metadata from a ForiegnApiRepo. Media handlers
898 that need to have versioned metadata should add an element to the end of
899 the version array of the form 'handler_name=version'. Most media handlers
900 won't need to do this unless they broke backwards compatibility with a
901 previous version of the media handler metadata output.
902 &$version: Array of version strings
904 'GetPreferences': modify user preferences
905 $user: User whose preferences are being modified.
906 &$preferences: Preferences description array, to be fed to an HTMLForm object
908 'getUserPermissionsErrors': Add a permissions error when permissions errors are
909 checked for. Use instead of userCan for most cases. Return false if the
910 user can't do it, and populate $result with the reason in the form of
911 array( messagename, param1, param2, ... ). For consistency, error messages
912 should be plain text with no special coloring, bolding, etc. to show that
913 they're errors; presenting them properly to the user as errors is done by
915 $title: Title object being checked against
916 $user : Current user object
917 $action: Action being checked
918 $result: User permissions error to add. If none, return true.
920 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
921 if expensive checks are enabled.
923 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
924 image insertion. You can skip the default logic entirely by returning
925 false, or just modify a few things using call-by-reference.
927 &$title: Title object of the image
928 &$file: File object, or false if it doesn't exist
929 &$frameParams: Various parameters with special meanings; see documentation in
930 includes/Linker.php for Linker::makeImageLink2
931 &$handlerParams: Various parameters with special meanings; see documentation in
932 includes/Linker.php for Linker::makeImageLink2
933 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
934 &$res: Final HTML output, used if you return false
937 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
938 the image on an image page
939 $imagePage: ImagePage object ($this)
942 'ImagePageAfterImageLinks': called after the image links section on an image
944 $imagePage: ImagePage object ($this)
945 &$html: HTML for the hook to add
947 'ImagePageFileHistoryLine': called when a file history line is contructed
949 $line: the HTML of the history line
950 $css: the line CSS class
952 'ImagePageFindFile': called when fetching the file associated with an image page
953 $page: ImagePage object
955 &$displayFile: displayed File object
957 'ImagePageShowTOC': called when the file toc on an image page is generated
958 $page: ImagePage object
959 &$toc: Array of <li> strings
961 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
963 &$title: the Title object of the file as it would appear for the upload page
964 &$path: the original file and path name when img_auth was invoked by the the web
966 &$name: the name only component of the file
967 &$result: The location to pass back results of the hook routine (only used if
969 $result[0]=The index of the header message
970 $result[1]=The index of the body text message
971 $result[2 through n]=Parameters passed to body text message. Please note the
972 header message cannot receive/use parameters.
974 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
975 $reader: XMLReader object
976 $logInfo: Array of information
977 Return false to stop further processing of the tag
979 'ImportHandlePageXMLTag': When parsing a XML tag in a page
980 $reader: XMLReader object
981 $pageInfo: Array of information
982 Return false to stop further processing of the tag
984 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
985 $reader: XMLReader object
986 $revInfo: Array of information
987 Return false to stop further processing of the tag
989 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
990 $reader: XMLReader object
991 Return false to stop further processing of the tag
993 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
994 $reader: XMLReader object
995 $revisionInfo: Array of information
996 Return false to stop further processing of the tag
998 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
999 $title: Title object ($wgTitle)
1000 $request: WebRequest
1001 $ignoreRedirect: boolean to skip redirect check
1002 $target: Title/string of redirect target
1003 $article: Article object
1005 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1006 Return true without providing an interwiki to continue interwiki search.
1007 $prefix: interwiki prefix we are looking for.
1008 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1009 iw_trans and optionally iw_api and iw_wikiid.
1011 'InternalParseBeforeLinks': during Parser's internalParse method before links
1012 but after noinclude/includeonly/onlyinclude and other processing.
1013 &$parser: Parser object
1014 &$text: string containing partially parsed text
1015 &$stripState: Parser's internal StripState object
1017 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1018 $user: user (object) whose email is being invalidated
1020 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1021 $article: article (object) being checked
1023 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1025 $result: Change this value to override the result of wfIsTrustedProxy()
1027 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1028 tance to return false if the domain name doesn't match your organization
1029 $addr: The e-mail address entered by the user
1030 &$result: Set this and return false to override the internal checks
1032 'isValidPassword': Override the result of User::isValidPassword()
1033 $password: The password entered by the user
1034 &$result: Set this and return false to override the internal checks
1035 $user: User the password is being validated for
1037 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1038 $wgExtensionMessagesFiles instead.
1039 Use this to define synonyms of magic words depending of the language
1040 $magicExtensions: associative array of magic words synonyms
1041 $lang: laguage code (string)
1043 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1044 listed in $wgExtensionMessagesFiles instead.
1045 Use to define aliases of special pages names depending of the language
1046 $specialPageAliases: associative array of magic words synonyms
1047 $lang: laguage code (string)
1049 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1050 &$names: array of language code => language name
1051 $code language of the preferred translations
1053 'LinkBegin': Used when generating internal and interwiki links in
1054 Linker::link(), before processing starts. Return false to skip default proces-
1055 sing and return $ret. See documentation for Linker::link() for details on the
1056 expected meanings of parameters.
1057 $skin: the Skin object
1058 $target: the Title that the link is pointing to
1059 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1061 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1062 tive array form, with keys and values unescaped. Should be merged with de-
1063 fault values, with a value of false meaning to suppress the attribute.
1064 &$query: the query string to add to the generated URL (the bit after the "?"),
1065 in associative array form, with keys and values unescaped.
1066 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1067 &$ret: the value to return if your hook returns false.
1069 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1070 just before the function returns a value. If you return true, an <a> element
1071 with HTML attributes $attribs and contents $html will be returned. If you re-
1072 turn false, $ret will be returned.
1073 $skin: the Skin object
1074 $target: the Title object that the link is pointing to
1075 $options: the options. Will always include either 'known' or 'broken', and may
1076 include 'noclasses'.
1077 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1078 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1080 &$ret: the value to return if your hook returns false.
1082 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1084 &$url: the image url
1085 &$alt: the image's alt text
1086 &$img: the new image HTML (if returning false)
1088 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1091 &$text: the link text
1092 &$link: the new link HTML (if returning false)
1093 &$attribs: the attributes to be applied.
1094 $linkType: The external link type
1096 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1098 &$linksUpdate: the LinksUpdate object
1100 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1102 &$linksUpdate: the LinksUpdate object
1104 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1105 &$linksUpdate: the LinksUpdate object
1107 'ListDefinedTags': When trying to find all defined tags.
1108 &$tags: The list of tags.
1110 'LoadExtensionSchemaUpdates': called during database installation and updates
1111 &updater: A DatabaseUpdater subclass
1113 'LocalFile::getHistory': called before file history query performed
1116 $fields: select fields
1118 $opts: query options
1119 $join_conds: JOIN conditions
1121 'LocalisationCacheRecache': Called when loading the localisation data into cache
1122 $cache: The LocalisationCache object
1123 $code: language code
1124 &$alldata: The localisation data from core and extensions
1126 'LoginAuthenticateAudit': a login attempt for a valid user account either
1127 succeeded or failed. No return data is accepted; this hook is for auditing only.
1128 $user: the User object being authenticated against
1129 $password: the password being submitted and found wanting
1130 $retval: a LoginForm class constant with authenticateUserData() return
1131 value (SUCCESS, WRONG_PASS, etc)
1133 'LogLine': Processes a single log entry on Special:Log
1134 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1135 logging.log_type database field.
1136 $log_action: string for the type of log action (e.g. 'delete', 'block',
1137 'create2'). Corresponds to logging.log_action database field.
1138 $title: Title object that corresponds to logging.log_namespace and
1139 logging.log_title database fields.
1140 $paramArray: Array of parameters that corresponds to logging.log_params field.
1141 Note that only $paramArray[0] appears to contain anything.
1142 &$comment: string that corresponds to logging.log_comment database field, and
1143 which is displayed in the UI.
1144 &$revert: string that is displayed in the UI, similar to $comment.
1145 $time: timestamp of the log entry (added in 1.12)
1147 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1148 $refreshLinks: RefreshLinks object
1150 'MagicWordMagicWords': When defining new magic word.
1151 DEPRECATED: use $magicWords in a file listed in
1152 $wgExtensionMessagesFiles instead.
1153 $magicWords: array of strings
1155 'MagicWordwgVariableIDs': When definig new magic words IDs.
1156 $variableIDs: array of strings
1158 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1159 is executed. Ideally, this hook should only be used to add variables that
1160 depend on the current page/request; static configuration should be added
1161 through ResourceLoaderGetConfigVars instead.
1162 &$vars: variable (or multiple variables) to be added into the output
1163 of Skin::makeVariablesScript
1165 'MarkPatrolled': before an edit is marked patrolled
1166 $rcid: ID of the revision to be marked patrolled
1167 $user: the user (object) marking the revision as patrolled
1168 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1169 needs to be a sysop in order to mark an edit patrolled
1171 'MarkPatrolledComplete': after an edit is marked patrolled
1172 $rcid: ID of the revision marked as patrolled
1173 $user: user (object) who marked the edit patrolled
1174 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1175 must be a sysop to patrol the edit
1177 'MediaWikiPerformAction': Override MediaWiki::performAction().
1178 Use this to do something completely different, after the basic
1179 globals have been set up, but before ordinary actions take place.
1181 $article: $wgArticle
1184 $request: $wgRequest
1185 $mediaWiki: The $mediawiki object
1187 'MessagesPreLoad': When loading a message from the database
1188 $title: title of the message (string)
1189 $message: value (string), change it to the message you want to define
1191 'MessageCacheReplace': When a message page is changed.
1192 Useful for updating caches.
1193 $title: name of the page changed.
1194 $text: new contents of the page.
1196 'ModifyExportQuery': Modify the query used by the exporter.
1197 $db: The database object to be queried.
1198 &$tables: Tables in the query.
1199 &$conds: Conditions in the query.
1200 &$opts: Options for the query.
1201 &$join_conds: Join conditions for the query.
1203 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1204 been rendered (useful for adding more)
1205 Note: this is only run for the Monobook skin. This hook is deprecated and
1206 may be removed in the future. To add items to the toolbox you should use
1207 the SkinTemplateToolboxEnd hook instead, which works for all
1208 "SkinTemplate"-type skins.
1209 $tools: array of tools
1211 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1212 and returning it for the skin to output. You can add items to the toolbox while
1213 still letting the skin make final decisions on skin-specific markup conventions
1215 &$sk: The BaseTemplate base skin template
1216 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1217 BaseTemplate::makeListItem for details on the format of individual
1218 items inside of this array
1220 'NewRevisionFromEditComplete': called when a revision was inserted
1222 $article: the article edited
1223 $rev: the new revision
1224 $baseID: the revision ID this was based off, if any
1225 $user: the editing user
1227 'NormalizeMessageKey': Called before the software gets the text of a message
1228 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1230 &$key: the message being looked up. Change this to something else to change
1231 what message gets displayed (string)
1232 &$useDB: whether or not to look up the message in the database (bool)
1233 &$langCode: the language code to get the message for (string) - or -
1234 whether to use the content language (true) or site language (false) (bool)
1235 &$transform: whether or not to expand variables and templates
1236 in the message (bool)
1238 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1239 &$changeslist: The OldChangesList instance.
1240 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1241 &$rc: The RecentChange object.
1243 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1244 Hooks can alter or append to the array of URLs for search & suggestion formats.
1245 &$urls: array of associative arrays with Url element attributes
1247 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1248 users and/or IP addresses too
1249 $otherBlockLink: An array with links to other block logs
1250 $ip: The requested IP address or username
1252 'OutputPageBeforeHTML': a page has been processed by the parser and
1253 the resulting HTML is about to be displayed.
1254 $parserOutput: the parserOutput (object) that corresponds to the page
1255 $text: the text that will be displayed, in HTML (string)
1257 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1258 tag to allow for extensions to add attributes to the body of the page they might
1259 need. Or to allow building extensions to add body classes that aren't of high
1260 enough demand to be included in core.
1261 $out: The OutputPage which called the hook, can be used to get the real title
1262 $sk: The Skin that called OutputPage::headElement
1263 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1265 'OutputPageCheckLastModified': when checking if the page has been modified
1266 since the last visit
1267 &$modifiedTimes: array of timestamps.
1268 The following keys are set: page, user, epoch
1270 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1271 $out: OutputPage instance (object)
1272 $parserOutput: parserOutput instance being added in $out
1274 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1275 categories. Implementations should return false if they generate the category
1276 links, so the default link generation is skipped.
1277 $out: OutputPage instance (object)
1278 $categories: associative array, keys are category names, values are category
1279 types ("normal" or "hidden")
1280 $links: array, intended to hold the result. Must be an associative array with
1281 category types as keys and arrays of HTML links as values.
1283 'PageHistoryBeforeList': When a history page list is about to be constructed.
1284 $article: the article that the history is loading for
1286 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1287 $row: the revision row for this line
1288 $s: the string representing this parsed line
1289 $classes: array containing the <li> element classes
1291 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1294 $queryInfo: the query parameters
1296 'PageRenderingHash': alter the parser cache option hash key
1297 A parser extension which depends on user options should install
1298 this hook and append its values to the key.
1299 $hash: reference to a hash key string which can be modified
1301 'ParserAfterStrip': Same as ParserBeforeStrip
1303 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1304 $parser: Parser object being used
1305 $text: text that'll be returned
1307 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1308 $parser: Parser object
1309 $text: text to parse
1310 $stripState: StripState instance being used
1312 'ParserBeforeStrip': Called at start of parsing time
1313 (no more strip, deprecated ?)
1314 $parser: parser object
1315 $text: text being parsed
1316 $stripState: stripState used (object)
1318 'ParserBeforeTidy': called before tidy and custom tags replacements
1319 $parser: Parser object being used
1322 'ParserClearState': called at the end of Parser::clearState()
1323 $parser: Parser object being cleared
1325 'ParserFirstCallInit': called when the parser initialises for the first time
1326 &$parser: Parser object being cleared
1328 'ParserGetVariableValueSwitch': called when the parser need the value of a
1330 $parser: Parser object
1331 $varCache: array to store the value in case of multiples calls of the
1333 $index: index (string) of the magic
1334 $ret: value of the magic word (the hook should set it)
1335 $frame: PPFrame object to use for expanding any template variables
1337 'ParserGetVariableValueTs': use this to change the value of the time for the
1338 {{LOCAL...}} magic word
1339 $parser: Parser object
1340 $time: actual time (timestamp)
1342 'ParserGetVariableValueVarCache': use this to change the value of the
1343 variable cache or return false to not use it
1344 $parser: Parser object
1345 $varCache: varaiable cache (array)
1347 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1348 include comments about size of the text parsed
1349 $parser: Parser object
1350 $limitReport: text that will be included (without comment tags)
1352 'ParserMakeImageParams': Called before the parser make an image link, use this
1353 to modify the parameters of the image.
1354 $title: title object representing the file
1355 $file: file object that will be used to create the image
1356 &$params: 2-D array of parameters
1358 'ParserTestParser': called when creating a new instance of Parser in
1359 maintenance/parserTests.inc
1360 $parser: Parser object created
1362 'ParserTestTables': alter the list of tables to duplicate when parser tests
1363 are run. Use when page save hooks require the presence of custom tables
1364 to ensure that tests continue to run properly.
1365 &$tables: array of table names
1367 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1368 my talk page, my contributions" etc).
1370 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1371 &$title: Title object representing the current page
1373 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1374 &$user : User performing the action
1375 $action : Action being performed
1376 &$result : Whether or not the action should be prevented
1377 Change $result and return false to give a definitive answer, otherwise
1378 the built-in rate limiting checks are used, if enabled.
1380 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1381 AJAX search suggestions. Put results into &$results outparam and return false.
1382 $ns : array of int namespace keys to search in
1383 $search : search term (not guaranteed to be conveniently normalized)
1384 $limit : maximum number of results to return
1385 &$results : out param: array of page names (strings)
1387 'PrefsEmailAudit': called when user changes his email address
1388 $user: User (object) changing his email address
1389 $oldaddr: old email address (string)
1390 $newaddr: new email address (string)
1392 'PrefsPasswordAudit': called when user changes his password
1393 $user: User (object) changing his passoword
1394 $newPass: new password
1395 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1397 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1398 $article: the title being (un)protected
1399 $output: a string of the form HTML so far
1401 'ProtectionForm::save': called when a protection form is submitted
1402 $article: the title being (un)protected
1403 $errorMsg: an html message string of an error
1405 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1406 $article: the page the form is shown for
1407 $out: OutputPage object
1409 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1410 loader request or generating HTML output.
1411 &$resourceLoader: ResourceLoader object
1413 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1414 to add modules to the startup module. This hook should be used sparingly since any module added here
1415 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1418 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1419 &$obj: RawPage object
1420 &$text: The text that's going to be the output
1422 'RecentChange_save': called at the end of RecentChange::save()
1423 $recentChange: RecentChange object
1425 'ResourceLoaderGetConfigVars': called at the end of
1426 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1427 configuration variables to JavaScript. Things that depend on the current
1428 page/request state must be added through MakeGlobalVariablesScript instead.
1429 &$vars: array( variable name => value )
1431 'RevisionInsertComplete': called after a revision is inserted into the DB
1432 &$revision: the Revision
1433 $data: the data stored in old_text. The meaning depends on $flags: if external
1434 is set, it's the URL of the revision text in external storage; otherwise,
1435 it's the revision text itself. In either case, if gzip is set, the revision
1437 $flags: a comma-delimited list of strings representing the options used. May
1438 include: utf8 (this will always be set for new revisions); gzip; external.
1440 'SearchUpdate': Prior to search update completion
1442 $namespace : Page namespace
1444 $text : Current text being indexed
1446 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1447 $allSearchTerms : Array of the search terms in all content languages
1448 &$titleResult : Outparam; the value to return. A Title object or null.
1450 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1451 $term : Search term string
1452 &$title : Outparam; set to $title object and return false for a match
1454 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1455 $term : Search term string
1456 &$title : Current Title object that is being returned (null if none found).
1458 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1459 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1460 in the $searchEngine->namespaces array.
1461 $query : Original query.
1462 &$parsed : Resultant query with the prefixes stripped.
1464 'SearchableNamespaces': An option to modify which namespaces are searchable.
1465 &$arr : Array of namespaces ($nsId => $name) which will be used.
1467 'SetupAfterCache': Called in Setup.php, after cache objects are set
1469 'ShowMissingArticle': Called when generating the output for a non-existent page
1470 $article: The article object corresponding to the page
1472 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1473 $text: Text being shown
1474 $title: Title of the custom script/stylesheet page
1475 $output: Current OutputPage object
1477 'ShowSearchHitTitle': Customise display of search hit title/link.
1478 &$title: Title to link to
1479 &$text: Text to use for the link
1480 $result: The search result
1481 $terms: The search terms entered
1482 $page: The SpecialSearch object.
1484 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1485 &$siteNotice: HTML returned as the sitenotice
1487 Return true to allow the normal method of notice selection/rendering to work,
1488 or change the value of $siteNotice and return false to alter it.
1490 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1491 &$siteNotice: HTML sitenotice
1493 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1495 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1497 &$text: bottomScripts Text
1498 Append to $text to add additional text/scripts after the stock bottom scripts.
1500 'SkinAfterContent': Allows extensions to add text after the page content and
1502 &$data: (string) Text to be printed out directly (without parsing)
1504 This hook should work in all skins. Just set the &$data variable to the text
1505 you're going to add.
1507 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1509 &$bar: Sidebar contents
1510 Modify $bar to add or modify sidebar portlets.
1512 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1513 $title: displayed page title
1514 $type: 'normal' or 'history' for old/diff views
1515 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1516 &$link: overridable HTML link to be passed into the message as $1
1517 &$forContent: overridable flag if copyright footer is shown in content language.
1520 &$text: additional 'powered by' icons in HTML.
1521 Note: Modern skin does not use the MediaWiki icon but plain text instead
1524 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1525 &$subpages: Subpage links HTML
1527 $out: OutputPage object
1528 If false is returned $subpages will be used instead of the HTML
1529 subPageSubtitle() generates.
1530 If true is returned, $subpages will be ignored and the rest of
1531 subPageSubtitle() will run.
1533 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1534 "permanent link" tab
1535 $sktemplate: SkinTemplate object
1536 $nav_urls: array of tabs
1538 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1539 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1540 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1541 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1542 &$sktemplate: SkinTemplate object
1543 &$links: Structured navigation links
1544 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1546 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1548 &$sktemplate: SkinTemplate object
1549 &$tpl: Template engine object
1551 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1552 $sktemplate: SkinTemplate object
1553 $res: set to true to prevent active tabs
1555 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1558 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1559 You can either create your own array, or alter the parameters for
1561 &$sktemplate: The SkinTemplate instance.
1562 $title: Title instance for the page.
1563 $message: Visible label of tab.
1564 $selected: Whether this is a selected tab.
1565 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1566 &$classes: Array of CSS classes to apply.
1567 &$query: Query string to add to link.
1569 &$result: Complete assoc. array if you want to return true.
1571 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1572 been rendered (useful for adding more)
1573 $sk: The QuickTemplate based skin template running the hook.
1575 'SoftwareInfo': Called by Special:Version for returning information about
1577 $software: The array of software in format 'name' => 'version'.
1578 See SpecialVersion::softwareInformation()
1580 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1581 $id: User identifier
1583 'SpecialListusersDefaultQuery': called right before the end of
1584 UsersPager::getDefaultQuery()
1585 $pager: The UsersPager instance
1586 $query: The query array to be returned
1588 'SpecialListusersFormatRow': called right before the end of
1589 UsersPager::formatRow()
1590 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1591 $row: Database row object
1593 'SpecialListusersHeader': called before closing the <fieldset> in
1594 UsersPager::getPageHeader()
1595 $pager: The UsersPager instance
1596 $out: The header HTML
1598 'SpecialListusersHeaderForm': called before adding the submit button in
1599 UsersPager::getPageHeader()
1600 $pager: The UsersPager instance
1601 $out: The header HTML
1603 'SpecialListusersQueryInfo': called right before the end of
1604 UsersPager::getQueryInfo()
1605 $pager: The UsersPager instance
1606 $query: The query array to be returned
1608 'SpecialMovepageAfterMove': called after moving a page
1609 $movePage: MovePageForm object
1610 $oldTitle: old title (object)
1611 $newTitle: new title (object)
1613 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1614 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1615 $opts: FormOptions object containing special page options
1616 &$conds: array of WHERE conditionals for query
1617 &tables: array of tables to be queried
1618 &$fields: array of columns to select
1619 &$join_conds: join conditions for the tables
1621 'SpecialNewPagesFilters': called after building form options at NewPages
1622 $special: the special page object
1623 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1624 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1626 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1627 hook to remove a core special page
1628 $list: list (array) of core special pages
1630 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1631 $users: array of User objects
1632 $data: array of data submitted by the user
1633 &$error: string, error code (message name) used to describe to error (out paramater).
1634 The hook needs to return false when setting this, otherwise it will have no effect.
1636 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1637 use this to change some selection criteria or substitute a different title
1638 &$randstr: The random number from wfRandom()
1639 &$isRedir: Boolean, whether to select a redirect or non-redirect
1640 &$namespaces: An array of namespace indexes to get the title from
1641 &$extra: An array of extra SQL statements
1642 &$title: If the hook returns false, a Title object to use instead of the
1643 result from the normal query
1645 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1646 $special: the special page object
1647 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1648 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1650 'SpecialRecentChangesPanel': called when building form options in
1651 SpecialRecentChanges
1652 &$extraOpts: array of added items, to which can be added
1653 $opts: FormOptions for this request
1655 'SpecialRecentChangesQuery': called when building sql query for
1656 SpecialRecentChanges and SpecialRecentChangesLinked
1657 &$conds: array of WHERE conditionals for query
1658 &$tables: array of tables to be queried
1659 &$join_conds: join conditions for the tables
1660 $opts: FormOptions for this request
1661 &$query_options: array of options for the database request
1662 &$select: Array of columns to select
1664 'SpecialSearchGo': called when user clicked the "Go"
1665 &$title: title object generated from the text entered by the user
1666 &$term: the search term entered by the user
1668 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1669 target doesn't exist
1670 &$title: title object generated from the text entered by the user
1672 'SpecialSearchProfiles': allows modification of search profiles
1673 &$profiles: profiles, which can be modified.
1675 'SpecialSearchProfileForm': allows modification of search profile forms
1676 $search: special page object
1677 &$form: String: form html
1678 $profile: String: current search profile
1679 $term: String: search term
1680 $opts: Array: key => value of hidden options for inclusion in custom forms
1682 'SpecialSearchSetupEngine': allows passing custom data to search engine
1683 $search: special page object
1684 $profile: String: current search profile
1685 $engine: the search engine
1687 'SpecialSearchResults': called before search result display when there
1689 $term: string of search term
1690 &$titleMatches: empty or SearchResultSet object
1691 &$textMatches: empty or SearchResultSet object
1693 'SpecialSearchNoResults': called before search result display when there are
1695 $term: string of search term
1697 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1698 &$extraStats: Array to save the new stats
1699 ( $extraStats['<name of statistic>'] => <value>; )
1701 'SpecialUploadComplete': Called after successfully uploading a file from
1703 $form: The SpecialUpload object
1705 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1706 use this to change the tables headers
1707 $extTypes: associative array of extensions types
1709 'SpecialWatchlistFilters': called after building form options at Watchlist
1710 $special: the special page object
1711 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1712 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1714 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1715 &$conds: array of WHERE conditionals for query
1716 &$tables: array of tables to be queried
1717 &$join_conds: join conditions for the tables
1718 &$fields: array of query fields
1720 'TitleArrayFromResult': called when creating an TitleArray object from a
1722 &$titleArray: set this to an object to override the default object returned
1723 $res: database result used to create the object
1725 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1726 that can be applied.
1727 $title: The title in question.
1728 &$types: The types of protection available.
1730 'TitleMoveComplete': after moving an article (title)
1733 $user: user who did the move
1734 $pageid: database ID of the page that's been moved
1735 $redirid: database ID of the created redirect
1737 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1738 PageArchive object has been created but before any further processing is done.
1739 &$archive: PageArchive object
1740 $title: Title object of the page that we're viewing
1742 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1743 PageArchive object has been created but before any further processing is done.
1744 &$archive: PageArchive object
1745 $title: Title object of the page that we're viewing
1747 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1748 the site is not in read-only mode, that the Title object is not null and after
1749 a PageArchive object has been constructed but before performing any further
1751 &$archive: PageArchive object
1752 $title: Title object of the page that we're about to undelete
1754 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1755 $title: title object related to the revision
1756 $rev: revision (object) that will be viewed
1758 'UnknownAction': An unknown "action" has occured (useful for defining
1760 $action: action name
1761 $article: article "acted on"
1763 'UnitTestsList': Called when building a list of files with PHPUnit tests
1764 &$files: list of files
1766 'UnwatchArticle': before a watch is removed from an article
1767 $user: user watching
1768 $article: article object to be removed
1770 'UnwatchArticle': after a watch is removed from an article
1771 $user: user that was watching
1772 $article: article object removed
1774 'UnwatchArticleComplete': after a watch is removed from an article
1775 $user: user that watched
1776 $article: article object that was watched
1778 'UploadForm:initial': before the upload form is generated
1779 $form: UploadForm object
1780 You might set the member-variables $uploadFormTextTop and
1781 $uploadFormTextAfterSummary to inject text (HTML) either before
1782 or after the editform.
1784 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1785 $form: UploadForm object
1786 Lets you poke at member variables like $mUploadDescription before the
1788 Do not use this hook to break upload processing. This will return the user to
1789 a blank form with no error message; use UploadVerification and
1790 UploadVerifyFile instead
1792 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1793 $type: (string) the requested upload type
1794 &$className: the class name of the Upload instance to be created
1796 'UploadComplete': when Upload completes an upload
1797 &$upload: an UploadBase child instance
1799 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1801 $descriptor: (array) the HTMLForm descriptor
1803 'UploadFormSourceDescriptors': after the standard source inputs have been
1804 added to the descriptor
1805 $descriptor: (array) the HTMLForm descriptor
1807 'UploadVerification': additional chances to reject an uploaded file. Consider
1808 using UploadVerifyFile instead.
1809 string $saveName: destination file name
1810 string $tempName: filesystem path to the temporary file for checks
1811 string &$error: output: message key for message to show if upload canceled
1812 by returning false. May also be an array, where the first element
1813 is the message key and the remaining elements are used as parameters to
1816 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1817 in most cases over UploadVerification.
1818 object $upload: an instance of UploadBase, with all info about the upload
1819 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1820 will typically only apply for specific mime types.
1821 object &$error: output: true if the file is valid. Otherwise, an indexed array
1822 representing the problem with the file, where the first element
1823 is the message key and the remaining elements are used as parameters to
1826 'UploadComplete': Upon completion of a file upload
1827 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1828 $uploadBase->getLocalFile().
1830 'User::mailPasswordInternal': before creation and mailing of a user's new
1832 $user: the user who sent the message out
1833 $ip: IP of the user who sent the message out
1834 $u: the account whose new password will be set
1836 'UserAddGroup': called when adding a group; return false to override
1837 stock group addition.
1838 $user: the user object that is to have a group added
1839 &$group: the group to add, can be modified
1841 'UserArrayFromResult': called when creating an UserArray object from a
1843 &$userArray: set this to an object to override the default object returned
1844 $res: database result used to create the object
1846 'userCan': To interrupt/advise the "user can do X to Y article" check.
1847 If you want to display an error message, try getUserPermissionsErrors.
1848 $title: Title object being checked against
1849 $user : Current user object
1850 $action: Action being checked
1851 $result: Pointer to result returned if hook returns false. If null is returned,
1852 userCan checks are continued by internal code.
1854 'UserCanSendEmail': To override User::canSendEmail() permission check
1855 $user: User (object) whose permission is being checked
1856 &$canSend: bool set on input, can override on output
1858 'UserClearNewTalkNotification': called when clearing the
1859 "You have new messages!" message, return false to not delete it
1860 $user: User (object) that'll clear the message
1862 'UserComparePasswords': called when checking passwords, return false to
1863 override the default password checks
1864 &$hash: String of the password hash (from the database)
1865 &$password: String of the plaintext password the user entered
1866 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1868 &$result: If the hook returns false, this Boolean value will be checked to
1869 determine if the password was valid
1871 'UserCreateForm': change to manipulate the login form
1872 $template: SimpleTemplate instance for the form
1874 'UserCryptPassword': called when hashing a password, return false to implement
1875 your own hashing method
1876 &$password: String of the plaintext password to encrypt
1877 &$salt: String of the password salt or Boolean false if no salt is provided
1878 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1880 &$hash: If the hook returns false, this String will be used as the hash
1882 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1883 $user: User to get groups for
1884 &$groups: Current effective groups
1886 'UserGetAllRights': after calculating a list of all available rights
1887 &$rights: Array of rights, which may be added to.
1889 'UserGetEmail': called when getting an user email address
1891 &$email: email, change this to override local email
1893 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1894 email authentification
1896 &$timestamp: timestamp, change this to override local email authentification
1899 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1900 &$groups: List of implicit (automatically-assigned) groups
1902 'UserGetLanguageObject': Called when getting user's interface language object
1904 &$code: Langauge code that will be used to create the object
1906 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1907 &$reservedUsernames: $wgReservedUsernames
1909 'UserGetRights': Called in User::getRights()
1910 $user: User to get rights for
1911 &$rights: Current rights
1913 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1915 $user: User in question
1916 $title: Title of the page in question
1917 &$blocked: Out-param, whether or not the user is blocked from that page.
1918 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1919 own user talk pages.
1921 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1923 $ip: User's IP address
1924 &$blocked: Whether the user is blocked, to be modified by the hook
1926 'UserLoadAfterLoadFromSession': called to authenticate users on
1927 external/environmental means; occurs after session is loaded
1928 $user: user object being loaded
1930 'UserLoadDefaults': called when loading a default user
1934 'UserLoadFromDatabase': called when loading a user from the database
1936 &$s: database query object
1938 'UserLoadFromSession': called to authenticate users on external/environmental
1939 means; occurs before session is loaded
1940 $user: user object being loaded
1941 &$result: set this to a boolean value to abort the normal authentification
1944 'UserLoadOptions': when user options/preferences are being loaded from
1947 &$options: Options, can be modified.
1949 'UserLoginComplete': after a user has logged in
1950 $user: the user object that was created on login
1951 $inject_html: Any HTML to inject after the "logged in" message.
1953 'UserLoginForm': change to manipulate the login form
1954 $template: SimpleTemplate instance for the form
1956 'UserLogout': before a user logs out
1957 $user: the user object that is about to be logged out
1959 'UserLogoutComplete': after a user has logged out
1960 $user: the user object _after_ logout (won't have name, ID, etc.)
1961 $inject_html: Any HTML to inject after the "logged out" message.
1962 $oldName: name of the user before logout (string)
1964 'UserRemoveGroup': called when removing a group; return false to override
1965 stock group removal.
1966 $user: the user object that is to have a group removed
1967 &$group: the group to be removed, can be modified
1969 'UserRights': After a user's group memberships are changed
1970 $user : User object that was changed
1971 $add : Array of strings corresponding to groups added
1972 $remove: Array of strings corresponding to groups removed
1974 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1976 $user: user retrieving new talks messages
1977 $talks: array of new talks page(s)
1979 'UserSaveSettings': called when saving user settings
1982 'UserSaveOptions': Called just before saving user preferences/options.
1984 &$options: Options, modifiable
1986 'UserSetCookies': called when setting user cookies
1988 &$session: session array, will be added to $_SESSION
1989 &$cookies: cookies array mapping cookie name to its value
1991 'UserSetEmail': called when changing user email address
1993 &$email: new email, change this to override new email address
1995 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1996 of email authentification
1998 &$timestamp: new timestamp, change this to override local email
1999 authentification timestamp
2001 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2002 used to alter the SQL query which gets the list of wanted pages
2003 &$wantedPages: WantedPagesPage object
2004 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2006 'WatchArticle': before a watch is added to an article
2007 $user: user that will watch
2008 $article: article object to be watched
2010 'WatchArticleComplete': after a watch is added to an article
2011 $user: user that watched
2012 $article: article object watched
2014 'WatchlistEditorBuildRemoveLine': when building remove lines in
2015 Special:Watchlist/edit
2016 &$tools: array of extra links
2017 $title: Title object
2018 $redirect: whether the page is a redirect
2021 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2023 One, and only one hook should set this, and return false.
2024 &$tables: Database tables to use in the SELECT query
2025 &$opts: Options to use for the query
2026 &$join: Join conditions
2028 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2029 query pages to be updated with maintenance/updateSpecialPages.php
2030 $query: $wgQueryPages itself
2032 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2033 metadata to be added.
2034 $obj: The XmlDumpWriter object.
2035 &$out: The output string.
2036 $row: The database row for the page.
2037 $title: The title of the page.
2039 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2041 $obj: The XmlDumpWriter object.
2042 &$out: The text being output.
2043 $row: The database row for the revision.
2044 $text: The revision text.
2046 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2047 additional tags to extract.
2048 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2050 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2051 used to post-process the results.
2052 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2053 metadata tags returned (each tag is either a value, or an array of values).
2055 More hooks might be available but undocumented, you can execute
2056 ./maintenance/findhooks.php to find hidden one.