JUserHelper::getCryptedPassword: Difference between revisions
From Joomla! Documentation
Layout updates |
Updated to r1448:247ba8d88526 |
||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JUserHelper::getCryptedPassword|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JUserHelper::getCryptedPassword|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
<source lang="php"> | <source lang="php"> | ||
public static | public static function getCryptedPassword ( | ||
$plaintext | |||
$salt= '' | |||
$encryption= 'md5-hex' | |||
$show_encrypt=false | |||
) | |||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 40: | Line 44: | ||
|- | |- | ||
|} | |} | ||
* '''Returns''' string The encrypted password. | |||
string The encrypted password. | * '''Defined''' on line 296 of libraries/joomla/user/helper.php | ||
* '''Referenced by''' | |||
libraries/joomla/user/helper.php | ** [[JUser::bind/11.1|JUser::bind]] | ||
* | |||
* [[JUser::bind/11.1|JUser::bind]] | |||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JUserHelper::getCryptedPassword source code''' on [[jplatform:user/helper.php#cl-288|BitBucket]] | |||
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]] | |||
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]] | |||
* [[JUserHelper::getCryptedPassword|Other versions of JUserHelper::getCryptedPassword]] | |||
{{SeeAlso:JUserHelper::getCryptedPassword}} | |||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JUserHelper::getCryptedPassword|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JUserHelper::getCryptedPassword|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
===User contributed notes=== | |||
=== | |||
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 62: | Line 65: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
namespace=CodeExample | |||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::getCryptedPassword]]</noinclude> | <noinclude>[[Category:JUserHelper]][[Category:JUserHelper::getCryptedPassword]]</noinclude> | ||
Revision as of 02:55, 28 April 2011
JUserHelper::getCryptedPassword
Description
Formats a password using the current encryption.
Template:Description:JUserHelper::getCryptedPassword [Edit Descripton]
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
See also
- JUserHelper::getCryptedPassword source code on BitBucket
- Class JUserHelper
- Subpackage User
- Other versions of JUserHelper::getCryptedPassword
Template:SeeAlso:JUserHelper::getCryptedPassword [Edit See Also]
User contributed notes
<CodeExamplesForm />