X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=blobdiff_plain;f=docs%2Fhooks.txt;h=7084b51d56aa9df9ecb5cb1690e0930713a90562;hp=c21ce8a00495f60ba60d25df735c707598a37dd0;hb=236488d398046838059f758b0915341648b64c7b;hpb=43da7fb8844a6d517460aaf68b64092d1ced2068 diff --git a/docs/hooks.txt b/docs/hooks.txt index c21ce8a004..7084b51d56 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -689,6 +689,8 @@ $destTitle: destination title (object) 'ArticlePageDataBefore': Before loading data of an article from the database. &$wikiPage: WikiPage (object) that data will be loaded &$fields: fields (array) to load from the database +&$tables: tables (array) to load from the database +&$joinConds: join conditions (array) to load from the database 'ArticlePrepareTextForEdit': Called when preparing text to be saved. $wikiPage: the WikiPage being saved @@ -949,7 +951,7 @@ $id: the page ID (original ID in case of page deletions) in a Category page. Gives extensions the opportunity to batch load any related data about the pages. $type: The category type. Either 'page', 'file' or 'subcat' -$res: Query result from DatabaseBase::select() +$res: Query result from Wikimedia\Rdbms\IDatabase::select() 'CategoryViewer::generateLink': Before generating an output link allow extensions opportunity to generate a more specific or relevant link. @@ -996,13 +998,10 @@ $special: ChangesListSpecialPage instance 'ChangesListSpecialPageQuery': Called when building SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist). - Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure. - Instead, use sub-classes of those classes, in conjunction with the ChangesListSpecialPageStructuredFilters hook. - This hook can be used to implement filters that do not implement that structure, or custom behavior that is not an individual filter. $name: name of the special page, e.g. 'Watchlist' @@ -1017,11 +1016,16 @@ $opts: FormOptions for this request filters for pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked, and Watchlist). Generally, you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects. - When constructing them, you specify which group they belong to. You can reuse existing groups (accessed through $special->getFilterGroup), or create your own (ChangesListBooleanFilterGroup or ChangesListStringOptionsFilterGroup). If you create new groups, you must register them with $special->registerFilterGroup. +Note that this is called regardless of whether the user is currently using +the new (structured) or old (unstructured) filter UI. If you want your boolean +filter to show on both the new and old UI, specify all the supported fields. +These include showHide, label, and description. +See the constructor of each ChangesList* class for documentation of supported +fields. $special: ChangesListSpecialPage instance 'ChangeTagAfterDelete': Called after a change tag has been deleted (that is, @@ -1843,6 +1847,11 @@ $revisionInfo: Array of revision information Return false to stop further processing of the tag $reader: XMLReader object +'ImportHandleUnknownUser': When a user doesn't exist locally, this hook is called +to give extensions an opportunity to auto-create it. If the auto-creation is +successful, return false. +$name: User name + 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader: XMLReader object @@ -2592,6 +2601,12 @@ RejectParserCacheValue hook) because MediaWiki won't do it for you. callable here. The callable is passed the ParserOptions object and the option name. +'ParserOutputPostCacheTransform': Called from ParserOutput::getText() to do +post-cache transforms. +$parserOutput: The ParserOutput object. +&$text: The text being transformed, before core transformations are done. +&$options: The options array being used for the transformation. + 'ParserSectionCreate': Called each time the parser creates a document section from wikitext. Use this to apply per-section modifications to HTML (like wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV @@ -2771,9 +2786,10 @@ configuration variables to JavaScript. Things that depend on the current page or request state must be added through MakeGlobalVariablesScript instead. &$vars: array( variable name => value ) -'ResourceLoaderGetLessVars': Called in ResourceLoader::getLessVars after -variables from $wgResourceLoaderLESSVars are added. Can be used to add -context-based variables. +'ResourceLoaderGetLessVars': DEPRECATED! Called in ResourceLoader::getLessVars +to add global LESS variables. Loaded after $wgResourceLoaderLESSVars is added. +Global LESS variables are deprecated. Use ResourceLoaderModule::getLessVars() +instead to expose variables only in modules that need them. &$lessVars: array of variables already added 'ResourceLoaderJqueryMsgModuleMagicWords': Called in @@ -2801,14 +2817,14 @@ called after the addition of 'qunit' and MediaWiki testing resources. added to any module. &$ResourceLoader: object -'RevisionInsertComplete': Called after a revision is inserted into the database. -&$revision: the Revision -$data: the data stored in old_text. The meaning depends on $flags: if external - is set, it's the URL of the revision text in external storage; otherwise, - it's the revision text itself. In either case, if gzip is set, the revision - text is gzipped. -$flags: a comma-delimited list of strings representing the options used. May - include: utf8 (this will always be set for new revisions); gzip; external. +'RevisionRecordInserted': Called after a revision is inserted into the database. +$revisionRecord: the RevisionRecord that has just been inserted. + +'RevisionInsertComplete': DEPRECATED! Use RevisionRecordInserted hook instead. +Called after a revision is inserted into the database. +$revision: the Revision +$data: DEPRECATED! Always null! +$flags: DEPRECATED! Always null! 'SearchableNamespaces': An option to modify which namespaces are searchable. &$arr: Array of namespaces ($nsId => $name) which will be used. @@ -2944,6 +2960,7 @@ $result: The SearchResult object $terms: String of the search terms entered $specialSearch: The SpecialSearch object &$query: Array of query string parameters for the link representing the search result. +&$attributes: Array of title link attributes, can be modified by extension. 'SidebarBeforeOutput': Allows to edit sidebar just before it is output by skins. Warning: This hook is run on each display. You should consider to use @@ -3511,6 +3528,12 @@ blank form with no error message; use UploadVerification and UploadVerifyFile instead. &$form: UploadForm object +'UploadForm:getInitialPageText': After the initial page text for file uploads +is generated, to allow it to be altered. +&$pageText: the page text +$msg: array of header messages +$config: Config object + 'UploadForm:initial': Before the upload form is generated. You might set the member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject text (HTML) either before or after the editform. @@ -3793,12 +3816,16 @@ After a user's group memberships are changed. $add: Array of strings corresponding to groups added $remove: Array of strings corresponding to groups removed -'UserSaveOptions': Called just before saving user preferences/options. -$user: User object -&$options: Options, modifiable +'UserSaveOptions': Called just before saving user preferences. Hook handlers can either add or +manipulate options, or reset one back to it's default to block changing it. Hook handlers are also +allowed to abort the process by returning false, e.g. to save to a global profile instead. Compare +to the UserSaveSettings hook, which is called after the preferences have been saved. +$user: The User for which the options are going to be saved +&$options: The users options as an associative array, modifiable -'UserSaveSettings': Called when saving user settings. -$user: User object +'UserSaveSettings': Called directly after user preferences (user_properties in the database) have +been saved. Compare to the UserSaveOptions hook, which is called before. +$user: The User for which the options have been saved 'UserSetCookies': DEPRECATED! If you're trying to replace core session cookie handling, you want to create a subclass of MediaWiki\Session\CookieSessionProvider @@ -3907,14 +3934,15 @@ dumps. One, and only one hook should set this, and return false. &$opts: Options to use for the query &$join: Join conditions -'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when +'WikiPageDeletionUpdates': manipulate the list of DeferrableUpdates to be applied when a page is deleted. Called in WikiPage::getDeletionUpdates(). Note that updates specific to a content model should be provided by the respective Content's getDeletionUpdates() method. $page: the WikiPage -$content: the Content to generate updates for (or null, if the Content could not be loaded -due to an error) -&$updates: the array of DataUpdate objects. Hook function may want to add to it. +$content: the Content to generate updates for, or null in case the page revision could not be + loaded. The delete will succeed despite this. +&$updates: the array of objects that implement DeferrableUpdate. Hook function may want to add to + it. 'WikiPageFactory': Override WikiPage class used for a title $title: Title of the page