r51122 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r51121‎ | r51122 | r51123 >
Date:17:05, 28 May 2009
Author:ialex
Status:ok
Tags:
Comment:
* break lines at 80 chars
* spacing consistency
Modified paths:
  • /trunk/phase3/docs/hooks.txt (modified) (history)

Diff [purge]

Index: trunk/phase3/docs/hooks.txt
@@ -324,7 +324,8 @@
325325 $tokenFunctions array and return true (returning false makes no sense)
326326 $tokenFunctions: array(action => callback)
327327
328 -'APIQueryRecentChangesTokens': use this hook to add custom tokens to list=recentchanges.
 328+'APIQueryRecentChangesTokens': use this hook to add custom tokens to
 329+list=recentchanges.
329330 Every token has an action, which will be used in the rctoken parameter
330331 and in the output (actiontoken="..."), and a callback function which
331332 should return the token, or false if the user isn't allowed to obtain
@@ -344,7 +345,8 @@
345346 $tokenFunctions array and return true (returning false makes no sense)
346347 $tokenFunctions: array(action => callback)
347348
348 -'ArticleAfterFetchContent': after fetching content of an article from the database
 349+'ArticleAfterFetchContent': after fetching content of an article from
 350+the database
349351 $article: the article (object) being loaded from the database
350352 $content: the content (string) of the article
351353
@@ -361,18 +363,23 @@
362364 $reason: the reason the article was deleted
363365 $id: id of the article that was deleted
364366
365 -'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
 367+'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
 368+was changed
366369 $article: article (object) of the user talk page
367370
368 -'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an article has been changed
 371+'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
 372+article has been changed
369373 $article: the article (object)
370 -$editInfo: data holder that includes the parser output ($editInfo->output) for that page after the change
 374+$editInfo: data holder that includes the parser output ($editInfo->output) for
 375+that page after the change
371376 $changed: bool for if the page was changed
372377
373 -'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
 378+'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
 379+recentchanges table, return false to not delete old entries
374380 $article: article (object) being modified
375381
376 -'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
 382+'ArticleFromTitle': when creating an article object from a title object using
 383+Wiki::articleFromTitle()
377384 $title: title (object) used to create the article object
378385 $article: article (object) that will be returned
379386
@@ -457,17 +464,20 @@
458465 $create: Whether or not the restoration caused the page to be created
459466 (i.e. it didn't exist before)
460467
461 -'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
 468+'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
 469+before the user is redirected back to the page
462470 &$article: the article
463471 &$sectionanchor: The section anchor link (e.g. "#overview" )
464472 &$extraq: Extra query parameters which can be added via hooked functions
465473
466 -'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
 474+'ArticleViewHeader': Before the parser cache is about to be tried for article
 475+viewing.
467476 &$article: the article
468477 &$pcache: whether to try the parser cache or not
469478 &$outputDone: whether the output for this page finished or not
470479
471 -'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
 480+'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
 481+follwed an redirect
472482 $article: target article (object)
473483
474484 'AuthPluginAutoCreate': Called when creating a local account for an user logged
@@ -573,7 +583,8 @@
574584 $oldRev: Revision object of the "old" revision (may be null/invalid)
575585 $newRev: Revision object of the "new" revision
576586
577 -'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
 587+'DisplayOldSubtitle': before creating subtitle when browsing old versions of
 588+an article
578589 $article: article (object) being viewed
579590 $oldid: oldid (int) being viewed
580591
@@ -601,7 +612,8 @@
602613 $error: error message to return
603614 $summary: Edit summary for page
604615
605 -'EditFormPreloadText': Allows population of the edit form when creating new pages
 616+'EditFormPreloadText': Allows population of the edit form when creating
 617+new pages
606618 &$text: Text to preload with
607619 &$title: Title object representing the page being created
608620
@@ -617,10 +629,10 @@
618630 'EditPage::showEditForm:initial': before showing the edit form
619631 $editor: EditPage instance (object)
620632
621 -Return false to halt editing; you'll need to handle error messages, etc. yourself.
622 -Alternatively, modifying $error and returning true will cause the contents of $error
623 -to be echoed at the top of the edit form as wikitext. Return true without altering
624 -$error to allow the edit to proceed.
 633+Return false to halt editing; you'll need to handle error messages, etc.
 634+yourself. Alternatively, modifying $error and returning true will cause the
 635+contents of $error to be echoed at the top of the edit form as wikitext.
 636+Return true without altering $error to allow the edit to proceed.
625637
626638 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
627639 when there's an edit conflict. Return false to halt normal diff output; in
@@ -630,12 +642,14 @@
631643 &$editor: EditPage instance
632644 &$out: OutputPage instance
633645
634 -'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
 646+'EditPageBeforeEditButtons': allows modifying the edit buttons below the
 647+textarea in the edit form
635648 &$editpage: The current EditPage object
636649 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
637650 &$tabindex: HTML tabindex of the last edit check/button
638651
639 -'EditPageBeforeEditChecks': allows modifying the edit checks below the textarea in the edit form
 652+'EditPageBeforeEditChecks': allows modifying the edit checks below the
 653+textarea in the edit form
640654 &$editpage: The current EditPage object
641655 &$checks: Array of edit checks like "watch this page"/"minor edit"
642656 &$tabindex: HTML tabindex of the last edit check/button
@@ -670,17 +684,18 @@
671685 $editToken: The user's edit token.
672686 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
673687
674 -'FetchChangesList': When fetching the ChangesList derivative for a particular user
 688+'FetchChangesList': When fetching the ChangesList derivative for
 689+a particular user
675690 &$user: User the list is being fetched for
676691 &$skin: Skin object to be used with the list
677 -&$list: List object (defaults to NULL, change it to an object instance and return
678 -false override the list derivative used)
 692+&$list: List object (defaults to NULL, change it to an object
 693+ instance and return false override the list derivative used)
679694
680695 'FileDeleteComplete': When a file is deleted
681696 $file: reference to the deleted file
682697 $oldimage: in case of the deletion of an old image, the name of the old file
683 -$article: in case all revisions of the file are deleted a reference to the article
684 - associated with the file.
 698+$article: in case all revisions of the file are deleted a reference to the
 699+ article associated with the file.
685700 $user: user who performed the deletion
686701 $reason: reason
687702
@@ -693,7 +708,8 @@
694709 $user: user who performed the undeletion
695710 $reason: reason
696711
697 -'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
 712+'GetAutoPromoteGroups': When determining which autopromote groups a user
 713+is entitled to be in.
698714 &$user: user to promote.
699715 &$promote: groups that will be added.
700716
@@ -716,7 +732,8 @@
717733 $query: query options passed to Title::getInternalURL()
718734
719735 'GetLinkColours': modify the CSS class of an array of page links
720 -$linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
 736+$linkcolour_ids: array of prefixed DB keys of the pages linked to,
 737+ indexed by page_id.
721738 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
722739
723740 'GetLocalURL': modify local URLs as output into page links
@@ -743,7 +760,8 @@
744761 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
745762 if expensive checks are enabled.
746763
747 -'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted into the job queue.
 764+'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
 765+into the job queue.
748766 $title: Title object, pages linked to this title are purged.
749767
750768 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
@@ -782,8 +800,8 @@
783801 $target: Title/string of redirect target
784802 $article: Article object
785803
786 -'InternalParseBeforeLinks': during Parser's internalParse method before links but
787 -after noinclude/includeonly/onlyinclude and other processing.
 804+'InternalParseBeforeLinks': during Parser's internalParse method before links
 805+but after noinclude/includeonly/onlyinclude and other processing.
788806 &$this: Parser object
789807 &$text: string containing partially parsed text
790808 &$this->mStripState: Parser's internal StripState object
@@ -805,11 +823,13 @@
806824 &$result: Set this and return false to override the internal checks
807825 $user: User the password is being validated for
808826
809 -'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
 827+'LanguageGetMagic': Use this to define synonyms of magic words depending
 828+of the language
810829 $magicExtensions: associative array of magic words synonyms
811830 $lang: laguage code (string)
812831
813 -'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
 832+'LanguageGetSpecialPageAliases': Use to define aliases of special pages
 833+names depending of the language
814834 $specialPageAliases: associative array of magic words synonyms
815835 $lang: laguage code (string)
816836
@@ -842,22 +862,26 @@
843863 ciative array form.
844864 &$ret: the value to return if your hook returns false.
845865
846 -'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
 866+'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
 867+before the return
847868 &$url: the image url
848869 &$alt: the image's alt text
849870 &$img: the new image HTML (if returning false)
850871
851 -'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
 872+'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
 873+before the return
852874 &$url: the link url
853875 &$text: the link text
854876 &$link: the new link HTML (if returning false)
855877 &$attribs: the attributes to be applied.
856878 $linkType: The external link type
857879
858 -'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
 880+'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
 881+actual update
859882 &$linksUpdate: the LinkUpdate object
860883
861 -'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
 884+'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
 885+completed
862886 &$linksUpdate: the LinkUpdate object
863887
864888 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
@@ -866,10 +890,12 @@
867891 'ListDefinedTags': When trying to find all defined tags.
868892 &$tags: The list of tags.
869893
870 -'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
 894+'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions
 895+messages
871896 &$messageCache: The MessageCache object
872897
873 -'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
 898+'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
 899+database schema
874900
875901 'LocalFile::getHistory': called before file history query performed
876902 $file: the file
@@ -879,62 +905,71 @@
880906 $opts: query options
881907 $join_conds: JOIN conditions
882908
883 -'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
884 - No return data is accepted; this hook is for auditing only.
 909+'LoginAuthenticateAudit': a login attempt for a valid user account either
 910+succeeded or failed. No return data is accepted; this hook is for auditing only.
885911 $user: the User object being authenticated against
886912 $password: the password being submitted and found wanting
887 -$retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
 913+$retval: a LoginForm class constant with authenticateUserData() return
 914+ value (SUCCESS, WRONG_PASS, etc)
888915
889916 'LogLine': Processes a single log entry on Special:Log
890 -$log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
891 - database field.
892 -$log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
893 - to logging.log_action database field.
894 -$title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
895 -$paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
896 - appears to contain anything.
897 -&$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
 917+$log_type: string for the type of log entry (e.g. 'move'). Corresponds to
 918+ logging.log_type database field.
 919+$log_action: string for the type of log action (e.g. 'delete', 'block',
 920+ 'create2'). Corresponds to logging.log_action database field.
 921+$title: Title object that corresponds to logging.log_namespace and
 922+ logging.log_title database fields.
 923+$paramArray: Array of parameters that corresponds to logging.log_params field.
 924+ Note that only $paramArray[0] appears to contain anything.
 925+&$comment: string that corresponds to logging.log_comment database field, and
 926+ which is displayed in the UI.
898927 &$revert: string that is displayed in the UI, similar to $comment.
899928 $time: timestamp of the log entry (added in 1.12)
900929
901 -'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
 930+'LogPageValidTypes': action being logged.
 931+DEPRECATED: Use $wgLogTypes
902932 &$type: array of strings
903933
904 -'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
 934+'LogPageLogName': name of the logging page(s).
 935+DEPRECATED: Use $wgLogNames
905936 &$typeText: array of strings
906937
907 -'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
 938+'LogPageLogHeader': strings used by wfMsg as a header.
 939+DEPRECATED: Use $wgLogHeaders
908940 &$headerText: array of strings
909941
910 -'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
 942+'LogPageActionText': strings used by wfMsg as a header.
 943+DEPRECATED: Use $wgLogActions
911944 &$actionText: array of strings
912945
913 -'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
 946+'MagicWordMagicWords': When defining new magic word.
 947+DEPRECATED: Use LanguageGetMagic hook instead
914948 $magicWords: array of strings
915949
916950 'MagicWordwgVariableIDs': When definig new magic words IDs.
917951 $variableIDs: array of strings
918952
919 -'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript is executed
 953+'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
 954+is executed
920955 &$vars: variable (or multiple variables) to be added into the output
921 - of Skin::makeVariablesScript
 956+ of Skin::makeVariablesScript
922957
923958 'MarkPatrolled': before an edit is marked patrolled
924959 $rcid: ID of the revision to be marked patrolled
925960 $user: the user (object) marking the revision as patrolled
926961 $wcOnlySysopsCanPatrol: config setting indicating whether the user
927 - needs to be a sysop in order to mark an edit patrolled
 962+ needs to be a sysop in order to mark an edit patrolled
928963
929964 'MarkPatrolledComplete': after an edit is marked patrolled
930965 $rcid: ID of the revision marked as patrolled
931966 $user: user (object) who marked the edit patrolled
932967 $wcOnlySysopsCanPatrol: config setting indicating whether the user
933 - must be a sysop to patrol the edit
 968+ must be a sysop to patrol the edit
934969
935970 'MathAfterTexvc': after texvc is executed when rendering mathematics
936971 $mathRenderer: instance of MathRenderer
937972 $errmsg: error message, in HTML (string). Nonempty indicates failure
938 - of rendering the formula
 973+ of rendering the formula
939974
940975 'MediaWikiPerformAction': Override MediaWiki::performAction().
941976 Use this to do something completely different, after the basic
@@ -950,7 +985,8 @@
951986 $title: title of the message (string)
952987 $message: value (string), change it to the message you want to define
953988
954 -'MessageCacheReplace': When a message page is changed. Useful for updating caches.
 989+'MessageCacheReplace': When a message page is changed.
 990+Useful for updating caches.
955991 $title: name of the page changed.
956992 $text: new contents of the page.
957993
@@ -961,25 +997,30 @@
962998 $langcode: language code
963999 $isFullKey: specifies whether $lckey is a two part key "msg/lang"
9641000
965 -'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
 1001+'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
 1002+been rendered (useful for adding more)
9661003 Note: this is only run for the Monobook skin. To add items to the toolbox
9671004 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
9681005 instead.
9691006 $tools: array of tools
9701007
971 -'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
 1008+'NewRevisionFromEditComplete': called when a revision was inserted
 1009+due to an edit
9721010 $article: the article edited
9731011 $rev: the new revision
9741012 $baseID: the revision ID this was based off, if any
9751013 $user: the editing user
9761014
9771015 'NormalizeMessageKey': Called before the software gets the text of a message
978 - (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
979 -&$key: the message being looked up. Change this to something else to change what message gets displayed (string)
 1016+(stuff in the MediaWiki: namespace), useful for changing WHAT message gets
 1017+displayed
 1018+&$key: the message being looked up. Change this to something else to change
 1019+ what message gets displayed (string)
9801020 &$useDB: whether or not to look up the message in the database (bool)
9811021 &$langCode: the language code to get the message for (string) - or -
982 - whether to use the content language (true) or site language (false) (bool)
983 -&$transform: whether or not to expand variables and templates in the message (bool)
 1022+ whether to use the content language (true) or site language (false) (bool)
 1023+&$transform: whether or not to expand variables and templates
 1024+ in the message (bool)
9841025
9851026 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
9861027 &$changeslist: The OldChangesList instance.
@@ -995,18 +1036,23 @@
9961037 $parserOutput: the parserOutput (object) that corresponds to the page
9971038 $text: the text that will be displayed, in HTML (string)
9981039
999 -'OutputPageCheckLastModified': when checking if the page has been modified since the last visit
1000 -&$modifiedTimes: array of timestamps, the following keys are set: page, user, epoch
 1040+'OutputPageCheckLastModified': when checking if the page has been modified
 1041+since the last visit
 1042+&$modifiedTimes: array of timestamps.
 1043+ The following keys are set: page, user, epoch
10011044
10021045 'OutputPageParserOutput': after adding a parserOutput to $wgOut
10031046 $out: OutputPage instance (object)
10041047 $parserOutput: parserOutput instance being added in $out
10051048
1006 -'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
1007 - Implementations should return false if they generate the category links, so the default link generation is skipped.
 1049+'OutputPageMakeCategoryLinks': links are about to be generated for the page's
 1050+categories. Implementations should return false if they generate the category
 1051+links, so the default link generation is skipped.
10081052 $out: OutputPage instance (object)
1009 -$categories: associative array, keys are category names, values are category types ("normal" or "hidden")
1010 -$links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
 1053+$categories: associative array, keys are category names, values are category
 1054+ types ("normal" or "hidden")
 1055+$links: array, intended to hold the result. Must be an associative array with
 1056+ category types as keys and arrays of HTML links as values.
10111057
10121058 'PageHistoryBeforeList': When a history page list is about to be constructed.
10131059 $article: the article that the history is loading for
@@ -1015,13 +1061,14 @@
10161062 $row: the revision row for this line
10171063 $s: the string representing this parsed line
10181064
1019 -'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
 1065+'PageHistoryPager::getQueryInfo': when a history pager query parameter set
 1066+is constructed
10201067 $pager: the pager
10211068 $queryInfo: the query parameters
10221069
10231070 'PageRenderingHash': alter the parser cache option hash key
1024 - A parser extension which depends on user options should install
1025 - this hook and append its values to the key.
 1071+A parser extension which depends on user options should install
 1072+this hook and append its values to the key.
10261073 $hash: reference to a hash key string which can be modified
10271074
10281075 'ParserAfterStrip': Same as ParserBeforeStrip
@@ -1035,7 +1082,8 @@
10361083 $text: text to parse
10371084 $stripState: StripState instance being used
10381085
1039 -'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
 1086+'ParserBeforeStrip': Called at start of parsing time
 1087+(no more strip, deprecated ?)
10401088 $parser: parser object
10411089 $text: text being parsed
10421090 $stripState: stripState used (object)
@@ -1050,30 +1098,37 @@
10511099 'ParserFirstCallInit': called when the parser initialises for the first time
10521100 &$parser: Parser object being cleared
10531101
1054 -'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
 1102+'ParserGetVariableValueSwitch': called when the parser need the value of a
 1103+custom magic word
10551104 $parser: Parser object
1056 -$varCache: array to store the value in case of multiples calls of the same magic word
 1105+$varCache: array to store the value in case of multiples calls of the
 1106+ same magic word
10571107 $index: index (string) of the magic
10581108 $ret: value of the magic word (the hook should set it)
10591109
1060 -'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
 1110+'ParserGetVariableValueTs': use this to change the value of the time for the
 1111+{{LOCAL...}} magic word
10611112 $parser: Parser object
10621113 $time: actual time (timestamp)
10631114
1064 -'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
 1115+'ParserGetVariableValueVarCache': use this to change the value of the
 1116+variable cache or return false to not use it
10651117 $parser: Parser object
10661118 $varCache: varaiable cache (array)
10671119
1068 -'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
 1120+'ParserLimitReport': called at the end of Parser:parse() when the parser will
 1121+include comments about size of the text parsed
10691122 $parser: Parser object
10701123 $limitReport: text that will be included (without comment tags)
10711124
1072 -'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
 1125+'ParserMakeImageParams': Called before the parser make an image link, use this
 1126+to modify the parameters of the image.
10731127 $title: title object representing the file
10741128 $file: file object that will be used to create the image
10751129 &$params: 2-D array of parameters
10761130
1077 -'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
 1131+'ParserTestParser': called when creating a new instance of Parser in
 1132+maintenance/parserTests.inc
10781133 $parser: Parser object created
10791134
10801135 'ParserTestTables': alter the list of tables to duplicate when parser tests
@@ -1172,14 +1227,18 @@
11731228 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
11741229 $skin: Skin object
11751230 &$subpages: Subpage links HTML
1176 -If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1177 -If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
 1231+If false is returned $subpages will be used instead of the HTML
 1232+subPageSubtitle() generates.
 1233+If true is returned, $subpages will be ignored and the rest of
 1234+subPageSubtitle() will run.
11781235
1179 -'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
 1236+'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
 1237+when showing a special page
11801238 $sktemplate: SkinTemplate object
11811239 $content_actions: array of tabs
11821240
1183 -'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
 1241+'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
 1242+"permanent link" tab
11841243 $sktemplate: SkinTemplate object
11851244 $nav_urls: array of tabs
11861245
@@ -1188,7 +1247,8 @@
11891248 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
11901249 for an example]
11911250
1192 -'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
 1251+'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
 1252+starts page output
11931253 &$sktemplate: SkinTemplate object
11941254 &$tpl: Template engine object
11951255
@@ -1200,7 +1260,8 @@
12011261 $out: Css to return
12021262
12031263 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1204 - You can either create your own array, or alter the parameters for the normal one.
 1264+You can either create your own array, or alter the parameters for
 1265+the normal one.
12051266 &$this: The SkinTemplate instance.
12061267 $title: Title instance for the page.
12071268 $message: Visible label of tab.
@@ -1215,32 +1276,40 @@
12161277 $sktemplate: SkinTemplate object
12171278 $content_actions: array of tabs
12181279
1219 -'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
 1280+'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
 1281+been rendered (useful for adding more)
12201282 $tools: array of tools
12211283
1222 -'SoftwareInfo': Called by Special:Version for returning information about the software
1223 -$software: The array of software in format 'name' => 'version'. See SpecialVersion::softwareInformation()
 1284+'SoftwareInfo': Called by Special:Version for returning information about
 1285+the software
 1286+$software: The array of software in format 'name' => 'version'.
 1287+ See SpecialVersion::softwareInformation()
12241288
12251289 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
12261290 $id: User identifier
12271291
1228 -'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
 1292+'SpecialListusersDefaultQuery': called right before the end of
 1293+UsersPager::getDefaultQuery()
12291294 $pager: The UsersPager instance
12301295 $query: The query array to be returned
12311296
1232 -'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
 1297+'SpecialListusersFormatRow': called right before the end of
 1298+UsersPager::formatRow()
12331299 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
12341300 $row: Database row object
12351301
1236 -'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
 1302+'SpecialListusersHeader': called before closing the <fieldset> in
 1303+UsersPager::getPageHeader()
12371304 $pager: The UsersPager instance
12381305 $out: The header HTML
12391306
1240 -'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
 1307+'SpecialListusersHeaderForm': called before adding the submit button in
 1308+UsersPager::getPageHeader()
12411309 $pager: The UsersPager instance
12421310 $out: The header HTML
12431311
1244 -'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
 1312+'SpecialListusersQueryInfo': called right before the end of
 1313+UsersPager::getQueryInfo()
12451314 $pager: The UsersPager instance
12461315 $query: The query array to be returned
12471316
@@ -1249,31 +1318,38 @@
12501319 $oldTitle: old title (object)
12511320 $newTitle: new title (object)
12521321
1253 -'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
 1322+'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
 1323+hook to remove a core special page
12541324 $list: list (array) of core special pages
12551325
1256 -'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
 1326+'SpecialRecentChangesPanel': called when building form options in
 1327+SpecialRecentChanges
12571328 &$extraOpts: array of added items, to which can be added
12581329 $opts: FormOptions for this request
12591330
1260 -'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
 1331+'SpecialRecentChangesQuery': called when building sql query for
 1332+SpecialRecentChanges
12611333 &$conds: array of WHERE conditionals for query
12621334 &$tables: array of tables to be queried
12631335 &$join_conds: join conditions for the tables
12641336 $opts: FormOptions for this request
12651337
1266 -'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
 1338+'SpecialSearchNogomatch': called when user clicked the "Go" button but the
 1339+target doesn't exist
12671340 $title: title object generated from the text entred by the user
12681341
1269 -'SpecialSearchResults': called before search result display when there are matches
 1342+'SpecialSearchResults': called before search result display when there
 1343+are matches
12701344 $term: string of search term
12711345 &$titleMatches: empty or SearchResultSet object
12721346 &$textMatches: empty or SearchResultSet object
12731347
1274 -'SpecialSearchNoResults': called before search result display when there are no matches
 1348+'SpecialSearchNoResults': called before search result display when there are
 1349+no matches
12751350 $term: string of search term
12761351
1277 -'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
 1352+'SpecialVersionExtensionTypes': called when generating the extensions credits,
 1353+use this to change the tables headers
12781354 $extTypes: associative array of extensions types
12791355
12801356 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
@@ -1282,7 +1358,8 @@
12831359 &$join_conds: join conditions for the tables
12841360 &$fields: array of query fields
12851361
1286 -'TitleArrayFromResult': called when creating an TitleArray object from a database result
 1362+'TitleArrayFromResult': called when creating an TitleArray object from a
 1363+database result
12871364 &$titleArray: set this to an object to override the default object returned
12881365 $res: database result used to create the object
12891366
@@ -1331,46 +1408,55 @@
13321409 string &$error: output: HTML error to show if upload canceled by returning false
13331410
13341411 'UploadComplete': Upon completion of a file upload
1335 -$uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
 1412+$uploadForm: Upload form object. File can be accessed by
 1413+ $uploadForm->mLocalFile.
13361414
1337 -'User::mailPasswordInternal': before creation and mailing of a user's new temporary password
 1415+'User::mailPasswordInternal': before creation and mailing of a user's new
 1416+temporary password
13381417 $user: the user who sent the message out
13391418 $ip: IP of the user who sent the message out
13401419 $u: the account whose new password will be set
13411420
1342 -'UserArrayFromResult': called when creating an UserArray object from a database result
 1421+'UserArrayFromResult': called when creating an UserArray object from a
 1422+database result
13431423 &$userArray: set this to an object to override the default object returned
13441424 $res: database result used to create the object
13451425
13461426 'userCan': To interrupt/advise the "user can do X to Y article" check.
1347 - If you want to display an error message, try getUserPermissionsErrors.
 1427+If you want to display an error message, try getUserPermissionsErrors.
13481428 $title: Title object being checked against
13491429 $user : Current user object
13501430 $action: Action being checked
13511431 $result: Pointer to result returned if hook returns false. If null is returned,
1352 - userCan checks are continued by internal code.
 1432+ userCan checks are continued by internal code.
13531433
13541434 'UserCanSendEmail': To override User::canSendEmail() permission check
13551435 $user: User (object) whose permission is being checked
13561436 &$canSend: bool set on input, can override on output
13571437
13581438
1359 -'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
 1439+'UserClearNewTalkNotification': called when clearing the
 1440+"You have new messages!" message, return false to not delete it
13601441 $user: User (object) that'll clear the message
13611442
1362 -'UserComparePasswords': called when checking passwords, return false to override the default password checks
 1443+'UserComparePasswords': called when checking passwords, return false to
 1444+override the default password checks
13631445 &$hash: String of the password hash (from the database)
13641446 &$password: String of the plaintext password the user entered
1365 -&$userId: Integer of the user's ID or Boolean false if the user ID was not supplied
1366 -&$result: If the hook returns false, this Boolean value will be checked to determine if the password was valid
 1447+&$userId: Integer of the user's ID or Boolean false if the user ID was not
 1448+ supplied
 1449+&$result: If the hook returns false, this Boolean value will be checked to
 1450+ determine if the password was valid
13671451
13681452 'UserCreateForm': change to manipulate the login form
13691453 $template: SimpleTemplate instance for the form
13701454
1371 -'UserCryptPassword': called when hashing a password, return false to implement your own hashing method
 1455+'UserCryptPassword': called when hashing a password, return false to implement
 1456+your own hashing method
13721457 &$password: String of the plaintext password to encrypt
13731458 &$salt: String of the password salt or Boolean false if no salt is provided
1374 -&$wgPasswordSalt: Boolean of whether the salt is used in the default hashing method
 1459+&$wgPasswordSalt: Boolean of whether the salt is used in the default
 1460+ hashing method
13751461 &$hash: If the hook returns false, this String will be used as the hash
13761462
13771463 'UserEffectiveGroups': Called in User::getEffectiveGroups()
@@ -1384,9 +1470,11 @@
13851471 $user: User object
13861472 &$email: email, change this to override local email
13871473
1388 -'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
 1474+'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
 1475+email authentification
13891476 $user: User object
1390 -&$timestamp: timestamp, change this to override local email authentification timestamp
 1477+&$timestamp: timestamp, change this to override local email authentification
 1478+ timestamp
13911479
13921480 'UserGetImplicitGroups': Called in User::getImplicitGroups()
13931481 &$groups: List of implicit (automatically-assigned) groups
@@ -1403,7 +1491,8 @@
14041492 $ip: User's IP address
14051493 &$blocked: Whether the user is blocked, to be modified by the hook
14061494
1407 -'UserLoadAfterLoadFromSession': called to authenticate users on external/environmental means; occurs after session is loaded
 1495+'UserLoadAfterLoadFromSession': called to authenticate users on
 1496+external/environmental means; occurs after session is loaded
14081497 $user: user object being loaded
14091498
14101499 'UserLoadDefaults': called when loading a default user
@@ -1414,11 +1503,14 @@
14151504 $user: user object
14161505 &$s: database query object
14171506
1418 -'UserLoadFromSession': called to authenticate users on external/environmental means; occurs before session is loaded
 1507+'UserLoadFromSession': called to authenticate users on external/environmental
 1508+means; occurs before session is loaded
14191509 $user: user object being loaded
1420 -&$result: set this to a boolean value to abort the normal authentification process
 1510+&$result: set this to a boolean value to abort the normal authentification
 1511+ process
14211512
1422 -'UserLoadOptions': when user options/preferences are being loaded from the database.
 1513+'UserLoadOptions': when user options/preferences are being loaded from
 1514+the database.
14231515 $user: User object
14241516 &$options: Options, can be modified.
14251517
@@ -1442,7 +1534,8 @@
14431535 $add : Array of strings corresponding to groups added
14441536 $remove: Array of strings corresponding to groups removed
14451537
1446 -'UserrightsChangeableGroups': allows modification of the groups a user may add or remove via Special:UserRights
 1538+'UserrightsChangeableGroups': allows modification of the groups a user
 1539+may add or remove via Special:UserRights
14471540 $userrights : UserrightsPage object
14481541 $user : User object of the current user
14491542 $addergroups : Array of groups that the user is in
@@ -1454,7 +1547,8 @@
14551548 'remove-self' => array( removable groups from self )
14561549 )
14571550
1458 -'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
 1551+'UserRetrieveNewTalks': called when retrieving "You have new messages!"
 1552+message(s)
14591553 $user: user retrieving new talks messages
14601554 $talks: array of new talks page(s)
14611555
@@ -1474,14 +1568,18 @@
14751569 $user: User object
14761570 &$email: new email, change this to override new email address
14771571
1478 -'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
 1572+'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
 1573+of email authentification
14791574 $user: User object
1480 -&$timestamp: new timestamp, change this to override local email authentification timestamp
 1575+&$timestamp: new timestamp, change this to override local email
 1576+authentification timestamp
14811577
1482 -'UserToggles': called when initialising User::$mToggles, use this to add new toggles
 1578+'UserToggles': called when initialising User::$mToggles, use this to add
 1579+new toggles
14831580 $toggles: array of toggles to add
14841581
1485 -'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to alter the SQL query which gets the list of wanted pages
 1582+'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
 1583+alter the SQL query which gets the list of wanted pages
14861584 &$wantedPages: WantedPagesPage object
14871585 &$sql: raw SQL query used to get the list of wanted pages
14881586
@@ -1493,13 +1591,15 @@
14941592 $user: user that watched
14951593 $article: article object watched
14961594
1497 -'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions dumps
 1595+'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
 1596+dumps
14981597 One, and only one hook should set this, and return false.
14991598 &$tables: Database tables to use in the SELECT query
15001599 &$opts: Options to use for the query
15011600 &$join: Join conditions
15021601
1503 -'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
 1602+'wgQueryPages': called when initialising $wgQueryPages, use this to add new
 1603+query pages to be updated with maintenance/updateSpecialPages.php
15041604 $query: $wgQueryPages itself
15051605
15061606 More hooks might be available but undocumented, you can execute

Status & tagging log