Revert r34906, r34907, r34928 -- mixing high-level data into low-level storage functi...
[lhc/web/wiklou.git] / docs / hooks.txt
1 hooks.txt
2
3 This document describes how event hooks work in MediaWiki; how to add
4 hooks for an event; and how to run hooks for an event.
5
6 ==Glossary==
7
8 event
9 Something that happens with the wiki. For example: a user logs
10 in. A wiki page is saved. A wiki page is deleted. Often there are
11 two events associated with a single action: one before the code
12 is run to make the event happen, and one after. Each event has a
13 name, preferably in CamelCase. For example, 'UserLogin',
14 'ArticleSave', 'ArticleSaveComplete', 'ArticleDelete'.
15
16 hook
17 A clump of code and data that should be run when an event
18 happens. This can be either a function and a chunk of data, or an
19 object and a method.
20
21 hook function
22 The function part of a hook.
23
24 ==Rationale==
25
26 Hooks allow us to decouple optionally-run code from code that is run
27 for everyone. It allows MediaWiki hackers, third-party developers and
28 local administrators to define code that will be run at certain points
29 in the mainline code, and to modify the data run by that mainline
30 code. Hooks can keep mainline code simple, and make it easier to
31 write extensions. Hooks are a principled alternative to local patches.
32
33 Consider, for example, two options in MediaWiki. One reverses the
34 order of a title before displaying the article; the other converts the
35 title to all uppercase letters. Currently, in MediaWiki code, we
36 would handle this as follows (note: not real code, here):
37
38 function showAnArticle($article) {
39 global $wgReverseTitle, $wgCapitalizeTitle;
40
41 if ($wgReverseTitle) {
42 wfReverseTitle($article);
43 }
44
45 if ($wgCapitalizeTitle) {
46 wfCapitalizeTitle($article);
47 }
48
49 # code to actually show the article goes here
50 }
51
52 An extension writer, or a local admin, will often add custom code to
53 the function -- with or without a global variable. For example,
54 someone wanting email notification when an article is shown may add:
55
56 function showAnArticle($article) {
57 global $wgReverseTitle, $wgCapitalizeTitle;
58
59 if ($wgReverseTitle) {
60 wfReverseTitle($article);
61 }
62
63 if ($wgCapitalizeTitle) {
64 wfCapitalizeTitle($article);
65 }
66
67 # code to actually show the article goes here
68
69 if ($wgNotifyArticle) {
70 wfNotifyArticleShow($article));
71 }
72 }
73
74 Using a hook-running strategy, we can avoid having all this
75 option-specific stuff in our mainline code. Using hooks, the function
76 becomes:
77
78 function showAnArticle($article) {
79
80 if (wfRunHooks('ArticleShow', array(&$article))) {
81
82 # code to actually show the article goes here
83
84 wfRunHooks('ArticleShowComplete', array(&$article));
85 }
86 }
87
88 We've cleaned up the code here by removing clumps of weird,
89 infrequently used code and moving them off somewhere else. It's much
90 easier for someone working with this code to see what's _really_ going
91 on, and make changes or fix bugs.
92
93 In addition, we can take all the code that deals with the little-used
94 title-reversing options (say) and put it in one place. Instead of
95 having little title-reversing if-blocks spread all over the codebase
96 in showAnArticle, deleteAnArticle, exportArticle, etc., we can
97 concentrate it all in an extension file:
98
99 function reverseArticleTitle($article) {
100 # ...
101 }
102
103 function reverseForExport($article) {
104 # ...
105 }
106
107 The setup function for the extension just has to add its hook
108 functions to the appropriate events:
109
110 setupTitleReversingExtension() {
111 global $wgHooks;
112
113 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
114 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
115 $wgHooks['ArticleExport'][] = 'reverseForExport';
116 }
117
118 Having all this code related to the title-reversion option in one
119 place means that it's easier to read and understand; you don't have to
120 do a grep-find to see where the $wgReverseTitle variable is used, say.
121
122 If the code is well enough isolated, it can even be excluded when not
123 used -- making for some slight savings in memory and load-up
124 performance at runtime. Admins who want to have all the reversed
125 titles can add:
126
127 require_once('extensions/ReverseTitle.php');
128
129 ...to their LocalSettings.php file; those of us who don't want or need
130 it can just leave it out.
131
132 The extensions don't even have to be shipped with MediaWiki; they
133 could be provided by a third-party developer or written by the admin
134 him/herself.
135
136 ==Writing hooks==
137
138 A hook is a chunk of code run at some particular event. It consists of:
139
140 * a function with some optional accompanying data, or
141 * an object with a method and some optional accompanying data.
142
143 Hooks are registered by adding them to the global $wgHooks array for a
144 given event. All the following are valid ways to define hooks:
145
146 $wgHooks['EventName'][] = 'someFunction'; # function, no data
147 $wgHooks['EventName'][] = array('someFunction', $someData);
148 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
149
150 $wgHooks['EventName'][] = $object; # object only
151 $wgHooks['EventName'][] = array($object, 'someMethod');
152 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
153 $wgHooks['EventName'][] = array($object); # weird but OK
154
155 When an event occurs, the function (or object method) will be called
156 with the optional data provided as well as event-specific parameters.
157 The above examples would result in the following code being executed
158 when 'EventName' happened:
159
160 # function, no data
161 someFunction($param1, $param2)
162 # function with data
163 someFunction($someData, $param1, $param2)
164
165 # object only
166 $object->onEventName($param1, $param2)
167 # object with method
168 $object->someMethod($param1, $param2)
169 # object with method and data
170 $object->someMethod($someData, $param1, $param2)
171
172 Note that when an object is the hook, and there's no specified method,
173 the default method called is 'onEventName'. For different events this
174 would be different: 'onArticleSave', 'onUserLogin', etc.
175
176 The extra data is useful if we want to use the same function or object
177 for different purposes. For example:
178
179 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
180 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
181
182 This code would result in ircNotify being run twice when an article is
183 saved: once for 'TimStarling', and once for 'brion'.
184
185 Hooks can return three possible values:
186
187 * true: the hook has operated successfully
188 * "some string": an error occurred; processing should
189 stop and the error should be shown to the user
190 * false: the hook has successfully done the work
191 necessary and the calling function should skip
192
193 The last result would be for cases where the hook function replaces
194 the main functionality. For example, if you wanted to authenticate
195 users to a custom system (LDAP, another PHP program, whatever), you
196 could do:
197
198 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
199
200 function ldapLogin($username, $password) {
201 # log user into LDAP
202 return false;
203 }
204
205 Returning false makes less sense for events where the action is
206 complete, and will normally be ignored.
207
208 ==Using hooks==
209
210 A calling function or method uses the wfRunHooks() function to run
211 the hooks related to a particular event, like so:
212
213 class Article {
214 # ...
215 function protect() {
216 global $wgUser;
217 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
218 # protect the article
219 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
220 }
221 }
222 }
223
224 wfRunHooks() returns true if the calling function should continue
225 processing (the hooks ran OK, or there are no hooks to run), or false
226 if it shouldn't (an error occurred, or one of the hooks handled the
227 action already). Checking the return value matters more for "before"
228 hooks than for "complete" hooks.
229
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can
232 be changed) into the hook code. Also note that earlier versions of
233 wfRunHooks took a variable number of arguments; the array() calling
234 protocol came about after MediaWiki 1.4rc1.
235
236 ==Events and parameters==
237
238 This is a list of known events and parameters; please add to it if
239 you're going to add events to the MediaWiki code.
240
241 'AbortLogin': Return false to cancel account login.
242 $user: the User object being authenticated against
243 $password: the password being submitted, not yet checked for validity
244 &$retval: a LoginForm class constant to return from authenticateUserData();
245 default is LoginForm::ABORTED. Note that the client may be using
246 a machine API rather than the HTML user interface.
247
248 'AbortMove': allows to abort moving an article (title)
249 $old: old title
250 $nt: new title
251 $user: user who is doing the move
252 $err: error message
253
254 'AbortNewAccount': Return false to cancel account creation.
255 $user: the User object about to be created (read-only, incomplete)
256 $message: out parameter: error message to display on abort
257
258 'AddNewAccount': after a user account is created
259 $user: the User object that was created. (Parameter added in 1.7)
260 $byEmail: true when account was created "by email" (added in 1.12)
261
262 'AjaxAddScript': Called in output page just before the initialisation
263 of the javascript ajax engine. The hook is only called when ajax
264 is enabled ( $wgUseAjax = true; ).
265
266 'AlternateEdit': before checking if an user can edit a page and
267 before showing the edit form ( EditPage::edit() ). This is triggered
268 on &action=edit.
269 $EditPage : the EditPage object
270
271 'APIEditBeforeSave': before saving a page with api.php?action=edit,
272 after processing request parameters. Return false to let the request
273 fail, returning an error message or an <edit result="Failure"> tag
274 if $resultArr was filled.
275 $EditPage : the EditPage object
276 $text : the new text of the article (has yet to be saved)
277 $resultArr : data in this array will be added to the API result
278
279 'ArticleAfterFetchContent': after fetching content of an article from the database
280 $article: the article (object) being loaded from the database
281 $content: the content (string) of the article
282
283 'ArticleDelete': before an article is deleted
284 $article: the article (object) being deleted
285 $user: the user (object) deleting the article
286 $reason: the reason (string) the article is being deleted
287
288 'ArticleDeleteComplete': after an article is deleted
289 $article: the article that was deleted
290 $user: the user that deleted the article
291 $reason: the reason the article was deleted
292 $id: id of the article that was deleted
293
294 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
295 $article: article (object) of the user talk page
296
297 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
298 $article: article (object) being modified
299
300 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
301 $title: title (object) used to create the article object
302 $article: article (object) that will be returned
303
304 'ArticleInsertComplete': After an article is created
305 $article: Article created
306 $user: User creating the article
307 $text: New content
308 $summary: Edit summary/comment
309 $isMinor: Whether or not the edit was marked as minor
310 $isWatch: (No longer used)
311 $section: (No longer used)
312 $flags: Flags passed to Article::doEdit()
313 $revision: New Revision of the article
314
315 'ArticleMergeComplete': after merging to article using Special:Mergehistory
316 $targetTitle: target title (object)
317 $destTitle: destination title (object)
318
319 'ArticlePageDataAfter': after loading data of an article from the database
320 $article: article (object) whose data were loaded
321 $row: row (object) returned from the database server
322
323 'ArticlePageDataBefore': before loading data of an article from the database
324 $article: article (object) that data will be loaded
325 $fields: fileds (array) to load from the database
326
327 'ArticleProtect': before an article is protected
328 $article: the article being protected
329 $user: the user doing the protection
330 $protect: boolean whether this is a protect or an unprotect
331 $reason: Reason for protect
332 $moveonly: boolean whether this is for move only or not
333
334 'ArticleProtectComplete': after an article is protected
335 $article: the article that was protected
336 $user: the user who did the protection
337 $protect: boolean whether it was a protect or an unprotect
338 $reason: Reason for protect
339 $moveonly: boolean whether it was for move only or not
340
341 'ArticlePurge': before executing "&action=purge"
342 $article: article (object) to purge
343
344 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
345 revision of an article
346 &$title: title object of the article
347
348 'ArticleRevisionUndeleted': after an article revision is restored
349 $title: the article title
350 $revision: the revision
351 $oldPageID: the page ID of the revision when archived (may be null)
352
353 'ArticleRollbackComplete': after an article rollback is completed
354 $article: the article that was edited
355 $user: the user who did the rollback
356 $revision: the revision the page was reverted back to
357
358 'ArticleSave': before an article is saved
359 $article: the article (object) being saved
360 $user: the user (object) saving the article
361 $text: the new article text
362 $summary: the article summary (comment)
363 $isminor: minor flag
364 $iswatch: watch flag
365 $section: section #
366
367 'ArticleSaveComplete': After an article has been updated
368 $article: Article modified
369 $user: User performing the modification
370 $text: New content
371 $summary: Edit summary/comment
372 $isMinor: Whether or not the edit was marked as minor
373 $isWatch: (No longer used)
374 $section: (No longer used)
375 $flags: Flags passed to Article::doEdit()
376 $revision: New Revision of the article
377
378 'ArticleSaveComplete': after an article is saved
379 $article: the article (object) saved
380 $user: the user (object) who saved the article
381 $text: the new article text
382 $summary: the article summary (comment)
383 $isminor: minor flag
384 $iswatch: watch flag
385 $section: section #
386
387 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
388
389 'ArticleUndelete': When one or more revisions of an article are restored
390 $title: Title corresponding to the article restored
391 $create: Whether or not the restoration caused the page to be created
392 (i.e. it didn't exist before)
393
394 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
395 &$article: the article
396 &$sectionanchor: The section anchor link (e.g. "#overview" )
397 &$extraq: Extra query parameters which can be added via hooked functions
398
399 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
400 &$article: the article
401 &$pcache: whether to try the parser cache or not
402 &$outputDone: whether the output for this page finished or not
403
404 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
405 $article: target article (object)
406
407 'AuthPluginAutoCreate': Called when creating a local account for an user logged
408 in from an external authentication method
409 $user: User object created locally
410
411 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
412 Gives a chance for an extension to set it programattically to a variable class.
413 &$auth: the $wgAuth object, probably a stub
414
415 'AutopromoteCondition': check autopromote condition for user.
416 $type: condition type
417 $args: arguments
418 $user: user
419 $result: result of checking autopromote condition
420
421 'BadImage': When checking against the bad image list
422 $name: Image name being checked
423 &$bad: Whether or not the image is "bad"
424
425 Change $bad and return false to override. If an image is "bad", it is not
426 rendered inline in wiki pages or galleries in category pages.
427
428 'BeforeGalleryFindFile': before an image is fetched for a gallery
429 &$gallery,: the gallery object
430 &$nt: the image title
431 &$time: image timestamp
432
433 'BeforePageDisplay': Prior to outputting a page
434 &$out: OutputPage object
435 &$skin: Skin object
436
437 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
438 &$parser: Parser object
439 &$title: title of the template
440 &$skip: skip this template and link it?
441 &$id: the id of the revision being parsed
442
443 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
444 &$parser: Parser object
445 &$nt: the image title
446 &$skip: skip this image and link it?
447 &$time: the image timestamp
448
449 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
450 &$parser: Parser object
451 &$ig: ImageGallery object
452
453 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
454 $nondefaults: Assoc array with the following keys:
455 days, hideOwn, hideBots, hideMinor, namespace
456 $wgUser: wgUser.
457 &$hookSql: a string which will be inserted without sanitation into the SQL query
458 used to get the watchlist, at the end of the WHERE part.
459
460 'BlockIp': before an IP address or user is blocked
461 $block: the Block object about to be saved
462 $user: the user _doing_ the block (not the one being blocked)
463
464 'BlockIpComplete': after an IP address or user is blocked
465 $block: the Block object that was saved
466 $user: the user who did the block (not the one being blocked)
467
468 'BookInformation': Before information output on Special:Booksources
469 $isbn: ISBN to show information for
470 $output: OutputPage object in use
471
472 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
473 &$linker: Linker instance
474 $nt: the page title
475 $query: the URL query string passed in
476 &$u: the URL of this link
477 &$style: the inline CSS style
478 &$prefix: a prefix prepended to the linked text
479 &$text: the text placed by the user in the wiki-link
480 &$inside: any additional alphanumeric characters placed after the wiki-link,
481 that are made part of the link text
482 &$trail: text placed immediately after the HTML link
483
484 'CategoryPageView': before viewing a categorypage in CategoryPage::view
485 $catpage: CategoryPage instance
486
487 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
488 &$this: ChangesList instance.
489 &$articlelink: HTML of link to article (already filled-in).
490 &$s: HTML of row that is being constructed.
491 &$rc: RecentChange instance.
492 $unpatrolled: Whether or not we are showing unpatrolled changes.
493 $watched: Whether or not the change is watched by the user.
494
495 'ContributionsToolLinks': Change tool links above Special:Contributions
496 $id: User identifier
497 $title: User page title
498 &$tools: Array of tool links
499
500 'CustomEditor': When invoking the page editor
501 $article: Article being edited
502 $user: User performing the edit
503
504 Return true to allow the normal editor to be used, or false
505 if implementing a custom editor, e.g. for a special namespace,
506 etc.
507
508 'DiffViewHeader': called before diff display
509 $diff: DifferenceEngine object that's calling
510 $oldRev: Revision object of the "old" revision (may be null/invalid)
511 $newRev: Revision object of the "new" revision
512
513 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
514 $article: article (object) being viewed
515 $oldid: oldid (int) being viewed
516
517 'EditFilter': Perform checks on an edit
518 $editor: Edit form (see includes/EditPage.php)
519 $text: Contents of the edit box
520 $section: Section being edited
521 &$error: Error message to return
522
523 'EditFilterMerged': Post-section-merge edit filter
524 $editor: EditPage instance (object)
525 $text: content of the edit box
526 $error: error message to return
527
528 'EditFormPreloadText': Allows population of the edit form when creating new pages
529 &$text: Text to preload with
530 &$title: Title object representing the page being created
531
532 'EditPage::attemptSave': called before an article is
533 saved, that is before insertNewArticle() is called
534 &$editpage_Obj: the current EditPage object
535
536 'EditPage::showEditForm:fields': allows injection of form field into edit form
537 &$editor: the EditPage instance for reference
538 &$out: an OutputPage instance to write to
539 return value is ignored (should always return true)
540
541 'EditPage::showEditForm:initial': before showing the edit form
542 $editor: EditPage instance (object)
543
544 Return false to halt editing; you'll need to handle error messages, etc. yourself.
545 Alternatively, modifying $error and returning true will cause the contents of $error
546 to be echoed at the top of the edit form as wikitext. Return true without altering
547 $error to allow the edit to proceed.
548
549 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
550 when there's an edit conflict. Return false to halt normal diff output; in
551 this case you're responsible for computing and outputting the entire "conflict"
552 part, i.e., the "difference between revisions" and "your text" headers and
553 sections.
554 &$editor: EditPage instance
555 &$out: OutputPage instance
556
557 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
558 &$editpage: The current EditPage object
559 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
560
561 'EditSectionLink': Override the return value of Linker::editSectionLink()
562 $skin: Skin rendering the UI
563 $title: Title being linked to
564 $section: Section to link to
565 $link: Default link
566 $result: Result (alter this to override the generated links)
567
568 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
569 $skin: Skin rendering the UI
570 $title: Title being linked to
571 $section: Section to link to
572 $hint: Anchor title/tooltip attributes
573 $link: Default link
574 $result: Result (alter this to override the generated links)
575
576 'EmailConfirmed': When checking that the user's email address is "confirmed"
577 $user: User being checked
578 $confirmed: Whether or not the email address is confirmed
579 This runs before the other checks, such as anonymity and the real check; return
580 true to allow those checks to occur, and false if checking is done.
581
582 'EmailUser': before sending email from one user to another
583 $to: address of receiving user
584 $from: address of sending user
585 $subject: subject of the mail
586 $text: text of the mail
587
588 'EmailUserComplete': after sending email from one user to another
589 $to: address of receiving user
590 $from: address of sending user
591 $subject: subject of the mail
592 $text: text of the mail
593
594 'FetchChangesList': When fetching the ChangesList derivative for a particular user
595 &$user: User the list is being fetched for
596 &$skin: Skin object to be used with the list
597 &$list: List object (defaults to NULL, change it to an object instance and return
598 false override the list derivative used)
599
600 'FileDeleteComplete': When a file is deleted
601 $file: reference to the deleted file
602 $oldimage: in case of the deletion of an old image, the name of the old file
603 $article: in case all revisions of the file are deleted a reference to the article
604 associated with the file.
605 $user: user who performed the deletion
606 $reason: reason
607
608 'FileUpload': When a file upload occurs
609 $file : Image object representing the file that was uploaded
610
611 'FileUndeleteComplete': When a file is undeleted
612 $title: title object to the file
613 $fileVersions: array of undeleted versions. Empty if all versions were restored
614 $user: user who performed the undeletion
615 $reason: reason
616
617 'GetBlockedStatus': after loading blocking status of an user from the database
618 $user: user (object) being checked
619
620 'GetCacheVaryCookies': get cookies that should vary cache options
621 $out: OutputPage object
622 &$cookies: array of cookies name, add a value to it if you want to add a cookie
623 that have to vary cache options
624
625 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
626 $title: Title object of page
627 $url: string value as output (out parameter, can modify)
628 $query: query options passed to Title::getFullURL()
629
630 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
631 $title: Title object of page
632 $url: string value as output (out parameter, can modify)
633 $query: query options passed to Title::getInternalURL()
634
635 'GetLinkColours': modify the CSS class of an array of page links
636 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
637 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
638
639 'GetLocalURL': modify local URLs as output into page links
640 $title: Title object of page
641 $url: string value as output (out parameter, can modify)
642 $query: query options passed to Title::getLocalURL()
643
644 'getUserPermissionsErrors': Add a permissions error when permissions errors are
645 checked for. Use instead of userCan for most cases. Return false if the
646 user can't do it, and populate $result with the reason in the form of
647 array( messagename, param1, param2, ... ). For consistency, error messages
648 should be plain text with no special coloring, bolding, etc. to show that
649 they're errors; presenting them properly to the user as errors is done by
650 the caller.
651 $title: Title object being checked against
652 $user : Current user object
653 $action: Action being checked
654 $result: User permissions error to add. If none, return true.
655
656 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
657 if expensive checks are enabled.
658
659 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
660 image insertion. You can skip the default logic entirely by returning
661 false, or just modify a few things using call-by-reference.
662 &$this: Skin object
663 &$title: Title object of the image
664 &$file: File object, or false if it doesn't exist
665 &$frameParams: Various parameters with special meanings; see documentation in
666 includes/Linker.php for Linker::makeImageLink2
667 &$handlerParams: Various parameters with special meanings; see documentation in
668 includes/Linker.php for Linker::makeImageLink2
669 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
670 &$res: Final HTML output, used if you return false
671
672
673 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
674 the image on an image page
675 $imagePage: ImagePage object ($this)
676 $output: $wgOut
677
678 'ImagePageFileHistoryLine': called when a file history line is contructed
679 $file: the file
680 $line: the HTML of the history line
681 $css: the line CSS class
682
683 'InitPreferencesForm': called at the end of PreferencesForm's constructor
684 $form: the PreferencesForm
685 $request: the web request to initialized from
686
687 'InternalParseBeforeLinks': during Parser's internalParse method before links but
688 after noinclude/includeonly/onlyinclude and other processing.
689 &$this: Parser object
690 &$text: string containing partially parsed text
691 &$this->mStripState: Parser's internal StripState object
692
693 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
694 $article: article (object) being checked
695
696 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
697 $ip: IP being check
698 $result: Change this value to override the result of wfIsTrustedProxy()
699
700 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
701 tance to return false if the domain name doesn't match your organization
702 $addr: The e-mail address entered by the user
703 &$result: Set this and return false to override the internal checks
704
705 'isValidPassword': Override the result of User::isValidPassword()
706 $password: The password entered by the user
707 &$result: Set this and return false to override the internal checks
708 $user: User the password is being validated for
709
710 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
711 $magicExtensions: associative array of magic words synonyms
712 $lang: laguage code (string)
713
714 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
715 $specialPageAliases: associative array of magic words synonyms
716 $lang: laguage code (string)
717
718 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
719 &$linksUpdate: the LinkUpdate object
720
721 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
722 &$linksUpdate: the LinkUpdate object
723
724 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
725 &$linksUpdate: the LinkUpdate object
726
727 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
728
729 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
730
731 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
732 No return data is accepted; this hook is for auditing only.
733 $user: the User object being authenticated against
734 $password: the password being submitted and found wanting
735 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
736
737 'LogLine': Processes a single log entry on Special:Log
738 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
739 database field.
740 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
741 to logging.log_action database field.
742 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
743 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
744 appears to contain anything.
745 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
746 &$revert: string that is displayed in the UI, similar to $comment.
747 $time: timestamp of the log entry (added in 1.12)
748
749 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
750 &$type: array of strings
751
752 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
753 &$typeText: array of strings
754
755 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
756 &$headerText: array of strings
757
758 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
759 &$actionText: array of strings
760
761 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
762 $magicWords: array of strings
763
764 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
765 $variableIDs: array of strings
766
767 'MarkPatrolled': before an edit is marked patrolled
768 $rcid: ID of the revision to be marked patrolled
769 $user: the user (object) marking the revision as patrolled
770 $wcOnlySysopsCanPatrol: config setting indicating whether the user
771 needs to be a sysop in order to mark an edit patrolled
772
773 'MarkPatrolledComplete': after an edit is marked patrolled
774 $rcid: ID of the revision marked as patrolled
775 $user: user (object) who marked the edit patrolled
776 $wcOnlySysopsCanPatrol: config setting indicating whether the user
777 must be a sysop to patrol the edit
778
779 'MathAfterTexvc': after texvc is executed when rendering mathematics
780 $mathRenderer: instance of MathRenderer
781 $errmsg: error message, in HTML (string). Nonempty indicates failure
782 of rendering the formula
783
784 'MediaWikiPerformAction': Override MediaWiki::performAction().
785 Use this to do something completely different, after the basic
786 globals have been set up, but before ordinary actions take place.
787 $output: $wgOut
788 $article: $wgArticle
789 $title: $wgTitle
790 $user: $wgUser
791 $request: $wgRequest
792
793 'MessagesPreLoad': When loading a message from the database
794 $title: title of the message (string)
795 $message: value (string), change it to the message you want to define
796
797 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
798 Note: this is only run for the Monobook skin. To add items to the toolbox
799 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
800 instead.
801 $tools: array of tools
802
803 'OutputPageBeforeHTML': a page has been processed by the parser and
804 the resulting HTML is about to be displayed.
805 $parserOutput: the parserOutput (object) that corresponds to the page
806 $text: the text that will be displayed, in HTML (string)
807
808 'OutputPageParserOutput': after adding a parserOutput to $wgOut
809 $out: OutputPage instance (object)
810 $parserOutput: parserOutput instance being added in $out
811
812 'PageHistoryBeforeList': When a history page list is about to be constructed.
813 $article: the article that the history is loading for
814
815 'PageHistoryLineEnding' : right before the end <li> is added to a history line
816 $row: the revision row for this line
817 $s: the string representing this parsed line
818
819 'PageRenderingHash': alter the parser cache option hash key
820 A parser extension which depends on user options should install
821 this hook and append its values to the key.
822 $hash: reference to a hash key string which can be modified
823
824 'ParserAfterStrip': Same as ParserBeforeStrip
825
826 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
827 $parser: Parser object being used
828 $text: text that'll be returned
829
830 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
831 $parser: Parser object
832 $text: text to parse
833 $stripState: StripState instance being used
834
835 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
836 $parser: parser object
837 $text: text being parsed
838 $stripState: stripState used (object)
839
840 'ParserBeforeTidy': called before tidy and custom tags replacements
841 $parser: Parser object being used
842 $text: actual text
843
844 'ParserClearState': called at the end of Parser::clearState()
845 $parser: Parser object being cleared
846
847 'ParserFirstCallInit': called when the parser initialises for the first time
848 &$parser: Parser object being cleared
849
850 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
851 $parser: Parser object
852 $varCache: array to store the value in case of multiples calls of the same magic word
853 $index: index (string) of the magic
854 $ret: value of the magic word (the hook should set it)
855
856 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
857 $parser: Parser object
858 $time: actual time (timestamp)
859
860 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
861 $parser: Parser object
862 $varCache: varaiable cache (array)
863
864 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
865 $parser: Parser object
866 $limitReport: text that will be included (without comment tags)
867
868 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
869 $title: title object representing the file
870 $file: file object that will be used to create the image
871 &$params: 2-D array of parameters
872
873 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
874 $parser: Parser object created
875
876 'ParserTestTables': alter the list of tables to duplicate when parser tests
877 are run. Use when page save hooks require the presence of custom tables
878 to ensure that tests continue to run properly.
879 &$tables: array of table names
880
881 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
882 my talk page, my contributions" etc).
883
884 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
885 &$title: Title object representing the current page
886
887 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
888 &$user : User performing the action
889 $action : Action being performed
890 &$result : Whether or not the action should be prevented
891 Change $result and return false to give a definitive answer, otherwise
892 the built-in rate limiting checks are used, if enabled.
893
894 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
895 $form : PreferencesForm object
896 &$html : HTML to append to
897
898 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
899 AJAX search suggestions. Put results into &$results outparam and return false.
900 $ns : array of int namespace keys to search in
901 $search : search term (not guaranteed to be conveniently normalized)
902 $limit : maximum number of results to return
903 &$results : out param: array of page names (strings)
904
905 'PrefsEmailAudit': called when user changes his email address
906 $user: User (object) changing his email address
907 $oldaddr: old email address (string)
908 $newaddr: new email address (string)
909
910 'PrefsPasswordAudit': called when user changes his password
911 $user: User (object) changing his passoword
912 $newPass: new password
913 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
914
915 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
916 &$obj: RawPage object
917 &$text: The text that's going to be the output
918
919 'RecentChange_save': called at the end of RecenChange::save()
920 $recentChange: RecentChange object
921
922 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
923 $form: the PreferencesForm
924 $out: output page to render to, probably $wgOut
925
926 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
927 $form: the PreferencesForm
928 $user: the User object to load preferences from
929
930 'RevisionInsertComplete': called after a revision is inserted into the DB
931 $revision: the Revision
932
933 'SavePreferences': called at the end of PreferencesForm::savePreferences;
934 returning false prevents the preferences from being saved.
935 $form: the PreferencesForm
936 $user: the User object to save preferences to
937 $message: change this to set an error message (ignored if the hook does not return false)
938 $old: old preferences of the user
939
940 'SearchUpdate': Prior to search update completion
941 $id : Page id
942 $namespace : Page namespace
943 $title : Page title
944 $text : Current text being indexed
945
946 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
947 $term : Search term string
948 &$title : Outparam; set to $title object and return false for a match
949
950 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
951 $text: Text being shown
952 $title: Title of the custom script/stylesheet page
953 $output: Current OutputPage object
954
955 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
956 &$siteNotice: HTML returned as the sitenotice
957 Return true to allow the normal method of notice selection/rendering to work,
958 or change the value of $siteNotice and return false to alter it.
959
960 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
961 &$siteNotice: HTML sitenotice
962 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
963
964 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
965 $skin: Skin object
966 &$text: bottomScripts Text
967 Append to $text to add additional text/scripts after the stock bottom scripts.
968
969 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
970 $skin: Skin object
971 &$subpages: Subpage links HTML
972 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
973 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
974
975 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
976 $sktemplate: SkinTemplate object
977 $content_actions: array of tabs
978
979 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
980 $sktemplate: SkinTemplate object
981 $nav_urls: array of tabs
982
983 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
984 &$content_actions: Content actions
985 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
986 for an example]
987
988 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
989 &$sktemplate: SkinTemplate object
990 &$tpl: Template engine object
991
992 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
993 $sktemplate: SkinTemplate object
994 $res: set to true to prevent active tabs
995
996 'SkinTemplateSetupPageCss': use this to provide per-page CSS
997 $out: Css to return
998
999 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1000 You can either create your own array, or alter the parameters for the normal one.
1001 &$this: The SkinTemplate instance.
1002 $title: Title instance for the page.
1003 $message: Visible label of tab.
1004 $selected: Whether this is a selected tab.
1005 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1006 &$classes: Array of CSS classes to apply.
1007 &$query: Query string to add to link.
1008 &$text: Link text.
1009 &$result: Complete assoc. array if you want to return true.
1010
1011 'SkinTemplateTabs': called when finished to build the actions tabs
1012 $sktemplate: SkinTemplate object
1013 $content_actions: array of tabs
1014
1015 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1016 $tools: array of tools
1017
1018 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1019 $id: User identifier
1020
1021 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1022 $pager: The UsersPager instance
1023 $query: The query array to be returned
1024
1025 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1026 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1027 $row: Database row object
1028
1029 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1030 $pager: The UsersPager instance
1031 $out: The header HTML
1032
1033 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1034 $pager: The UsersPager instance
1035 $out: The header HTML
1036
1037 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1038 $pager: The UsersPager instance
1039 $query: The query array to be returned
1040
1041 'SpecialMovepageAfterMove': called after moving a page
1042 $movePage: MovePageForm object
1043 $oldTitle: old title (object)
1044 $newTitle: new title (object)
1045
1046 'SpecialPageExecuteAfterPage': called after executing a special page
1047 Warning: Not all the special pages call this hook
1048 $specialPage: SpecialPage object
1049 $par: paramter passed to the special page (string)
1050 $funct: function called to execute the special page
1051
1052 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1053 Warning: Not all the special pages call this hook
1054 $specialPage: SpecialPage object
1055 $par: paramter passed to the special page (string)
1056 $funct: function called to execute the special page
1057
1058 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1059 Warning: Not all the special pages call this hook
1060 $specialPage: SpecialPage object
1061 $par: paramter passed to the special page (string)
1062 $funct: function called to execute the special page
1063
1064 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1065 $list: list (array) of core special pages
1066
1067 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1068 $title: title object generated from the text entred by the user
1069
1070 'SpecialSearchResults': called before search result display when there are matches
1071 $term: string of search term
1072 $titleMatches: empty or SearchResultSet object
1073 $textMatches: empty or SearchResultSet object
1074
1075 'SpecialSearchNoResults': called before search result display when there are no matches
1076 $term: string of search term
1077
1078 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1079 $extTypes: associative array of extensions types
1080
1081 'TitleMoveComplete': after moving an article (title)
1082 $old: old title
1083 $nt: new title
1084 $user: user who did the move
1085 $pageid: database ID of the page that's been moved
1086 $redirid: database ID of the created redirect
1087
1088 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1089 $title: title object related to the revision
1090 $rev: revision (object) that will be viewed
1091
1092 'UnknownAction': An unknown "action" has occured (useful for defining
1093 your own actions)
1094 $action: action name
1095 $article: article "acted on"
1096
1097 'UnwatchArticle': before a watch is removed from an article
1098 $user: user watching
1099 $article: article object to be removed
1100
1101 'UnwatchArticle': after a watch is removed from an article
1102 $user: user that was watching
1103 $article: article object removed
1104
1105 'UnwatchArticleComplete': after a watch is removed from an article
1106 $user: user that watched
1107 $article: article object that was watched
1108
1109 'UploadForm:initial': before the upload form is generated
1110 $form: UploadForm object
1111 You might set the member-variables $uploadFormTextTop and
1112 $uploadFormTextAfterSummary to inject text (HTML) either before
1113 or after the editform.
1114
1115 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1116 $form: UploadForm object
1117 Lets you poke at member variables like $mUploadDescription before the
1118 file is saved.
1119
1120 'UploadVerification': additional chances to reject an uploaded file
1121 string $saveName: destination file name
1122 string $tempName: filesystem path to the temporary file for checks
1123 string &$error: output: HTML error to show if upload canceled by returning false
1124
1125 'UploadComplete': Upon completion of a file upload
1126 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1127
1128 'UserArrayFromResult': called when creating an UserArray object from a database result
1129 &$userArray: set this to an object to override the default object returned
1130 $res: database result used to create the object
1131
1132 'userCan': To interrupt/advise the "user can do X to Y article" check.
1133 If you want to display an error message, try getUserPermissionsErrors.
1134 $title: Title object being checked against
1135 $user : Current user object
1136 $action: Action being checked
1137 $result: Pointer to result returned if hook returns false. If null is returned,
1138 userCan checks are continued by internal code.
1139
1140 'UserCanSendEmail': To override User::canSendEmail() permission check
1141 $user: User (object) whose permission is being checked
1142 &$canSend: bool set on input, can override on output
1143
1144
1145 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1146 $user: User (object) that'll clear the message
1147
1148 'UserCreateForm': change to manipulate the login form
1149 $template: SimpleTemplate instance for the form
1150
1151 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1152 $user: User to get groups for
1153 &$groups: Current effective groups
1154
1155 'UserGetAllRights': after calculating a list of all available rights
1156 &$rights: Array of rights, which may be added to.
1157
1158 'UserGetEmail': called when getting an user email address
1159 $user: User object
1160 &$email: email, change this to override local email
1161
1162 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1163 $user: User object
1164 &$timestamp: timestamp, change this to override local email authentification timestamp
1165
1166 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1167 &$groups: List of implicit (automatically-assigned) groups
1168
1169 'UserGetRights': Called in User::getRights()
1170 $user: User to get rights for
1171 &$rights: Current rights
1172
1173 'UserLoadFromSession': called to authenticate users on external/environmental means
1174 $user: user object being loaded
1175 &$result: set this to a boolean value to abort the normal authentification process
1176
1177 'UserLoginComplete': after a user has logged in
1178 $user: the user object that was created on login
1179 $inject_html: Any HTML to inject after the "logged in" message.
1180
1181 'UserLoginForm': change to manipulate the login form
1182 $template: SimpleTemplate instance for the form
1183
1184 'UserLogout': before a user logs out
1185 $user: the user object that is about to be logged out
1186
1187 'UserLogoutComplete': after a user has logged out
1188 $user: the user object _after_ logout (won't have name, ID, etc.)
1189 $inject_html: Any HTML to inject after the "logged out" message.
1190
1191 'UserRights': After a user's group memberships are changed
1192 $user : User object that was changed
1193 $add : Array of strings corresponding to groups added
1194 $remove: Array of strings corresponding to groups removed
1195
1196 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1197 $user: user retrieving new talks messages
1198 $talks: array of new talks page(s)
1199
1200 'UserSaveSettings': called when saving user settings
1201 $user: User object
1202
1203 'UserSetEmail': called when changing user email address
1204 $user: User object
1205 &$email: new email, change this to override new email address
1206
1207 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1208 $user: User object
1209 &$timestamp: new timestamp, change this to override local email authentification timestamp
1210
1211 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1212 $toggles: array of toggles to add
1213
1214 'WatchArticle': before a watch is added to an article
1215 $user: user that will watch
1216 $article: article object to be watched
1217
1218 'WatchArticleComplete': after a watch is added to an article
1219 $user: user that watched
1220 $article: article object watched
1221
1222 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1223 $query: $wgQueryPages itself
1224
1225 More hooks might be available but undocumented, you can execute
1226 ./maintenance/findhooks.php to find hidden one.