X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=dba6281666f817feac30c28d871ef0996f51e7a2;hb=878523f6225a9d7e39d58398c6ab3cb0a5193ea7;hp=06445367e48ee3c8646ef12d28475d29446d21d3;hpb=fcbd03ad6e8a248e59c93b1e97fc6287c424a834;p=lhc%2Fweb%2Fwiklou.git diff --git a/docs/hooks.txt b/docs/hooks.txt index 06445367e4..dba6281666 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -314,7 +314,7 @@ $output: The OutputPage object where output() was called 'AfterImportPage': When a page import is completed. $title: Title under which the revisions were imported -$origTitle: Title provided by the XML file +$foreignTitle: ForeignTitle object based on data provided by the XML file $revCount: Number of revisions in the XML file $sRevCount: Number of successfully imported revisions $pageInfo: associative array of page information @@ -372,6 +372,17 @@ $editPage : the EditPage object $text : the new text of the article (has yet to be saved) &$resultArr : data in this array will be added to the API result +'ApiFeedContributions::feedItem': Called to convert the result of ContribsPager +into a FeedItem instance that ApiFeedContributions can consume. Implementors of +this hook may cancel the hook to signal that the item is not viewable in the +provided context. +$row: A row of data from ContribsPager. The set of data returned by ContribsPager + can be adjusted by handling the ContribsPager::reallyDoQuery hook. +$context: An IContextSource implementation. +&$feedItem: Set this to a FeedItem instance if the callback can handle the provided + row. This is provided to the hook as a null, if it is non null then another callback + has already handled the hook. + 'ApiFormatHighlight': Use to syntax-highlight API pretty-printed output. When highlighting, add output to $context->getOutput() and return false. $context: An IContextSource. @@ -409,7 +420,8 @@ $options: Array Options passed to ApiHelp::getHelp 'ApiOpenSearchSuggest': Called when constructing the OpenSearch results. Hooks can alter or append to the array. -&$results: array of associative arrays. Keys are: +&$results: array with integer keys to associative arrays. Keys in associative +array: - title: Title object. - redirect from: Title or null. - extract: Description for this result. @@ -891,6 +903,38 @@ $name: name of the special page, e.g. 'Watchlist' &$join_conds: join conditions for the tables $opts: FormOptions for this request +'ChangeTagAfterDelete': Called after a change tag has been deleted (that is, +removed from all revisions and log entries to which it was applied). This gives +extensions a chance to take it off their books. +$tag: name of the tag +&$status: Status object. Add warnings to this as required. There is no point + setting errors, as the deletion has already been partly carried out by this + point. + +'ChangeTagCanCreate': Tell whether a change tag should be able to be created +from the UI (Special:Tags) or via the API. You could use this hook if you want +to reserve a specific "namespace" of tags, or something similar. +$tag: name of the tag +$user: user initiating the action +&$status: Status object. Add your errors using `$status->fatal()` or warnings + using `$status->warning()`. Errors and warnings will be relayed to the user. + If you set an error, the user will be unable to create the tag. + +'ChangeTagCanDelete': Tell whether a change tag should be able to be +deleted from the UI (Special:Tags) or via the API. The default is that tags +defined using the ListDefinedTags hook are not allowed to be deleted unless +specifically allowed. If you wish to allow deletion of the tag, set +`$status = Status::newGood()` to allow deletion, and then `return false` from +the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry +out custom deletion actions. +$tag: name of the tag +$user: user initiating the action +&$status: Status object. See above. + +'ChangeTagsListActive': Allows you to nominate which of the tags your extension +uses are in active use. +&$tags: list of all active tags. Append to this array. + 'LoginUserMigrated': Called during login to allow extensions the opportunity to inform a user that their username doesn't exist for a specific reason, instead of letting the login form give the generic error message that the account does @@ -1252,15 +1296,15 @@ $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. + $pre: Boolean, true if there is text before this autocomment $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. + $post: Boolean, true if there is text after this autocomment $title: An optional title object used to links to sections. Can be null. $local: Boolean indicating whether section links should refer to local page. 'GalleryGetModes': Get list of classes that can render different modes of a gallery -$modeArray: An associative array mapping mode names to classes that implement +&$modeArray: An associative array mapping mode names to classes that implement that mode. It is expected all registered classes are a subclass of ImageGalleryBase. @@ -1460,7 +1504,7 @@ $page: ImagePage object 'ImgAuthBeforeStream': executed before file is streamed to user, but only when using img_auth.php. &$title: the Title object of the file as it would appear for the upload page -&$path: the original file and path name when img_auth was invoked by the the web +&$path: the original file and path name when img_auth was invoked by the web server &$name: the name only component of the file &$result: The location to pass back results of the hook routine (only used if