From 619dc887e15217db5446b5ceb3a45aca2827dc4e Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Tue, 4 Dec 2012 09:50:44 -0800
Subject: Issue #1787876 by Albert Volkman, cirage, BrockBoland: Add return
 docs for drupal_get_token() function

---
 includes/common.inc | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'includes')

diff --git a/includes/common.inc b/includes/common.inc
index d521268eb..39836589f 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -5046,6 +5046,11 @@ function drupal_get_private_key() {
  *
  * @param $value
  *   An additional value to base the token on.
+ *
+ * @return string
+ *   A 43-character URL-safe token for validation, based on the user session ID,
+ *   the global $drupal_hash_salt variable from settings.php, and the
+ *   'drupal_private_key' configuration variable.
  */
 function drupal_get_token($value = '') {
   return drupal_hmac_base64($value, session_id() . drupal_get_private_key() . drupal_get_hash_salt());
-- 
cgit v1.2.3