886190b60bf809e3a80ecd06fee8eaabc7cde12e
[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 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
408 Gives a chance for an extension to set it programattically to a variable class.
409 &$auth: the $wgAuth object, probably a stub
410
411 'AutoAuthenticate': called to authenticate users on external/environmental means
412 $user: writes user object to this parameter
413
414 'AutopromoteCondition': check autopromote condition for user.
415 $type: condition type
416 $args: arguments
417 $user: user
418 $result: result of checking autopromote condition
419
420 'BadImage': When checking against the bad image list
421 $name: Image name being checked
422 &$bad: Whether or not the image is "bad"
423
424 Change $bad and return false to override. If an image is "bad", it is not
425 rendered inline in wiki pages or galleries in category pages.
426
427 'BeforeGalleryFindFile': before an image is fetched for a gallery
428 &$gallery,: the gallery object
429 &$nt: the image title
430 &$time: image timestamp
431
432 'BeforePageDisplay': Prior to outputting a page
433 &$out: OutputPage object
434 &$skin: Skin object
435
436 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
437 &$parser: Parser object
438 &$title: title of the template
439 &$skip: skip this template and link it?
440 &$id: the id of the revision being parsed
441
442 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
443 &$parser: Parser object
444 &$nt: the image title
445 &$skip: skip this image and link it?
446 &$time: the image timestamp
447
448 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
449 &$parser: Parser object
450 &$ig: ImageGallery object
451
452 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
453 $nondefaults: Assoc array with the following keys:
454 days, hideOwn, hideBots, hideMinor, namespace
455 $wgUser: wgUser.
456 &$hookSql: a string which will be inserted without sanitation into the SQL query
457 used to get the watchlist, at the end of the WHERE part.
458
459 'BlockIp': before an IP address or user is blocked
460 $block: the Block object about to be saved
461 $user: the user _doing_ the block (not the one being blocked)
462
463 'BlockIpComplete': after an IP address or user is blocked
464 $block: the Block object that was saved
465 $user: the user who did the block (not the one being blocked)
466
467 'BookInformation': Before information output on Special:Booksources
468 $isbn: ISBN to show information for
469 $output: OutputPage object in use
470
471 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
472 &$this: Linker instance
473 $nt: the page title
474 $query: the URL query string passed in
475 &$u: the URL of this link
476 &$style: the inline CSS style
477 &$prefix: a prefix prepended to the linked text
478 &$text: the text placed by the user in the wiki-link
479 &$inside: any additional alphanumeric characters placed after the wiki-link,
480 that are made part of the link text
481 &$trail: text placed immediately after the HTML link
482
483 'CategoryPageView': before viewing a categorypage in CategoryPage::view
484 $catpage: CategoryPage instance
485
486 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
487 &$this: ChangesList instance.
488 &$articlelink: HTML of link to article (already filled-in).
489 &$s: HTML of row that is being constructed.
490 &$rc: RecentChange instance.
491 $unpatrolled: Whether or not we are showing unpatrolled changes.
492 $watched: Whether or not the change is watched by the user.
493
494 'ContributionsToolLinks': Change tool links above Special:Contributions
495 $id: User identifier
496 $title: User page title
497 &$tools: Array of tool links
498
499 'CustomEditor': When invoking the page editor
500 $article: Article being edited
501 $user: User performing the edit
502
503 Return true to allow the normal editor to be used, or false
504 if implementing a custom editor, e.g. for a special namespace,
505 etc.
506
507 'DiffViewHeader': called before diff display
508 $diff: DifferenceEngine object that's calling
509 $oldRev: Revision object of the "old" revision (may be null/invalid)
510 $newRev: Revision object of the "new" revision
511
512 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
513 $article: article (object) being viewed
514 $oldid: oldid (int) being viewed
515
516 'EditFilter': Perform checks on an edit
517 $editor: Edit form (see includes/EditPage.php)
518 $text: Contents of the edit box
519 $section: Section being edited
520 &$error: Error message to return
521
522 'EditFilterMerged': Post-section-merge edit filter
523 $editor: EditPage instance (object)
524 $text: content of the edit box
525 $error: error message to return
526
527 'EditFormPreloadText': Allows population of the edit form when creating new pages
528 &$text: Text to preload with
529 &$title: Title object representing the page being created
530
531 'EditPage::attemptSave': called before an article is
532 saved, that is before insertNewArticle() is called
533 &$editpage_Obj: the current EditPage object
534
535 'EditPage::showEditForm:fields': allows injection of form field into edit form
536 &$editor: the EditPage instance for reference
537 &$out: an OutputPage instance to write to
538 return value is ignored (should always return true)
539
540 'EditPage::showEditForm:initial': before showing the edit form
541 $editor: EditPage instance (object)
542
543 Return false to halt editing; you'll need to handle error messages, etc. yourself.
544 Alternatively, modifying $error and returning true will cause the contents of $error
545 to be echoed at the top of the edit form as wikitext. Return true without altering
546 $error to allow the edit to proceed.
547
548 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
549 when there's an edit conflict. Return false to halt normal diff output; in
550 this case you're responsible for computing and outputting the entire "conflict"
551 part, i.e., the "difference between revisions" and "your text" headers and
552 sections.
553 &$editor: EditPage instance
554 &$out: OutputPage instance
555
556 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
557 &$editpage: The current EditPage object
558 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
559
560 'EditSectionLink': Override the return value of Linker::editSectionLink()
561 $skin: Skin rendering the UI
562 $title: Title being linked to
563 $section: Section to link to
564 $link: Default link
565 $result: Result (alter this to override the generated links)
566
567 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
568 $skin: Skin rendering the UI
569 $title: Title being linked to
570 $section: Section to link to
571 $hint: Anchor title/tooltip attributes
572 $link: Default link
573 $result: Result (alter this to override the generated links)
574
575 'EmailConfirmed': When checking that the user's email address is "confirmed"
576 $user: User being checked
577 $confirmed: Whether or not the email address is confirmed
578 This runs before the other checks, such as anonymity and the real check; return
579 true to allow those checks to occur, and false if checking is done.
580
581 'EmailUser': before sending email from one user to another
582 $to: address of receiving user
583 $from: address of sending user
584 $subject: subject of the mail
585 $text: text of the mail
586
587 'EmailUserComplete': after sending email from one user to another
588 $to: address of receiving user
589 $from: address of sending user
590 $subject: subject of the mail
591 $text: text of the mail
592
593 'FetchChangesList': When fetching the ChangesList derivative for a particular user
594 &$user: User the list is being fetched for
595 &$skin: Skin object to be used with the list
596 &$list: List object (defaults to NULL, change it to an object instance and return
597 false override the list derivative used)
598
599 'FileDeleteComplete': When a file is deleted
600 $file: reference to the deleted file
601 $oldimage: in case of the deletion of an old image, the name of the old file
602 $article: in case all revisions of the file are deleted a reference to the article
603 associated with the file.
604 $user: user who performed the deletion
605 $reason: reason
606
607 'FileUpload': When a file upload occurs
608 $file : Image object representing the file that was uploaded
609
610 'FileUndeleteComplete': When a file is undeleted
611 $title: title object to the file
612 $fileVersions: array of undeleted versions. Empty if all versions were restored
613 $user: user who performed the undeletion
614 $reason: reason
615
616 'GetAvailableRights': after calculating a list of all available rights
617 &$rights: Array of rights, which may be added to.
618
619 'GetBlockedStatus': after loading blocking status of an user from the database
620 $user: user (object) being checked
621
622 'GetCacheVaryCookies': get cookies that should vary cache options
623 $out: OutputPage object
624 &$cookies: array of cookies name, add a value to it if you want to add a cookie
625 that have to vary cache options
626
627 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
628 $title: Title object of page
629 $url: string value as output (out parameter, can modify)
630 $query: query options passed to Title::getFullURL()
631
632 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
633 $title: Title object of page
634 $url: string value as output (out parameter, can modify)
635 $query: query options passed to Title::getInternalURL()
636
637 'GetLinkColours': modify the CSS class of an array of page links
638 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
639 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
640
641 'GetLocalURL': modify local URLs as output into page links
642 $title: Title object of page
643 $url: string value as output (out parameter, can modify)
644 $query: query options passed to Title::getLocalURL()
645
646 'getUserPermissionsErrors': Add a permissions error when permissions errors are
647 checked for. Use instead of userCan for most cases. Return false if the
648 user can't do it, and populate $result with the reason in the form of
649 array( messagename, param1, param2, ... ). For consistency, error messages
650 should be plain text with no special coloring, bolding, etc. to show that
651 they're errors; presenting them properly to the user as errors is done by
652 the caller.
653 $title: Title object being checked against
654 $user : Current user object
655 $action: Action being checked
656 $result: User permissions error to add. If none, return true.
657
658 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
659 if expensive checks are enabled.
660
661 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
662 the image on an image page
663 $imagePage: ImagePage object ($this)
664 $output: $wgOut
665
666 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
667 image insertion. You can skip the default logic entirely by returning
668 false, or just modify a few things using call-by-reference.
669 &$this: Skin object
670 &$title: Title object of the image
671 &$file: File object, or false if it doesn't exist
672 &$frameParams: Various parameters with special meanings; see documentation in
673 includes/Linker.php for Linker::makeImageLink2
674 &$handlerParams: Various parameters with special meanings; see documentation in
675 includes/Linker.php for Linker::makeImageLink2
676 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
677 &$res: Final HTML output, used if you return false
678
679 'InitPreferencesForm': called at the end of PreferencesForm's constructor
680 $form: the PreferencesForm
681 $request: the web request to initialized from
682
683 'InternalParseBeforeLinks': during Parser's internalParse method before links but
684 after noinclude/includeonly/onlyinclude and other processing.
685 &$this: Parser object
686 &$text: string containing partially parsed text
687 &$this->mStripState: Parser's internal StripState object
688
689 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
690 $article: article (object) being checked
691
692 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
693 $ip: IP being check
694 $result: Change this value to override the result of wfIsTrustedProxy()
695
696 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
697 tance to return false if the domain name doesn't match your organization
698 $addr: The e-mail address entered by the user
699 &$result: Set this and return false to override the internal checks
700
701 'isValidPassword': Override the result of User::isValidPassword()
702 $password: The password entered by the user
703 &$result: Set this and return false to override the internal checks
704 $user: User the password is being validated for
705
706 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
707 $magicExtensions: associative array of magic words synonyms
708 $lang: laguage code (string)
709
710 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
711 $specialPageAliases: associative array of magic words synonyms
712 $lang: laguage code (string)
713
714 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
715 &$linksUpdate: the LinkUpdate object
716
717 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
718 &$linksUpdate: the LinkUpdate object
719
720 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
721 &$linksUpdate: the LinkUpdate object
722
723 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
724
725 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
726
727 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
728 No return data is accepted; this hook is for auditing only.
729 $user: the User object being authenticated against
730 $password: the password being submitted and found wanting
731 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
732
733 'LogLine': Processes a single log entry on Special:Log
734 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
735 database field.
736 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
737 to logging.log_action database field.
738 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
739 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
740 appears to contain anything.
741 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
742 &$revert: string that is displayed in the UI, similar to $comment.
743 $time: timestamp of the log entry (added in 1.12)
744
745 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
746 &$type: array of strings
747
748 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
749 &$typeText: array of strings
750
751 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
752 &$headerText: array of strings
753
754 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
755 &$actionText: array of strings
756
757 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
758 $magicWords: array of strings
759
760 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
761 $variableIDs: array of strings
762
763 'MarkPatrolled': before an edit is marked patrolled
764 $rcid: ID of the revision to be marked patrolled
765 $user: the user (object) marking the revision as patrolled
766 $wcOnlySysopsCanPatrol: config setting indicating whether the user
767 needs to be a sysop in order to mark an edit patrolled
768
769 'MarkPatrolledComplete': after an edit is marked patrolled
770 $rcid: ID of the revision marked as patrolled
771 $user: user (object) who marked the edit patrolled
772 $wcOnlySysopsCanPatrol: config setting indicating whether the user
773 must be a sysop to patrol the edit
774
775 'MathAfterTexvc': after texvc is executed when rendering mathematics
776 $mathRenderer: instance of MathRenderer
777 $errmsg: error message, in HTML (string). Nonempty indicates failure
778 of rendering the formula
779
780 'MediaWikiPerformAction': Override MediaWiki::performAction().
781 Use this to do something completely different, after the basic
782 globals have been set up, but before ordinary actions take place.
783 $output: $wgOut
784 $article: $wgArticle
785 $title: $wgTitle
786 $user: $wgUser
787 $request: $wgRequest
788
789 'MessagesPreLoad': When loading a message from the database
790 $title: title of the message (string)
791 $message: value (string), change it to the message you want to define
792
793 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
794 $tools: array of tools
795
796 'OutputPageBeforeHTML': a page has been processed by the parser and
797 the resulting HTML is about to be displayed.
798 $parserOutput: the parserOutput (object) that corresponds to the page
799 $text: the text that will be displayed, in HTML (string)
800
801 'OutputPageParserOutput': after adding a parserOutput to $wgOut
802 $out: OutputPage instance (object)
803 $parserOutput: parserOutput instance being added in $out
804
805 'PageHistoryBeforeList': When a history page list is about to be constructed.
806 $article: the article that the history is loading for
807
808 'PageHistoryLineEnding' : right before the end <li> is added to a history line
809 $row: the revision row for this line
810 $s: the string representing this parsed line
811
812 'PageRenderingHash': alter the parser cache option hash key
813 A parser extension which depends on user options should install
814 this hook and append its values to the key.
815 $hash: reference to a hash key string which can be modified
816
817 'ParserAfterStrip': Same as ParserBeforeStrip
818
819 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
820 $parser: Parser object being used
821 $text: text that'll be returned
822
823 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
824 $parser: Parser object
825 $text: text to parse
826 $stripState: StripState instance being used
827
828 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
829 $parser: parser object
830 $text: text being parsed
831 $stripState: stripState used (object)
832
833 'ParserBeforeTidy': called before tidy and custom tags replacements
834 $parser: Parser object being used
835 $text: actual text
836
837 'ParserClearState': called at the end of Parser::clearState()
838 $parser: Parser object being cleared
839
840 'ParserFirstCallInit': called when the parser initialises for the first time
841 &$parser: Parser object being cleared
842
843 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
844 $parser: Parser object
845 $varCache: array to store the value in case of multiples calls of the same magic word
846 $index: index (string) of the magic
847 $ret: value of the magic word (the hook should set it)
848
849 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
850 $parser: Parser object
851 $time: actual time (timestamp)
852
853 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
854 $parser: Parser object
855 $varCache: varaiable cache (array)
856
857 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
858 $parser: Parser object
859 $limitReport: text that will be included (without comment tags)
860
861 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
862 $title: title object representing the file
863 $file: file object that will be used to create the image
864 &$params: 2-D array of parameters
865
866 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
867 $parser: Parser object created
868
869 'ParserTestTables': alter the list of tables to duplicate when parser tests
870 are run. Use when page save hooks require the presence of custom tables
871 to ensure that tests continue to run properly.
872 &$tables: array of table names
873
874 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
875 my talk page, my contributions" etc).
876
877 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
878 &$title: Title object representing the current page
879
880 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
881 &$user : User performing the action
882 $action : Action being performed
883 &$result : Whether or not the action should be prevented
884 Change $result and return false to give a definitive answer, otherwise
885 the built-in rate limiting checks are used, if enabled.
886
887 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
888 $form : PreferencesForm object
889 &$html : HTML to append to
890
891 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
892 AJAX search suggestions. Put results into &$results outparam and return false.
893 $ns : array of int namespace keys to search in
894 $search : search term (not guaranteed to be conveniently normalized)
895 $limit : maximum number of results to return
896 &$results : out param: array of page names (strings)
897
898 'PrefsEmailAudit': called when user changes his email address
899 $user: User (object) changing his email address
900 $oldaddr: old email address (string)
901 $newaddr: new email address (string)
902
903 'PrefsPasswordAudit': called when user changes his password
904 $user: User (object) changing his passoword
905 $newPass: new password
906 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
907
908 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
909 &$obj: RawPage object
910 &$text: The text that's going to be the output
911
912 'RecentChange_save': called at the end of RecenChange::save()
913 $recentChange: RecentChange object
914
915 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
916 $form: the PreferencesForm
917 $out: output page to render to, probably $wgOut
918
919 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
920 $form: the PreferencesForm
921 $user: the User object to load preferences from
922
923 'RevisionInsertComplete': called after a revision is inserted into the DB
924 $revision: the Revision
925
926 'SavePreferences': called at the end of PreferencesForm::savePreferences;
927 returning false prevents the preferences from being saved.
928 $form: the PreferencesForm
929 $user: the User object to save preferences to
930 $message: change this to set an error message (ignored if the hook does not return false)
931 $old: old preferences of the user
932
933 'SearchUpdate': Prior to search update completion
934 $id : Page id
935 $namespace : Page namespace
936 $title : Page title
937 $text : Current text being indexed
938
939 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
940 $term : Search term string
941 &$title : Outparam; set to $title object and return false for a match
942
943 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
944 $text: Text being shown
945 $title: Title of the custom script/stylesheet page
946 $output: Current OutputPage object
947
948 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
949 &$siteNotice: HTML returned as the sitenotice
950 Return true to allow the normal method of notice selection/rendering to work,
951 or change the value of $siteNotice and return false to alter it.
952
953 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
954 &$siteNotice: HTML sitenotice
955 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
956
957 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
958 $skin: Skin object
959 &$text: bottomScripts Text
960 Append to $text to add additional text/scripts after the stock bottom scripts.
961
962 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
963 $skin: Skin object
964 &$subpages: Subpage links HTML
965 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
966 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
967
968 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
969 $sktemplate: SkinTemplate object
970 $content_actions: array of tabs
971
972 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
973 $sktemplate: SkinTemplate object
974 $nav_urls: array of tabs
975
976 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
977 &$content_actions: Content actions
978 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
979 for an example]
980
981 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
982 &$sktemplate: SkinTemplate object
983 &$tpl: Template engine object
984
985 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
986 $sktemplate: SkinTemplate object
987 $res: set to true to prevent active tabs
988
989 'SkinTemplateSetupPageCss': use this to provide per-page CSS
990 $out: Css to return
991
992 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
993 You can either create your own array, or alter the parameters for the normal one.
994 &$this: The SkinTemplate instance.
995 $title: Title instance for the page.
996 $message: Visible label of tab.
997 $selected: Whether this is a selected tab.
998 $checkEdit: Whether or not the action=edit query should be added if appropriate.
999 &$classes: Array of CSS classes to apply.
1000 &$query: Query string to add to link.
1001 &$text: Link text.
1002 &$result: Complete assoc. array if you want to return true.
1003
1004 'SkinTemplateTabs': called when finished to build the actions tabs
1005 $sktemplate: SkinTemplate object
1006 $content_actions: array of tabs
1007
1008 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1009 $id: User identifier
1010
1011 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1012 $pager: The UsersPager instance
1013 $query: The query array to be returned
1014
1015 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1016 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1017 $row: Database row object
1018
1019 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1020 $pager: The UsersPager instance
1021 $out: The header HTML
1022
1023 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1024 $pager: The UsersPager instance
1025 $out: The header HTML
1026
1027 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1028 $pager: The UsersPager instance
1029 $query: The query array to be returned
1030
1031 'SpecialMovepageAfterMove': called after moving a page
1032 $movePage: MovePageForm object
1033 $oldTitle: old title (object)
1034 $newTitle: new title (object)
1035
1036 'SpecialPageExecuteAfterPage': called after executing a special page
1037 Warning: Not all the special pages call this hook
1038 $specialPage: SpecialPage object
1039 $par: paramter passed to the special page (string)
1040 $funct: function called to execute the special page
1041
1042 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1043 Warning: Not all the special pages call this hook
1044 $specialPage: SpecialPage object
1045 $par: paramter passed to the special page (string)
1046 $funct: function called to execute the special page
1047
1048 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1049 Warning: Not all the special pages call this hook
1050 $specialPage: SpecialPage object
1051 $par: paramter passed to the special page (string)
1052 $funct: function called to execute the special page
1053
1054 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1055 $list: list (array) of core special pages
1056
1057 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1058 $title: title object generated from the text entred by the user
1059
1060 'SpecialSearchResults': called before search result display when there are matches
1061 $term: string of search term
1062 $titleMatches: empty or SearchResultSet object
1063 $textMatches: empty or SearchResultSet object
1064
1065 'SpecialSearchNoResults': called before search result display when there are no matches
1066 $term: string of search term
1067
1068 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1069 $extTypes: associative array of extensions types
1070
1071 'TitleMoveComplete': after moving an article (title)
1072 $old: old title
1073 $nt: new title
1074 $user: user who did the move
1075 $pageid: database ID of the page that's been moved
1076 $redirid: database ID of the created redirect
1077
1078 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1079 $title: title object related to the revision
1080 $rev: revision (object) that will be viewed
1081
1082 'UnknownAction': An unknown "action" has occured (useful for defining
1083 your own actions)
1084 $action: action name
1085 $article: article "acted on"
1086
1087 'UnwatchArticle': before a watch is removed from an article
1088 $user: user watching
1089 $article: article object to be removed
1090
1091 'UnwatchArticle': after a watch is removed from an article
1092 $user: user that was watching
1093 $article: article object removed
1094
1095 'UnwatchArticleComplete': after a watch is removed from an article
1096 $user: user that watched
1097 $article: article object that was watched
1098
1099 'UploadForm:initial': before the upload form is generated
1100 $form: UploadForm object
1101 You might set the member-variables $uploadFormTextTop and
1102 $uploadFormTextAfterSummary to inject text (HTML) either before
1103 or after the editform.
1104
1105 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1106 $form: UploadForm object
1107 Lets you poke at member variables like $mUploadDescription before the
1108 file is saved.
1109
1110 'UploadVerification': additional chances to reject an uploaded file
1111 string $saveName: destination file name
1112 string $tempName: filesystem path to the temporary file for checks
1113 string &$error: output: HTML error to show if upload canceled by returning false
1114
1115 'UploadComplete': Upon completion of a file upload
1116 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1117
1118 'UserArrayFromResult': called when creating an UserArray object from a database result
1119 &$userArray: set this to an object to override the default object returned
1120 $res: database result used to create the object
1121
1122 'userCan': To interrupt/advise the "user can do X to Y article" check.
1123 If you want to display an error message, try getUserPermissionsErrors.
1124 $title: Title object being checked against
1125 $user : Current user object
1126 $action: Action being checked
1127 $result: Pointer to result returned if hook returns false. If null is returned,
1128 userCan checks are continued by internal code.
1129
1130 'UserCanSendEmail': To override User::canSendEmail() permission check
1131 $user: User (object) whose permission is being checked
1132 &$canSend: bool set on input, can override on output
1133
1134
1135 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1136 $user: User (object) that'll clear the message
1137
1138 'UserCreateForm': change to manipulate the login form
1139 $template: SimpleTemplate instance for the form
1140
1141 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1142 $user: User to get groups for
1143 &$groups: Current effective groups
1144
1145 'UserGetEmail': called when getting an user email address
1146 $user: User object
1147 &$email: email, change this to override local email
1148
1149 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1150 $user: User object
1151 &$timestamp: timestamp, change this to override local email authentification timestamp
1152
1153 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1154 &$groups: List of implicit (automatically-assigned) groups
1155
1156 'UserGetRights': Called in User::getRights()
1157 $user: User to get rights for
1158 &$rights: Current rights
1159
1160 'UserLoginComplete': after a user has logged in
1161 $user: the user object that was created on login
1162 $inject_html: Any HTML to inject after the "logged in" message.
1163
1164 'UserLoginForm': change to manipulate the login form
1165 $template: SimpleTemplate instance for the form
1166
1167 'UserLogout': before a user logs out
1168 $user: the user object that is about to be logged out
1169
1170 'UserLogoutComplete': after a user has logged out
1171 $user: the user object _after_ logout (won't have name, ID, etc.)
1172 $inject_html: Any HTML to inject after the "logged out" message.
1173
1174 'UserRights': After a user's group memberships are changed
1175 $user : User object that was changed
1176 $add : Array of strings corresponding to groups added
1177 $remove: Array of strings corresponding to groups removed
1178
1179 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1180 $user: user retrieving new talks messages
1181 $talks: array of new talks page(s)
1182
1183 'UserSaveSettings': called when saving user settings
1184 $user: User object
1185
1186 'UserSetEmail': called when changing user email address
1187 $user: User object
1188 &$email: new email, change this to override new email address
1189
1190 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1191 $user: User object
1192 &$timestamp: new timestamp, change this to override local email authentification timestamp
1193
1194 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1195 $toggles: array of toggles to add
1196
1197 'WatchArticle': before a watch is added to an article
1198 $user: user that will watch
1199 $article: article object to be watched
1200
1201 'WatchArticleComplete': after a watch is added to an article
1202 $user: user that watched
1203 $article: article object watched
1204
1205 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1206 $query: $wgQueryPages itself
1207
1208 More hooks might be available but undocumented, you can execute
1209 ./maintenance/findhooks.php to find hidden one.