[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] [doc-en] master: Fix #81299: password_hash() documentation is missing PHP 8 changes
From: "Christoph M. Becker" <noreply () php ! net>
Date: 2021-07-26 11:21:11
Message-ID: Vqg6wBBDqlDM3FL1kbkQwnKWrBNqxEz0QM07V01WdA () main ! php ! net
[Download RAW message or body]
Author: Christoph M. Becker (cmb69)
Date: 2021-07-26T13:21:14+02:00
Commit: https://github.com/php/doc-en/commit/79c06cc0e7872f1401a4c37dc9298b0bedb0dde4
Raw diff: https://github.com/php/doc-en/commit/79c06cc0e7872f1401a4c37dc9298b0bedb0dde4.diff
Fix #81299: password_hash() documentation is missing PHP 8 changes
Changed paths:
M reference/password/functions/password-hash.xml
Diff:
diff --git a/reference/password/functions/password-hash.xml \
b/reference/password/functions/password-hash.xml index 9ffed03b63..fc6de5b799 100644
--- a/reference/password/functions/password-hash.xml
+++ b/reference/password/functions/password-hash.xml
@@ -10,10 +10,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type class="union"><type>string</type><type>false</type></type><methodname>password_hash</methodname>
+ <type>string</type><methodname>password_hash</methodname>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
- <methodparam><type>mixed</type><parameter>algo</parameter></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
+ <methodparam><type \
class="union"><type>string</type><type>int</type><type>null</type></type><parameter>algo</parameter></methodparam>
+ <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<para>
<function>password_hash</function> creates a new password hash using a strong \
one-way hashing @@ -72,8 +72,9 @@
</para>
<warning>
<para>
- The salt option has been deprecated as of PHP 7.0.0. It is now
+ The salt option is deprecated. It is now
preferred to simply use the salt that is generated by default.
+ As of PHP 8.0.0, an explicitly given salt is ignored.
</para>
</warning>
</listitem>
@@ -114,7 +115,7 @@
</para>
<warning>
<para>
- Only available when PHP use libargon2, not with libsodium implementation.
+ Only available when PHP uses libargon2, not with libsodium implementation.
</para>
</warning>
</listitem>
@@ -167,7 +168,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the hashed password, &return.falseforfailure;.
+ Returns the hashed password.
</para>
<para>
The used algorithm, cost and salt are returned as part of the hash. Therefore,
@@ -189,6 +190,18 @@
</row>
</thead>
<tbody>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ <function>password_hash</function> no longer returns &false; on failure.
+ </entry>
+ </row>
+ <row>
+ <entry>8.0.0</entry>
+ <entry>
+ The <parameter>algo</parameter> parameter is nullable now.
+ </entry>
+ </row>
<row>
<entry>7.4.0</entry>
<entry>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic