function WorkspacesUiHooks::help

Implements hook_help().

Attributes

#[Hook('help')]

File

core/modules/workspaces_ui/src/Hook/WorkspacesUiHooks.php, line 22

Class

WorkspacesUiHooks
Hook implementations for the workspaces_ui module.

Namespace

Drupal\workspaces_ui\Hook

Code

public function help($route_name, RouteMatchInterface $route_match) : ?string {
  switch ($route_name) {
    // Main module help for the Workspaces UI module.
    case 'help.page.workspaces_ui':
      $output = '';
      $output .= '<h2>' . $this->t('About') . '</h2>';
      $output .= '<p>' . $this->t('The Workspaces UI module provides an interface for managing workspaces for the <a href=":workspaces_module">Workspaces module</a>. For more information, see the <a href=":workspaces">online documentation for the Workspaces UI module</a>.', [
        ':workspaces_module' => Url::fromRoute('help.page', [
          'name' => 'workspaces',
        ])->toString(),
        ':workspaces' => 'https://www.drupal.org/docs/8/core/modules/workspace/overview',
      ]) . '</p>';
      return $output;
  }
  return NULL;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.