MediaWiki  master
MediaWiki\SpecialPage\Hook\ChangesListSpecialPageQueryHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\SpecialPage\Hook\ChangesListSpecialPageQueryHook:

Public Member Functions

 onChangesListSpecialPageQuery ( $name, &$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)
 This hook is called when building an SQL query on pages inheriting from ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked and Watchlist). More...
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "ChangesListSpecialPageQuery" to register handlers implementing this interface.

Stable to implement

Definition at line 14 of file ChangesListSpecialPageQueryHook.php.

Member Function Documentation

◆ onChangesListSpecialPageQuery()

MediaWiki\SpecialPage\Hook\ChangesListSpecialPageQueryHook::onChangesListSpecialPageQuery (   $name,
$tables,
$fields,
$conds,
$query_options,
$join_conds,
  $opts 
)

This hook is called when building an 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.

Since
1.35
Parameters
string$nameName of the special page, e.g. 'Watchlist'
array&$tablesArray of tables to be queried
array&$fieldsArray of columns to select
array&$condsArray of WHERE conditionals for query
array&$query_optionsArray of options for the database request
array&$join_condsJoin conditions for the tables
FormOptions$optsFormOptions for this request
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


The documentation for this interface was generated from the following file: