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