API page: http://api.drupal.org/api/drupal/includes%21bootstrap.inc/function/varia...
On the variable_set() page, it states that the function will handle serializing data for you. On the variable_get() page, there is no mention of serialization or unserializing. For consistency, if nothing else, you need to mention it on this page. Otherwise the documentation sends mixed messages and is misleading. Aside from consistency, it would just be very useful.
| Comment | File | Size | Author |
|---|---|---|---|
| #4 | variablegetserializationdocumentation-1538182-4.patch | 486 bytes | infiniteluke |
| #2 | variablegetserializationdocumentation-1538182-2.patch | 484 bytes | infiniteluke |
Comments
Comment #1
jhodgdonThanks -- good idea to document.
The function does handle unserializing, which you can see in the variable_init()/variable_initialize() functions that read the variables out of the database.
This needs documenting in D8/D7/D6, starting with D8.
Comment #2
infiniteluke commentedHere is a try at the wording.
Comment #3
jhodgdonPerhaps it should say "unserializing" instead of "serializing"?
Comment #4
infiniteluke commentedGood point.
Comment #5
jhodgdonThat seems fine to me. I'll get it committed.
Comment #6
jhodgdonCommitted to both 8.x and 7.x. Thanks!