function HelpBlock::build

Same name in other branches
  1. 9 core/modules/help/src/Plugin/Block/HelpBlock.php \Drupal\help\Plugin\Block\HelpBlock::build()
  2. 8.9.x core/modules/help/src/Plugin/Block/HelpBlock.php \Drupal\help\Plugin\Block\HelpBlock::build()
  3. 10 core/modules/help/src/Plugin/Block/HelpBlock.php \Drupal\help\Plugin\Block\HelpBlock::build()

Overrides BlockPluginInterface::build

File

core/modules/help/src/Plugin/Block/HelpBlock.php, line 87

Class

HelpBlock
Provides a 'Help' block.

Namespace

Drupal\help\Plugin\Block

Code

public function build() {
    // Do not show on a 403 or 404 page.
    if ($this->request->attributes
        ->has('exception')) {
        return [];
    }
    $build = [];
    $this->moduleHandler
        ->invokeAllWith('help', function (callable $hook, string $module) use (&$build) {
        // Don't add empty strings to $build array.
        if ($help = $hook($this->routeMatch
            ->getRouteName(), $this->routeMatch)) {
            // Convert strings to #markup render arrays so that they will XSS admin
            // filtered.
            $build[] = is_array($help) ? $help : [
                '#markup' => $help,
            ];
        }
    });
    return $build;
}

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