summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2012-09-17 19:09:30 (GMT)
committer Jennifer Hodgdon2012-09-17 19:09:30 (GMT)
commit8281aa22df7579718f8ea0a0a64345de0cd78430 (patch)
tree3d9e7f400db5e01feaa0b03db264d1f87418717e
parente218effd9d7d01cf1e5e22b7b1ea367084b7a821 (diff)
Issue #1722244 by Albert Volkman, edb: Add return docs for 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 8ae0517..24d7405 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -510,6 +510,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() {