You are here

function hook_overlay_paths in Overlay Paths 7

Define non-administrative overlay paths.

Modules may specify whether or not the paths they define in hook_menu() should be displayed in the overlay, with the standard site theme.

To change the overlay status of menu items defined in another module's hook_menu(), modules should implement hook_overlay_paths_alter().

Return value

An associative array. For each item, the key is the path in question, in a format acceptable to drupal_match_path(). The value for each item should be FALSE (to explicitly stop the path using the overlay), TRUE, or an associative array with the following possible keys:

  • 'width': The width of the overlay when viewing this path, this can be specified in 'px', 'em' or '%' or no units, which will default to using 'px'.

See also

hook_menu()

drupal_match_path()

hook_admin_paths()

hook_overlay_paths_alter()

2 functions implement hook_overlay_paths()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

overlay_paths_get_overlay_paths in ./overlay_paths.module
Get an array of non-administrative overlay paths.
overlay_paths_ui_overlay_paths in overlay_paths_ui/overlay_paths_ui.module
Implements hook_overlay_paths().
1 invocation of hook_overlay_paths()
overlay_paths_get_overlay_paths in ./overlay_paths.module
Get an array of non-administrative overlay paths.

File

./overlay_paths.api.php, line 36
Hooks provided by the overlay paths module.

Code

function hook_overlay_paths() {
  $paths = array(
    'mymodule/*/add' => TRUE,
    'mymodule/*/edit' => array(
      'width' => 500,
    ),
  );
  return $paths;
}