help.module 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. <?php
  2. /**
  3. * @file
  4. * Manages displaying online help.
  5. */
  6. use Drupal\Core\Block\BlockPluginInterface;
  7. use Drupal\Core\Routing\RouteMatchInterface;
  8. /**
  9. * Implements hook_help().
  10. */
  11. function help_help($route_name, RouteMatchInterface $route_match) {
  12. switch ($route_name) {
  13. case 'help.main':
  14. $output = '<h2>' . t('Getting Started') . '</h2>';
  15. $output .= '<p>' . t('Follow these steps to set up and start using your website:') . '</p>';
  16. $output .= '<ol>';
  17. $output .= '<li>' . t('<strong>Configure your website</strong> Once logged in, visit the <a href=":admin">Administration page</a>, where you may <a href=":config">customize and configure</a> all aspects of your website.', [':admin' => \Drupal::url('system.admin'), ':config' => \Drupal::url('system.admin_config')]) . '</li>';
  18. $output .= '<li>' . t('<strong>Enable additional functionality</strong> Next, visit the <a href=":modules">Extend page</a> and enable modules that suit your specific needs. You can find additional modules at the <a href=":download_modules">Drupal.org modules page</a>.', [':modules' => \Drupal::url('system.modules_list'), ':download_modules' => 'https://www.drupal.org/project/modules']) . '</li>';
  19. $output .= '<li>' . t('<strong>Customize your website design</strong> To change the "look and feel" of your website, visit the <a href=":themes">Appearance page</a>. You may choose from one of the included themes or download additional themes from the <a href=":download_themes">Drupal.org themes page</a>.', [':themes' => \Drupal::url('system.themes_page'), ':download_themes' => 'https://www.drupal.org/project/themes']) . '</li>';
  20. // Display a link to the create content page if Node module is enabled.
  21. if (\Drupal::moduleHandler()->moduleExists('node')) {
  22. $output .= '<li>' . t('<strong>Start posting content</strong> Finally, you may <a href=":content">add new content</a> to your website.', [':content' => \Drupal::url('node.add_page')]) . '</li>';
  23. }
  24. $output .= '</ol>';
  25. $output .= '<p>' . t('For more information, refer to the help listed on this page or to the <a href=":docs">online documentation</a> and <a href=":support">support</a> pages at <a href=":drupal">drupal.org</a>.', [':docs' => 'https://www.drupal.org/documentation', ':support' => 'https://www.drupal.org/support', ':drupal' => 'https://www.drupal.org']) . '</p>';
  26. return ['#markup' => $output];
  27. case 'help.page.help':
  28. $output = '';
  29. $output .= '<h3>' . t('About') . '</h3>';
  30. $output .= '<p>' . t('The Help module generates <a href=":help-page">Help reference pages</a> to guide you through the use and configuration of modules, and provides a Help block with page-level help. The reference pages are a starting point for <a href=":handbook">Drupal.org online documentation</a> pages that contain more extensive and up-to-date information, are annotated with user-contributed comments, and serve as the definitive reference point for all Drupal documentation. For more information, see the <a href=":help">online documentation for the Help module</a>.', [':help' => 'https://www.drupal.org/documentation/modules/help/', ':handbook' => 'https://www.drupal.org/documentation', ':help-page' => \Drupal::url('help.main')]) . '</p>';
  31. $output .= '<h3>' . t('Uses') . '</h3>';
  32. $output .= '<dl>';
  33. $output .= '<dt>' . t('Providing a help reference') . '</dt>';
  34. $output .= '<dd>' . t('The Help module displays explanations for using each module listed on the main <a href=":help">Help reference page</a>.', [':help' => \Drupal::url('help.main')]) . '</dd>';
  35. $output .= '<dt>' . t('Providing page-specific help') . '</dt>';
  36. $output .= '<dd>' . t('Page-specific help text provided by modules is displayed in the Help block. This block can be placed and configured on the <a href=":blocks">Block layout page</a>.', [':blocks' => (\Drupal::moduleHandler()->moduleExists('block')) ? \Drupal::url('block.admin_display') : '#']) . '</dd>';
  37. $output .= '</dl>';
  38. return ['#markup' => $output];
  39. }
  40. }
  41. /**
  42. * Implements hook_theme().
  43. */
  44. function help_theme($existing, $type, $theme, $path) {
  45. return [
  46. 'help_section' => [
  47. 'variables' => [
  48. 'title' => NULL,
  49. 'description' => NULL,
  50. 'links' => NULL,
  51. 'empty' => NULL,
  52. ],
  53. ],
  54. ];
  55. }
  56. /**
  57. * Implements hook_preprocess_HOOK() for block templates.
  58. */
  59. function help_preprocess_block(&$variables) {
  60. if ($variables['plugin_id'] == 'help_block') {
  61. $variables['attributes']['role'] = 'complementary';
  62. }
  63. }
  64. /**
  65. * Implements hook_block_view_BASE_BLOCK_ID_alter().
  66. */
  67. function help_block_view_help_block_alter(array &$build, BlockPluginInterface $block) {
  68. // Assume that most users do not need or want to perform contextual actions on
  69. // the help block, so don't needlessly draw attention to it.
  70. unset($build['#contextual_links']);
  71. }