Enter a descriptive title (above) relating to drupal_get_destination, then describe the problem you have found:
There's no @return.
Also, this is not quite true on D7:
> Prepares a 'destination' URL query parameter
What is returned is a query array *containing* a destination, rather than a portion of a query parameter.
See this comment for details: http://api.drupal.org/api/drupal/includes!common.inc/function/drupal_get...
| Comment | File | Size | Author |
|---|---|---|---|
| #11 | drupal_get_destination_docs-1722244-11.patch | 631 bytes | albert volkman |
| #6 | drupal_get_destination_docs-1722244-6.patch | 652 bytes | albert volkman |
| #4 | drupal_get_destination_docs-1722244-4.patch | 651 bytes | edb |
| #3 | drupal_get_destination_docs-1722244-3.patch | 649 bytes | albert volkman |
| #3 | interdiff.txt | 611 bytes | albert volkman |
Comments
Comment #1
edb commentedAttached a patch that adds the return statement documentation. Thoughts on the wording?
Comment #2
jhodgdonThanks for the patch!
The list needs a bit of formatting work -- see
http://drupal.org/node/1354#lists
Looking at the code, I also don't think this documentation is accurate. What is returned in the array seems to be either $_GET['destination'] or current_path() with a query string appended if there is one.
Comment #3
albert volkman commentedCleaned up formatting errors and altered the return doc a bit.
Comment #4
edb commentedYep that's much clearer documentation, thanks Albert. However, I think 'querystring' should be two words.
Comment #5
jhodgdon"desination" is misspelled. :) Other than that, I think it's OK... maybe could use a comma in there before the "or"?
Comment #6
albert volkman commentedOoops. Fixed :)
Comment #8
jhodgdonThe test failure above is not related to this patch...
But I'm still not sure about this documentation:
+ * - destination: The path provided via the destination query string or the
+ * current path complete with query string if available.
This doesn't tell me which one (destination query string or current path) takes precedence, and I also think that it could use a comma before "or", and I'm not sure what "if available" really means -- if what is available?
Comment #9
albert volkman commentedIf the path includes a query string, it'll be included. I suppose that doesn't need to be explicitly stated, so perhaps it should just be "The path provided via the destination query string or, if not available, the current path." Not sure about the structure of that sentence... is it clear that the query string is the subject of "if not available"?
Comment #10
jhodgdonyes, that seems very clear to me. Thanks!
Comment #11
albert volkman commentedYou're welcome!
Comment #12
albert volkman commentedComment #13
jhodgdonLooks good! I'll get it committed shortly (probably the patch will work for 7.x also).
Comment #14
jhodgdonCommitted to 7.x and 8.x. Thanks!
Comment #16
David_Rothstein commentedThis was committed to Drupal 7, but for some reason was reverted later: http://drupalcode.org/project/drupal.git/commitdiff/549ced20094cc361f790...
I assume that was by mistake... but it's pretty weird.
I could fix it myself, but I'll leave it to another core committer to confirm that I'm not going crazy :)
Comment #17
jhodgdonYou are not going crazy (at least on this issue; I cannot vouch for your overall sanity. :) )...
The patch is still in 8.x, but there is no @return in 7.x and the patch needs to be reapplied. I suspect there was a merge issue or some other git mistake. I'll get it re-committed shortly.
Comment #18
jhodgdonCommitted (again) to 7.x.