function basic_auth_help

Same name and namespace in other branches
  1. 9 core/modules/basic_auth/basic_auth.module \basic_auth_help()
  2. 8.9.x core/modules/basic_auth/basic_auth.module \basic_auth_help()
  3. 10 core/modules/basic_auth/basic_auth.module \basic_auth_help()

Implements hook_help().


core/modules/basic_auth/basic_auth.module, line 14


function basic_auth_help($route_name, RouteMatchInterface $route_match) {
    switch ($route_name) {
        case '':
            $output = '';
            $output .= '<h2>' . t('About') . '</h2>';
            $output .= '<p>' . t('The HTTP Basic Authentication module supplies an <a href="">HTTP Basic authentication</a> provider for web service requests. This authentication provider authenticates requests using the HTTP Basic Authentication username and password, as an alternative to using Drupal\'s standard cookie-based authentication system. It is only useful if your site provides web services configured to use this type of authentication (for instance, the <a href=":rest_help">RESTful Web Services module</a>). For more information, see the <a href=":hba_do">online documentation for the HTTP Basic Authentication module</a>.', [
                ':hba_do' => '',
                ':rest_help' => \Drupal::moduleHandler()->moduleExists('rest') ? Url::fromRoute('', [
                    'name' => 'rest',
                ])->toString() : '#',
            ]) . '</p>';
            return $output;

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