9e27a8d059e3ce85144beb3b78ae944d1d5481fd
[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 'ArticleAfterFetchContent': after fetching content of an article from the database
272 $article: the article (object) being loaded from the database
273 $content: the content (string) of the article
274
275 'ArticleDelete': before an article is deleted
276 $article: the article (object) being deleted
277 $user: the user (object) deleting the article
278 $reason: the reason (string) the article is being deleted
279
280 'ArticleDeleteComplete': after an article is deleted
281 $article: the article that was deleted
282 $user: the user that deleted the article
283 $reason: the reason the article was deleted
284
285 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
286 $article: article (object) of the user talk page
287
288 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
289 $article: article (object) being modified
290
291 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
292 $title: title (object) used to create the article object
293 $article: article (object) that will be returned
294
295 'ArticleInsertComplete': After an article is created
296 $article: Article created
297 $user: User creating the article
298 $text: New content
299 $summary: Edit summary/comment
300 $isMinor: Whether or not the edit was marked as minor
301 $isWatch: (No longer used)
302 $section: (No longer used)
303 $flags: Flags passed to Article::doEdit()
304 $revision: New Revision of the article
305
306 'ArticleMergeComplete': after merging to article using Special:Mergehistory
307 $targetTitle: target title (object)
308 $destTitle: destination title (object)
309
310 'ArticlePageDataAfter': after loading data of an article from the database
311 $article: article (object) whose data were loaded
312 $row: row (object) returned from the database server
313
314 'ArticlePageDataBefore': before loading data of an article from the database
315 $article: article (object) that data will be loaded
316 $fields: fileds (array) to load from the database
317
318 'ArticleProtect': before an article is protected
319 $article: the article being protected
320 $user: the user doing the protection
321 $protect: boolean whether this is a protect or an unprotect
322 $reason: Reason for protect
323 $moveonly: boolean whether this is for move only or not
324
325 'ArticleProtectComplete': after an article is protected
326 $article: the article that was protected
327 $user: the user who did the protection
328 $protect: boolean whether it was a protect or an unprotect
329 $reason: Reason for protect
330 $moveonly: boolean whether it was for move only or not
331
332 'ArticlePurge': before executing "&action=purge"
333 $article: article (object) to purge
334
335 'ArticleRevisionUndeleted' after an article revision is restored
336 $title: the article title
337 $revision: the revision
338 $oldPageID: the page ID of the revision when archived (may be null)
339
340 'ArticleRollbackComplete': after an article rollback is completed
341 $article: the article that was edited
342 $user: the user who did the rollback
343 $revision: the revision the page was reverted back to
344
345 'ArticleSave': before an article is saved
346 $article: the article (object) being saved
347 $user: the user (object) saving the article
348 $text: the new article text
349 $summary: the article summary (comment)
350 $isminor: minor flag
351 $iswatch: watch flag
352 $section: section #
353
354 'ArticleSaveComplete': After an article has been updated
355 $article: Article modified
356 $user: User performing the modification
357 $text: New content
358 $summary: Edit summary/comment
359 $isMinor: Whether or not the edit was marked as minor
360 $isWatch: (No longer used)
361 $section: (No longer used)
362 $flags: Flags passed to Article::doEdit()
363 $revision: New Revision of the article
364
365 'ArticleSaveComplete': after an article is saved
366 $article: the article (object) saved
367 $user: the user (object) who saved the article
368 $text: the new article text
369 $summary: the article summary (comment)
370 $isminor: minor flag
371 $iswatch: watch flag
372 $section: section #
373
374 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
375
376 'ArticleUndelete': When one or more revisions of an article are restored
377 $title: Title corresponding to the article restored
378 $create: Whether or not the restoration caused the page to be created
379 (i.e. it didn't exist before)
380
381 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
382 &$article: the article
383 &$sectionanchor: The section anchor link (e.g. "#overview" )
384 &$extraq: Extra query parameters which can be added via hooked functions
385
386 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
387 &$article: the article
388 &$pcache: whether to try the parser cache or not
389 &$outputDone: whether the output for this page finished or not
390
391 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
392 $article: target article (object)
393
394 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
395 Gives a chance for an extension to set it programattically to a variable class.
396 &$auth: the $wgAuth object, probably a stub
397
398 'AutoAuthenticate': called to authenticate users on external/environmental means
399 $user: writes user object to this parameter
400
401 'AutopromoteCondition': check autopromote condition for user.
402 $type: condition type
403 $args: arguments
404 $user: user
405 $result: result of checking autopromote condition
406
407 'BadImage': When checking against the bad image list
408 $name: Image name being checked
409 &$bad: Whether or not the image is "bad"
410
411 Change $bad and return false to override. If an image is "bad", it is not
412 rendered inline in wiki pages or galleries in category pages.
413
414 'BeforeGalleryFindFile': before an image is fetched for a gallery
415 &$gallery,: the gallery object
416 &$nt: the image title
417 &$time: image timestamp
418
419 'BeforePageDisplay': Prior to outputting a page
420 $out: OutputPage object
421
422 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
423 &$parser: Parser object
424 &$title: title of the template
425 &$skip: skip this template and link it?
426 &$id: the id of the revision being parsed
427
428 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
429 &$parser: Parser object
430 &$nt: the image title
431 &$skip: skip this image and link it?
432 &$time: the image timestamp
433
434 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
435 &$parser: Parser object
436 &$ig: ImageGallery object
437
438 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
439 $nondefaults: Assoc array with the following keys:
440 days, hideOwn, hideBots, hideMinor, namespace
441 $wgUser: wgUser.
442 &$hookSql: a string which will be inserted without sanitation into the SQL query
443 used to get the watchlist, at the end of the WHERE part.
444
445 'BlockIp': before an IP address or user is blocked
446 $block: the Block object about to be saved
447 $user: the user _doing_ the block (not the one being blocked)
448
449 'BlockIpComplete': after an IP address or user is blocked
450 $block: the Block object that was saved
451 $user: the user who did the block (not the one being blocked)
452
453 'BookInformation': Before information output on Special:Booksources
454 $isbn: ISBN to show information for
455 $output: OutputPage object in use
456
457 'CategoryPageView': before viewing a categorypage in CategoryPage::view
458 $catpage: CategoryPage instance
459
460 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
461 &$this: ChangesList instance.
462 &$articlelink: HTML of link to article (already filled-in).
463 &$s: HTML of row that is being constructed.
464 &$rc: RecentChange instance.
465 $unpatrolled: Whether or not we are showing unpatrolled changes.
466 $watched: Whether or not the change is watched by the user.
467
468 'ContributionsToolLinks': Change tool links above Special:Contributions
469 $id: User identifier
470 $title: User page title
471 &$tools: Array of tool links
472
473 'CustomEditor': When invoking the page editor
474 $article: Article being edited
475 $user: User performing the edit
476
477 Return true to allow the normal editor to be used, or false
478 if implementing a custom editor, e.g. for a special namespace,
479 etc.
480
481 'DiffViewHeader': called before diff display
482 $diff: DifferenceEngine object that's calling
483 $oldRev: Revision object of the "old" revision (may be null/invalid)
484 $newRev: Revision object of the "new" revision
485
486 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
487 $article: article (object) being viewed
488 $oldid: oldid (int) being viewed
489
490 'EditFilter': Perform checks on an edit
491 $editor: Edit form (see includes/EditPage.php)
492 $text: Contents of the edit box
493 $section: Section being edited
494 &$error: Error message to return
495
496 'EditFilterMerged': Post-section-merge edit filter
497 $editor: EditPage instance (object)
498 $text: content of the edit box
499 $error: error message to return
500
501 'EditFormPreloadText': Allows population of the edit form when creating new pages
502 &$text: Text to preload with
503 &$title: Title object representing the page being created
504
505 'EditPage::attemptSave': called before an article is
506 saved, that is before insertNewArticle() is called
507 &$editpage_Obj: the current EditPage object
508
509 'EditPage::showEditForm:fields': allows injection of form field into edit form
510 &$editor: the EditPage instance for reference
511 &$out: an OutputPage instance to write to
512 return value is ignored (should always return true)
513
514 'EditPage::showEditForm:initial': before showing the edit form
515 $editor: EditPage instance (object)
516
517 Return false to halt editing; you'll need to handle error messages, etc. yourself.
518 Alternatively, modifying $error and returning true will cause the contents of $error
519 to be echoed at the top of the edit form as wikitext. Return true without altering
520 $error to allow the edit to proceed.
521
522 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
523 &$editpage: The current EditPage object
524 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
525
526 'EditSectionLink': Override the return value of Linker::editSectionLink()
527 $skin: Skin rendering the UI
528 $title: Title being linked to
529 $section: Section to link to
530 $link: Default link
531 $result: Result (alter this to override the generated links)
532
533 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
534 $skin: Skin rendering the UI
535 $title: Title being linked to
536 $section: Section to link to
537 $hint: Anchor title/tooltip attributes
538 $link: Default link
539 $result: Result (alter this to override the generated links)
540
541 'EmailConfirmed': When checking that the user's email address is "confirmed"
542 $user: User being checked
543 $confirmed: Whether or not the email address is confirmed
544 This runs before the other checks, such as anonymity and the real check; return
545 true to allow those checks to occur, and false if checking is done.
546
547 'EmailUser': before sending email from one user to another
548 $to: address of receiving user
549 $from: address of sending user
550 $subject: subject of the mail
551 $text: text of the mail
552
553 'EmailUserComplete': after sending email from one user to another
554 $to: address of receiving user
555 $from: address of sending user
556 $subject: subject of the mail
557 $text: text of the mail
558
559 'FetchChangesList': When fetching the ChangesList derivative for a particular user
560 &$user: User the list is being fetched for
561 &$skin: Skin object to be used with the list
562 &$list: List object (defaults to NULL, change it to an object instance and return
563 false override the list derivative used)
564
565 'FileUpload': When a file upload occurs
566 $file : Image object representing the file that was uploaded
567
568 'GetBlockedStatus': after loading blocking status of an user from the database
569 $user: user (object) being checked
570
571 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
572 $title: Title object of page
573 $url: string value as output (out parameter, can modify)
574 $query: query options passed to Title::getFullURL()
575
576 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
577 $title: Title object of page
578 $url: string value as output (out parameter, can modify)
579 $query: query options passed to Title::getInternalURL()
580
581 'GetLinkColours': modify the CSS class of an array of page links
582 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
583 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
584
585 'GetLocalURL': modify local URLs as output into page links
586 $title: Title object of page
587 $url: string value as output (out parameter, can modify)
588 $query: query options passed to Title::getLocalURL()
589
590 'getUserPermissionsErrors': Add a permissions error when permissions errors are
591 checked for. Use instead of userCan for most cases. Return false if the
592 user can't do it, and populate $result with the reason in the form of
593 array( messagename, param1, param2, ... ). For consistency, error messages
594 should be plain text with no special coloring, bolding, etc. to show that
595 they're errors; presenting them properly to the user as errors is done by
596 the caller.
597 $title: Title object being checked against
598 $user : Current user object
599 $action: Action being checked
600 $result: User permissions error to add. If none, return true.
601
602 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
603 if expensive checks are enabled.
604
605 'ImageOpenShowImageInlineBefore': Call potential extension just before showing the image on an image page
606 $imagePage: ImagePage object ($this)
607 $output: $wgOut
608
609 'InitPreferencesForm': called at the end of PreferencesForm's constructor
610 $form: the PreferencesForm
611 $request: the web request to initialized from
612
613 'InternalParseBeforeLinks': during Parser's internalParse method before links but
614 after noinclude/includeonly/onlyinclude and other processing.
615 &$this: Parser object
616 &$text: string containing partially parsed text
617 &$this->mStripState: Parser's internal StripState object
618
619 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
620 $article: article (object) being checked
621
622 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
623 $ip: IP being check
624 $result: Change this value to override the result of wfIsTrustedProxy()
625
626 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
627 tance to return false if the domain name doesn't match your organization
628 $addr: The e-mail address entered by the user
629 &$result: Set this and return false to override the internal checks
630
631 'isValidPassword': Override the result of User::isValidPassword()
632 $password: The password entered by the user
633 &$result: Set this and return false to override the internal checks
634 $user: User the password is being validated for
635
636 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
637 $magicExtensions: associative array of magic words synonyms
638 $lang: laguage code (string)
639
640 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
641 $specialPageAliases: associative array of magic words synonyms
642 $lang: laguage code (string)
643
644 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
645 &$linksUpdate: the LinkUpdate object
646
647 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
648 &$linksUpdate: the LinkUpdate object
649
650 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
651 &$linksUpdate: the LinkUpdate object
652
653 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
654
655 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
656
657 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
658 No return data is accepted; this hook is for auditing only.
659 $user: the User object being authenticated against
660 $password: the password being submitted and found wanting
661 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
662
663 'LogLine': Processes a single log entry on Special:Log
664 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
665 database field.
666 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
667 to logging.log_action database field.
668 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
669 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
670 appears to contain anything.
671 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
672 &$revert: string that is displayed in the UI, similar to $comment.
673 $time: timestamp of the log entry (added in 1.12)
674
675 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
676 &$type: array of strings
677
678 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
679 &$typeText: array of strings
680
681 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
682 &$headerText: array of strings
683
684 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
685 &$actionText: array of strings
686
687 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
688 $magicWords: array of strings
689
690 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
691 $variableIDs: array of strings
692
693 'MarkPatrolled': before an edit is marked patrolled
694 $rcid: ID of the revision to be marked patrolled
695 $user: the user (object) marking the revision as patrolled
696 $wcOnlySysopsCanPatrol: config setting indicating whether the user
697 needs to be a sysop in order to mark an edit patrolled
698
699 'MarkPatrolledComplete': after an edit is marked patrolled
700 $rcid: ID of the revision marked as patrolled
701 $user: user (object) who marked the edit patrolled
702 $wcOnlySysopsCanPatrol: config setting indicating whether the user
703 must be a sysop to patrol the edit
704
705 'MathAfterTexvc': after texvc is executed when rendering mathematics
706 $mathRenderer: instance of MathRenderer
707 $errmsg: error message, in HTML (string). Nonempty indicates failure
708 of rendering the formula
709
710 'MediaWikiPerformAction': Override MediaWiki::performAction().
711 Use this to do something completely different, after the basic
712 globals have been set up, but before ordinary actions take place.
713 $output: $wgOut
714 $article: $wgArticle
715 $title: $wgTitle
716 $user: $wgUser
717 $request: $wgRequest
718
719 'MessagesPreLoad': When loading a message from the database
720 $title: title of the message (string)
721 $message: value (string), change it to the message you want to define
722
723 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
724 $tools: array of tools
725
726 'OutputPageBeforeHTML': a page has been processed by the parser and
727 the resulting HTML is about to be displayed.
728 $parserOutput: the parserOutput (object) that corresponds to the page
729 $text: the text that will be displayed, in HTML (string)
730
731 'OutputPageParserOutput': after adding a parserOutput to $wgOut
732 $out: OutputPage instance (object)
733 $parserOutput: parserOutput instance being added in $out
734
735 'PageHistoryBeforeList': When a history page list is about to be constructed.
736 $article: the article that the history is loading for
737
738 'PageHistoryLineEnding' : right before the end <li> is added to a history line
739 $row: the revision row for this line
740 $s: the string representing this parsed line
741
742 'PageRenderingHash': alter the parser cache option hash key
743 A parser extension which depends on user options should install
744 this hook and append its values to the key.
745 $hash: reference to a hash key string which can be modified
746
747 'ParserAfterStrip': Same as ParserBeforeStrip
748
749 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
750 $parser: Parser object being used
751 $text: text that'll be returned
752
753 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
754 $parser: Parser object
755 $text: text to parse
756 $stripState: StripState instance being used
757
758 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
759 $parser: parser object
760 $text: text being parsed
761 $stripState: stripState used (object)
762
763 'ParserBeforeTidy': called before tidy and custom tags replacements
764 $parser: Parser object being used
765 $text: actual text
766
767 'ParserClearState': called at the end of Parser::clearState()
768 $parser: Parser object being cleared
769
770 'ParserFirstCallInit': called when the ther parser initialises for the first time
771 $parser: Parser object being cleared
772
773 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
774 $parser: Parser object
775 $varCache: array to store the value in case of multiples calls of the same magic word
776 $index: index (string) of the magic
777 $ret: value of the magic word (the hook should set it)
778
779 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
780 $parser: Parser object
781 $time: actual time (timestamp)
782
783 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
784 $parser: Parser object
785 $varCache: varaiable cache (array)
786
787 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
788 $parser: Parser object
789 $limitReport: text that will be included (without comment tags)
790
791 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
792 $parser: Parser object created
793
794 'ParserTestTables': alter the list of tables to duplicate when parser tests
795 are run. Use when page save hooks require the presence of custom tables
796 to ensure that tests continue to run properly.
797 &$tables: array of table names
798
799 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
800 my talk page, my contributions" etc).
801
802 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
803 &$title: Title object representing the current page
804
805 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
806 &$user : User performing the action
807 $action : Action being performed
808 &$result : Whether or not the action should be prevented
809 Change $result and return false to give a definitive answer, otherwise
810 the built-in rate limiting checks are used, if enabled.
811
812 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
813 $form : PreferencesForm object
814 &$html : HTML to append to
815
816 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
817 AJAX search suggestions. Put results into &$results outparam and return false.
818 $ns : int namespace key to search in
819 $search : search term (not guaranteed to be conveniently normalized)
820 $limit : maximum number of results to return
821 &$results : out param: array of page names (strings)
822
823 'PrefsEmailAudit': called when user changes his email address
824 $user: User (object) changing his email address
825 $oldaddr: old email address (string)
826 $newaddr: new email address (string)
827
828 'PrefsPasswordAudit': called when user changes his password
829 $user: User (object) changing his passoword
830 $newPass: new password
831 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
832
833 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
834 &$obj: RawPage object
835 &$text: The text that's going to be the output
836
837 'RecentChange_save': called at the end of RecenChange::save()
838 $recentChange: RecentChange object
839
840 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
841 $form: the PreferencesForm
842 $out: output page to render to, probably $wgOut
843
844 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
845 $form: the PreferencesForm
846 $user: the User object to load preferences from
847
848 'SavePreferences': called at the end of PreferencesForm::savePreferences;
849 returning false prevents the preferences from being saved.
850 $form: the PreferencesForm
851 $user: the User object to save preferences to
852 $message: change this to set an error message (ignored if the hook does notreturn fals)
853
854 'SearchUpdate': Prior to search update completion
855 $id : Page id
856 $namespace : Page namespace
857 $title : Page title
858 $text : Current text being indexed
859
860 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
861 $term : Search term string
862 &$title : Outparam; set to $title object and return false for a match
863
864 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
865 $text: Text being shown
866 $title: Title of the custom script/stylesheet page
867 $output: Current OutputPage object
868
869 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
870 &$siteNotice: HTML returned as the sitenotice
871 Return true to allow the normal method of notice selection/rendering to work,
872 or change the value of $siteNotice and return false to alter it.
873
874 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
875 &$siteNotice: HTML sitenotice
876 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
877
878 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
879 $skin: Skin object
880 &$text: bottomScripts Text
881 Append to $text to add additional text/scripts after the stock bottom scripts.
882
883 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
884 $skin: Skin object
885 &$subpages: Subpage links HTML
886 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
887 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
888
889 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
890 $sktemplate: SkinTemplate object
891 $content_actions: array of tabs
892
893 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
894 $sktemplate: SkinTemplate object
895 $nav_urls: array of tabs
896
897 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
898 &$content_actions: Content actions
899 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
900 for an example]
901
902 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
903 &$sktemplate: SkinTemplate object
904 &$tpl: Template engine object
905
906 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
907 $sktemplate: SkinTemplate object
908 $res: set to true to prevent active tabs
909
910 'SkinTemplateSetupPageCss': use this to provide per-page CSS
911 $out: Css to return
912
913 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
914 You can either create your own array, or alter the parameters for the normal one.
915 &$this: The SkinTemplate instance.
916 $title: Title instance for the page.
917 $message: Visible label of tab.
918 $selected: Whether this is a selected tab.
919 $checkEdit: Whether or not the action=edit query should be added if appropriate.
920 &$classes: Array of CSS classes to apply.
921 &$query: Query string to add to link.
922 &$text: Link text.
923 &$result: Complete assoc. array if you want to return true.
924
925 'SkinTemplateTabs': called when finished to build the actions tabs
926 $sktemplate: SkinTemplate object
927 $content_actions: array of tabs
928
929 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
930 $id: User identifier
931
932 'SpecialMovepageAfterMove': called after moving a page
933 $movePage: MovePageForm object
934 $oldTitle: old title (object)
935 $newTitle: new title (object)
936
937 'SpecialPageExecuteAfterPage': called after executing a special page
938 Warning: Not all the special pages call this hook
939 $specialPage: SpecialPage object
940 $par: paramter passed to the special page (string)
941 $funct: function called to execute the special page
942
943 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
944 Warning: Not all the special pages call this hook
945 $specialPage: SpecialPage object
946 $par: paramter passed to the special page (string)
947 $funct: function called to execute the special page
948
949 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
950 Warning: Not all the special pages call this hook
951 $specialPage: SpecialPage object
952 $par: paramter passed to the special page (string)
953 $funct: function called to execute the special page
954
955 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
956 $list: list (array) of core special pages
957
958 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
959 $title: title object generated from the text entred by the user
960
961 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
962 $extTypes: associative array of extensions types
963
964 'TitleMoveComplete': after moving an article (title)
965 $old: old title
966 $nt: new title
967 $user: user who did the move
968 $pageid: database ID of the page that's been moved
969 $redirid: database ID of the created redirect
970
971 'UndeleteShowRevision': called when showing a revision in Special:Undelete
972 $title: title object related to the revision
973 $rev: revision (object) that will be viewed
974
975 'UnknownAction': An unknown "action" has occured (useful for defining
976 your own actions)
977 $action: action name
978 $article: article "acted on"
979
980 'UnwatchArticle': before a watch is removed from an article
981 $user: user watching
982 $article: article object to be removed
983
984 'UnwatchArticle': after a watch is removed from an article
985 $user: user that was watching
986 $article: article object removed
987
988 'UnwatchArticleComplete': after a watch is removed from an article
989 $user: user that watched
990 $article: article object that was watched
991
992 'UploadForm:initial': before the upload form is generated
993 $form: UploadForm object
994 You might set the member-variables $uploadFormTextTop and
995 $uploadFormTextAfterSummary to inject text (HTML) either before
996 or after the editform.
997
998 'UploadForm:BeforeProcessing': at the beginning of processUpload()
999 $form: UploadForm object
1000 Lets you poke at member variables like $mUploadDescription before the
1001 file is saved.
1002
1003 'UploadVerification': additional chances to reject an uploaded file
1004 string $saveName: destination file name
1005 string $tempName: filesystem path to the temporary file for checks
1006 string &$error: output: HTML error to show if upload canceled by returning false
1007
1008 'UploadComplete': Upon completion of a file upload
1009 $image: Image object representing the file that was uploaded
1010
1011 'userCan': To interrupt/advise the "user can do X to Y article" check.
1012 If you want to display an error message, try getUserPermissionsErrors.
1013 $title: Title object being checked against
1014 $user : Current user object
1015 $action: Action being checked
1016 $result: Pointer to result returned if hook returns false. If null is returned,
1017 userCan checks are continued by internal code.
1018
1019 'UserCanSendEmail': To override User::canSendEmail() permission check
1020 $user: User (object) whose permission is being checked
1021 &$canSend: bool set on input, can override on output
1022
1023
1024 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1025 $user: User (object) that'll clear the message
1026
1027 'UserCreateForm': change to manipulate the login form
1028 $template: SimpleTemplate instance for the form
1029
1030 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1031 $user: User to get groups for
1032 &$groups: Current effective groups
1033
1034 'UserLoginComplete': after a user has logged in
1035 $user: the user object that was created on login
1036
1037 'UserLoginForm': change to manipulate the login form
1038 $template: SimpleTemplate instance for the form
1039
1040 'UserLogout': before a user logs out
1041 $user: the user object that is about to be logged out
1042
1043 'UserLogoutComplete': after a user has logged out
1044 $user: the user object _after_ logout (won't have name, ID, etc.)
1045
1046 'UserRights': After a user's group memberships are changed
1047 $user : User object that was changed
1048 $add : Array of strings corresponding to groups added
1049 $remove: Array of strings corresponding to groups removed
1050
1051 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1052 &$groups: List of implicit (automatically-assigned) groups
1053
1054 'UserGetRights': Called in User::getRights()
1055 $user: User to get rights for
1056 &$rights: Current rights
1057
1058 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1059 $user: user retrieving new talks messages
1060 $talks: array of new talks page(s)
1061
1062 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1063 $toggles: array of toggles to add
1064
1065 'WatchArticle': before a watch is added to an article
1066 $user: user that will watch
1067 $article: article object to be watched
1068
1069 'WatchArticleComplete': after a watch is added to an article
1070 $user: user that watched
1071 $article: article object watched
1072
1073 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1074 $query: $wgQueryPages itself
1075
1076 More hooks might be available but undocumented, you can execute
1077 ./maintenance/findhooks.php to find hidden one.