API17:JUserHelper::getCryptedPassword

JUserHelper::getCryptedPassword

Description

Formats a password using the current encryption.

{{subst:Description:JUserHelper::getCryptedPassword}}

public static function getCryptedPassword (
        $plaintext
        $salt= ''
        $encryption= 'md5-hex'
        $show_encrypt=false
)

Parameter	Type	Default	Description
$plaintext	string		The plaintext password to encrypt.
$salt	string		The salt to use to encrypt the password. [] If not present, a new salt will be generated.
$encryption	string	'md5-hex'	The kind of pasword encryption to use. Defaults to md5-hex.
$show_encrypt	boolean	false	Some password systems prepend the kind of encryption to the crypted password ({SHA}, etc). Defaults to false.

• Returns string The encrypted password.
• Defined on line 296 of libraries/joomla/user/helper.php
• Referenced by
  • JUser::bind

See also

• JUserHelper::getCryptedPassword source code on BitBucket
• Class JUserHelper
• Subpackage User
• Other versions of JUserHelper::getCryptedPassword

{{subst:SeeAlso:JUserHelper::getCryptedPassword}}

User contributed notes

<CodeExamplesForm />