hook_admin_paths

  1. drupal
    1. 8
    2. 7
Versions
7 – 8 hook_admin_paths()

Define administrative paths.

Modules may specify whether or not the paths they define in hook_menu() are to be considered administrative. Other modules may use this information to display those pages differently (e.g. in a modal overlay, or in a different theme).

To change the administrative status of menu items defined in another module's hook_menu(), modules should implement hook_admin_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 TRUE (for paths considered administrative) or FALSE (for non- administrative paths).

See also

hook_menu()

drupal_match_path()

hook_admin_paths_alter()

Related topics

Code

modules/system/system.api.php, line 469

<?php
function hook_admin_paths() {
  $paths = array(
    'mymodule/*/add' => TRUE, 
    'mymodule/*/edit' => TRUE,
  );
  return $paths;
}
?>