summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/helpers
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide_src/source/helpers')
-rw-r--r--user_guide_src/source/helpers/string_helper.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/user_guide_src/source/helpers/string_helper.rst b/user_guide_src/source/helpers/string_helper.rst
index c9b5e278c..d32ff54a3 100644
--- a/user_guide_src/source/helpers/string_helper.rst
+++ b/user_guide_src/source/helpers/string_helper.rst
@@ -35,7 +35,6 @@ The following functions are available:
:rtype: string
Generates a random string based on the type and length you specify.
- Useful for creating passwords or generating random hashes.
The first parameter specifies the type of string, the second parameter
specifies the length. The following choices are available:
@@ -52,6 +51,10 @@ The following functions are available:
echo random_string('alnum', 16);
+ .. note:: Usage of this function is NOT suitable for password generation
+ or other security-sensitive purposes. Please use
+ `random_bytes() <https://secure.php.net/random_bytes>`_ instead.
+
.. php:function:: increment_string($str[, $separator = '_'[, $first = 1]])
:param string $str: Input string