summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2014-08-20 12:33:45 (GMT)
committer Jennifer Hodgdon2014-08-20 12:33:45 (GMT)
commit8af676d68440e4909eb9f42a4a0189a266f2191a (patch)
tree9a151a60a880ec61242507d642c81c396d186f82
parentb5585495b9ae8768d3cbb91afd76afebeb31050d (diff)
Issue #2324083 by er.pushpinderrana, martin_q: Fix up description of return value from drupal_array_get_nested_value()7.x
-rw-r--r--includes/common.inc8
1 files changed, 4 insertions, 4 deletions
diff --git a/includes/common.inc b/includes/common.inc
index 477ecc0..63b691e 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -6636,10 +6636,10 @@ function drupal_array_set_nested_value(array &$array, array $parents, $value, $f
* $value = drupal_array_get_nested_value($form, $parents);
* @endcode
*
- * The return value will be NULL, regardless of whether the actual value is NULL
- * or whether the requested key does not exist. If it is required to know
- * whether the nested array key actually exists, pass a third argument that is
- * altered by reference:
+ * A return value of NULL is ambiguous, and can mean either that the requested
+ * key does not exist, or that the actual value is NULL. If it is required to
+ * know whether the nested array key actually exists, pass a third argument that
+ * is altered by reference:
* @code
* $key_exists = NULL;
* $value = drupal_array_get_nested_value($form, $parents, $key_exists);