summaryrefslogtreecommitdiff
path: root/includes
diff options
context:
space:
mode:
authorDavid Rothstein <drothstein@gmail.com>2014-11-04 23:29:30 -0500
committerDavid Rothstein <drothstein@gmail.com>2014-11-04 23:29:30 -0500
commitb73583ffb3274f7f7561cae5bc45db2890a3cc25 (patch)
treee7c2481478c550afd7f0ea4cecdacb1467d1aecc /includes
parentebf478b5af00163c15e92ffca779b26479785a84 (diff)
downloadbrdo-b73583ffb3274f7f7561cae5bc45db2890a3cc25.tar.gz
brdo-b73583ffb3274f7f7561cae5bc45db2890a3cc25.tar.bz2
Issue #393538 by Liam Morland, valthebald, dmitrig01, David_Rothstein: Document that check_plain() can issue PHP messages on invalid UTF-8 input.
Diffstat (limited to 'includes')
-rw-r--r--includes/bootstrap.inc9
1 files changed, 5 insertions, 4 deletions
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc
index 6516db0ff..5788cf7d9 100644
--- a/includes/bootstrap.inc
+++ b/includes/bootstrap.inc
@@ -1568,12 +1568,13 @@ function format_string($string, array $args = array()) {
* Also validates strings as UTF-8 to prevent cross site scripting attacks on
* Internet Explorer 6.
*
- * @param $text
+ * @param $text string
* The text to be checked or processed.
*
- * @return
- * An HTML safe version of $text, or an empty string if $text is not
- * valid UTF-8.
+ * @return string
+ * An HTML safe version of $text. If $text is not valid UTF-8, an empty string
+ * is returned and, on PHP < 5.4, a warning may be issued depending on server
+ * configuration (see @link https://bugs.php.net/bug.php?id=47494 @endlink).
*
* @see drupal_validate_utf8()
* @ingroup sanitization