function ban_help in Drupal 9
Same name and namespace in other branches
- 8 core/modules/ban/ban.module \ban_help()
- 10 core/modules/ban/ban.module \ban_help()
Implements hook_help().
File
- core/
modules/ ban/ ban.module, line 14 - Allows to ban individual IP addresses.
Code
function ban_help($route_name, RouteMatchInterface $route_match) {
switch ($route_name) {
case 'help.page.ban':
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Ban module allows administrators to ban visits to their site from individual IP addresses. For more information, see the <a href=":url">online documentation for the Ban module</a>.', [
':url' => 'https://www.drupal.org/documentation/modules/ban',
]) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Banning IP addresses') . '</dt>';
$output .= '<dd>' . t('Administrators can enter IP addresses to ban on the <a href=":bans">IP address bans</a> page.', [
':bans' => Url::fromRoute('ban.admin_page')
->toString(),
]) . '</dd>';
$output .= '</dl>';
return $output;
case 'ban.admin_page':
return '<p>' . t('IP addresses listed here are banned from your site. Banned addresses are completely forbidden from accessing the site and instead see a brief message explaining the situation.') . '</p>';
}
}