You are here

function big_pipe_help in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/big_pipe/big_pipe.module \big_pipe_help()
  2. 9 core/modules/big_pipe/big_pipe.module \big_pipe_help()

Implements hook_help().

File

core/modules/big_pipe/big_pipe.module, line 15
Adds BigPipe no-JS detection.

Code

function big_pipe_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.big_pipe':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The BigPipe module sends pages with dynamic content in a way that allows browsers to show them much faster. For more information, see the <a href=":big_pipe-documentation">online documentation for the BigPipe module</a>.', [
        ':big_pipe-documentation' => 'https://www.drupal.org/documentation/modules/big_pipe',
      ]) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Speeding up your site') . '</dt>';
      $output .= '<dd>' . t('The module requires no configuration. Every part of the page contains metadata that allows BigPipe to figure this out on its own.') . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}