MediaWiki  master
MediaWiki\Hook\DeleteUnknownPreferencesHook Interface Reference

Stable to implement. More...

Inheritance diagram for MediaWiki\Hook\DeleteUnknownPreferencesHook:

Public Member Functions

 onDeleteUnknownPreferences (&$where, $db)
 This hook is called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. More...
 

Detailed Description

Stable to implement.

Definition at line 11 of file DeleteUnknownPreferencesHook.php.

Member Function Documentation

◆ onDeleteUnknownPreferences()

MediaWiki\Hook\DeleteUnknownPreferencesHook::onDeleteUnknownPreferences ( $where,
  $db 
)

This hook is called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about.

This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', so anything with that prefix is excluded from the deletion.

Since
1.35
Parameters
array&$whereArray that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table
IDatabase$dbIDatabase object, useful for accessing $db->buildLike() etc.
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: