X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=blobdiff_plain;f=docs%2Fhooks.txt;h=effc6d9ee23844bf1a95902e72b738100bc4feb8;hp=8912b82b70d1d28bb04f97db11f652c521abb7ef;hb=f783b2707183c64fcd2dc7e43e6c3c38c0c4f02b;hpb=e364403ca5c7972cb04b1e82b7a27e3eeedd9c26 diff --git a/docs/hooks.txt b/docs/hooks.txt index 8912b82b70..effc6d9ee2 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,