added comments on get_input and set_input since they do not handle nested arrays

git-svn-id: http://code.elgg.org/elgg/trunk@3760 36083f99-b078-4883-b0ff-0f9b5a30f544

1 files changed, 5 insertions, 0 deletions

diff --git a/engine/lib/input.php b/engine/lib/input.php
index a412f3644..abc2d6811 100644
--- a/engine/lib/input.php
+++ b/engine/lib/input.php
@@ -12,6 +12,9 @@
 /**
  * Get some input from variables passed on the GET or POST line.
  *
+ * Note: this function does not handle nested arrays (ex: form input of param[m][n])
+ * because of the filtering done in htmlawed from the filter_tags call.
+ * 
  * @param $variable string The variable we want to return.
  * @param $default mixed A default value for the variable if it is not found.
  * @param $filter_result If true then the result is filtered for bad tags.
@@ -49,6 +52,8 @@ function get_input($variable, $default = "", $filter_result = true) {
 
 /**
  * Sets an input value that may later be retrieved by get_input
+ * 
+ * Note: this function does not handle nested arrays (ex: form input of param[m][n])
  *
  * @param string $variable The name of the variable
  * @param string $value The value of the variable