Community Documentation

hook_view

5 node.php hook_view($node, $teaser = FALSE, $page = FALSE)
6 node.php hook_view($node, $teaser = FALSE, $page = FALSE)
7 node.api.php hook_view($node, $view_mode)
8 node.api.php hook_view($node, $view_mode)

Display a node.

This is a hook used by node modules. It allows a module to define a custom method of displaying its nodes, usually by displaying extra information particular to that node type.

Parameters

$node: The node to be displayed.

$teaser: Whether we are to generate a "teaser" or summary of the node, rather than display the whole thing.

$page: Whether the node is being displayed as a standalone page. If this is TRUE, the node title should not be displayed, as it will be printed automatically by the theme system. Also, the module may choose to alter the default breadcrumb trail in this case.

Return value

$node. The passed $node parameter should be modified as necessary and returned so it can be properly presented. Nodes are prepared for display by assembling a structured array in $node->content, rather than directly manipulating $node->body and $node->teaser. The format of this array is the same used by the Forms API. As with FormAPI arrays, the #weight property can be used to control the relative positions of added elements. If for some reason you need to change the body or teaser returned by node_prepare(), you can modify $node->content['body']['#value']. Note that this will be the un-rendered content. To modify the rendered output, see hook_nodeapi($op = 'alter').

For a detailed usage example, see node_example.module.

Related topics

▾ 32 functions implement hook_view()

aggregator_admin_overview in modules/aggregator/aggregator.module
Menu callback; displays the aggregator administration page.
aggregator_view in modules/aggregator/aggregator.module
blog_view in modules/blog/blog.module
Implementation of hook_view().
book_admin_overview in modules/book/book.module
Returns an administrative overview of all books.
comment_admin_overview in modules/comment/comment.module
comment_form_add_preview in modules/comment/comment.module
fileupload_view in developer/examples/fileupload.module
Implementation of hook_view.
filter_admin_overview in modules/filter/filter.module
Displays a list of all input formats and which one is the default
forum_overview in modules/forum/forum.module
Returns an overview list of existing forums and containers
forum_view in modules/forum/forum.module
Implementation of hook_view().
menu_overview in modules/menu/menu.module
Menu callback; present the main menu management page.
multipage_form_example_view in developer/examples/multipage_form_example.module
Implementation of hook_view().
node_example_view in developer/examples/node_example.module
Implementation of hook_view().
node_form_add_preview in modules/node/node.module
node_page_view in modules/node/node.module
Menu callback; view a single node.
node_preview in modules/node/node.module
Generate a node preview.
node_revision_overview in modules/node/node.module
Generate an overview table of older revisions of a node.
node_view in modules/node/node.module
Generate a display of the given node.
path_overview in modules/path/path.module
Return a listing of all defined URL aliases.
poll_view in modules/poll/poll.module
Implementation of hook_view().
profile_admin_overview in modules/profile/profile.module
Menu callback; display a listing of all editable profile fields.
search_view in modules/search/search.module
Menu callback; presents the search form and/or search results.
system_settings_overview in modules/system/system.module
Menu callback; displays a module's settings page.
theme_comment_admin_overview in modules/comment/comment.module
theme_comment_preview in modules/comment/comment.module
theme_comment_view in modules/comment/comment.module
theme_filter_admin_overview in modules/filter/filter.module
theme_node_preview in modules/node/node.module
Display a node preview for display during node creation and editing.
theme_watchdog_form_overview in modules/watchdog/watchdog.module
user_view in modules/user/user.module
watchdog_form_overview in modules/watchdog/watchdog.module
watchdog_overview in modules/watchdog/watchdog.module
Menu callback; displays a listing of log messages.

File

developer/hooks/node.php, line 418
These hooks are defined by node modules, modules that define a new kind of node.

Code

<?php
function hook_view($node, $teaser = FALSE, $page = FALSE) {
  if ($page) {
    $breadcrumb = array();
    $breadcrumb[] = array(
      'path' => 'example',
      'title' => t('example'),
    );
    $breadcrumb[] = array(
      'path' => 'example/' . $node->field1, 
      'title' => t('%category', array('%category' => $node->field1)),
    );
    $breadcrumb[] = array('path' => 'node/' . $node->nid);
    menu_set_location($breadcrumb);
  }

  $node = node_prepare($node, $teaser);
  $node->content['myfield'] = array(
    '#value' => theme('mymodule_myfield', $node->myfield), 
    '#weight' => 1,
  );

  return $node;
}
?>
Login or register to post comments