In your menu item definitions, you can specify TRUE as the access callback to make the item always accessible.

See http://api.drupal.org/api/function/_menu_check_access/7.

The other day, I was trying to create a menu item with a dynamically generated path and hit a couple road blocks. After some reading I eventually worked it out and thought I would post an example here. It all came down to the wildcards and how to handle them. I was using a local task menu item as an example at first, but soon figured out that the wildcard technique for local tasks are quite a bit different than normal menu items...

These are all the readings I used to compile *some* understanding of the menu system:

Api Docs
Drupal Menu System Overview:
Dynamic Menu Argument replacement. This one is Good!
Wildcard usage and core's wildcards This one also has the full list of all the existing wildcard loaders for D6 (probably similar for D7)
http://api.drupal.org/api/function/page_example_menu
http://api.drupal.org/api/group/menu

Google Books:
Pro Drupal Development Chapter 4 - The Menu System

<?php

function time_sheet_menu() {
  $items = array();
  // This one creates a 'tab' (local task) when on a page whose URL matches the format:
  // 'user/%user/profile'. The syntax for %user is indicating two things:
  //   - '%' Represents a wild card (in this case we're looking for a user id)
  //   - 'user' Represents which wildcard loader to use ( user_load(%) )
  //        There are a finite number of wildcard loaders which can be seen at
  //        http://drupal.org/node/209056 (you will need to scroll down a bit)
  // What happens is:
  // 1) A tab is created on any path that matches user/%/profile (e.g. user/38/profile)
  // 2) When the link is clicked, profile_user_page() is called...
  // 3) The argument passed into profile_user_page() is the result of user_load(38)
  //     -- 'page arguments' gets an array passed in indicating which 
  //         part of the path should be used for the callback args.
  //         Assuming the path www.example.com/user/38/profile could have its path 
  //         numbered www.example.com/[0]/[1]/[2], array(1) is referring to the second
  //         item in the path after the base. In our case the number 38
  $items['user/%user/profile'] = array(
    'title' => 'Profile',
    'description' => 'My Profile',
    'page callback' => 'profile_user_page', // the function to be called when link is clicked [below]
    'page arguments' => array(1), // arguments for the callback function 'profile_use_page'
    'access arguments' => array('view own profile'), // permission
    'type' => MENU_LOCAL_TASK,
  );
  // In this example, we are creating a actual menu item with a dynamically generated path. 
  // Givens: A menu item will be added to the 'my_menu' menu,
  // with the text 'Profile', pointing to profile/[the_current_users_id]
  // How the path is generated:
  // 1) The %currentuser wildcard is actually calling the function: 
  //    currentuser_to_arg (defined after this function) because currentuser_load()
  //    is not in the list of existing wildcard loaders. The wildcard will be passed
  //    to the function: currentuser_to_arg(%)
  // 2) The currentuser_to_arg() [below] function runs and returns the user id
  // 3) The user id is passed as a argument into the time_sheet_user_page() callback
  //    using the same technique as the above example
  $items['profile/%currentuser'] = array(
    'title' => 'Profile', // The link text
    'description' => 'My Profile',
    'page callback' => 'profile_user_page', // the function to be called when link is clicked [below]
    'page arguments' => array(1), // arguments for the callback function 'profile_use_page'
    'access arguments' => array('view own profile'),
    'type' => MENU_NORMAL_ITEM,
    'menu_name' => 'my_menu', // You'll need to have a menu named my_menu for this to work
                              // If not specified, it will default to 'navigation'
  );
  // Just remember that a "MENU_CALLBACK" is really just telling
  // drupal what to do if that particular path is requested
  // It doesn't create menu items.
  $items['user/add_user'] = array(
    'page callback' => 'add_new_user_form', // the function to be called when link is clicked [below]
    'access arguments' => array('create new users'), // permission?
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
 * Helper function to dynamically enter the current user
 * into the path of the 'Profile' link in the my_menu menu
 */
function currentuser_to_arg($arg) {
  global $user;
  return $user->uid;
}

/**
 * A user's profile page
 *
 * @param $user_id
 * The user id of the user whose profile page will be laoded
 */
function profile_user_page($user_id) {
  // Enter your code here
}

/**
 * The form for adding a new User
 */
function add_new_user_form() {
  // Create a form here
  return $form
}

?>

In Drupal 6.x, menu items of type MENU_CALLBACK honor the title attribute. In 7.x, you'll find these items have a title like "Home". You can get something like the 6.x behavior by specifying type MENU_VISIBLE_IN_BREADCRUMB

I thought this worth mentioning, even if it is already documented.

If you want the menu item to show in the Main menu instead of the navigation, just set menu_name to 'main-menu', like so:

function mymodule_menu(){
  $items['mypage'] = array(
    'title' => 'Page name',
    'description' => t('Some page'),
    /* ... */
    'menu_name' => 'main-menu',
    /* ... */
  );
  return $items;
}

in page_example.module, there is an $items variable with 'expanded' => TRUE, which isn't mentioned on this page or in the module:

 $items['examples/page_example'] = array(
    'title' => 'Page Example',
    'page callback' => 'page_example_description',
    'access callback' => TRUE,
    'expanded' => TRUE,
  ); 

Not in the code above a small comment line:

// Need to add access callback or access arguments.

in the code for tabs:

// Make an additional tab called "Node settings" on "Foo settings"
$items['admin/config/foo/node'] = array(
'title' => 'Node settings',
'type' => MENU_LOCAL_TASK,
// Page callback and theme callback will be inherited from
// 'admin/config/foo', if not specified here to override.
// Need to add access callback or access arguments.
);

If you are having trouble with tabs not showing up using the code above you may need to add the access callback or access arguments as it says above.

If you are adding menu items that you would like to come up in a modal overlay, or in a different theme), you'll need to also implement hook_admin_paths().

This should only be required if you are using a path other than something that starts with "admin", as Drupal by default adds the path "admin/*" in system_admin_paths().

If you (like me) happen to do a faulty implementation of hook_menu and your site crashes and gives only 404 not found for all pages, try this: "Page Not Found" error on ALL pages of Drupal 6 website

Warning: using l() in descriptions will cause an infinite loop in Drupal core 7.7 and later. Using url() is safe.

Note that the include file is not only loaded for the page callback, but for the title callback as well.

Menu Access callback function gets called multiple time and sometimes even if you are not accessing corresponding menu item. Thats why dont alter anything in access callback function, just check if user can access the menu. You can place all that code in page callback.

Add menu block container in administrator configuration page
http://drupalst.com/blog/add-menu-block-administrator-configuration-page

/**
* Implementation of hook_menu
*/
function drupalst_blocks_menu() {
 
	$menu['admin/config/drupalst'] =  array(  // this is the block that contain another configuration links
		'title' => t('DRUPALST') , 
		'description' => t('Drupalst tools') , 
		'weight' => -8, 		
		'page callback' => 'system_admin_menu_block_page',  // we should implement this function in system.admin.inc file
		'access arguments' => array('access administration pages'), 
		'file' => 'system.admin.inc',	 // don't forget to add the file and path
		'file path' => drupal_get_path('module', 'system'),
		'position' => 'right', 
	); 
 
	$menu['admin/config/drupalst/blocks'] = array( // this is an example of configuration link
		'title' => t('Drupalst blocks') , 
		'description' => t('Add themed blocks to drupalst themes') , 
		'page callback' => '_drupalst_blocks_generator' , 		
		'type' => MENU_NORMAL_ITEM, 
		'access arguments' => array('administer site configuration') ,
	); 
 
	return $menu ; 	
}

There is a awesome 'controller' module: http://drupal.org/node/1389042
that allows to write something like this one without adding your rules in the hook_menu():

class MySuperControllerController {
  /**
   * @path => 'admin/config/controller',
   * @access arguments => array(CONTROLLER_CHANGE_SETTINGS_PERM),
   * @title => 'Controller',
   * @default => array('default' => 'Settings'),
   */
  public function indexAction() {
    require_once drupal_get_path('module', 'controller') . '/forms/settings_form.inc';
    return drupal_get_form('controller_settings_form');
  }

  /**
   * @path => 'admin/config/controller/hook-menu'
   * @access arguments => array(CONTROLLER_CHANGE_SETTINGS_PERM),
   * @title => 'Show hook_menu()',
   * @type => MENU_LOCAL_TASK,
   * @weight => 2,
   */
  public function exportAction() {
    require_once drupal_get_path('module', 'controller') . '/forms/export_form.inc';
    return drupal_get_form('controller_export_form');
  } 
...
}

I was having trouble getting a menu item to display with the following code:

<?php
function mymodule_menu() {
  $items['custom-page'] = array(
    'title' => 'Custom Page',
    'menu_name' => 'main-menu',
    'access arguments' => array('access custom pages')
  );
?>

It was continuously denying me access to the specified path in addition to not displaying the item in the menu. I discovered that the reason behind this is if you do not specify a page callback, then the access callback will acquire a value of 0 in the database and thus render that path/menu item inaccessible.

Working code:

<?php
function mymodule_menu() {
  $items['custom-page'] = array(
    'title' => 'Custom Page',
    'menu_name' => 'main-menu',
    'page callback' => 'mymodule_custom_page',
    'access arguments' => array('access custom pages')
  );
?>

From what I can determine, using a uid in a path to access a different users profiles or other user paths only works if the menu type is MENU_LOCAL_TASK. I tried MENU_NORMAL_ITEM to no avail.

This works

$items['user/%user/profile'] = array(
    'title' => 'Profile',
    'page callback' => 'profile_user_page',
    'page arguments' => array(1),
    'access arguments' => array('view own profile'),
    'type' => MENU_LOCAL_TASK,
);

This doesn't work

$items['user/%user/profile'] = array(
    'title' => 'Profile',
    'page callback' => 'profile_user_page',
    'page arguments' => array(1),
    'access arguments' => array('view own profile'),
    'type' => MENU_NORMAL_ITEM,
);

This blog post contains a potential solution that works, but doesn't seem to work with path aliases. http://yuriybabenko.com/blog/using-user-id-arguments-in-drupal-menu-items

Hi, i was desperately searching for how to change the title on a custom page, thx to IRC someone told me to use: drupal_set_title:

http://api.drupal.org/api/drupal/includes!bootstrap.inc/function/drupal_...

When changed 'title_callback' and 'title_arguments' in hook_menu_get_item_alter(), I had to serialize the array in 'title_arguments'.

function MY_MODULE_menu_get_item_alter(&$router_item, $path, $original_map){
  if ($my_condition) {
      $router_item['title_callback'] = 'MY_MODULE_custom_menu_title';
      $router_item['title_arguments'] = serialize(array(1,'reference_value'));
  }
}

Posting this to help other people as I had a hard time figuring it out myself.

The wildcard name set in the $item array key (%edit_example) is used
to trigger a function with the same name with _load suffix(edit_example_load()) automagically and will send the argument as parameter to this function.

Use the load function to check if the item you want to edit exists.
If load function returns false the form function(edit_example_form()) in "page arguments" is not called and an "page not found" will appear instead.
If not return false the return value will be the third parameter in the form function.

The number after the first "page argument"(The second "page argument") is pointing at wildcard in $item array key (represented by number if splitted by / like this 0/1/2/3/4/5)), i have not figured out why yet.

Totally logic!!! :D

function edit_example_menu() {
  $items['admin/config/system/edit_example/edit/%edit_example'] = array(
    'title' => t('Edit example'),
    'description' => t('Example of edit'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('edit_example_form', 5),
    'access arguments' => array('access administration pages'),
  );
}
  
function edit_example_load($example_id) {
  // Check if id item exist and return false to stop call to form function.
  // No use to edit non existing stuff
  return true;
}

function edit_example_form($form, &$form_state, $example_id) {
  //fill your form with data from exemple_id item
}

A) The path must be valid for it to show up in the menu. I struggled for a long time in creating a placeholder like this:

function foo_menu() {
   // '/foo' doesn't exist yet
  $items['foo'] => array( 'title' => 'foo', 'description' => 'bar');
  return $items;
}

and wondering why no entry would be created. Looks like there's a validation step when hook_menu() runs.

B) The wildcard MUST begin with a letter. I was trying to stick to a convention of having _modulename as the prefix for functions that aren't directly implementing or creating a hook, like this:

function foo_menu() {
  $items['foo/%_foo'] => array( 'title' => 'foo', 'description' => 'bar');
  return $items;
}

function _foo_to_arg() { /* do something */ }

But drupal will silently fail on the %_foo wildcard without any indication otherwise.

C) God forbid you ever accidentally create an empty path  $items[''] =  or something that evaluates to an empty path  $items[''] = /* for some reason this turns into an empty path */  You will never be able to get rid of this menu item once created, due to some NULL checks, no matter how many times you rebuild menu/clear cache/remove module/etc. the only fix in this situation is to manually find the menu entry in your sql database (table: menu_links i think) and deleting it.

I use drupal_json_output as delivery callback. But this isn't normal practice for the system. Should I expect problems?

In Drupal 7 the pagetitle does not work for MENU_LOCAL_TASK and perhaps MENU_CALLBACK,

http://alastaira.wordpress.com/2011/01/18/drupal-7-x-hook_menu-not-displ...

The title of a page turns to "Home".

The workaround in this post is to use MENU_VISIBLE_IN_BREADCRUMB instead.

Thanks for the plid reminder!

Looking at the menu entry in the menu-links table shows that despite clearing the cache this setting is not necessarily picked up. In fact, it only registered when I changed the name and title of my menu item and proceeded to clear the cache.

I could have just updated directly in the database table myself but I mention this as perhaps something's amiss in the way hook_menu is read and passed to the database table?

Per the doc:
"options": An array of options to be passed to l() when generating a link from this menu item. Note that the "options" parameter has no effect on MENU_LOCAL_TASK, MENU_DEFAULT_LOCAL_TASK, and MENU_LOCAL_ACTION items.

I "should" be able to set "html" => true here and have l() not strip out the html. This does not work. My menu item is a MENU_NORMAL_ITEM so I don't see any reason for this not to work.

Tracing the code on a menu router rebuild, I see the property peristing through _menu_link_build. I do not see where this option is stored anywhere in the menu tables though. Options under menu_links just has the title attribute.

I put a breakpoint on every call to l() in menu.inc and I can see where my menu item is build, however I do not see where the options specified in the menu item are making it into the localized_options array that is passed into the l() call.

Is anyone else using this feature? I'm running 7.22.

The "delivery callback" function is very powerfull but it is not documented.

By default it calls the drupal_deliver_html_page() function, that returns a full rendered HTML page, including, header, footer, blocks, etc.

For webservices applications Drupal provides a json output using the ajax_deliver() function.

This function is very easy to manipulate, for example if you want your call to return just the content of your page without headers, footers and so, just use the following function:

<?php
function MyModule_content_callback($page_callback_result) {
  print drupal_render($page_callback_result);
  // Perform end-of-request tasks.
  drupal_page_footer();
}
?>

This one could be used as response for jQuery.load().

Here i have created the menu and sub link for the menu , it's created but it shows only menu, not a sub link of menu .

I want display the sub link of menu

function mymodule_coupon_menu() {
$menu_items['admin/mymodule'] = array(
'title' => 'mymodule',
'callback' => 'drupal_goto',
'page arguments' => array('admin/mymodule'),
'access arguments' => array('wandisco coupon'),
'weight' => 15,
'expanded' => TRUE,
'type' => MENU_NORMAL_ITEM,
);
$menu_items['admin/mymodule/coupon'] = array(
'title' => t('mymodule coupon'),
'page callback' => 'drupal_get_form',
'page arguments' => array('admin/mymodule/coupon'),
'access arguments' => array('mymodule coupon'),
'weight' => 0,
'expanded' => TRUE,
'type' => MENU_NORMAL_ITEM,
);

return $menu_items;
}

If you happen to call arg(X) within the callback function, and the argument is not set, a "Page not found" page will be displayed instead.

So when you're desperate after a few menu_rebuild()'s, flushing cache and maybe even rebuild via menu_rebuild(), just check your code for this.

From https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_de...

The page callback function can return one of:

• NULL: to indicate no content.

• An integer menu status constant: to indicate an error condition.

• A string of HTML content.

• A renderable array of content.

Returning a renderable array rather than a string of HTML is preferred, because that provides modules with more flexibility in customizing the final result.

See https://drupal.org/node/1800686.

I wanted a menu item to show up both as MENU_LOCAL_TASK and MENU_NORMAL_ITEM. This can be achieved with a pipe delimiter! Like so:

'type' => MENU_LOCAL_TASK | MENU_NORMAL_ITEM,

i create a custom frontpage page--frontpage.tpl.php... Actually i want to create a menu tab dynamically.. i try this " print drupal_render($main_menu_tree);" but not work in custom page.. Please help me....

Este modulo nos permite crear el contenido en una ruta, por ejemplo si la ruta es 'propiedad/la_mia', un ejemplo seria:

in the file:
standart.module

function standart_menu() {
  $items = array();
  $items['propiedad/la_mia'] = array(
    'title' => 'The best property',
    'page callback' => 'nombrefuncionavizualizar',
  );
  return $items;
}

//  YO tecomiendo que las funciones dentro de un modulo, tengan el nombre del modulo
//  standart_nombrefuncionavizualizar
function nombrefuncionavizualizar()
{
  return 'La mejor';
}

This took me some to figure out so maybe it could help to someone else.
I wanted to allow access to the users from some Roles.

I has to write access arguments this way:

'access callback' => 'user_has_role',
'access arguments' => array(array('Role 1', 'Role 2')),

Then my validation function looks looks like this:

function user_has_role($roles) {
    if (user_is_logged_in()) {
        global $user;
        if (in_array('administrator', $user->roles)) {
            return TRUE;
        }
        foreach ($roles as $role) {
            if (in_array($role, $user->roles)) {
                return TRUE;
            }
        }
    }
    else {
        return FALSE;
    }
}

This look like a typo:

'mymodule_abc_to_arg()' should be '%mymodule_abc_to_arg()'

You might can't get effect just set weight for menu and sub menu until you clear cache.

Some of the examples above are using t() for title like 'title' => t('Title').
These will result in calling t() twice and you will end up with translated strings in the locales_source table because Drupal will call t(t('Title')).

https://api.drupal.org/api/drupal/includes!menu.inc/constant/MENU_MAX_PA...

In some cases, to avoid the Object of class stdClass could not be converted to int , you might want to put 'page callback', 'page arguments', 'access callback', and 'access arguments' near the end of your item list. For example, this commit to the Nodequeue module was required to work around that notice.

1. Clear cache
2. Make sure your hook_menu ends with a return:
return $items;