Manual:Hooks/UserCryptPassword

UserCryptPassword
Available from version 1.14.0 (r44815, codereview)
Removed in version 1.24.0
Was called when hashing a password.
Define function:
public static function onUserCryptPassword( &$password, &$salt, &$wgPasswordSalt, &$hash ) { ... }
Attach hook: In extension.json:
{
	"Hooks": {
		"UserCryptPassword": "MediaWiki\\Extension\\MyExtension\\Hooks::onUserCryptPassword"
	}
}
Called from: File(s): User.php
Function(s): crypt
Interface: UserCryptPasswordHook.php

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


Details edit

This hook was removed in Gerrit change 77645 as part of the RFC for improving the storage of passwords.

Return false to implement your own hashing method.

  • &$password: String of the plaintext password to encrypt
  • &$salt: String of the password salt or boolean false if no salt is provided
  • &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing method
  • &$hash: If the hook returns false, this string will be used as the hash