Extension:UserMerge/Hooks/UserMergeAccountFields

From Linux Web Expert

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
UserMergeAccountFields
Available from version ??? (Gerrit change 145146)
define database fields to be automatically updated from the old user ID / username to the new one
Define function:
public static function onUserMergeAccountFields( &$updateFields ) { ... }
Attach hook:
$wgHooks['UserMergeAccountFields'][] = 'MyExtensionHooks::onUserMergeAccountFields';
Called from:File(s): UserMerge / includes/MergeUser.php
Function(s): mergeDatabaseTables

For more information about attaching hooks, see Manual:Hooks .
For examples of other extensions using this hook, see Category:UserMergeAccountFields extensions.

Details

  • &$updateFields: an array containing a list of field configurations. Each configuration is in the form array( $tableName, $idField, $textField, 'batchKey' => $batchKey, 'options' => $options, 'db' => $db ). Everything except $tableName and $idField is optional.
    • $tableName: name of the table containing the field(s) to update
    • $idField: field containing the user ID
    • $textField: field containing the username
    • $batchKey: primary key of the table. If present, update will be done in batches.
    • $options: options array for Database::update(). Typically used to ignore duplicate keys.
    • $db: DB connection to use

If the update operation is too complex to be handled this way, MergeAccountFromTo can be used instead.