function menu_get_object in Drupal 7

Same name and namespace in other branches

1. 6 includes/menu.inc \menu_get_object()

Gets a loaded object from a router item.

menu_get_object() provides access to objects loaded by the current router item. For example, on the page node/%node, the router loads the %node object, and calling menu_get_object() will return that. Normally, it is necessary to specify the type of object referenced, however node is the default. The following example tests to see whether the node being displayed is of the "story" content type:

$node = menu_get_object();
$story = $node->type == 'story';

Parameters

$type: Type of the object. These appear in hook_menu definitions as %type. Core provides aggregator_feed, aggregator_category, contact, filter_format, forum_term, menu, menu_link, node, taxonomy_vocabulary, user. See the relevant {$type}_load function for more on each. Defaults to node.

$position: The position of the object in the path, where the first path segment is 0. For node/%node, the position of %node is 1, but for comment/reply/%node, it's 2. Defaults to 1.

$path: See menu_get_item() for more on this. Defaults to the current path.

Related topics

8 calls to menu_get_object()

book_block_view in modules/book/book.module

Implements hook_block_view().

book_page_alter in modules/book/book.module

Implements hook_page_alter().

hook_page_build in modules/system/system.api.php

Add elements to a page before it is rendered.

node_block_list_alter in modules/node/node.module

Implements hook_block_list_alter().

node_is_page in modules/node/node.module

Returns whether the current page is the full page view of the passed-in node.

... See full list

File

includes/menu.inc, line 982

API for the Drupal menu system.

Code

function menu_get_object($type = 'node', $position = 1, $path = NULL) {
  $router_item = menu_get_item($path);
  if (isset($router_item['load_functions'][$position]) && !empty($router_item['map'][$position]) && $router_item['load_functions'][$position] == $type . '_load') {
    return $router_item['map'][$position];
  }
}