X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=7396fe1eeedebb62af8ea78602fa59110349e214;hb=add1ebe2ab7cbbaf27f8f60a2d0b05769dff71a2;hp=8f0f874bb1788e12b98a7a1446063a316d61ade8;hpb=cb506aecdfe6356b5a848858f1d6c04f6c7821f6;p=lhc%2Fweb%2Fwiklou.git diff --git a/docs/hooks.txt b/docs/hooks.txt index 8f0f874bb1..7396fe1eee 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -903,6 +903,7 @@ $image: File 'BlockIpComplete': After an IP address or user is blocked. $block: the Block object that was saved $user: the user who did the block (not the one being blocked) +$priorBlock: the Block object for the prior block or null if there was none 'BookInformation': Before information output on Special:Booksources. $isbn: ISBN to show information for @@ -2359,24 +2360,12 @@ cache or return false to not use it. &$parser: Parser object &$varCache: variable cache (array) -'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare and -ParserLimitReportFormat instead. +'ParserLimitReport': DEPRECATED! Use ParserLimitReportPrepare instead. Called at the end of Parser:parse() when the parser will include comments about size of the text parsed. $parser: Parser object &$limitReport: text that will be included (without comment tags) -'ParserLimitReportFormat': Called for each row in the parser limit report that -needs formatting. If nothing handles this hook, the default is to use "$key" to -get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to -format the value. -$key: Key for the limit report item (string) -&$value: Value of the limit report item -&$report: String onto which to append the data -$isHTML: If true, $report is an HTML table with two columns; if false, it's - text intended for display in a monospaced font. -$localize: If false, $report should be output in English. - 'ParserLimitReportPrepare': Called at the end of Parser:parse() when the parser will include comments about size of the text parsed. Hooks should use $output->setLimitReportData() to populate data. Functions for this hook should @@ -2631,6 +2620,18 @@ search results. $title: Current Title object being displayed in search results. &$id: Revision ID (default is false, for latest) +'SearchIndexFields': Add fields to search index mapping. +&$fields: Array of fields, all implement SearchIndexField +$engine: SearchEngine instance for which mapping is being built. + +'SearchDataForIndex': Add data to search document. Allows to add any data to +the field map used to index the document. +&$fields: Array of name => value pairs for fields +$handler: ContentHandler for the content being indexed +$page: WikiPage that is being indexed +$output: ParserOutput that is produced from the page +$engine: SearchEngine for which the indexing is intended + 'SecondaryDataUpdates': Allows modification of the list of DataUpdates to perform when page content is modified. Currently called by AbstractContent::getSecondaryDataUpdates. @@ -3466,6 +3467,9 @@ $user: User object for the logged-in user For functionality that needs to run after any login (API or web) use UserLoggedIn. &$user: the user object that was created on login &$inject_html: Any HTML to inject after the "logged in" message. +$direct: (bool) The hook is called directly after a successful login. This will only happen once + per login. A UserLoginComplete call with direct=false can happen when the user visits the login + page while already logged in. 'UserLoginForm': DEPRECATED! Create an AuthenticationProvider instead. Manipulate the login form.