diff options
| author | Ivan Tcholakov <ivantcholakov@gmail.com> | 2014-08-25 11:13:31 +0200 |
|---|---|---|
| committer | Ivan Tcholakov <ivantcholakov@gmail.com> | 2014-08-25 11:13:31 +0200 |
| commit | 993f98c09c80ebad3328b7aa4182a941174d1d4a (patch) | |
| tree | c2cf06389bef2fe10888c74eab664aa2b2028a7c | |
| parent | 4f45858c0ab3165c59bad9dbae6b8fb43a18d56e (diff) | |
Upgrading the function html_escape() - documentation corrections.
| -rw-r--r-- | system/core/Common.php | 7 | ||||
| -rw-r--r-- | user_guide_src/source/changelog.rst | 2 |
2 files changed, 4 insertions, 5 deletions
diff --git a/system/core/Common.php b/system/core/Common.php index fd248e9b9..74864ec56 100644 --- a/system/core/Common.php +++ b/system/core/Common.php @@ -691,11 +691,10 @@ if ( ! function_exists('html_escape')) { /** * Returns HTML escaped variable. - * $double_encode set to FALSE prevents escaping twice. * - * @param mixed - * @param bool - * @return mixed + * @param mixed $var The input string or array of strings to be escaped. + * @param bool $double_encode $double_encode set to FALSE prevents escaping twice. + * @return mixed The escaped string or array of strings as a result. */ function html_escape($var, $double_encode = TRUE) { diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst index 4ff71a525..165ef424f 100644 --- a/user_guide_src/source/changelog.rst +++ b/user_guide_src/source/changelog.rst @@ -489,7 +489,7 @@ Release Date: Not Released - Removed the third (`$php_error`) argument from function :func:`log_message()`. - Changed internal function ``load_class()`` to accept a constructor parameter instead of (previously unused) class name prefix. - Removed default parameter value of :func:`is_php()`. - - Added a second optional argument ``$double_encode`` to :func:`html_escape()`. When ``$double_encode`` is set to FALSE, escaping twice is prevented. + - Added a second argument ``$double_encode`` to :func:`html_escape()`. - :doc:`Output Library <libraries/output>` changes include: |