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 'BlockIp': before an IP address or user is blocked
599 $block: the Block object about to be saved
600 $user: the user _doing_ the block (not the one being blocked)
602 'BlockIpComplete': after an IP address or user is blocked
603 $block: the Block object that was saved
604 $user: the user who did the block (not the one being blocked)
606 'BookInformation': Before information output on Special:Booksources
607 $isbn: ISBN to show information for
608 $output: OutputPage object in use
610 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
611 &$namespaces: Array of namespace numbers with corresponding canonical names
613 'CategoryPageView': before viewing a categorypage in CategoryPage::view
614 $catpage: CategoryPage instance
616 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
617 &$changesList: ChangesList instance.
618 &$articlelink: HTML of link to article (already filled-in).
619 &$s: HTML of row that is being constructed.
620 &$rc: RecentChange instance.
621 $unpatrolled: Whether or not we are showing unpatrolled changes.
622 $watched: Whether or not the change is watched by the user.
624 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
625 $collationName: Name of the collation in question
626 &$collationObject: Null. Replace with a subclass of the Collation class that implements
627 the collation given in $collationName.
629 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
630 $user: user (object) whose email is being confirmed
632 'ContribsPager::getQueryInfo': Before the contributions query is about to run
633 &$pager: Pager object for contributions
634 &queryInfo: The query for the contribs Pager
636 'ContributionsLineEnding': Called before a contributions HTML line is finished
637 $page: SpecialPage object for contributions
639 $row: the DB row for this line
641 'ContributionsToolLinks': Change tool links above Special:Contributions
643 $title: User page title
644 &$tools: Array of tool links
646 'CustomEditor': When invoking the page editor
647 $article: Article being edited
648 $user: User performing the edit
650 Return true to allow the normal editor to be used, or false
651 if implementing a custom editor, e.g. for a special namespace,
654 'DatabaseOraclePostInit': Called after initialising an Oracle database
655 &$db: the DatabaseOracle object
657 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
658 $text: plaintext string to be output
659 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
661 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
662 $title: the diff page title (nullable)
663 &$oldId: the actual old Id to use in the diff
664 &$newId: the actual new Id to use in the diff (0 means current)
665 $old: the ?old= param value from the url
666 $new: the ?new= param value from the url
668 'DiffViewHeader': called before diff display
669 $diff: DifferenceEngine object that's calling
670 $oldRev: Revision object of the "old" revision (may be null/invalid)
671 $newRev: Revision object of the "new" revision
673 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
675 $article: article (object) being viewed
676 $oldid: oldid (int) being viewed
678 'DoEditSectionLink': Override the HTML generated for section edit links
679 $skin: Skin object rendering the UI
680 $title: Title object for the title being linked to (may not be the same as
681 $wgTitle, if the section is included from a template)
682 $section: The designation of the section being pointed to, to be included in
683 the link, like "§ion=$section"
684 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
685 By default, this is wrapped in the 'editsectionhint' message.
686 &$result: The HTML to return, prefilled with the default plus whatever other
687 changes earlier hooks have made
688 $lang: The language code to use for the link in the wfMsg* functions
690 'EditFilter': Perform checks on an edit
691 $editor: Edit form (see includes/EditPage.php)
692 $text: Contents of the edit box
693 $section: Section being edited
694 &$error: Error message to return
695 $summary: Edit summary for page
697 'EditFilterMerged': Post-section-merge edit filter
698 $editor: EditPage instance (object)
699 $text: content of the edit box
700 &$error: error message to return
701 $summary: Edit summary for page
703 'EditFormPreloadText': Allows population of the edit form when creating
705 &$text: Text to preload with
706 &$title: Title object representing the page being created
708 'EditFormInitialText': Allows modifying the edit form when editing existing
710 $editPage: EditPage object
712 'EditPage::attemptSave': called before an article is
713 saved, that is before Article::doEdit() is called
714 $editpage_Obj: the current EditPage object
716 'EditPage::importFormData': allow extensions to read additional data
718 $editpage: EditPage instance
720 return value is ignored (should always return true)
722 'EditPage::showEditForm:fields': allows injection of form field into edit form
723 &$editor: the EditPage instance for reference
724 &$out: an OutputPage instance to write to
725 return value is ignored (should always return true)
727 'EditPage::showEditForm:initial': before showing the edit form
728 $editor: EditPage instance (object)
729 $formCallback: Array for callback of modifying the edit form
731 Return false to halt editing; you'll need to handle error messages, etc.
732 yourself. Alternatively, modifying $error and returning true will cause the
733 contents of $error to be echoed at the top of the edit form as wikitext.
734 Return true without altering $error to allow the edit to proceed.
736 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
737 when there's an edit conflict. Return false to halt normal diff output; in
738 this case you're responsible for computing and outputting the entire "conflict"
739 part, i.e., the "difference between revisions" and "your text" headers and
741 &$editor: EditPage instance
742 &$out: OutputPage instance
744 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
745 textarea in the edit form
746 &$editpage: The current EditPage object
747 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
748 &$tabindex: HTML tabindex of the last edit check/button
750 'EditPageBeforeEditChecks': allows modifying the edit checks below the
751 textarea in the edit form
752 &$editpage: The current EditPage object
753 &$checks: Array of edit checks like "watch this page"/"minor edit"
754 &$tabindex: HTML tabindex of the last edit check/button
756 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
757 textarea in the edit form
758 &$toolbar: The toolbar HTMl
760 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
761 $title: title of page being edited
762 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
764 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
766 $editPage: EditPage object
767 &$newtext: wikitext that will be used as "your version"
769 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
770 $editPage: EditPage object
771 &$toparse: wikitext that will be parsed
773 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
774 &$editpage: The current EditPage object
775 &$res: the HTML of the error text
777 'EditPageTosSummary': Give a chance for site and per-namespace customizations
778 of terms of service summary link that might exist separately from the copyright
780 $title: title of page being edited
781 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
783 'EditSectionLink': Do not use, use DoEditSectionLink instead.
784 $skin: Skin rendering the UI
785 $title: Title being linked to
786 $section: Section to link to
788 &$result: Result (alter this to override the generated links)
789 $lang: The language code to use for the link in the wfMsg* functions
791 'EmailConfirmed': When checking that the user's email address is "confirmed"
792 $user: User being checked
793 $confirmed: Whether or not the email address is confirmed
794 This runs before the other checks, such as anonymity and the real check; return
795 true to allow those checks to occur, and false if checking is done.
797 'EmailUser': before sending email from one user to another
798 $to: address of receiving user
799 $from: address of sending user
800 $subject: subject of the mail
801 $text: text of the mail
803 'EmailUserCC': before sending the copy of the email to the author
804 $to: address of receiving user
805 $from: address of sending user
806 $subject: subject of the mail
807 $text: text of the mail
809 'EmailUserComplete': after sending email from one user to another
810 $to: address of receiving user
811 $from: address of sending user
812 $subject: subject of the mail
813 $text: text of the mail
815 'EmailUserForm': after building the email user form object
816 $form: HTMLForm object
818 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
819 $user: The user who is trying to email another user.
820 $editToken: The user's edit token.
821 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
823 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
824 &$extTypes: associative array of extensions types
826 'FetchChangesList': When fetching the ChangesList derivative for
828 $user: User the list is being fetched for
829 &$skin: Skin object to be used with the list
830 &$list: List object (defaults to NULL, change it to an object
831 instance and return false override the list derivative used)
833 'FileDeleteComplete': When a file is deleted
834 $file: reference to the deleted file
835 $oldimage: in case of the deletion of an old image, the name of the old file
836 $article: in case all revisions of the file are deleted a reference to the
837 article associated with the file.
838 $user: user who performed the deletion
841 'FileUpload': When a file upload occurs
842 $file : Image object representing the file that was uploaded
843 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
844 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
846 'FileUndeleteComplete': When a file is undeleted
847 $title: title object to the file
848 $fileVersions: array of undeleted versions. Empty if all versions were restored
849 $user: user who performed the undeletion
852 'GetAutoPromoteGroups': When determining which autopromote groups a user
853 is entitled to be in.
854 &$user: user to promote.
855 &$promote: groups that will be added.
857 'GetBlockedStatus': after loading blocking status of an user from the database
858 $user: user (object) being checked
860 'GetCacheVaryCookies': get cookies that should vary cache options
861 $out: OutputPage object
862 &$cookies: array of cookies name, add a value to it if you want to add a cookie
863 that have to vary cache options
865 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
866 $title: Title object of page
867 $url: string value as output (out parameter, can modify)
868 $query: query options passed to Title::getFullURL()
870 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
871 $title: Title object of page
872 $url: string value as output (out parameter, can modify)
873 $query: query options passed to Title::getInternalURL()
875 'GetIP': modify the ip of the current user (called only once)
876 &$ip: string holding the ip as determined so far
878 'GetLinkColours': modify the CSS class of an array of page links
879 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
881 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
883 'GetLocalURL': modify local URLs as output into page links
884 $title: Title object of page
885 $url: string value as output (out parameter, can modify)
886 $query: query options passed to Title::getLocalURL()
888 'GetMetadataVersion': modify the image metadata version currently in use. This is
889 used when requesting image metadata from a ForiegnApiRepo. Media handlers
890 that need to have versioned metadata should add an element to the end of
891 the version array of the form 'handler_name=version'. Most media handlers
892 won't need to do this unless they broke backwards compatibility with a
893 previous version of the media handler metadata output.
894 &$version: Array of version strings
896 'GetPreferences': modify user preferences
897 $user: User whose preferences are being modified.
898 &$preferences: Preferences description array, to be fed to an HTMLForm object
900 'getUserPermissionsErrors': Add a permissions error when permissions errors are
901 checked for. Use instead of userCan for most cases. Return false if the
902 user can't do it, and populate $result with the reason in the form of
903 array( messagename, param1, param2, ... ). For consistency, error messages
904 should be plain text with no special coloring, bolding, etc. to show that
905 they're errors; presenting them properly to the user as errors is done by
907 $title: Title object being checked against
908 $user : Current user object
909 $action: Action being checked
910 $result: User permissions error to add. If none, return true.
912 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
913 if expensive checks are enabled.
915 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
916 image insertion. You can skip the default logic entirely by returning
917 false, or just modify a few things using call-by-reference.
919 &$title: Title object of the image
920 &$file: File object, or false if it doesn't exist
921 &$frameParams: Various parameters with special meanings; see documentation in
922 includes/Linker.php for Linker::makeImageLink2
923 &$handlerParams: Various parameters with special meanings; see documentation in
924 includes/Linker.php for Linker::makeImageLink2
925 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
926 &$res: Final HTML output, used if you return false
929 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
930 the image on an image page
931 $imagePage: ImagePage object ($this)
934 'ImagePageAfterImageLinks': called after the image links section on an image
936 $imagePage: ImagePage object ($this)
937 &$html: HTML for the hook to add
939 'ImagePageFileHistoryLine': called when a file history line is contructed
941 $line: the HTML of the history line
942 $css: the line CSS class
944 'ImagePageFindFile': called when fetching the file associated with an image page
945 $page: ImagePage object
947 &$displayFile: displayed File object
949 'ImagePageShowTOC': called when the file toc on an image page is generated
950 $page: ImagePage object
951 &$toc: Array of <li> strings
953 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
955 &$title: the Title object of the file as it would appear for the upload page
956 &$path: the original file and path name when img_auth was invoked by the the web
958 &$name: the name only component of the file
959 &$result: The location to pass back results of the hook routine (only used if
961 $result[0]=The index of the header message
962 $result[1]=The index of the body text message
963 $result[2 through n]=Parameters passed to body text message. Please note the
964 header message cannot receive/use parameters.
966 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
967 $reader: XMLReader object
968 $logInfo: Array of information
969 Return false to stop further processing of the tag
971 'ImportHandlePageXMLTag': When parsing a XML tag in a page
972 $reader: XMLReader object
973 $pageInfo: Array of information
974 Return false to stop further processing of the tag
976 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
977 $reader: XMLReader object
978 $revInfo: Array of information
979 Return false to stop further processing of the tag
981 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
982 $reader: XMLReader object
983 Return false to stop further processing of the tag
985 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
986 $reader: XMLReader object
987 $revisionInfo: Array of information
988 Return false to stop further processing of the tag
990 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
991 $title: Title object ($wgTitle)
993 $ignoreRedirect: boolean to skip redirect check
994 $target: Title/string of redirect target
995 $article: Article object
997 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
998 Return true without providing an interwiki to continue interwiki search.
999 $prefix: interwiki prefix we are looking for.
1000 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1001 iw_trans and optionally iw_api and iw_wikiid.
1003 'InternalParseBeforeLinks': during Parser's internalParse method before links
1004 but after noinclude/includeonly/onlyinclude and other processing.
1005 &$parser: Parser object
1006 &$text: string containing partially parsed text
1007 &$stripState: Parser's internal StripState object
1009 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1010 $user: user (object) whose email is being invalidated
1012 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1013 $article: article (object) being checked
1015 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1017 $result: Change this value to override the result of wfIsTrustedProxy()
1019 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1020 tance to return false if the domain name doesn't match your organization
1021 $addr: The e-mail address entered by the user
1022 &$result: Set this and return false to override the internal checks
1024 'isValidPassword': Override the result of User::isValidPassword()
1025 $password: The password entered by the user
1026 &$result: Set this and return false to override the internal checks
1027 $user: User the password is being validated for
1029 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1030 $wgExtensionMessagesFiles instead.
1031 Use this to define synonyms of magic words depending of the language
1032 $magicExtensions: associative array of magic words synonyms
1033 $lang: laguage code (string)
1035 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1036 listed in $wgExtensionMessagesFiles instead.
1037 Use to define aliases of special pages names depending of the language
1038 $specialPageAliases: associative array of magic words synonyms
1039 $lang: laguage code (string)
1041 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1042 &$names: array of language code => language name
1043 $code language of the preferred translations
1045 'LinkBegin': Used when generating internal and interwiki links in
1046 Linker::link(), before processing starts. Return false to skip default proces-
1047 sing and return $ret. See documentation for Linker::link() for details on the
1048 expected meanings of parameters.
1049 $skin: the Skin object
1050 $target: the Title that the link is pointing to
1051 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1053 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1054 tive array form, with keys and values unescaped. Should be merged with de-
1055 fault values, with a value of false meaning to suppress the attribute.
1056 &$query: the query string to add to the generated URL (the bit after the "?"),
1057 in associative array form, with keys and values unescaped.
1058 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1059 &$ret: the value to return if your hook returns false.
1061 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1062 just before the function returns a value. If you return true, an <a> element
1063 with HTML attributes $attribs and contents $html will be returned. If you re-
1064 turn false, $ret will be returned.
1065 $skin: the Skin object
1066 $target: the Title object that the link is pointing to
1067 $options: the options. Will always include either 'known' or 'broken', and may
1068 include 'noclasses'.
1069 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1070 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1072 &$ret: the value to return if your hook returns false.
1074 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1076 &$url: the image url
1077 &$alt: the image's alt text
1078 &$img: the new image HTML (if returning false)
1080 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1083 &$text: the link text
1084 &$link: the new link HTML (if returning false)
1085 &$attribs: the attributes to be applied.
1086 $linkType: The external link type
1088 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1090 &$linksUpdate: the LinksUpdate object
1092 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1094 &$linksUpdate: the LinksUpdate object
1096 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1097 &$linksUpdate: the LinksUpdate object
1099 'ListDefinedTags': When trying to find all defined tags.
1100 &$tags: The list of tags.
1102 'LoadExtensionSchemaUpdates': called during database installation and updates
1103 &updater: A DatabaseUpdater subclass
1105 'LocalFile::getHistory': called before file history query performed
1108 $fields: select fields
1110 $opts: query options
1111 $join_conds: JOIN conditions
1113 'LocalisationCacheRecache': Called when loading the localisation data into cache
1114 $cache: The LocalisationCache object
1115 $code: language code
1116 &$alldata: The localisation data from core and extensions
1118 'LoginAuthenticateAudit': a login attempt for a valid user account either
1119 succeeded or failed. No return data is accepted; this hook is for auditing only.
1120 $user: the User object being authenticated against
1121 $password: the password being submitted and found wanting
1122 $retval: a LoginForm class constant with authenticateUserData() return
1123 value (SUCCESS, WRONG_PASS, etc)
1125 'LogLine': Processes a single log entry on Special:Log
1126 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1127 logging.log_type database field.
1128 $log_action: string for the type of log action (e.g. 'delete', 'block',
1129 'create2'). Corresponds to logging.log_action database field.
1130 $title: Title object that corresponds to logging.log_namespace and
1131 logging.log_title database fields.
1132 $paramArray: Array of parameters that corresponds to logging.log_params field.
1133 Note that only $paramArray[0] appears to contain anything.
1134 &$comment: string that corresponds to logging.log_comment database field, and
1135 which is displayed in the UI.
1136 &$revert: string that is displayed in the UI, similar to $comment.
1137 $time: timestamp of the log entry (added in 1.12)
1139 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1140 $refreshLinks: RefreshLinks object
1142 'MagicWordMagicWords': When defining new magic word.
1143 DEPRECATED: use $magicWords in a file listed in
1144 $wgExtensionMessagesFiles instead.
1145 $magicWords: array of strings
1147 'MagicWordwgVariableIDs': When definig new magic words IDs.
1148 $variableIDs: array of strings
1150 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1151 is executed. Ideally, this hook should only be used to add variables that
1152 depend on the current page/request; static configuration should be added
1153 through ResourceLoaderGetConfigVars instead.
1154 &$vars: variable (or multiple variables) to be added into the output
1155 of Skin::makeVariablesScript
1157 'MarkPatrolled': before an edit is marked patrolled
1158 $rcid: ID of the revision to be marked patrolled
1159 $user: the user (object) marking the revision as patrolled
1160 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1161 needs to be a sysop in order to mark an edit patrolled
1163 'MarkPatrolledComplete': after an edit is marked patrolled
1164 $rcid: ID of the revision marked as patrolled
1165 $user: user (object) who marked the edit patrolled
1166 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1167 must be a sysop to patrol the edit
1169 'MediaWikiPerformAction': Override MediaWiki::performAction().
1170 Use this to do something completely different, after the basic
1171 globals have been set up, but before ordinary actions take place.
1173 $article: $wgArticle
1176 $request: $wgRequest
1177 $mediaWiki: The $mediawiki object
1179 'MessagesPreLoad': When loading a message from the database
1180 $title: title of the message (string)
1181 $message: value (string), change it to the message you want to define
1183 'MessageCacheReplace': When a message page is changed.
1184 Useful for updating caches.
1185 $title: name of the page changed.
1186 $text: new contents of the page.
1188 'ModifyExportQuery': Modify the query used by the exporter.
1189 $db: The database object to be queried.
1190 &$tables: Tables in the query.
1191 &$conds: Conditions in the query.
1192 &$opts: Options for the query.
1193 &$join_conds: Join conditions for the query.
1195 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1196 been rendered (useful for adding more)
1197 Note: this is only run for the Monobook skin. This hook is deprecated and
1198 may be removed in the future. To add items to the toolbox you should use
1199 the SkinTemplateToolboxEnd hook instead, which works for all
1200 "SkinTemplate"-type skins.
1201 $tools: array of tools
1203 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1204 and returning it for the skin to output. You can add items to the toolbox while
1205 still letting the skin make final decisions on skin-specific markup conventions
1207 &$sk: The BaseTemplate base skin template
1208 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1209 BaseTemplate::makeListItem for details on the format of individual
1210 items inside of this array
1212 'NewRevisionFromEditComplete': called when a revision was inserted
1214 $article: the article edited
1215 $rev: the new revision
1216 $baseID: the revision ID this was based off, if any
1217 $user: the editing user
1219 'NormalizeMessageKey': Called before the software gets the text of a message
1220 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1222 &$key: the message being looked up. Change this to something else to change
1223 what message gets displayed (string)
1224 &$useDB: whether or not to look up the message in the database (bool)
1225 &$langCode: the language code to get the message for (string) - or -
1226 whether to use the content language (true) or site language (false) (bool)
1227 &$transform: whether or not to expand variables and templates
1228 in the message (bool)
1230 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1231 &$changeslist: The OldChangesList instance.
1232 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1233 &$rc: The RecentChange object.
1235 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1236 Hooks can alter or append to the array of URLs for search & suggestion formats.
1237 &$urls: array of associative arrays with Url element attributes
1239 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1240 users and/or IP addresses too
1241 $otherBlockLink: An array with links to other block logs
1242 $ip: The requested IP address or username
1244 'OutputPageBeforeHTML': a page has been processed by the parser and
1245 the resulting HTML is about to be displayed.
1246 $parserOutput: the parserOutput (object) that corresponds to the page
1247 $text: the text that will be displayed, in HTML (string)
1249 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1250 tag to allow for extensions to add attributes to the body of the page they might
1251 need. Or to allow building extensions to add body classes that aren't of high
1252 enough demand to be included in core.
1253 $out: The OutputPage which called the hook, can be used to get the real title
1254 $sk: The Skin that called OutputPage::headElement
1255 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1257 'OutputPageCheckLastModified': when checking if the page has been modified
1258 since the last visit
1259 &$modifiedTimes: array of timestamps.
1260 The following keys are set: page, user, epoch
1262 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1263 $out: OutputPage instance (object)
1264 $parserOutput: parserOutput instance being added in $out
1266 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1267 categories. Implementations should return false if they generate the category
1268 links, so the default link generation is skipped.
1269 $out: OutputPage instance (object)
1270 $categories: associative array, keys are category names, values are category
1271 types ("normal" or "hidden")
1272 $links: array, intended to hold the result. Must be an associative array with
1273 category types as keys and arrays of HTML links as values.
1275 'PageHistoryBeforeList': When a history page list is about to be constructed.
1276 $article: the article that the history is loading for
1278 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1279 $row: the revision row for this line
1280 $s: the string representing this parsed line
1281 $classes: array containing the <li> element classes
1283 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1286 $queryInfo: the query parameters
1288 'PageRenderingHash': alter the parser cache option hash key
1289 A parser extension which depends on user options should install
1290 this hook and append its values to the key.
1291 $hash: reference to a hash key string which can be modified
1293 'ParserAfterStrip': Same as ParserBeforeStrip
1295 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1296 $parser: Parser object being used
1297 $text: text that'll be returned
1299 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1300 $parser: Parser object
1301 $text: text to parse
1302 $stripState: StripState instance being used
1304 'ParserBeforeStrip': Called at start of parsing time
1305 (no more strip, deprecated ?)
1306 $parser: parser object
1307 $text: text being parsed
1308 $stripState: stripState used (object)
1310 'ParserBeforeTidy': called before tidy and custom tags replacements
1311 $parser: Parser object being used
1314 'ParserClearState': called at the end of Parser::clearState()
1315 $parser: Parser object being cleared
1317 'ParserFirstCallInit': called when the parser initialises for the first time
1318 &$parser: Parser object being cleared
1320 'ParserGetVariableValueSwitch': called when the parser need the value of a
1322 $parser: Parser object
1323 $varCache: array to store the value in case of multiples calls of the
1325 $index: index (string) of the magic
1326 $ret: value of the magic word (the hook should set it)
1327 $frame: PPFrame object to use for expanding any template variables
1329 'ParserGetVariableValueTs': use this to change the value of the time for the
1330 {{LOCAL...}} magic word
1331 $parser: Parser object
1332 $time: actual time (timestamp)
1334 'ParserGetVariableValueVarCache': use this to change the value of the
1335 variable cache or return false to not use it
1336 $parser: Parser object
1337 $varCache: varaiable cache (array)
1339 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1340 include comments about size of the text parsed
1341 $parser: Parser object
1342 $limitReport: text that will be included (without comment tags)
1344 'ParserMakeImageParams': Called before the parser make an image link, use this
1345 to modify the parameters of the image.
1346 $title: title object representing the file
1347 $file: file object that will be used to create the image
1348 &$params: 2-D array of parameters
1350 'ParserTestParser': called when creating a new instance of Parser in
1351 maintenance/parserTests.inc
1352 $parser: Parser object created
1354 'ParserTestTables': alter the list of tables to duplicate when parser tests
1355 are run. Use when page save hooks require the presence of custom tables
1356 to ensure that tests continue to run properly.
1357 &$tables: array of table names
1359 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1360 my talk page, my contributions" etc).
1362 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1363 &$title: Title object representing the current page
1365 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1366 &$user : User performing the action
1367 $action : Action being performed
1368 &$result : Whether or not the action should be prevented
1369 Change $result and return false to give a definitive answer, otherwise
1370 the built-in rate limiting checks are used, if enabled.
1372 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1373 AJAX search suggestions. Put results into &$results outparam and return false.
1374 $ns : array of int namespace keys to search in
1375 $search : search term (not guaranteed to be conveniently normalized)
1376 $limit : maximum number of results to return
1377 &$results : out param: array of page names (strings)
1379 'PrefsEmailAudit': called when user changes his email address
1380 $user: User (object) changing his email address
1381 $oldaddr: old email address (string)
1382 $newaddr: new email address (string)
1384 'PrefsPasswordAudit': called when user changes his password
1385 $user: User (object) changing his passoword
1386 $newPass: new password
1387 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1389 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1390 $article: the title being (un)protected
1391 $output: a string of the form HTML so far
1393 'ProtectionForm::save': called when a protection form is submitted
1394 $article: the title being (un)protected
1395 $errorMsg: an html message string of an error
1397 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1398 $article: the page the form is shown for
1399 $out: OutputPage object
1401 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1402 loader request or generating HTML output.
1403 &$resourceLoader: ResourceLoader object
1405 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1406 to add modules to the startup module. This hook should be used sparingly since any module added here
1407 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1410 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1411 &$obj: RawPage object
1412 &$text: The text that's going to be the output
1414 'RecentChange_save': called at the end of RecentChange::save()
1415 $recentChange: RecentChange object
1417 'ResourceLoaderGetConfigVars': called at the end of
1418 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1419 configuration variables to JavaScript. Things that depend on the current
1420 page/request state must be added through MakeGlobalVariablesScript instead.
1421 &$vars: array( variable name => value )
1423 'RevisionInsertComplete': called after a revision is inserted into the DB
1424 &$revision: the Revision
1425 $data: the data stored in old_text. The meaning depends on $flags: if external
1426 is set, it's the URL of the revision text in external storage; otherwise,
1427 it's the revision text itself. In either case, if gzip is set, the revision
1429 $flags: a comma-delimited list of strings representing the options used. May
1430 include: utf8 (this will always be set for new revisions); gzip; external.
1432 'SearchUpdate': Prior to search update completion
1434 $namespace : Page namespace
1436 $text : Current text being indexed
1438 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1439 $allSearchTerms : Array of the search terms in all content languages
1440 &$titleResult : Outparam; the value to return. A Title object or null.
1442 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1443 $term : Search term string
1444 &$title : Outparam; set to $title object and return false for a match
1446 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1447 $term : Search term string
1448 &$title : Current Title object that is being returned (null if none found).
1450 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1451 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1452 in the $searchEngine->namespaces array.
1453 $query : Original query.
1454 &$parsed : Resultant query with the prefixes stripped.
1456 'SearchableNamespaces': An option to modify which namespaces are searchable.
1457 &$arr : Array of namespaces ($nsId => $name) which will be used.
1459 'SetupAfterCache': Called in Setup.php, after cache objects are set
1461 'ShowMissingArticle': Called when generating the output for a non-existent page
1462 $article: The article object corresponding to the page
1464 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1465 $text: Text being shown
1466 $title: Title of the custom script/stylesheet page
1467 $output: Current OutputPage object
1469 'ShowSearchHitTitle': Customise display of search hit title/link.
1470 &$title: Title to link to
1471 &$text: Text to use for the link
1472 $result: The search result
1473 $terms: The search terms entered
1474 $page: The SpecialSearch object.
1476 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1477 &$siteNotice: HTML returned as the sitenotice
1479 Return true to allow the normal method of notice selection/rendering to work,
1480 or change the value of $siteNotice and return false to alter it.
1482 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1483 &$siteNotice: HTML sitenotice
1485 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1487 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1489 &$text: bottomScripts Text
1490 Append to $text to add additional text/scripts after the stock bottom scripts.
1492 'SkinAfterContent': Allows extensions to add text after the page content and
1494 &$data: (string) Text to be printed out directly (without parsing)
1496 This hook should work in all skins. Just set the &$data variable to the text
1497 you're going to add.
1499 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1501 &$bar: Sidebar contents
1502 Modify $bar to add or modify sidebar portlets.
1504 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1505 $title: displayed page title
1506 $type: 'normal' or 'history' for old/diff views
1507 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1508 &$link: overridable HTML link to be passed into the message as $1
1509 &$forContent: overridable flag if copyright footer is shown in content language.
1512 &$text: additional 'powered by' icons in HTML.
1513 Note: Modern skin does not use the MediaWiki icon but plain text instead
1516 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1517 &$subpages: Subpage links HTML
1519 $out: OutputPage object
1520 If false is returned $subpages will be used instead of the HTML
1521 subPageSubtitle() generates.
1522 If true is returned, $subpages will be ignored and the rest of
1523 subPageSubtitle() will run.
1525 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1526 "permanent link" tab
1527 $sktemplate: SkinTemplate object
1528 $nav_urls: array of tabs
1530 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1531 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1532 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1533 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1534 &$sktemplate: SkinTemplate object
1535 &$links: Structured navigation links
1536 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1538 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1540 &$sktemplate: SkinTemplate object
1541 &$tpl: Template engine object
1543 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1544 $sktemplate: SkinTemplate object
1545 $res: set to true to prevent active tabs
1547 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1550 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1551 You can either create your own array, or alter the parameters for
1553 &$sktemplate: The SkinTemplate instance.
1554 $title: Title instance for the page.
1555 $message: Visible label of tab.
1556 $selected: Whether this is a selected tab.
1557 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1558 &$classes: Array of CSS classes to apply.
1559 &$query: Query string to add to link.
1561 &$result: Complete assoc. array if you want to return true.
1563 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1564 been rendered (useful for adding more)
1565 $sk: The QuickTemplate based skin template running the hook.
1567 'SoftwareInfo': Called by Special:Version for returning information about
1569 $software: The array of software in format 'name' => 'version'.
1570 See SpecialVersion::softwareInformation()
1572 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1573 $id: User identifier
1575 'SpecialListusersDefaultQuery': called right before the end of
1576 UsersPager::getDefaultQuery()
1577 $pager: The UsersPager instance
1578 $query: The query array to be returned
1580 'SpecialListusersFormatRow': called right before the end of
1581 UsersPager::formatRow()
1582 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1583 $row: Database row object
1585 'SpecialListusersHeader': called before closing the <fieldset> in
1586 UsersPager::getPageHeader()
1587 $pager: The UsersPager instance
1588 $out: The header HTML
1590 'SpecialListusersHeaderForm': called before adding the submit button in
1591 UsersPager::getPageHeader()
1592 $pager: The UsersPager instance
1593 $out: The header HTML
1595 'SpecialListusersQueryInfo': called right before the end of
1596 UsersPager::getQueryInfo()
1597 $pager: The UsersPager instance
1598 $query: The query array to be returned
1600 'SpecialMovepageAfterMove': called after moving a page
1601 $movePage: MovePageForm object
1602 $oldTitle: old title (object)
1603 $newTitle: new title (object)
1605 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1606 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1607 $opts: FormOptions object containing special page options
1608 &$conds: array of WHERE conditionals for query
1609 &tables: array of tables to be queried
1610 &$fields: array of columns to select
1611 &$join_conds: join conditions for the tables
1613 'SpecialNewPagesFilters': called after building form options at NewPages
1614 $special: the special page object
1615 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1616 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1618 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1619 hook to remove a core special page
1620 $list: list (array) of core special pages
1622 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1623 $users: array of User objects
1624 $data: array of data submitted by the user
1625 &$error: string, error code (message name) used to describe to error (out paramater).
1626 The hook needs to return false when setting this, otherwise it will have no effect.
1628 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1629 use this to change some selection criteria or substitute a different title
1630 &$randstr: The random number from wfRandom()
1631 &$isRedir: Boolean, whether to select a redirect or non-redirect
1632 &$namespaces: An array of namespace indexes to get the title from
1633 &$extra: An array of extra SQL statements
1634 &$title: If the hook returns false, a Title object to use instead of the
1635 result from the normal query
1637 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1638 $special: the special page object
1639 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1640 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1642 'SpecialRecentChangesPanel': called when building form options in
1643 SpecialRecentChanges
1644 &$extraOpts: array of added items, to which can be added
1645 $opts: FormOptions for this request
1647 'SpecialRecentChangesQuery': called when building sql query for
1648 SpecialRecentChanges and SpecialRecentChangesLinked
1649 &$conds: array of WHERE conditionals for query
1650 &$tables: array of tables to be queried
1651 &$join_conds: join conditions for the tables
1652 $opts: FormOptions for this request
1653 &$query_options: array of options for the database request
1654 &$select: Array of columns to select
1656 'SpecialSearchGo': called when user clicked the "Go"
1657 &$title: title object generated from the text entered by the user
1658 &$term: the search term entered by the user
1660 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1661 target doesn't exist
1662 &$title: title object generated from the text entered by the user
1664 'SpecialSearchProfiles': allows modification of search profiles
1665 &$profiles: profiles, which can be modified.
1667 'SpecialSearchProfileForm': allows modification of search profile forms
1668 $search: special page object
1669 &$form: String: form html
1670 $profile: String: current search profile
1671 $term: String: search term
1672 $opts: Array: key => value of hidden options for inclusion in custom forms
1674 'SpecialSearchSetupEngine': allows passing custom data to search engine
1675 $search: special page object
1676 $profile: String: current search profile
1677 $engine: the search engine
1679 'SpecialSearchResults': called before search result display when there
1681 $term: string of search term
1682 &$titleMatches: empty or SearchResultSet object
1683 &$textMatches: empty or SearchResultSet object
1685 'SpecialSearchNoResults': called before search result display when there are
1687 $term: string of search term
1689 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1690 &$extraStats: Array to save the new stats
1691 ( $extraStats['<name of statistic>'] => <value>; )
1693 'SpecialUploadComplete': Called after successfully uploading a file from
1695 $form: The SpecialUpload object
1697 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1698 use this to change the tables headers
1699 $extTypes: associative array of extensions types
1701 'SpecialWatchlistFilters': called after building form options at Watchlist
1702 $special: the special page object
1703 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1704 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1706 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1707 &$conds: array of WHERE conditionals for query
1708 &$tables: array of tables to be queried
1709 &$join_conds: join conditions for the tables
1710 &$fields: array of query fields
1712 'TitleArrayFromResult': called when creating an TitleArray object from a
1714 &$titleArray: set this to an object to override the default object returned
1715 $res: database result used to create the object
1717 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1718 that can be applied.
1719 $title: The title in question.
1720 &$types: The types of protection available.
1722 'TitleMoveComplete': after moving an article (title)
1725 $user: user who did the move
1726 $pageid: database ID of the page that's been moved
1727 $redirid: database ID of the created redirect
1729 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1730 PageArchive object has been created but before any further processing is done.
1731 &$archive: PageArchive object
1732 $title: Title object of the page that we're viewing
1734 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1735 PageArchive object has been created but before any further processing is done.
1736 &$archive: PageArchive object
1737 $title: Title object of the page that we're viewing
1739 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1740 the site is not in read-only mode, that the Title object is not null and after
1741 a PageArchive object has been constructed but before performing any further
1743 &$archive: PageArchive object
1744 $title: Title object of the page that we're about to undelete
1746 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1747 $title: title object related to the revision
1748 $rev: revision (object) that will be viewed
1750 'UnknownAction': An unknown "action" has occured (useful for defining
1752 $action: action name
1753 $article: article "acted on"
1755 'UnitTestsList': Called when building a list of files with PHPUnit tests
1756 &$files: list of files
1758 'UnwatchArticle': before a watch is removed from an article
1759 $user: user watching
1760 $article: article object to be removed
1762 'UnwatchArticle': after a watch is removed from an article
1763 $user: user that was watching
1764 $article: article object removed
1766 'UnwatchArticleComplete': after a watch is removed from an article
1767 $user: user that watched
1768 $article: article object that was watched
1770 'UploadForm:initial': before the upload form is generated
1771 $form: UploadForm object
1772 You might set the member-variables $uploadFormTextTop and
1773 $uploadFormTextAfterSummary to inject text (HTML) either before
1774 or after the editform.
1776 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1777 $form: UploadForm object
1778 Lets you poke at member variables like $mUploadDescription before the
1780 Do not use this hook to break upload processing. This will return the user to
1781 a blank form with no error message; use UploadVerification and
1782 UploadVerifyFile instead
1784 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1785 $type: (string) the requested upload type
1786 &$className: the class name of the Upload instance to be created
1788 'UploadComplete': when Upload completes an upload
1789 &$upload: an UploadBase child instance
1791 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1793 $descriptor: (array) the HTMLForm descriptor
1795 'UploadFormSourceDescriptors': after the standard source inputs have been
1796 added to the descriptor
1797 $descriptor: (array) the HTMLForm descriptor
1799 'UploadVerification': additional chances to reject an uploaded file. Consider
1800 using UploadVerifyFile instead.
1801 string $saveName: destination file name
1802 string $tempName: filesystem path to the temporary file for checks
1803 string &$error: output: message key for message to show if upload canceled
1804 by returning false. May also be an array, where the first element
1805 is the message key and the remaining elements are used as parameters to
1808 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1809 in most cases over UploadVerification.
1810 object $upload: an instance of UploadBase, with all info about the upload
1811 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1812 will typically only apply for specific mime types.
1813 object &$error: output: true if the file is valid. Otherwise, an indexed array
1814 representing the problem with the file, where the first element
1815 is the message key and the remaining elements are used as parameters to
1818 'UploadComplete': Upon completion of a file upload
1819 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1820 $uploadBase->getLocalFile().
1822 'User::mailPasswordInternal': before creation and mailing of a user's new
1824 $user: the user who sent the message out
1825 $ip: IP of the user who sent the message out
1826 $u: the account whose new password will be set
1828 'UserAddGroup': called when adding a group; return false to override
1829 stock group addition.
1830 $user: the user object that is to have a group added
1831 &$group: the group to add, can be modified
1833 'UserArrayFromResult': called when creating an UserArray object from a
1835 &$userArray: set this to an object to override the default object returned
1836 $res: database result used to create the object
1838 'userCan': To interrupt/advise the "user can do X to Y article" check.
1839 If you want to display an error message, try getUserPermissionsErrors.
1840 $title: Title object being checked against
1841 $user : Current user object
1842 $action: Action being checked
1843 $result: Pointer to result returned if hook returns false. If null is returned,
1844 userCan checks are continued by internal code.
1846 'UserCanSendEmail': To override User::canSendEmail() permission check
1847 $user: User (object) whose permission is being checked
1848 &$canSend: bool set on input, can override on output
1850 'UserClearNewTalkNotification': called when clearing the
1851 "You have new messages!" message, return false to not delete it
1852 $user: User (object) that'll clear the message
1854 'UserComparePasswords': called when checking passwords, return false to
1855 override the default password checks
1856 &$hash: String of the password hash (from the database)
1857 &$password: String of the plaintext password the user entered
1858 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1860 &$result: If the hook returns false, this Boolean value will be checked to
1861 determine if the password was valid
1863 'UserCreateForm': change to manipulate the login form
1864 $template: SimpleTemplate instance for the form
1866 'UserCryptPassword': called when hashing a password, return false to implement
1867 your own hashing method
1868 &$password: String of the plaintext password to encrypt
1869 &$salt: String of the password salt or Boolean false if no salt is provided
1870 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1872 &$hash: If the hook returns false, this String will be used as the hash
1874 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1875 $user: User to get groups for
1876 &$groups: Current effective groups
1878 'UserGetAllRights': after calculating a list of all available rights
1879 &$rights: Array of rights, which may be added to.
1881 'UserGetEmail': called when getting an user email address
1883 &$email: email, change this to override local email
1885 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1886 email authentification
1888 &$timestamp: timestamp, change this to override local email authentification
1891 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1892 &$groups: List of implicit (automatically-assigned) groups
1894 'UserGetLanguageObject': Called when getting user's interface language object
1896 &$code: Langauge code that will be used to create the object
1898 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1899 &$reservedUsernames: $wgReservedUsernames
1901 'UserGetRights': Called in User::getRights()
1902 $user: User to get rights for
1903 &$rights: Current rights
1905 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1907 $user: User in question
1908 $title: Title of the page in question
1909 &$blocked: Out-param, whether or not the user is blocked from that page.
1910 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1911 own user talk pages.
1913 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1915 $ip: User's IP address
1916 &$blocked: Whether the user is blocked, to be modified by the hook
1918 'UserLoadAfterLoadFromSession': called to authenticate users on
1919 external/environmental means; occurs after session is loaded
1920 $user: user object being loaded
1922 'UserLoadDefaults': called when loading a default user
1926 'UserLoadFromDatabase': called when loading a user from the database
1928 &$s: database query object
1930 'UserLoadFromSession': called to authenticate users on external/environmental
1931 means; occurs before session is loaded
1932 $user: user object being loaded
1933 &$result: set this to a boolean value to abort the normal authentification
1936 'UserLoadOptions': when user options/preferences are being loaded from
1939 &$options: Options, can be modified.
1941 'UserLoginComplete': after a user has logged in
1942 $user: the user object that was created on login
1943 $inject_html: Any HTML to inject after the "logged in" message.
1945 'UserLoginForm': change to manipulate the login form
1946 $template: SimpleTemplate instance for the form
1948 'UserLogout': before a user logs out
1949 $user: the user object that is about to be logged out
1951 'UserLogoutComplete': after a user has logged out
1952 $user: the user object _after_ logout (won't have name, ID, etc.)
1953 $inject_html: Any HTML to inject after the "logged out" message.
1954 $oldName: name of the user before logout (string)
1956 'UserRemoveGroup': called when removing a group; return false to override
1957 stock group removal.
1958 $user: the user object that is to have a group removed
1959 &$group: the group to be removed, can be modified
1961 'UserRights': After a user's group memberships are changed
1962 $user : User object that was changed
1963 $add : Array of strings corresponding to groups added
1964 $remove: Array of strings corresponding to groups removed
1966 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1968 $user: user retrieving new talks messages
1969 $talks: array of new talks page(s)
1971 'UserSaveSettings': called when saving user settings
1974 'UserSaveOptions': Called just before saving user preferences/options.
1976 &$options: Options, modifiable
1978 'UserSetCookies': called when setting user cookies
1980 &$session: session array, will be added to $_SESSION
1981 &$cookies: cookies array mapping cookie name to its value
1983 'UserSetEmail': called when changing user email address
1985 &$email: new email, change this to override new email address
1987 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1988 of email authentification
1990 &$timestamp: new timestamp, change this to override local email
1991 authentification timestamp
1993 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
1994 used to alter the SQL query which gets the list of wanted pages
1995 &$wantedPages: WantedPagesPage object
1996 &$query: query array, see QueryPage::getQueryInfo() for format documentation
1998 'WatchArticle': before a watch is added to an article
1999 $user: user that will watch
2000 $article: article object to be watched
2002 'WatchArticleComplete': after a watch is added to an article
2003 $user: user that watched
2004 $article: article object watched
2006 'WatchlistEditorBuildRemoveLine': when building remove lines in
2007 Special:Watchlist/edit
2008 &$tools: array of extra links
2009 $title: Title object
2010 $redirect: whether the page is a redirect
2013 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2015 One, and only one hook should set this, and return false.
2016 &$tables: Database tables to use in the SELECT query
2017 &$opts: Options to use for the query
2018 &$join: Join conditions
2020 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2021 query pages to be updated with maintenance/updateSpecialPages.php
2022 $query: $wgQueryPages itself
2024 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2025 metadata to be added.
2026 $obj: The XmlDumpWriter object.
2027 &$out: The output string.
2028 $row: The database row for the page.
2029 $title: The title of the page.
2031 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2033 $obj: The XmlDumpWriter object.
2034 &$out: The text being output.
2035 $row: The database row for the revision.
2036 $text: The revision text.
2038 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2039 additional tags to extract.
2040 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2042 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2043 used to post-process the results.
2044 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2045 metadata tags returned (each tag is either a value, or an array of values).
2047 More hooks might be available but undocumented, you can execute
2048 ./maintenance/findhooks.php to find hidden one.