HookDiscovery.php

Same filename and directory in other branches
  1. 11.x core/lib/Drupal/Core/Plugin/Discovery/HookDiscovery.php
  2. 10 core/lib/Drupal/Core/Plugin/Discovery/HookDiscovery.php
  3. 9 core/lib/Drupal/Core/Plugin/Discovery/HookDiscovery.php
  4. 8.9.x core/lib/Drupal/Core/Plugin/Discovery/HookDiscovery.php

Namespace

Drupal\Core\Plugin\Discovery

File

core/lib/Drupal/Core/Plugin/Discovery/HookDiscovery.php

View source
<?php

namespace Drupal\Core\Plugin\Discovery;

use Drupal\Component\Plugin\Discovery\DiscoveryInterface;
use Drupal\Component\Plugin\Discovery\DiscoveryTrait;
use Drupal\Core\Extension\ModuleHandlerInterface;

/**
 * Provides a hook-based plugin discovery class.
 */
class HookDiscovery implements DiscoveryInterface {
  use DiscoveryTrait;
  
  /**
   * Constructs a Drupal\Core\Plugin\Discovery\HookDiscovery object.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler.
   * @param string $hook
   *   The Drupal hook that a module can implement in order to interface to
   *   this discovery class.
   */
  public function __construct(protected ModuleHandlerInterface $moduleHandler, protected $hook) {
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDefinitions() {
    $definitions = [];
    $this->moduleHandler
      ->invokeAllWith($this->hook, function (callable $hook, string $module) use (&$definitions) {
      $module_definitions = $hook();
      foreach ($module_definitions as $plugin_id => $definition) {
        $definition['provider'] = $module;
        $definitions[$plugin_id] = $definition;
      }
    });
    return $definitions;
  }

}

Classes

Title Deprecated Summary
HookDiscovery Provides a hook-based plugin discovery class.

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