BanHooks.php

Namespace

Drupal\ban\Hook

File

core/modules/ban/src/Hook/BanHooks.php

View source
<?php

namespace Drupal\ban\Hook;

use Drupal\Core\Url;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Hook\Attribute\Hook;

/**
 * Hook implementations for ban.
 */
class BanHooks {
    
    /**
     * Implements hook_help().
     */
    public function help($route_name, RouteMatchInterface $route_match) {
        switch ($route_name) {
            case 'help.page.ban':
                $output = '';
                $output .= '<h2>' . t('About') . '</h2>';
                $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 .= '<h2>' . t('Uses') . '</h2>';
                $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>';
        }
    }

}

Classes

Title Deprecated Summary
BanHooks Hook implementations for ban.

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