summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2012-08-23 07:37:20 -0700
committerJennifer Hodgdon <yahgrp@poplarware.com>2012-08-23 07:37:20 -0700
commit2c3cba3b6e8442a12b02f626d2151716b9aad8ae (patch)
treea77bd9e04f5e75c1383ef3401a7fe6f41c65c50d
parentdc5d2b4c8f9fe16b65406e0b0f8b6031b4bb42b5 (diff)
downloadbrdo-2c3cba3b6e8442a12b02f626d2151716b9aad8ae.tar.gz
brdo-2c3cba3b6e8442a12b02f626d2151716b9aad8ae.tar.bz2
Issue #1722244 by Albert Volkman, edb: Add return docs to drupal_get_destination function
-rw-r--r--includes/common.inc6
1 files changed, 6 insertions, 0 deletions
diff --git a/includes/common.inc b/includes/common.inc
index efb7926a3..39ed04e8c 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -505,6 +505,12 @@ function drupal_http_build_query(array $query, $parent = '') {
* previous request, that destination is returned. As such, a destination can
* persist across multiple pages.
*
+ * @return
+ * An associative array containing the key:
+ * - destination: The path provided via the destination query string or, if
+ * not available, the current path.
+ *
+ * @see current_path()
* @see drupal_goto()
*/
function drupal_get_destination() {