1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Plugin
  7. \
  8. Discovery
  9. \
  10. HookDiscovery

HookDiscovery

class HookDiscovery implements DiscoveryInterface (View source)

Provides a hook-based plugin discovery class.

Traits

DiscoveryTrait

Properties

protected string $hook

The name of the hook that will be implemented by this discovery instance.
protected ModuleHandlerInterface $moduleHandler

The module handler used to find and execute the plugin hook.

Methods

array
getDefinitions()

Gets the definition of all plugins for this type.

getDefinition($plugin_id, $exception_on_invalid = TRUE)

{@inheritdoc}

from  DiscoveryTrait
array|null
doGetDefinition(array $definitions, string $plugin_id, bool $exception_on_invalid)

Gets a specific plugin definition.

from  DiscoveryTrait
hasDefinition($plugin_id)

{@inheritdoc}

from  DiscoveryTrait
__construct(ModuleHandlerInterface $module_handler, string $hook)

Constructs a Drupal\Core\Plugin\Discovery\HookDiscovery object.

Details

at line 47
array getDefinitions()

Gets the definition of all plugins for this type.

Return Value

array

An array of plugin definitions (empty array if no definitions were found). Keys are plugin IDs.

in DiscoveryTrait at line 20
getDefinition($plugin_id, $exception_on_invalid = TRUE)

{@inheritdoc}

Parameters

$plugin_id
$exception_on_invalid

in DiscoveryTrait at line 43
protected array|null doGetDefinition(array $definitions, string $plugin_id, bool $exception_on_invalid)

Gets a specific plugin definition.

Parameters

array $definitions

An array of the available plugin definitions.
string $plugin_id

A plugin id.
bool $exception_on_invalid

If TRUE, an invalid plugin ID will cause an exception to be thrown; if FALSE, NULL will be returned.

Return Value

array|null

A plugin definition, or NULL if the plugin ID is invalid and $exception_on_invalid is TRUE.

Exceptions

PluginNotFoundException

in DiscoveryTrait at line 59
hasDefinition($plugin_id)

{@inheritdoc}

Parameters

$plugin_id

at line 39
__construct(ModuleHandlerInterface $module_handler, string $hook)

Constructs a Drupal\Core\Plugin\Discovery\HookDiscovery object.

Parameters

ModuleHandlerInterface $module_handler

The module handler.
string $hook

The Drupal hook that a module can implement in order to interface to this discovery class.