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.
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'.
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
22 The function part of a hook.
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.
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):
38 function showAnArticle($article) {
39 global $wgReverseTitle, $wgCapitalizeTitle;
41 if ($wgReverseTitle) {
42 wfReverseTitle($article);
45 if ($wgCapitalizeTitle) {
46 wfCapitalizeTitle($article);
49 # code to actually show the article goes here
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:
56 function showAnArticle($article) {
57 global $wgReverseTitle, $wgCapitalizeTitle;
59 if ($wgReverseTitle) {
60 wfReverseTitle($article);
63 if ($wgCapitalizeTitle) {
64 wfCapitalizeTitle($article);
67 # code to actually show the article goes here
69 if ($wgNotifyArticle) {
70 wfNotifyArticleShow($article));
74 Using a hook-running strategy, we can avoid having all this
75 option-specific stuff in our mainline code. Using hooks, the function
78 function showAnArticle($article) {
80 if (wfRunHooks('ArticleShow', array(&$article))) {
82 # code to actually show the article goes here
84 wfRunHooks('ArticleShowComplete', array(&$article));
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.
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:
99 function reverseArticleTitle($article) {
103 function reverseForExport($article) {
107 The setup function for the extension just has to add its hook
108 functions to the appropriate events:
110 setupTitleReversingExtension() {
113 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
114 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
115 $wgHooks['ArticleExport'][] = 'reverseForExport';
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.
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
127 require_once('extensions/ReverseTitle.php');
129 ...to their LocalSettings.php file; those of us who don't want or need
130 it can just leave it out.
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
138 A hook is a chunk of code run at some particular event. It consists of:
140 * a function with some optional accompanying data, or
141 * an object with a method and some optional accompanying data.
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:
146 $wgHooks['EventName'][] = 'someFunction'; # function, no data
147 $wgHooks['EventName'][] = array('someFunction', $someData);
148 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
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
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:
161 someFunction($param1, $param2)
163 someFunction($someData, $param1, $param2)
166 $object->onEventName($param1, $param2)
168 $object->someMethod($param1, $param2)
169 # object with method and data
170 $object->someMethod($someData, $param1, $param2)
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.
176 The extra data is useful if we want to use the same function or object
177 for different purposes. For example:
179 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
180 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
182 This code would result in ircNotify being run twice when an article is
183 saved: once for 'TimStarling', and once for 'brion'.
185 Hooks can return three possible values:
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
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
198 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
200 function ldapLogin($username, $password) {
205 Returning false makes less sense for events where the action is
206 complete, and will normally be ignored.
210 A calling function or method uses the wfRunHooks() function to run
211 the hooks related to a particular event, like so:
217 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
218 # protect the article
219 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
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.
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.
236 ==Events and parameters==
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.
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.
248 'AbortMove': allows to abort moving an article (title)
251 $user: user who is doing the move
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
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)
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; ).
266 'AlternateEdit': before checking if an user can edit a page and
267 before showing the edit form ( EditPage::edit() ). This is triggered
269 $EditPage : the EditPage object
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
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
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
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
293 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
294 $article: article (object) of the user talk page
296 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
297 $article: article (object) being modified
299 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
300 $title: title (object) used to create the article object
301 $article: article (object) that will be returned
303 'ArticleInsertComplete': After an article is created
304 $article: Article created
305 $user: User creating the article
307 $summary: Edit summary/comment
308 $isMinor: Whether or not the edit was marked as minor
309 $isWatch: (No longer used)
310 $section: (No longer used)
311 $flags: Flags passed to Article::doEdit()
312 $revision: New Revision of the article
314 'ArticleMergeComplete': after merging to article using Special:Mergehistory
315 $targetTitle: target title (object)
316 $destTitle: destination title (object)
318 'ArticlePageDataAfter': after loading data of an article from the database
319 $article: article (object) whose data were loaded
320 $row: row (object) returned from the database server
322 'ArticlePageDataBefore': before loading data of an article from the database
323 $article: article (object) that data will be loaded
324 $fields: fileds (array) to load from the database
326 'ArticleProtect': before an article is protected
327 $article: the article being protected
328 $user: the user doing the protection
329 $protect: boolean whether this is a protect or an unprotect
330 $reason: Reason for protect
331 $moveonly: boolean whether this is for move only or not
333 'ArticleProtectComplete': after an article is protected
334 $article: the article that was protected
335 $user: the user who did the protection
336 $protect: boolean whether it was a protect or an unprotect
337 $reason: Reason for protect
338 $moveonly: boolean whether it was for move only or not
340 'ArticlePurge': before executing "&action=purge"
341 $article: article (object) to purge
343 'ArticleRevisionUndeleted' after an article revision is restored
344 $title: the article title
345 $revision: the revision
346 $oldPageID: the page ID of the revision when archived (may be null)
348 'ArticleRollbackComplete': after an article rollback is completed
349 $article: the article that was edited
350 $user: the user who did the rollback
351 $revision: the revision the page was reverted back to
353 'ArticleSave': before an article is saved
354 $article: the article (object) being saved
355 $user: the user (object) saving the article
356 $text: the new article text
357 $summary: the article summary (comment)
362 'ArticleSaveComplete': After an article has been updated
363 $article: Article modified
364 $user: User performing the modification
366 $summary: Edit summary/comment
367 $isMinor: Whether or not the edit was marked as minor
368 $isWatch: (No longer used)
369 $section: (No longer used)
370 $flags: Flags passed to Article::doEdit()
371 $revision: New Revision of the article
373 'ArticleSaveComplete': after an article is saved
374 $article: the article (object) saved
375 $user: the user (object) who saved the article
376 $text: the new article text
377 $summary: the article summary (comment)
382 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
384 'ArticleUndelete': When one or more revisions of an article are restored
385 $title: Title corresponding to the article restored
386 $create: Whether or not the restoration caused the page to be created
387 (i.e. it didn't exist before)
389 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
390 &$article: the article
391 &$sectionanchor: The section anchor link (e.g. "#overview" )
392 &$extraq: Extra query parameters which can be added via hooked functions
394 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
395 &$article: the article
396 &$pcache: whether to try the parser cache or not
397 &$outputDone: whether the output for this page finished or not
399 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
400 $article: target article (object)
402 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
403 Gives a chance for an extension to set it programattically to a variable class.
404 &$auth: the $wgAuth object, probably a stub
406 'AutoAuthenticate': called to authenticate users on external/environmental means
407 $user: writes user object to this parameter
409 'AutopromoteCondition': check autopromote condition for user.
410 $type: condition type
413 $result: result of checking autopromote condition
415 'BadImage': When checking against the bad image list
416 $name: Image name being checked
417 &$bad: Whether or not the image is "bad"
419 Change $bad and return false to override. If an image is "bad", it is not
420 rendered inline in wiki pages or galleries in category pages.
422 'BeforeGalleryFindFile': before an image is fetched for a gallery
423 &$gallery,: the gallery object
424 &$nt: the image title
425 &$time: image timestamp
427 'BeforePageDisplay': Prior to outputting a page
428 $out: OutputPage object
430 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
431 &$parser: Parser object
432 &$title: title of the template
433 &$skip: skip this template and link it?
434 &$id: the id of the revision being parsed
436 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
437 &$parser: Parser object
438 &$nt: the image title
439 &$skip: skip this image and link it?
440 &$time: the image timestamp
442 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
443 &$parser: Parser object
444 &$ig: ImageGallery object
446 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
447 $nondefaults: Assoc array with the following keys:
448 days, hideOwn, hideBots, hideMinor, namespace
450 &$hookSql: a string which will be inserted without sanitation into the SQL query
451 used to get the watchlist, at the end of the WHERE part.
453 'BlockIp': before an IP address or user is blocked
454 $block: the Block object about to be saved
455 $user: the user _doing_ the block (not the one being blocked)
457 'BlockIpComplete': after an IP address or user is blocked
458 $block: the Block object that was saved
459 $user: the user who did the block (not the one being blocked)
461 'BookInformation': Before information output on Special:Booksources
462 $isbn: ISBN to show information for
463 $output: OutputPage object in use
465 'CategoryPageView': before viewing a categorypage in CategoryPage::view
466 $catpage: CategoryPage instance
468 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
469 &$this: ChangesList instance.
470 &$articlelink: HTML of link to article (already filled-in).
471 &$s: HTML of row that is being constructed.
472 &$rc: RecentChange instance.
473 $unpatrolled: Whether or not we are showing unpatrolled changes.
474 $watched: Whether or not the change is watched by the user.
476 'ContributionsToolLinks': Change tool links above Special:Contributions
478 $title: User page title
479 &$tools: Array of tool links
481 'CustomEditor': When invoking the page editor
482 $article: Article being edited
483 $user: User performing the edit
485 Return true to allow the normal editor to be used, or false
486 if implementing a custom editor, e.g. for a special namespace,
489 'DiffViewHeader': called before diff display
490 $diff: DifferenceEngine object that's calling
491 $oldRev: Revision object of the "old" revision (may be null/invalid)
492 $newRev: Revision object of the "new" revision
494 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
495 $article: article (object) being viewed
496 $oldid: oldid (int) being viewed
498 'EditFilter': Perform checks on an edit
499 $editor: Edit form (see includes/EditPage.php)
500 $text: Contents of the edit box
501 $section: Section being edited
502 &$error: Error message to return
504 'EditFilterMerged': Post-section-merge edit filter
505 $editor: EditPage instance (object)
506 $text: content of the edit box
507 $error: error message to return
509 'EditFormPreloadText': Allows population of the edit form when creating new pages
510 &$text: Text to preload with
511 &$title: Title object representing the page being created
513 'EditPage::attemptSave': called before an article is
514 saved, that is before insertNewArticle() is called
515 &$editpage_Obj: the current EditPage object
517 'EditPage::showEditForm:fields': allows injection of form field into edit form
518 &$editor: the EditPage instance for reference
519 &$out: an OutputPage instance to write to
520 return value is ignored (should always return true)
522 'EditPage::showEditForm:initial': before showing the edit form
523 $editor: EditPage instance (object)
525 Return false to halt editing; you'll need to handle error messages, etc. yourself.
526 Alternatively, modifying $error and returning true will cause the contents of $error
527 to be echoed at the top of the edit form as wikitext. Return true without altering
528 $error to allow the edit to proceed.
530 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
531 &$editpage: The current EditPage object
532 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
534 'EditSectionLink': Override the return value of Linker::editSectionLink()
535 $skin: Skin rendering the UI
536 $title: Title being linked to
537 $section: Section to link to
539 $result: Result (alter this to override the generated links)
541 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
542 $skin: Skin rendering the UI
543 $title: Title being linked to
544 $section: Section to link to
545 $hint: Anchor title/tooltip attributes
547 $result: Result (alter this to override the generated links)
549 'EmailConfirmed': When checking that the user's email address is "confirmed"
550 $user: User being checked
551 $confirmed: Whether or not the email address is confirmed
552 This runs before the other checks, such as anonymity and the real check; return
553 true to allow those checks to occur, and false if checking is done.
555 'EmailUser': before sending email from one user to another
556 $to: address of receiving user
557 $from: address of sending user
558 $subject: subject of the mail
559 $text: text of the mail
561 'EmailUserComplete': after sending email from one user to another
562 $to: address of receiving user
563 $from: address of sending user
564 $subject: subject of the mail
565 $text: text of the mail
567 'FetchChangesList': When fetching the ChangesList derivative for a particular user
568 &$user: User the list is being fetched for
569 &$skin: Skin object to be used with the list
570 &$list: List object (defaults to NULL, change it to an object instance and return
571 false override the list derivative used)
573 'FileDeleteComplete': When a file is deleted
574 $file: reference to the deleted file
575 $oldimage: in case of the deletion of an old image, the name of the old file
576 $article: in case all revisions of the file are deleted a reference to the article
577 associated with the file.
578 $user: user who performed the deletion
581 'FileUpload': When a file upload occurs
582 $file : Image object representing the file that was uploaded
584 'FileUndeleteComplete': When a file is undeleted
585 $title: title object to the file
586 $fileVersions: array of undeleted versions. Empty if all versions were restored
587 $user: user who performed the undeletion
590 'GetBlockedStatus': after loading blocking status of an user from the database
591 $user: user (object) being checked
593 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
594 $title: Title object of page
595 $url: string value as output (out parameter, can modify)
596 $query: query options passed to Title::getFullURL()
598 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
599 $title: Title object of page
600 $url: string value as output (out parameter, can modify)
601 $query: query options passed to Title::getInternalURL()
603 'GetLinkColours': modify the CSS class of an array of page links
604 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
605 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
607 'GetLocalURL': modify local URLs as output into page links
608 $title: Title object of page
609 $url: string value as output (out parameter, can modify)
610 $query: query options passed to Title::getLocalURL()
612 'getUserPermissionsErrors': Add a permissions error when permissions errors are
613 checked for. Use instead of userCan for most cases. Return false if the
614 user can't do it, and populate $result with the reason in the form of
615 array( messagename, param1, param2, ... ). For consistency, error messages
616 should be plain text with no special coloring, bolding, etc. to show that
617 they're errors; presenting them properly to the user as errors is done by
619 $title: Title object being checked against
620 $user : Current user object
621 $action: Action being checked
622 $result: User permissions error to add. If none, return true.
624 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
625 if expensive checks are enabled.
627 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
628 the image on an image page
629 $imagePage: ImagePage object ($this)
632 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
633 image insertion. You can skip the default logic entirely by returning
634 false, or just modify a few things using call-by-reference.
636 &$title: Title object of the image
637 &$file: File object, or false if it doesn't exist
638 &$frameParams: Various parameters with special meanings; see documentation in
639 includes/Linker.php for Linker::makeImageLink2
640 &$handlerParams: Various parameters with special meanings; see documentation in
641 includes/Linker.php for Linker::makeImageLink2
642 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
643 &$res: Final HTML output, used if you return false
645 'InitPreferencesForm': called at the end of PreferencesForm's constructor
646 $form: the PreferencesForm
647 $request: the web request to initialized from
649 'InternalParseBeforeLinks': during Parser's internalParse method before links but
650 after noinclude/includeonly/onlyinclude and other processing.
651 &$this: Parser object
652 &$text: string containing partially parsed text
653 &$this->mStripState: Parser's internal StripState object
655 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
656 $article: article (object) being checked
658 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
660 $result: Change this value to override the result of wfIsTrustedProxy()
662 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
663 tance to return false if the domain name doesn't match your organization
664 $addr: The e-mail address entered by the user
665 &$result: Set this and return false to override the internal checks
667 'isValidPassword': Override the result of User::isValidPassword()
668 $password: The password entered by the user
669 &$result: Set this and return false to override the internal checks
670 $user: User the password is being validated for
672 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
673 $magicExtensions: associative array of magic words synonyms
674 $lang: laguage code (string)
676 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
677 $specialPageAliases: associative array of magic words synonyms
678 $lang: laguage code (string)
680 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
681 &$linksUpdate: the LinkUpdate object
683 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
684 &$linksUpdate: the LinkUpdate object
686 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
687 &$linksUpdate: the LinkUpdate object
689 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
691 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
693 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
694 No return data is accepted; this hook is for auditing only.
695 $user: the User object being authenticated against
696 $password: the password being submitted and found wanting
697 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
699 'LogLine': Processes a single log entry on Special:Log
700 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
702 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
703 to logging.log_action database field.
704 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
705 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
706 appears to contain anything.
707 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
708 &$revert: string that is displayed in the UI, similar to $comment.
709 $time: timestamp of the log entry (added in 1.12)
711 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
712 &$type: array of strings
714 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
715 &$typeText: array of strings
717 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
718 &$headerText: array of strings
720 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
721 &$actionText: array of strings
723 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
724 $magicWords: array of strings
726 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
727 $variableIDs: array of strings
729 'MarkPatrolled': before an edit is marked patrolled
730 $rcid: ID of the revision to be marked patrolled
731 $user: the user (object) marking the revision as patrolled
732 $wcOnlySysopsCanPatrol: config setting indicating whether the user
733 needs to be a sysop in order to mark an edit patrolled
735 'MarkPatrolledComplete': after an edit is marked patrolled
736 $rcid: ID of the revision marked as patrolled
737 $user: user (object) who marked the edit patrolled
738 $wcOnlySysopsCanPatrol: config setting indicating whether the user
739 must be a sysop to patrol the edit
741 'MathAfterTexvc': after texvc is executed when rendering mathematics
742 $mathRenderer: instance of MathRenderer
743 $errmsg: error message, in HTML (string). Nonempty indicates failure
744 of rendering the formula
746 'MediaWikiPerformAction': Override MediaWiki::performAction().
747 Use this to do something completely different, after the basic
748 globals have been set up, but before ordinary actions take place.
755 'MessagesPreLoad': When loading a message from the database
756 $title: title of the message (string)
757 $message: value (string), change it to the message you want to define
759 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
760 $tools: array of tools
762 'OutputPageBeforeHTML': a page has been processed by the parser and
763 the resulting HTML is about to be displayed.
764 $parserOutput: the parserOutput (object) that corresponds to the page
765 $text: the text that will be displayed, in HTML (string)
767 'OutputPageParserOutput': after adding a parserOutput to $wgOut
768 $out: OutputPage instance (object)
769 $parserOutput: parserOutput instance being added in $out
771 'PageHistoryBeforeList': When a history page list is about to be constructed.
772 $article: the article that the history is loading for
774 'PageHistoryLineEnding' : right before the end <li> is added to a history line
775 $row: the revision row for this line
776 $s: the string representing this parsed line
778 'PageRenderingHash': alter the parser cache option hash key
779 A parser extension which depends on user options should install
780 this hook and append its values to the key.
781 $hash: reference to a hash key string which can be modified
783 'ParserAfterStrip': Same as ParserBeforeStrip
785 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
786 $parser: Parser object being used
787 $text: text that'll be returned
789 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
790 $parser: Parser object
792 $stripState: StripState instance being used
794 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
795 $parser: parser object
796 $text: text being parsed
797 $stripState: stripState used (object)
799 'ParserBeforeTidy': called before tidy and custom tags replacements
800 $parser: Parser object being used
803 'ParserClearState': called at the end of Parser::clearState()
804 $parser: Parser object being cleared
806 'ParserFirstCallInit': called when the parser initialises for the first time
807 &$parser: Parser object being cleared
809 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
810 $parser: Parser object
811 $varCache: array to store the value in case of multiples calls of the same magic word
812 $index: index (string) of the magic
813 $ret: value of the magic word (the hook should set it)
815 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
816 $parser: Parser object
817 $time: actual time (timestamp)
819 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
820 $parser: Parser object
821 $varCache: varaiable cache (array)
823 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
824 $parser: Parser object
825 $limitReport: text that will be included (without comment tags)
827 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
828 $title: title object representing the file
829 $file: file object that will be used to create the image
830 &$params: 2-D array of parameters
832 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
833 $parser: Parser object created
835 'ParserTestTables': alter the list of tables to duplicate when parser tests
836 are run. Use when page save hooks require the presence of custom tables
837 to ensure that tests continue to run properly.
838 &$tables: array of table names
840 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
841 my talk page, my contributions" etc).
843 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
844 &$title: Title object representing the current page
846 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
847 &$user : User performing the action
848 $action : Action being performed
849 &$result : Whether or not the action should be prevented
850 Change $result and return false to give a definitive answer, otherwise
851 the built-in rate limiting checks are used, if enabled.
853 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
854 $form : PreferencesForm object
855 &$html : HTML to append to
857 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
858 AJAX search suggestions. Put results into &$results outparam and return false.
859 $ns : int namespace key to search in
860 $search : search term (not guaranteed to be conveniently normalized)
861 $limit : maximum number of results to return
862 &$results : out param: array of page names (strings)
864 'PrefsEmailAudit': called when user changes his email address
865 $user: User (object) changing his email address
866 $oldaddr: old email address (string)
867 $newaddr: new email address (string)
869 'PrefsPasswordAudit': called when user changes his password
870 $user: User (object) changing his passoword
871 $newPass: new password
872 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
874 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
875 &$obj: RawPage object
876 &$text: The text that's going to be the output
878 'RecentChange_save': called at the end of RecenChange::save()
879 $recentChange: RecentChange object
881 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
882 $form: the PreferencesForm
883 $out: output page to render to, probably $wgOut
885 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
886 $form: the PreferencesForm
887 $user: the User object to load preferences from
889 'SavePreferences': called at the end of PreferencesForm::savePreferences;
890 returning false prevents the preferences from being saved.
891 $form: the PreferencesForm
892 $user: the User object to save preferences to
893 $message: change this to set an error message (ignored if the hook does notreturn fals)
895 'SearchUpdate': Prior to search update completion
897 $namespace : Page namespace
899 $text : Current text being indexed
901 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
902 $term : Search term string
903 &$title : Outparam; set to $title object and return false for a match
905 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
906 $text: Text being shown
907 $title: Title of the custom script/stylesheet page
908 $output: Current OutputPage object
910 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
911 &$siteNotice: HTML returned as the sitenotice
912 Return true to allow the normal method of notice selection/rendering to work,
913 or change the value of $siteNotice and return false to alter it.
915 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
916 &$siteNotice: HTML sitenotice
917 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
919 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
921 &$text: bottomScripts Text
922 Append to $text to add additional text/scripts after the stock bottom scripts.
924 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
926 &$subpages: Subpage links HTML
927 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
928 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
930 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
931 $sktemplate: SkinTemplate object
932 $content_actions: array of tabs
934 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
935 $sktemplate: SkinTemplate object
936 $nav_urls: array of tabs
938 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
939 &$content_actions: Content actions
940 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
943 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
944 &$sktemplate: SkinTemplate object
945 &$tpl: Template engine object
947 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
948 $sktemplate: SkinTemplate object
949 $res: set to true to prevent active tabs
951 'SkinTemplateSetupPageCss': use this to provide per-page CSS
954 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
955 You can either create your own array, or alter the parameters for the normal one.
956 &$this: The SkinTemplate instance.
957 $title: Title instance for the page.
958 $message: Visible label of tab.
959 $selected: Whether this is a selected tab.
960 $checkEdit: Whether or not the action=edit query should be added if appropriate.
961 &$classes: Array of CSS classes to apply.
962 &$query: Query string to add to link.
964 &$result: Complete assoc. array if you want to return true.
966 'SkinTemplateTabs': called when finished to build the actions tabs
967 $sktemplate: SkinTemplate object
968 $content_actions: array of tabs
970 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
973 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
974 $pager: The UsersPager instance
975 $query: The query array to be returned
977 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
978 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
979 $row: Database row object
981 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
982 $pager: The UsersPager instance
983 $out: The header HTML
985 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
986 $pager: The UsersPager instance
987 $out: The header HTML
989 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
990 $pager: The UsersPager instance
991 $query: The query array to be returned
993 'SpecialMovepageAfterMove': called after moving a page
994 $movePage: MovePageForm object
995 $oldTitle: old title (object)
996 $newTitle: new title (object)
998 'SpecialPageExecuteAfterPage': called after executing a special page
999 Warning: Not all the special pages call this hook
1000 $specialPage: SpecialPage object
1001 $par: paramter passed to the special page (string)
1002 $funct: function called to execute the special page
1004 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1005 Warning: Not all the special pages call this hook
1006 $specialPage: SpecialPage object
1007 $par: paramter passed to the special page (string)
1008 $funct: function called to execute the special page
1010 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1011 Warning: Not all the special pages call this hook
1012 $specialPage: SpecialPage object
1013 $par: paramter passed to the special page (string)
1014 $funct: function called to execute the special page
1016 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1017 $list: list (array) of core special pages
1019 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1020 $title: title object generated from the text entred by the user
1022 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1023 $extTypes: associative array of extensions types
1025 'TitleMoveComplete': after moving an article (title)
1028 $user: user who did the move
1029 $pageid: database ID of the page that's been moved
1030 $redirid: database ID of the created redirect
1032 'TitleSecureAndSplit': At the end of Title::secureAndSplit()
1033 $title: The Title object
1036 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1037 $title: title object related to the revision
1038 $rev: revision (object) that will be viewed
1040 'UnknownAction': An unknown "action" has occured (useful for defining
1042 $action: action name
1043 $article: article "acted on"
1045 'UnwatchArticle': before a watch is removed from an article
1046 $user: user watching
1047 $article: article object to be removed
1049 'UnwatchArticle': after a watch is removed from an article
1050 $user: user that was watching
1051 $article: article object removed
1053 'UnwatchArticleComplete': after a watch is removed from an article
1054 $user: user that watched
1055 $article: article object that was watched
1057 'UploadForm:initial': before the upload form is generated
1058 $form: UploadForm object
1059 You might set the member-variables $uploadFormTextTop and
1060 $uploadFormTextAfterSummary to inject text (HTML) either before
1061 or after the editform.
1063 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1064 $form: UploadForm object
1065 Lets you poke at member variables like $mUploadDescription before the
1068 'UploadVerification': additional chances to reject an uploaded file
1069 string $saveName: destination file name
1070 string $tempName: filesystem path to the temporary file for checks
1071 string &$error: output: HTML error to show if upload canceled by returning false
1073 'UploadComplete': Upon completion of a file upload
1074 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1076 'userCan': To interrupt/advise the "user can do X to Y article" check.
1077 If you want to display an error message, try getUserPermissionsErrors.
1078 $title: Title object being checked against
1079 $user : Current user object
1080 $action: Action being checked
1081 $result: Pointer to result returned if hook returns false. If null is returned,
1082 userCan checks are continued by internal code.
1084 'UserCanSendEmail': To override User::canSendEmail() permission check
1085 $user: User (object) whose permission is being checked
1086 &$canSend: bool set on input, can override on output
1089 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1090 $user: User (object) that'll clear the message
1092 'UserCreateForm': change to manipulate the login form
1093 $template: SimpleTemplate instance for the form
1095 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1096 $user: User to get groups for
1097 &$groups: Current effective groups
1099 'UserLoginComplete': after a user has logged in
1100 $user: the user object that was created on login
1102 'UserLoginForm': change to manipulate the login form
1103 $template: SimpleTemplate instance for the form
1105 'UserLogout': before a user logs out
1106 $user: the user object that is about to be logged out
1108 'UserLogoutComplete': after a user has logged out
1109 $user: the user object _after_ logout (won't have name, ID, etc.)
1111 'UserRights': After a user's group memberships are changed
1112 $user : User object that was changed
1113 $add : Array of strings corresponding to groups added
1114 $remove: Array of strings corresponding to groups removed
1116 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1117 &$groups: List of implicit (automatically-assigned) groups
1119 'UserGetRights': Called in User::getRights()
1120 $user: User to get rights for
1121 &$rights: Current rights
1123 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1124 $user: user retrieving new talks messages
1125 $talks: array of new talks page(s)
1127 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1128 $toggles: array of toggles to add
1130 'WatchArticle': before a watch is added to an article
1131 $user: user that will watch
1132 $article: article object to be watched
1134 'WatchArticleComplete': after a watch is added to an article
1135 $user: user that watched
1136 $article: article object watched
1138 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1139 $query: $wgQueryPages itself
1141 More hooks might be available but undocumented, you can execute
1142 ./maintenance/findhooks.php to find hidden one.