diff options
| author | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-12-04 09:50:44 -0800 |
|---|---|---|
| committer | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-12-04 09:50:44 -0800 |
| commit | 619dc887e15217db5446b5ceb3a45aca2827dc4e (patch) | |
| tree | 0a074e17f996caf4df5cfcf544105d5416d5787c /includes | |
| parent | bcacd22f28f47ca04bafd31afcf82667396e8ac1 (diff) | |
| download | brdo-619dc887e15217db5446b5ceb3a45aca2827dc4e.tar.gz brdo-619dc887e15217db5446b5ceb3a45aca2827dc4e.tar.bz2 | |
Issue #1787876 by Albert Volkman, cirage, BrockBoland: Add return docs for drupal_get_token() function
Diffstat (limited to 'includes')
| -rw-r--r-- | includes/common.inc | 5 |
1 files changed, 5 insertions, 0 deletions
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()); |