From b73583ffb3274f7f7561cae5bc45db2890a3cc25 Mon Sep 17 00:00:00 2001
From: David Rothstein <drothstein@gmail.com>
Date: Tue, 4 Nov 2014 23:29:30 -0500
Subject: Issue #393538 by Liam Morland, valthebald, dmitrig01,
 David_Rothstein: Document that check_plain() can issue PHP messages on
 invalid UTF-8 input.

---
 includes/bootstrap.inc | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

(limited to 'includes')

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
-- 
cgit v1.2.3