summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2012-12-04 17:50:44 (GMT)
committer Jennifer Hodgdon2012-12-04 17:50:44 (GMT)
commit619dc887e15217db5446b5ceb3a45aca2827dc4e (patch)
tree0a074e17f996caf4df5cfcf544105d5416d5787c
parentbcacd22f28f47ca04bafd31afcf82667396e8ac1 (diff)
Issue #1787876 by Albert Volkman, cirage, BrockBoland: Add return docs for drupal_get_token() function
-rw-r--r--includes/common.inc5
1 files changed, 5 insertions, 0 deletions
diff --git a/includes/common.inc b/includes/common.inc
index d521268..3983658 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());