X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=blobdiff_plain;f=docs%2Fhooks.txt;h=6c1597f3de76cc6fca1fd5254e2886777b9f5040;hp=8912b82b70d1d28bb04f97db11f652c521abb7ef;hb=5120937028f768749d058aa91dde82a96de0af1c;hpb=b95ca29602793f39191c06cd6941e3f32ab1bbb8 diff --git a/docs/hooks.txt b/docs/hooks.txt index 8912b82b70..6c1597f3de 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 @@ -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, @@ -2938,6 +2942,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