summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGreg Bor <borg4242@users.noreply.github.com>2017-03-20 20:15:08 +0000
committerGitHub <noreply@github.com>2017-03-20 20:15:08 +0000
commit27f3ae5be29e00dbb98d23a04929cfbb85dfc202 (patch)
tree17809b925d41a9f6c781db006d358c61ffa6c26d
parent1ecb013b51756effed3a3c446a314084b54c9916 (diff)
downloadpassword_compat-27f3ae5be29e00dbb98d23a04929cfbb85dfc202.zip
password_compat-27f3ae5be29e00dbb98d23a04929cfbb85dfc202.tar.gz
password_compat-27f3ae5be29e00dbb98d23a04929cfbb85dfc202.tar.bz2
Document erroneous return value more precisely
Proposed change for #30, just for clarity.
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 656f81f..280287a 100644
--- a/README.md
+++ b/README.md
@@ -49,7 +49,7 @@ Another algorithm name is supported:
````
This will use the strongest algorithm available to PHP at the current time. Presently, this is the same as specifying `PASSWORD_BCRYPT`. But in future versions of PHP, it may be updated to use a stronger algorithm if one is introduced. It can also be changed if a problem is identified with the BCRYPT algorithm. Note that if you use this option, you are **strongly** encouraged to store it in a `VARCHAR(255)` column to avoid truncation issues if a future algorithm increases the length of the generated hash.
-It is very important that you should check the return value of `password_hash` prior to storing it, because a `false` may be returned if it encountered an error.
+It is very important that you should check the return value of `password_hash` prior to storing it, because `false` or `null` may be returned if it encountered an error.
**Verifying Password Hashes**