function WorkspacesUiHooks::help

Implements hook_help().

File

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

Class

WorkspacesUiHooks

Hook implementations for the workspaces_ui module.

Namespace

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>' . t('About') . '</h2>';
            $output .= '<p>' . 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;
}