'; + $output .= t('The simple page requires \'access simple page\' + permission. The different permissions page requires + \'access content\' permission. The custom access + callback page requires \'access content\' permission + and the visitor to be signed in. The arguments page + requires \'access arguments page\' permission.'); + $output .= '
'; + return $output; + } +} + +/** + * Implements hook_perm() * * Since the access to our new custom pages will be granted based on * special permissions, we need to define what those permissions are here. @@ -28,6 +48,8 @@ * administration pages. */ function page_example_perm() { + // Defining permissions for your module is as simple + // as returning an array of strings. return array( 'access simple page', 'access arguments page', @@ -35,7 +57,7 @@ function page_example_perm() { } /** - * Implementation of hook_menu(). + * Implements hook_menu() * * hook_menu() must be implemented to emit items to place in the main menu. * This is a required step for modules wishing to display their own pages, @@ -45,6 +67,9 @@ function page_example_perm() { * * With the below menu definitions, URLs will be interpreted as follows: * + * Note that the URLs below are written as though Clean URLs are not + * enabled on the site. + * * If the user accesses http://example.com/?q=examples/page_example, then the * menu system will look for a menu item with that path. In this case it will * find a match, and execute page_example_description(). @@ -58,8 +83,8 @@ function page_example_perm() { * finding a match, it will look for examples/page_example/arguments/1/%. Again * not finding a match, it will look for examples/page_example/arguments/%/2. * Yet again not finding a match, it will look for example/arguments/%/%. This - * time it finds a match, and so will execute page_example_arguments(1, 2). Note - * the parameters being passed; this is a very useful technique. + * time it finds a match, and so will execute page_example_arguments(1, 2). + * Note the parameters being passed; this is a very useful technique. * * If http://example.com/?q=examples/page_example/arguments/1 is accessed, the * menu system will match 'examples/page_example', and not @@ -67,12 +92,24 @@ function page_example_perm() { * require 5 arguments. All the elements included in the menu entry definition * should be present for the menu system to match the request. * + * If the user accesses + * http://example.com/?q=examples/page_example/different-permission but + * does not have the required 'access content' permission, access will be + * denied. + * + * If the user accesses + * http://example.com/?q=examples/page_example/custom-access-callback but + * does not have the required 'access content' permission and/or + * is not signed in, access will be denied. + * * The @link menu_example.module Menu Example @endlink provides more extensive * examples for hook_menu(). */ function page_example_menu() { // This is the minimum information you can provide for a menu item. This menu // item will be created in the default menu (Navigation). + // Specifying 'access callback' => TRUE causes this menu item to be + // available for all roles. $items['examples/page_example'] = array( 'title' => 'Page Example', 'page callback' => 'page_example_description', @@ -109,11 +146,52 @@ function page_example_menu() { 'type' => MENU_CALLBACK, ); + // You are not limited to checking for permissions defined by + // this module. You can also check for permissions defined by + // other modules. In this case, we will check for permissions + // defined by node.module + $items['examples/page_example/different-permission'] = array( + 'title' => 'Page example checking for other permissions', + 'page callback' => 'page_example_other_permissions', + 'access arguments' => array('access content'), + ); + + // You can also define your own access callback function. + $items['examples/page_example/custom-access-callback'] = array( + 'title' => 'Page example using a custom access callback', + 'page callback' => 'page_example_custom_access_page', + 'access callback' => page_example_custom_access_callback, + ); return $items; } +/** + * None of these page examples makes use of the Form API. + * The @link form_example.module Form Example @endlink provides + * examples that do. + */ function page_example_description() { - return ''.t('The page_example provides two pages, "simple" and "arguments". The simple page just returns a string for display. The arguments page takes two arguments and displays them, as in @arguments_link', array('@simple_link' => url('examples/page_example/simple', array('absolute' => TRUE)), '@arguments_link' => url('examples/page_example/arguments/23/56', array('absolute' => TRUE)))).'
'; + $output = '
'; + $output .= t('The page_example provides four pages, "simple", "arguments", + "different permissions" and "custom access callback". + The simple page, + different permissions page and + custom access callback page + just return a string for display. + The arguments page takes + two arguments and displays them, + as in @arguments_link.', + array( + '@simple_link' => url('examples/page_example/simple', + array('absolute' => TRUE)), + '@dp_link' => url('examples/page_example/different-permission', + array('absolute' => TRUE)), + '@cac_link' => url('examples/page_example/custom-access-callback', + array('absolute' => TRUE)), + '@arguments_link' => url('examples/page_example/arguments/23/56', + array('absolute' => TRUE)))); + $output .= '
'; + return $output; } @@ -135,12 +213,12 @@ function page_example_simple() { /** * A more complex page callback that takes arguments. * - * The arguments are passed in from the page URL. There in our hook_menu + * The arguments are passed in from the page URL. In our hook_menu * implementation we instructed the menu system to extract the last two * parameters of the path and pass them to this function as arguments. */ function page_example_arguments($first, $second) { - // Make sure you don't trust the URL to be safe! Always check for exploits. + // Make sure you don't trust the arguments to be safe! Always check for exploits. if (!is_numeric($first) || !is_numeric($second)) { // We will just show a standard "access denied" page in this case. drupal_access_denied(); @@ -154,6 +232,24 @@ function page_example_arguments($first, $second) { return theme('item_list', $list); } +function page_example_other_permissions() { + return '' . t('Evidently, you are authorized to view content on the site.') . '
'; +} + /** - * @} End of "defgroup page_example". + * If your custom access callback function checks + * for permissions, it should still use user_access. + * You may add whatever additional logic you like, though. */ +function page_example_custom_access_callback() { + global $user; + return user_access('access simple page') && $user->uid > 0; +} + +function page_example_custom_access_page() { + return '' . t('Welcome to the custom access page, registered visitor.') . '
'; +} + +/** + * @} End of "defgroup page_example". + */ \ No newline at end of file