node_build_content return value doc is wrong [#1095066]

API page: http://api.drupal.org/api/drupal/modules--node--node.module/function/nod...

Describe the problem you have found:

The return values is documented as:

An structured array containing the individual elements of the node's body.

But the code disagrees:

$node->body = isset($node->body) ? str_replace('<!--break-->', '', $node->body) : '';
//...
return $node;

We're really returning a node withe the node's content property containing an array of structured data. See hook_view() for more details.

Comment	File	Size	Author
#9	node_build_content-1095066-9.patch	603 bytes	barbi
#9
#7	node_build_content-1095066-7.patch	602 bytes	barbi
#7
#3	node_build_content-1095066.patch	507 bytes	barbi
#3

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 17 March 2011 at 16:26

Title:

Documentation problem with node_build_content

» node_build_content return value doc is wrong

That is true, and it should be fixed. This is a Drupal 6 problem only -- in D7 the function doesn't return anything (it modifies $node in place).

Agreed with the "Novice" tag. Should be a good project for a novice doc contributor.

Comment #2

barbi CreditAttribution: barbi commented 22 May 2011 at 19:47

Assigned:

Unassigned

» barbi

Comment #3

barbi CreditAttribution: barbi commented 22 May 2011 at 20:16

Priority:	Normal	» Critical
Status:	Active	» Needs review

File	Size
node_build_content-1095066.patch	507 bytes

Changed return to "A fully-populated node object."

Comment #4

dawehner

German

CreditAttribution: dawehner commented 22 May 2011 at 20:18

Priority:	Critical	» Normal
Status:	Needs review	» Reviewed & tested by the community

node_load does the same see


 * @return
 *   A fully-populated node object.
 */
function node_load($param = array(), $revision = NULL, $reset = NULL) {

so the patch is fine.

Congratulations on your first patch.

@barbi: Critical means that something is really really broken. For example a white screen of death.
Set back to normal again.

Comment #5

Gábor Hojtsy

he/him

Hungarian

Hungary

CreditAttribution: Gábor Hojtsy commented 23 May 2011 at 11:45

Status:

Reviewed & tested by the community

» Needs work

Well, node_build_content() is only one of the functions that is being used to build up the "fully-populated node object", so I'd not say it builds a fully populated node object. Yes, that is what node_load() does. We should be more specific here and say what it builds.

Comment #6

barbi CreditAttribution: barbi commented 5 June 2011 at 05:49

Follow up:
Can you please suggest a good description?

Comment #7

barbi CreditAttribution: barbi commented 7 July 2011 at 23:53

Status:

Needs work

» Needs review

File	Size
node_build_content-1095066-7.patch	602 bytes

Modified the description to
* An node object with its content property set to structured array
* containing the individual elements of the node's body.