Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Hooks for the Help system.
Chris@0:  */
Chris@0: 
Chris@18: use Drupal\Core\Url;
Chris@18: 
Chris@0: /**
Chris@0:  * @addtogroup hooks
Chris@0:  * @{
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Provide online user help.
Chris@0:  *
Chris@0:  * By implementing hook_help(), a module can make documentation available to
Chris@0:  * the user for the module as a whole, or for specific pages. Help for
Chris@0:  * developers should usually be provided via function header comments in the
Chris@0:  * code, or in special API example files.
Chris@0:  *
Chris@0:  * The page-specific help information provided by this hook appears in the
Chris@0:  * Help block (provided by the core Help module), if the block is displayed on
Chris@0:  * that page. The module overview help information is displayed by the Help
Chris@0:  * module. It can be accessed from the page at /admin/help or from the Extend
Chris@0:  * page. If a module implements hook_help() the help system expects module
Chris@0:  * overview help to be provided.
Chris@0:  *
Chris@0:  * For detailed usage examples of:
Chris@0:  * - Module overview help, see content_translation_help(). Module overview
Chris@0:  *   help should follow
Chris@0:  *   @link https://www.drupal.org/node/632280 the standard help template. @endlink
Chris@0:  * - Page-specific help using only routes, see book_help().
Chris@0:  * - Page-specific help using routes and $request, see block_help().
Chris@0:  *
Chris@0:  * @param string $route_name
Chris@0:  *   For page-specific help, use the route name as identified in the
Chris@0:  *   module's routing.yml file. For module overview help, the route name
Chris@0:  *   will be in the form of "help.page.$modulename".
Chris@0:  * @param Drupal\Core\Routing\RouteMatchInterface $route_match
Chris@0:  *   The current route match. This can be used to generate different help
Chris@0:  *   output for different pages that share the same route.
Chris@0:  *
Chris@0:  * @return string|array
Chris@0:  *   A render array, localized string, or object that can be rendered into
Chris@0:  *   a string, containing the help text.
Chris@0:  */
Chris@0: function hook_help($route_name, \Drupal\Core\Routing\RouteMatchInterface $route_match) {
Chris@0:   switch ($route_name) {
Chris@0:     // Main module help for the block module.
Chris@0:     case 'help.page.block':
Chris@18:       return '<p>' . t('Blocks are boxes of content rendered into an area, or region, of a web page. The default theme Bartik, for example, implements the regions "Sidebar first", "Sidebar second", "Featured", "Content", "Header", "Footer", etc., and a block may appear in any one of these areas. The <a href=":blocks">blocks administration page</a> provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions.', [':blocks' => Url::fromRoute('block.admin_display')->toString()]) . '</p>';
Chris@0: 
Chris@0:     // Help for another path in the block module.
Chris@0:     case 'block.admin_display':
Chris@0:       return '<p>' . t('This page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the <em>Save blocks</em> button at the bottom of the page.') . '</p>';
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Perform alterations on help page section plugin definitions.
Chris@0:  *
Chris@0:  * Sections for the page at /admin/help are provided by plugins. This hook
Chris@0:  * allows modules to alter the plugin definitions.
Chris@0:  *
Chris@0:  * @param array $info
Chris@0:  *   Array of plugin information exposed by hook page section plugins, altered
Chris@0:  *   by reference.
Chris@0:  *
Chris@0:  * @see \Drupal\help\HelpSectionPluginInterface
Chris@0:  * @see \Drupal\help\Annotation\HelpSection
Chris@0:  * @see \Drupal\help\HelpSectionManager
Chris@0:  */
Chris@0: function hook_help_section_info_alter(&$info) {
Chris@0:   // Alter the header for the module overviews section.
Chris@0:   $info['hook_help']['header'] = t('Overviews of modules');
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * @} End of "addtogroup hooks".
Chris@0:  */