X-Git-Url: https://git.cyclocoop.org/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=47654ce9df8d2c352584c46387846aa3b470c053;hb=50d7729bea870759e3ff9dfc414ea6b22d99d23b;hp=c1fd5fac9921cdee914c124fb783ad205566519c;hpb=c31cb08184ca84e16962d8f972ad2a5f27f3f899;p=lhc%2Fweb%2Fwiklou.git diff --git a/docs/hooks.txt b/docs/hooks.txt index c1fd5fac99..47654ce9df 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -427,6 +427,8 @@ $user: the user (object) deleting the article $reason: the reason (string) the article is being deleted $error: if the deletion was prohibited, the (raw HTML) error message to display (added in 1.13) +$status: Status object, modify this to throw an error. Overridden by $error + (added in 1.20) 'ArticleDeleteComplete': after an article is deleted $article: the WikiPage that was deleted @@ -701,10 +703,18 @@ $user: user (object) whose email is being confirmed &$pager: Pager object for contributions &$queryInfo: The query for the contribs Pager +'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions +&$data: an array of results of all contribs queries +$pager: The ContribsPager object hooked into +$offset: Index offset, inclusive +$limit: Exact query limit +$descending: Query direction, false for ascending, true for descending + 'ContributionsLineEnding': Called before a contributions HTML line is finished $page: SpecialPage object for contributions -$ret: the HTML line +&$ret: the HTML line $row: the DB row for this line +&$classes: the classes to add to the surrounding
  • 'ContributionsToolLinks': Change tool links above Special:Contributions $id: User identifier @@ -930,6 +940,14 @@ $fileVersions: array of undeleted versions. Empty if all versions were restored $user: user who performed the undeletion $reason: reason +'FormatAutocomments': When an autocomment is formatted by the Linker + &$comment: Reference to the accumulated comment. Initially null, when set the default code will be skipped. + $pre: Initial part of the parsed comment before the call to the hook. + $auto: The extracted part of the parsed comment before the call to the hook. + $post: The final part of the parsed comment before the call to the hook. + $title: An optional title object used to links to sections. Can be null. + $local: Boolean indicating whether section links should refer to local page. + 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in. &$user: user to promote. @@ -1111,8 +1129,16 @@ $prefix: interwiki prefix we are looking for. &$iwData: output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. +'InternalParseBeforeSanitize': during Parser's internalParse method just before the +parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/ +onlyinclude and other processings. Ideal for syntax-extensions after template/parser +function execution which respect nowiki and HTML-comments. +&$parser: Parser object +&$text: string containing partially parsed text +&$stripState: Parser's internal StripState object + 'InternalParseBeforeLinks': during Parser's internalParse method before links -but after noinclude/includeonly/onlyinclude and other processing. +but after nowiki/noinclude/includeonly/onlyinclude and other processings. &$parser: Parser object &$text: string containing partially parsed text &$stripState: Parser's internal StripState object @@ -1452,6 +1478,12 @@ A parser extension which depends on user options should install this hook and append its values to the key. $hash: reference to a hash key string which can be modified +'ParserAfterParse': Called from Parser::parse() just after the call to +Parser::internalParse() returns +$parser: parser object +$text: text being parsed +$stripState: stripState used (object) + 'ParserAfterStrip': Same as ParserBeforeStrip 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse() @@ -1820,6 +1852,14 @@ Each key maps to an associative array with a 'msg' (message key) and a 'default' hook to remove a core special page $list: list (array) of core special pages +'SpecialPageAfterExecute': called after SpecialPage::execute +$special: the SpecialPage object +$subPage: the subpage string or null if no subpage was specified + +'SpecialPageBeforeExecute': called before SpecialPage::execute +$special: the SpecialPage object +$subPage: the subpage string or null if no subpage was specified + 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset $users: array of User objects $data: array of data submitted by the user