How do I use render() for my custom content?

Question

I am creating a custom module to read content from text files and generate various custom content types I have defined on a project. Some will have specialized lists and tables and all will have specific class assignments. I can easily generate the appropriate markup added to the text and send it to the node->body, but have been researching render().

I understand that render takes an array that encodes the content and styling, but cannot find a framework for the array to know how to structure it for my content.

How does render work?

Answer 1

There is no magic framework involved (just magic array structures). You just need to build up your array (Or in your case, extend $node->content in hook_node_view() if you want to alter how a node is displayed).

Basically, a render array is a nested array with properties (always start with a #) and child-elements, which are assumed to be another render-array. drupal_render() will then dig itself through and convert it to HTML.

There are basically three things you can do, define a #type (types are defined in hook_element_info(), see system_element_info) including the necessary properties, define a #theme function and the necessary properties or just simply #markup, which is simply going to print whatever is in it (Note that #markup actually #type => markup, which is added automatically)

A basic example:

<?php
$render_array = array(
  '#type' => 'cointainer',
  '#attributes' => array('class' => array('your-class')),
  'child_element' => array(
    '#markup' => t('Some text'),
  ),
  'a_table' => array(
    '#theme' => 'table',
    '#rows' => $rows,
    '#header' => $header,
  ),
);
$node->content['your_module'] = $render_array;
?>

Assuming that the node template uses render($content), this will result in <div class="your-class">Some text<table>...</table></div>

You can also directly return such an array in a page callback function, see userpoints_list_transactions() for an example.

I have a feeling that you are however asking the wrong question: Note that is only for rendering, you can not store anything in this structure. To store that, you should first create the necessary fields on your content types and put your data in it, if you don't want it to be just text within the body. Also have a look at Display Suite, which gives you a lot of control on how to display your fields.