MediaWiki\Hook\ModifyExportQueryHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onModifyExportQuery ( $db, &$tables, $cond, &$opts, &$join_conds, &$conds)
	Use this hook to modify the query used by the exporter.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file ModifyExportQueryHook.php.

Member Function Documentation

onModifyExportQuery()

MediaWiki\Hook\ModifyExportQueryHook::onModifyExportQuery	(		$db,
		&	$tables,
			$cond,
		&	$opts,
		&	$join_conds,
		&	$conds )

Use this hook to modify the query used by the exporter.

Since

1.35

Parameters

IReadableDatabase	$db	Database object to be queried
array	&$tables	Tables in the query
string	$cond	An SQL fragment included in the WHERE clause which is used to filter the results, for example to a specific page. Since 1.31, modification of this parameter has no effect. Since 1.35, you can use $conds instead to modify the array of conditions passed to IReadableDatabase::select().
array	&$opts	Options for the query
array	&$join_conds	Join conditions for the query
array	&$conds	The array of conditions to be passed to IReadableDatabase::select(). Can be modified. Includes the value of $cond.

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:

• includes/Export/Hook/ModifyExportQueryHook.php